colossus.service.AsyncHandlerGenerator

AsyncHandler

class AsyncHandler extends ServiceClient[I, O] with WatchedHandler

this is used to communicate with an external actor being used as a service client.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AsyncHandler
  2. WatchedHandler
  3. ServiceClient
  4. ManualUnbindHandler
  5. ServiceClientLike
  6. ClientConnectionHandler
  7. Controller
  8. OutputController
  9. InputController
  10. MasterController
  11. ConnectionHandler
  12. WorkerItem
  13. AnyRef
  14. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AsyncHandler(config: ClientConfig, caller: ActorRef, worker: WorkerRef)

Type Members

  1. case class QueuedItem(item: Output, postWrite: (OutputResult) ⇒ Unit, creationTimeMillis: Long) extends Product with Serializable

    Definition Classes
    OutputController
  2. type ResponseHandler = (Try[O]) ⇒ Unit

    Definition Classes
    ServiceClient
  3. case class SourcedRequest(message: I, handler: (Try[O]) ⇒ Unit) extends Product with Serializable

    Definition Classes
    ServiceClient

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 binding: Option[WorkerItemBinding]

    When bound to a worker, this contains the [WorkerItemBinding]

    When bound to a worker, this contains the [WorkerItemBinding]

    Definition Classes
    WorkerItem
  8. def boundWorker: Option[WorkerRef]

    Definition Classes
    WorkerItem
  9. val caller: ActorRef

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. val codec: Codec[I, O]

    Definition Classes
    ControllerMasterController
  12. def connected(endpoint: 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).

    endpoint

    The endpoint which wraps the java NIO layer.

    Definition Classes
    ServiceClientControllerConnectionHandler
  13. 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
    ServiceClientControllerConnectionHandler
  14. def connectionInfo: Option[ConnectionInfo]

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

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

    Definition Classes
    Controller
  15. 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
    ServiceClientControllerConnectionHandler
  16. def connectionStatus: ConnectionStatus

    returns

    Underlying WriteEndpoint's ConnectionStatus, defaults to Connecting if there is no WriteEndpoint

    Definition Classes
    ServiceClient
  17. 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
    ConnectionHandler
  18. val controllerConfig: ControllerConfig

    Definition Classes
    ControllerMasterController
  19. def disconnect(): Unit

    Definition Classes
    ControllerMasterController
  20. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  24. def gracefulDisconnect(): Unit

    Allow any requests in transit to complete, but cancel all pending requests and don't allow any new ones

    Allow any requests in transit to complete, but cancel all pending requests and don't allow any new ones

    Definition Classes
    ServiceClientServiceClientLikeController
  25. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  26. def id: Option[Long]

    Definition Classes
    WorkerItem
  27. def idleCheck(period: Duration): Unit

    Called periodically on every attached connection handler, this can be used for checking if an ongoing operation has timed out.

    Called periodically on every attached connection handler, this can be used for checking if an ongoing operation has timed out.

    Be aware that this is totally independant of a connection's idle timeout, which is only based on the last time there was any I/O.

    period

    the frequency at which this method is called. Currently this is hardcoded to WorkerManager.IdleCheckFrequency, but may become application dependent in the future.

    Definition Classes
    ServiceClientOutputControllerConnectionHandler
  28. def isBound: Boolean

    Definition Classes
    WorkerItem
  29. def isConnected: Boolean

    Definition Classes
    Controller
  30. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  31. lazy val log: LoggingAdapter

    Definition Classes
    ServiceClient
  32. val maxIdleTime: Duration

    If no data is either sent or received in this amount of time, the connection is closed.

    If no data is either sent or received in this amount of time, the connection is closed. Defaults to Duration.Inf but handlers can override it

    Definition Classes
    ServiceClientClientConnectionHandler
  33. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  36. def onBind(): Unit

    Called when the item is bound to a worker.

    Called when the item is bound to a worker.

    Definition Classes
    AsyncHandlerServiceClientWorkerItem
  37. def onUnbind(): Unit

    Called when the item has been unbound from a worker

    Called when the item has been unbound from a worker

    Definition Classes
    AsyncHandlerWorkerItem
  38. def outputQueueFull: Boolean

    Definition Classes
    OutputController
  39. def pauseReads(): Unit

    Attributes
    protected
    Definition Classes
    InputController
  40. def pauseWrites(): Unit

    Pauses writing of the next item in the queue.

    Pauses writing of the next item in the queue. If there is currently a message in the process of writing, it will be unaffected. New messages can still be pushed to the queue as long as it is not full

    Attributes
    protected
    Definition Classes
    OutputController
  41. def processMessage(response: O): Unit

    Definition Classes
    ServiceClientInputController
  42. def purgeAll(reason: Throwable): Unit

    Purge both pending and outgoing messages

    Purge both pending and outgoing messages

    Attributes
    protected
    Definition Classes
    OutputController
  43. def purgeOutgoing(reason: Throwable): Unit

    Purge the outgoing message, if there is one

    Purge the outgoing message, if there is one

    If a message is currently being streamed, the stream will be terminated

    Attributes
    protected
    Definition Classes
    OutputController
  44. def purgePending(reason: Throwable): Unit

    Purge all pending messages

    Purge all pending messages

    If a message is currently being written, it is not affected

    Attributes
    protected
    Definition Classes
    OutputController
  45. def push(item: I, createdMillis: Long = System.currentTimeMillis)(postWrite: (OutputResult) ⇒ Unit): Boolean

    Push a message to be written

    Push a message to be written

    Pushing a message does not necessarily mean it will be written, but rather that the message is queued to be written. Messages can be queue regardless of the state of the underlying connection, even if the connection is never reconnected. It is up to the caller to determine whether a message should be pushed based on connection state.

    item

    the message to push

    createdMillis

    the timestamp of when the message was created, defaults to now if not specified

    postWrite

    called either when writing has completed or failed

    returns

    true if the message was successfully enqueued, false if the queue is full

    Attributes
    protected
    Definition Classes
    OutputController
  46. def queueSize: Int

    Definition Classes
    OutputController
  47. def readsEnabled: Boolean

    Definition Classes
    InputController
  48. def readyForData(): Unit

    This function is called to signal to the handler that it can resume writing data.

    This function is called to signal to the handler that it can resume writing data. It is called as part of the WriteEndPoint event loop write cycle, where previously this handler attempted to write data, but the buffers were filled up. This is called once the buffers are empty again and able to receive data. This handler should be in a state where it is paused on writing data until this handler is invoked.

    Definition Classes
    OutputControllerConnectionHandler
  49. 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
    InputControllerConnectionHandler
  50. 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
    AsyncHandlerServiceClientWorkerItem
  51. def resumeReads(): Unit

    Attributes
    protected
    Definition Classes
    InputController
  52. def resumeWrites(): Unit

    Resumes writing of messages if currently paused, otherwise has no affect

    Resumes writing of messages if currently paused, otherwise has no affect

    Attributes
    protected
    Definition Classes
    OutputController
  53. def send(request: I): Callback[O]

    Create a callback for sending a request.

    Create a callback for sending a request. this allows you to do something like service.send("request"){response => "YAY"}.map{str => println(str)}.execute()

    Definition Classes
    ServiceClientServiceClientLike
  54. var state: ConnectionState

    Attributes
    protected
    Definition Classes
    ControllerMasterController
  55. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  56. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. val watchedActor: ActorRef

    Definition Classes
    AsyncHandlerWatchedHandler
  61. def writesEnabled: Boolean

    Definition Classes
    OutputController

Inherited from WatchedHandler

Inherited from ServiceClient[I, O]

Inherited from ManualUnbindHandler

Inherited from ServiceClientLike[I, O]

Inherited from ClientConnectionHandler

Inherited from Controller[O, I]

Inherited from OutputController[O, I]

Inherited from InputController[O, I]

Inherited from MasterController[O, I]

Inherited from ConnectionHandler

Inherited from WorkerItem

Inherited from AnyRef

Inherited from Any

Ungrouped