colossus.protocols.redis

RedisClient

Related Doc: package redis

class RedisClient extends ServiceClient[Command, Reply]

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RedisClient
  2. ServiceClient
  3. ManualUnbindHandler
  4. ServiceClientLike
  5. ClientConnectionHandler
  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 RedisClient(config: ClientConfig, worker: WorkerRef, maxSize: DataSize = RedisReplyParser.DefaultMaxSize)

Type Members

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

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

    Definition Classes
    ServiceClient
  3. case class SourcedRequest(message: I, handler: ResponseHandler) extends Product with Serializable

    Definition Classes
    ServiceClient

Value Members

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

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

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

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

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

    Definition Classes
    WorkerItem
  7. def clone(): AnyRef

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

    Definition Classes
    ControllerMasterController
  9. val config: ClientConfig

    Definition Classes
    ServiceClient
  10. 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
  11. 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
  12. def connectionFailed(): Unit

    Event handler for when a connection failed.

    Event handler for when a connection failed.

    Definition Classes
    ServiceClientClientConnectionHandler
  13. 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
  14. def connectionStatus: ConnectionStatus

    returns

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

    Definition Classes
    ServiceClient
  15. 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
  16. val controllerConfig: ControllerConfig

    Definition Classes
    ControllerMasterController
  17. def disconnect(): Unit

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

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

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

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

    Definition Classes
    AnyRef → Any
  22. 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
  23. def hashCode(): Int

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

    Definition Classes
    WorkerItem
  25. 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
    ServiceClientConnectionHandler
  26. def info: Callback[Map[String, String]]

  27. def isBound: Boolean

    Definition Classes
    WorkerItem
  28. def isConnected: Boolean

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

    Definition Classes
    Any
  30. lazy val log: LoggingAdapter

    Definition Classes
    ServiceClient
  31. 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
  32. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  35. def onBind(): Unit

    Called when the item is bound to a worker.

    Called when the item is bound to a worker.

    Definition Classes
    ServiceClientWorkerItem
  36. 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
  37. def pauseReads(): Unit

    Attributes
    protected
    Definition Classes
    InputController
  38. 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
  39. def processMessage(response: Reply): Unit

    Definition Classes
    ServiceClientInputController
  40. def purgeAll(): Unit

    Purge both pending and outgoing messages

    Purge both pending and outgoing messages

    Attributes
    protected
    Definition Classes
    OutputController
  41. 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
    OutputController
  42. 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
    OutputController
  43. def push(item: Command)(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

    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
  44. def queueSize: Int

    Definition Classes
    OutputController
  45. def readsEnabled: Boolean

    Definition Classes
    InputController
  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
    OutputControllerConnectionHandler
  47. 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
  48. def receivedMessage(message: Any, sender: ActorRef): Unit

    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
    ServiceClientWorkerItem
  49. def resumeReads(): Unit

    Attributes
    protected
    Definition Classes
    InputController
  50. 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
  51. def send(request: Command): Callback[Reply]

    Create a callback for sending a request.

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

    Definition Classes
    ServiceClientServiceClientLike
  52. var state: ConnectionState

    Attributes
    protected
    Definition Classes
    ControllerMasterController
  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( ... )
  58. val worker: WorkerRef

    Definition Classes
    ServiceClient
  59. def writesEnabled: Boolean

    Definition Classes
    OutputController

Inherited from ServiceClient[Command, Reply]

Inherited from ManualUnbindHandler

Inherited from ServiceClientLike[Command, Reply]

Inherited from ClientConnectionHandler

Inherited from Controller[Reply, Command]

Inherited from OutputController[Reply, Command]

Inherited from InputController[Reply, Command]

Inherited from MasterController[Reply, Command]

Inherited from ConnectionHandler

Inherited from WorkerItem

Inherited from AnyRef

Inherited from Any

Ungrouped