colossus.service

BasicServiceHandler

class BasicServiceHandler[C <: CodecDSL] extends ServiceServer[service.BasicServiceHandler.C.Input, service.BasicServiceHandler.C.Output] with DSLHandler[C]

Linear Supertypes
DSLHandler[C], ConnectionContext[C], ServiceServer[C.Input, C.Output], ServerConnectionHandler, Controller[C.Input, C.Output], OutputController[C.Input, C.Output], InputController[C.Input, C.Output], MasterController[C.Input, C.Output], ConnectionHandler, WorkerItem, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BasicServiceHandler
  2. DSLHandler
  3. ConnectionContext
  4. ServiceServer
  5. ServerConnectionHandler
  6. Controller
  7. OutputController
  8. InputController
  9. MasterController
  10. ConnectionHandler
  11. WorkerItem
  12. AnyRef
  13. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BasicServiceHandler(config: ServiceConfig, worker: WorkerRef, provider: CodecProvider[C], initializer: (ConnectionContext[C]) ⇒ Unit)(implicit ex: ExecutionContext)

Type Members

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

    Definition Classes
    OutputController
  2. case class SyncPromise(request: I) extends Product with Serializable

    Definition Classes
    ServiceServer

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. def addError(err: Throwable, extraTags: TagMap = TagMap.Empty): Unit

    Definition Classes
    ServiceServer
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def become(handler: PartialHandler[C]): Unit

    Set a partial function for the request processing handler for the connection.

    Set a partial function for the request processing handler for the connection. Any request that falls through the handler will be automatically converted into an error response with a UnhandledRequestException as the cause

    Definition Classes
    BasicServiceHandlerConnectionContext
  9. 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
  10. def boundWorker: Option[WorkerRef]

    Definition Classes
    WorkerItem
  11. implicit val callbackExecutor: CallbackExecutor

    Definition Classes
    ServiceServer
  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. val codec: Codec[C.Output, C.Input]

    Definition Classes
    ControllerMasterController
  14. val concurrentRequests: Local[Counter]

    Definition Classes
    ServiceServer
  15. def connected(e: 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
    BasicServiceHandlerControllerConnectionHandler
  16. 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

    Definition Classes
    ServiceServerControllerConnectionHandler
  17. 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
  18. 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

    Definition Classes
    ServiceServerControllerConnectionHandler
  19. 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
  20. val controllerConfig: ControllerConfig

    Definition Classes
    ControllerMasterController
  21. def disconnect(): Unit

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

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

    Definition Classes
    AnyRef → Any
  24. val errors: Local[Rate]

    Definition Classes
    ServiceServer
  25. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. def fullHandler: PartialFunction[C.Input, Callback[C.Output]]

    Attributes
    protected
  27. final def getClass(): Class[_]

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

    Terminate the connection, but allow any outstanding requests to complete (or timeout) before disconnecting

    Terminate the connection, but allow any outstanding requests to complete (or timeout) before disconnecting

    Definition Classes
    ServiceServerController
  29. def hashCode(): Int

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

    Definition Classes
    WorkerItem
  31. 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
    ServiceServerOutputControllerConnectionHandler
  32. val initializer: (ConnectionContext[C]) ⇒ Unit

  33. def isBound: Boolean

    Definition Classes
    WorkerItem
  34. def isConnected: Boolean

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

    Definition Classes
    Any
  36. val latency: Local[Histogram]

    Definition Classes
    ServiceServer
  37. val log: LoggingAdapter

    Definition Classes
    ServiceServer
  38. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  41. 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
    WorkerItem
  42. def onError(handler: ErrorHandler[C]): Unit

    Attach a handler for non-recoverable errors.

    Attach a handler for non-recoverable errors. This includes uncaught exceptions, unhandled requests, request timeouts, and other server-level errors. In every case, this handler should not attempt to actually process the request, but instead simply return an appropriately formatted error response.

    Definition Classes
    BasicServiceHandlerConnectionContext
  43. 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
    WorkerItem
  44. def pauseReads(): Unit

    Attributes
    protected
    Definition Classes
    InputController
  45. 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
  46. def process(f: (C.Input) ⇒ Callback[C.Output]): Unit

    Set a function for the request processing handler for the connection

    Set a function for the request processing handler for the connection

    Definition Classes
    ConnectionContext
  47. def processFailure(request: C.Input, reason: Throwable): C.Output

    Attributes
    protected
    Definition Classes
    BasicServiceHandlerServiceServer
  48. def processMessage(request: C.Input): Unit

    Attributes
    protected
    Definition Classes
    ServiceServerInputController
  49. def processRequest(i: C.Input): Callback[C.Output]

    Attributes
    protected
    Definition Classes
    BasicServiceHandlerServiceServer
  50. def purgeAll(reason: Throwable): Unit

    Purge both pending and outgoing messages

    Purge both pending and outgoing messages

    Attributes
    protected
    Definition Classes
    OutputController
  51. 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
  52. 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
  53. def push(item: C.Output, 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
  54. def queueSize: Int

    Definition Classes
    OutputController
  55. def readsEnabled: Boolean

    Definition Classes
    InputController
  56. 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
  57. def receive(handler: PartialFunction[Any, Unit]): Unit

    Set the handler for actor messages intended for this connection.

    Set the handler for actor messages intended for this connection.

    Definition Classes
    BasicServiceHandlerConnectionContext
  58. 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
  59. 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
    BasicServiceHandlerWorkerItem
  60. val requests: Local[Rate]

    Definition Classes
    ServiceServer
  61. val requestsPerConnection: Local[Histogram]

    Definition Classes
    ServiceServer
  62. def resumeReads(): Unit

    Attributes
    protected
    Definition Classes
    InputController
  63. 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
  64. def schedule(in: FiniteDuration, message: Any): Unit

    Definition Classes
    ServiceServer
  65. def sender(): ActorRef

    Gets the sender of the current message being processed in the receive handler

    Gets the sender of the current message being processed in the receive handler

    Definition Classes
    BasicServiceHandlerConnectionContext
  66. def shutdownRequest(): Unit

    The server is beginning to shutdown and is signaling to the connection that it should cleanup and terminate.

    The server is beginning to shutdown and is signaling to the connection that it should cleanup and terminate. This gives the connection time to gracefully shutdown, however eventually the server will timeout and forcefully close the connection

    Definition Classes
    ServiceServerServerConnectionHandler
  67. var state: ConnectionState

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

    Definition Classes
    AnyRef
  69. def toString(): String

    Definition Classes
    AnyRef → Any
  70. def unhandled: PartialHandler[C]

    Attributes
    protected
  71. def unhandledError: ErrorHandler[C]

    Attributes
    protected
  72. def unhandledReceive: Receive

    Attributes
    protected
  73. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  76. def writesEnabled: Boolean

    Definition Classes
    OutputController

Inherited from DSLHandler[C]

Inherited from ConnectionContext[C]

Inherited from ServiceServer[C.Input, C.Output]

Inherited from ServerConnectionHandler

Inherited from Controller[C.Input, C.Output]

Inherited from OutputController[C.Input, C.Output]

Inherited from InputController[C.Input, C.Output]

Inherited from MasterController[C.Input, C.Output]

Inherited from ConnectionHandler

Inherited from WorkerItem

Inherited from AnyRef

Inherited from Any

Ungrouped