Class

colossus.protocols.http

HttpService

Related Doc: package http

Permalink

abstract class HttpService extends BaseHttpServiceHandler[Http]

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HttpService
  2. BaseHttpServiceHandler
  3. Service
  4. ServiceServer
  5. ServerConnectionHandler
  6. Controller
  7. OutputController
  8. InputController
  9. MasterController
  10. IdleCheck
  11. CoreHandler
  12. ConnectionHandler
  13. WorkerItem
  14. AnyRef
  15. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HttpService(context: ServerContext)

    Permalink
  2. new HttpService(config: ServiceConfig, context: ServerContext)

    Permalink

Abstract Value Members

  1. abstract def handle: PartialHandler[Http]

    Permalink
    Definition Classes
    Service

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. final def become(nh: () ⇒ ConnectionHandler): Boolean

    Permalink

    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

    Definition Classes
    CoreHandler
  6. def canPush: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    OutputController
  7. def clone(): AnyRef

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

    Permalink
    Definition Classes
    ControllerMasterController
  9. def connected(endpt: WriteEndpoint): Unit

    Permalink

    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
    ControllerCoreHandlerConnectionHandler
  10. def connectionClosed(cause: DisconnectCause): Unit

    Permalink

    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
  11. final def connectionHandle: Option[ConnectionHandle]

    Permalink

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

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

    Definition Classes
    CoreHandler
  12. def connectionLost(cause: DisconnectError): Unit

    Permalink

    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
  13. def connectionState: ConnectionState

    Permalink
    Definition Classes
    CoreHandler
  14. def connectionTerminated(cause: DisconnectCause): Unit

    Permalink

    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
  15. val context: Context

    Permalink
    Definition Classes
    WorkerItem
  16. val controllerConfig: ControllerConfig

    Permalink
    Definition Classes
    ControllerMasterController
  17. def currentRequestBufferSize: Int

    Permalink
    Definition Classes
    ServiceServer
  18. final def disconnect(): Unit

    Permalink

    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.

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  21. implicit val executor: CallbackExecutor

    Permalink
    Definition Classes
    Service
  22. def fatalInputError(reason: Throwable): Unit

    Permalink
    Definition Classes
    ControllerInputController
  23. def finalize(): Unit

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

    Permalink

    Immediately terminate the connection.

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

    Definition Classes
    CoreHandler
  25. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  27. def id: Long

    Permalink
    Definition Classes
    WorkerItem
  28. def idleCheck(period: FiniteDuration): Unit

    Permalink

    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
    ServiceServerOutputControllerIdleCheck
  29. lazy val inputSizeHistogram: Option[Histogram]

    Permalink
    Definition Classes
    InputController
  30. lazy val inputSizeTracker: ParserSizeTracker

    Permalink
    Definition Classes
    InputController
  31. def isBound: Boolean

    Permalink
    Definition Classes
    WorkerItem
  32. def isConnected: Boolean

    Permalink
    Definition Classes
    CoreHandler
  33. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  34. val log: LoggingAdapter

    Permalink
    Definition Classes
    ServiceServer
  35. def logError(error: ProcessingFailure[Input]): Option[String]

    Permalink
    Attributes
    protected
    Definition Classes
    ServiceServer
  36. def name: MetricAddress

    Permalink
    Definition Classes
    ServiceServer
  37. implicit val namespace: MetricNamespace

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

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

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

    Permalink
    Definition Classes
    AnyRef
  41. def onBind(): Unit

    Permalink

    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: ErrorHandler[Http]

    Permalink
    Definition Classes
    Service
  43. def onUnbind(): Unit

    Permalink

    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

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

    Permalink

    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 pendingBufferSize: Int

    Permalink
    Attributes
    protected
    Definition Classes
    OutputController
  47. def processBadRequest(reason: Throwable): Some[Output]

    Permalink
    Definition Classes
    ServiceServerInputController
  48. def processFailure(error: ProcessingFailure[Input]): Output

    Permalink
    Attributes
    protected
    Definition Classes
    ServiceServiceServer
  49. def processMessage(request: Input): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ServiceServerInputController
  50. def processRequest(input: Input): Callback[Output]

    Permalink
    Definition Classes
    BaseHttpServiceHandlerServiceServiceServer
  51. def purgePending(reason: Throwable): Unit

    Permalink

    Purge all pending messages

    Purge all pending messages

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

    Attributes
    protected
    Definition Classes
    OutputController
  52. def push(item: Output, createdMillis: Long = System.currentTimeMillis)(postWrite: PostWrite): Boolean

    Permalink

    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
  53. def readsEnabled: Boolean

    Permalink
    Definition Classes
    InputController
  54. def readyForData(buffer: DataOutBuffer): MoreDataResult

    Permalink
    Definition Classes
    OutputControllerConnectionHandler
  55. def receive: Receive

    Permalink
    Definition Classes
    Service
  56. def receivedData(data: DataBuffer): Unit

    Permalink

    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
  57. def receivedMessage(message: Any, sender: ActorRef): Unit

    Permalink

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

    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
    ServiceWorkerItem
  58. def requestLogFormat: Option[RequestFormatter[Input]]

    Permalink
    Definition Classes
    ServiceServer
  59. def resumeReads(): Unit

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

    Permalink

    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
  61. def sender(): ActorRef

    Permalink
    Definition Classes
    Service
  62. def shutdown(): Unit

    Permalink
    Definition Classes
    ServiceServerControllerCoreHandler
  63. final def shutdownRequest(): Unit

    Permalink

    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
  64. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  65. def tagDecorator: ReturnCodeTagDecorator[Http]

    Permalink
    Definition Classes
    BaseHttpServiceHandlerServiceServer
  66. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  67. def unhandled: PartialHandler[Http]

    Permalink
    Attributes
    protected
    Definition Classes
    Service
  68. def unhandledError: ErrorHandler[Http]

    Permalink
    Attributes
    protected
    Definition Classes
    Service
  69. def unhandledReceive: Receive

    Permalink
    Attributes
    protected
    Definition Classes
    Service
  70. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    WorkerItem
  74. def writesEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    OutputController

Inherited from BaseHttpServiceHandler[Http]

Inherited from Service[Http]

Inherited from ServiceServer[Input, Output]

Inherited from ServerConnectionHandler

Inherited from Controller[Input, Output]

Inherited from OutputController[Input, Output]

Inherited from InputController[Input, Output]

Inherited from MasterController[Input, Output]

Inherited from IdleCheck

Inherited from CoreHandler

Inherited from ConnectionHandler

Inherited from WorkerItem

Inherited from AnyRef

Inherited from Any

Ungrouped