colossus.core

ServerRef

case class ServerRef extends Product with Serializable

A ServerRef is a handle to a created server. It can be used to get basic information about the state of the server as well as send operational commands to it.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ServerRef
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. val config: ServerConfig

    The ServerConfig used to create this Server

  9. def die(): Unit

    Immediately kill the server and all corresponding open connections.

  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  13. def info(): Future[ServerInfo]

  14. def initializerBroadcast(message: Any)(implicit sender: ActorRef = ActorRef.noSender): Unit

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  16. def maxIdleTime: Duration

  17. def name: MetricAddress

  18. val namespace: MetricNamespace

  19. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  22. val server: ActorRef

    The ActorRef of the Server

  23. def serverState: ServerState

  24. def shutdown(): Unit

    Gracefully shutdown this server.

    Gracefully shutdown this server. This will cause the server to immediately begin refusing connections, but attempt to allow existing connections to close on their own. The shutdownRequest method will be called on every ServerConnectionHandler associated with this server. shutdownTimeout in ServerSettings controls how long the server will wait before it force-closes all connections and shuts down. The server actor will remain alive until it is fully shutdown.

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  26. val system: IOSystem

    The IOSystem to which this Server belongs

  27. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def delegatorBroadcast(message: Any)(implicit sender: ActorRef = ActorRef.noSender): Unit

    Broadcast a message to a all of the Initializers of this server.

    Broadcast a message to a all of the Initializers of this server.

    message
    sender
    returns

    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.0) function has been deprecated, please use initializerBroadcast instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped