colossus.service

ServiceServer

abstract class ServiceServer[I, O] extends Controller[I, O]

The ServiceServer provides an interface and basic functionality to create a server that processes requests and returns responses over a codec.

A Codec is simply the format in which the data is represented. Http, Redis protocol, Memcached protocl are all examples(and natively supported). It is entirely possible to use an additional Codec by creating a Codec to parse the desired protocol.

Requests can be processed synchronously or asynchronously. The server will ensure that all responses are written back in the order that they are received.

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

Instance Constructors

  1. new ServiceServer(codec: ServerCodec[I, O], config: ServiceConfig, worker: WorkerRef)(implicit ex: ExecutionContext, tagDecorator: TagDecorator[I, O] = TagDecorator.default[I, O])

Type Members

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

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

Abstract Value Members

  1. abstract def processFailure(request: I, reason: Throwable): O

    Attributes
    protected
  2. abstract def processRequest(request: I): Callback[O]

    Attributes
    protected
  3. abstract 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
    WorkerItem

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

  7. final def asInstanceOf[T0]: T0

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

    Definition Classes
    WorkerItem
  10. implicit val callbackExecutor: CallbackExecutor

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. val concurrentRequests: Local[Counter]

  13. 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
    ControllerConnectionHandler
  14. 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
  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

    Definition Classes
    ServiceServerControllerConnectionHandler
  16. def connectionTerminated(cause: DisconnectCause): Unit

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

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

    cause

    why the connection was terminated

    Definition Classes
    ConnectionHandler
  17. val controllerConfig: ControllerConfig

    Definition Classes
    Controller
  18. def disconnect(): Unit

    Definition Classes
    Controller
  19. final def eq(arg0: AnyRef): Boolean

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

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

  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

    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
  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
    ServiceServerConnectionHandler
  28. def isBound: Boolean

    Definition Classes
    WorkerItem
  29. def isConnected: Boolean

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

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

  32. val log: LoggingAdapter

  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.

    Attributes
    protected
    Definition Classes
    WorkerItem
  37. 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
  38. def pauseReads(): Unit

    Attributes
    protected
    Definition Classes
    Controller
  39. 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
    Controller
  40. def paused: Boolean

    Attributes
    protected
    Definition Classes
    Controller
  41. def processMessage(request: I): Unit

    Attributes
    protected
    Definition Classes
    ServiceServerController
  42. def purgeAll(): Unit

    Purge both pending and outgoing messages

    Purge both pending and outgoing messages

    Attributes
    protected
    Definition Classes
    Controller
  43. def purgeOutgoing(): 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
    Controller
  44. def purgePending(): Unit

    Purge all pending messages

    Purge all pending messages

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

    Attributes
    protected
    Definition Classes
    Controller
  45. def push(item: O)(postWrite: (OutputResult) ⇒ Unit): Boolean

    Push a message to be written

    Push a message to be written

    item

    the message to push

    postWrite

    called either when writing has completed or failed

    Attributes
    protected
    Definition Classes
    Controller
  46. 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
    ControllerConnectionHandler
  47. def receivedData(data: DataBuffer): Unit

    ***** INPUT ******

    ***** INPUT ******

    data

    DataBuffer read from the underlying Connection.

    Definition Classes
    ControllerConnectionHandler
  48. val requests: Local[Rate]

  49. val requestsPerConnection: Local[Histogram]

  50. def resumeReads: Unit

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

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

    Definition Classes
    AnyRef
  54. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Controller[I, O]

Inherited from ConnectionHandler

Inherited from WorkerItem

Inherited from AnyRef

Inherited from Any

Ungrouped