colossus.core

ServerRef

Related Doc: package core

case class ServerRef(config: ServerConfig, server: ActorRef, system: IOSystem, serverStateAgent: Agent[ServerState]) extends Product with Serializable

A ServerRef is the public interface of a Server. Servers should ONLY be interfaced with through this class. Both from an application design and from Akka idioms and best practices, passing around an actual Actor is strongly discouraged.

config

The ServerConfig used to create this Server

server

The ActorRef of the Server

system

The IOSystem to which this Server belongs

serverStateAgent

The current state of the Server.

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

Instance Constructors

  1. new ServerRef(config: ServerConfig, server: ActorRef, system: IOSystem, serverStateAgent: Agent[ServerState])

    config

    The ServerConfig used to create this Server

    server

    The ActorRef of the Server

    system

    The IOSystem to which this Server belongs

    serverStateAgent

    The current state of the Server.

Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  5. def clone(): AnyRef

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

  6. val config: ServerConfig

    The ServerConfig used to create this Server

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

    Post a message to a Server's Delegator

    Post a message to a Server's Delegator

    message
    sender
    returns

  8. def die(): Unit

    Immediately kill the server and all corresponding open connections.

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

    Definition Classes
    AnyRef

  10. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  13. def maxIdleTime: Duration

  14. def name: MetricAddress

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

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  18. val server: ActorRef

    The ActorRef of the Server

  19. def serverState: ServerState

  20. 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.

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

    Definition Classes
    AnyRef

  22. val system: IOSystem

    The IOSystem to which this Server belongs

  23. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped