colossus.core

CoreHandler

abstract class CoreHandler extends ConnectionHandler

This is the connection handler on which the controller and service layers are built. It contains some common functionality that is ultimately exposed to the users, such as methods to call for disconnecting and safely getting a reference to the ConnectionHandle. While there is no requirement to build handlers on top of this one, it is recommended instead of directly implementing the ConnectionHandler trait

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CoreHandler
  2. ConnectionHandler
  3. WorkerItem
  4. WorkerItemEvents
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CoreHandler(context: Context)

Abstract Value Members

  1. abstract def connectionClosed(cause: DisconnectCause): Unit

    Connection was closed on our end, either by a shutdown, or by normal means

    Connection was closed on our end, either by a shutdown, or by normal means

    cause

    why the connection was closed

    Attributes
    protected
    Definition Classes
    ConnectionHandler
  2. abstract def connectionLost(cause: DisconnectError): Unit

    Connection lost is caused by termination, closed, etc

    Connection lost is caused by termination, closed, etc

    cause

    why the connection was lost

    Attributes
    protected
    Definition Classes
    ConnectionHandler
  3. abstract def readyForData(buffer: DataOutBuffer): MoreDataResult

    Definition Classes
    ConnectionHandler
  4. abstract def receivedData(data: DataBuffer): Unit

    Handler which is called when data is received from a Connection.

    Handler which is called when data is received from a Connection.

    data

    DataBuffer read from the underlying Connection.

    Definition Classes
    ConnectionHandler

Concrete 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. final def become(nh: () ⇒ ConnectionHandler): Boolean

    Replace this connection handler with the given handler.

    Replace this connection handler with the given handler. The actual swap only occurs when the shutdown process complete

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def completeShutdown(): Unit

    Attributes
    protected
  10. def connected(endpt: WriteEndpoint): Unit

    This handler is called when a Worker new Connection is established.

    This handler is called when a Worker new Connection is established. A Connection can be either an incoming (ie: something to connected to the server), or outgoing(ie: the server connected to a remote system).

    Definition Classes
    CoreHandlerConnectionHandler
  11. final def connectionHandle: Option[ConnectionHandle]

    Returns a read-only trait containing live information about the connection.

  12. def connectionState: ConnectionState

  13. def connectionTerminated(cause: DisconnectCause): Unit

    Called from Worker when a connection has been terminated either by an error or by normal means.

    Called from Worker when a connection has been terminated either by an error or by normal means.

    cause

    why the connection was terminated

    Definition Classes
    CoreHandlerConnectionHandler
  14. val context: Context

    Definition Classes
    CoreHandlerWorkerItem
  15. final def disconnect(): Unit

    Close the underlying connection.

    Close the underlying connection. This is a "graceful" disconnect process, in that any action mid-completion will be given a chance to finish what they're doing before the connection actually closes. For example, for a service this will allow any requests being processed to complete.

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

    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def forceDisconnect(): Unit

    Immediately terminate the connection.

    Immediately terminate the connection. this is a kill action and completely bypasses the shutdown process.

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

    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  22. def id: Long

    Definition Classes
    WorkerItem
  23. def isBound: Boolean

    Definition Classes
    WorkerItem
  24. def isConnected: Boolean

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  26. final def kill(reason: Throwable): Unit

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

    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  30. def onBind(): Unit

    Called when the item is bound to a worker.

    Called when the item is bound to a worker.

    Attributes
    protected
    Definition Classes
    WorkerItemEvents
  31. def onShutdown(): Unit

    Attributes
    protected
  32. def onUnbind(): Unit

    Called when the item has been unbound from a worker

    Called when the item has been unbound from a worker

    Attributes
    protected
    Definition Classes
    WorkerItemEvents
  33. def receivedMessage(message: Any, sender: ActorRef): Unit

    Provides a way to send this WorkerItem a message from an Actor by way of WorkerCommand.

    Provides a way to send this WorkerItem a message from an Actor by way of WorkerCommand.Message.

    message

    The message that was sent

    sender

    The sender who sent the message

    Definition Classes
    WorkerItemEvents
  34. def shutdown(): Unit

  35. final def shutdownRequest(): Unit

    A Request has been made to shutdown this WorkerItem.

    A Request has been made to shutdown this WorkerItem. By default this will simply unbind the item from its Worker, but this can be overriden to add in custom shutdown behaviors. Be aware that in some cases this method may not be called and the item will be unbound, such as when an IOSystem is shutting down.

    Definition Classes
    CoreHandlerWorkerItem
  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  37. def toString(): String

    Definition Classes
    AnyRef → Any
  38. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. def worker: WorkerRef

    Definition Classes
    WorkerItem

Inherited from ConnectionHandler

Inherited from WorkerItem

Inherited from WorkerItemEvents

Inherited from AnyRef

Inherited from Any

Ungrouped