ThriftConnectedClient

Instance Constructors

new ThriftConnectedClient(underlying: FinagledClientFactory, txnAbortTimeout: Duration)

underlying
a FinagledClientFactory that wraps a ServiceFactory[ThriftClientRequest, Array[Byte] ].

Value Members

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def close(): Unit

Close any consume resources such as TCP Connections.
Close any consume resources such as TCP Connections. This should will not release resources created by the from() and to() methods; it is the responsibility of the caller to release those resources directly.

Definition Classes
ClientBase → Client
def delete(queueName: String): Future[Response]

Delete a queue.
Delete a queue. Removes the journal file on the remote server.

Definition Classes
ThriftConnectedClient → Client
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flush(queueName: String): Future[Response]

Flush a queue.
Flush a queue. Empties all items from the queue without deleting the journal.

Definition Classes
ThriftConnectedClient → Client
def get(queueName: String, waitUpTo: Duration = 0.seconds): Future[Option[Buf]]

Dequeue an item.
Dequeue an item.
waitUpTo
if the queue is empty, indicate to the Kestrel server how long to block the operation, waiting for something to arrive, before returning None. 0.seconds (the default) means no waiting, as opposed to infinite wait.

Definition Classes
ThriftConnectedClient → Client
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def read(queueName: String): ReadHandle

Read indefinitely from the given queue with transactions.
Read indefinitely from the given queue with transactions. Note that {{read}} will reserve a connection for the duration of the read. Note that this does no buffering: we await acknowledment (through synchronizing on ReadMessage.ack) before acknowledging that message to the kestrel server & reading the next one.
returns
A read handle.

Definition Classes
ThriftConnectedClient → Client
def read(processResponse: (Seq[Item]) ⇒ Try[Option[(Buf, Long)]], openCommand: (FinagledClosableClient) ⇒ Future[Seq[Item]], closeAndOpenCommand: (Long) ⇒ (FinagledClosableClient) ⇒ Future[Seq[Item]], abortCommand: (Long) ⇒ (FinagledClosableClient) ⇒ Future[Seq[Item]]): ReadHandle

Read indefinitely from a underlying service
Read indefinitely from a underlying service
processResponse
function to process a raw reply into: Return(Some()) successful read of a single item, Return(None) successful read of zero items, or Throw() invalid reply
openCommand
the command to open a read
closeAndOpenCommand
the command to ack and open a read
abortCommand
the command to abort a read
returns
a ReadHandle

Attributes
protected
Definition Classes
ClientBase
def readReliably(queueName: String): ReadHandle

{{readReliably}} with infinite, 0-second backoff retries.
{{readReliably}} with infinite, 0-second backoff retries.

Definition Classes
Client
def readReliably(queueName: String, timer: Timer, retryBackoffs: ⇒ Stream[Duration]): ReadHandle

Read from a queue reliably: retry streaming reads on failure (which may indeed be backed by multiple kestrel hosts).
Read from a queue reliably: retry streaming reads on failure (which may indeed be backed by multiple kestrel hosts). This presents to the user a virtual "reliable" stream of messages, and errors are transparent.
queueName
the queue to read from
timer
a timer used to delay retries
retryBackoffs
a (possibly infinite) stream of durations comprising a backoff policy Note: the use of call-by-name for the stream is in order to ensure that we do not suffer a space leak for infinite retries.

Definition Classes
Client
def set(queueName: String, value: Buf, expiry: Time = Time.epoch): Future[Response]

Enqueue an item.
Enqueue an item.
expiry
how long the item is valid for (Kestrel will delete the item if it isn't dequeued in time). Time.epoch (0) means the item will never expire.

Definition Classes
ThriftConnectedClient → Client
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def write(queueName: String, offer: Offer[Buf]): Future[Throwable]

Write indefinitely to the given queue.
Write indefinitely to the given queue. The given offer is synchronized on indefinitely, writing the items as they become available. Unlike {{read}}, {{write}} does not reserve a connection.
returns
a Future indicating client failure.

Definition Classes
ClientBase → Client

Related Doc: package kestrel

class ThriftConnectedClient extends ClientBase[FinagledClosableClient, Seq[Item], Long]

Instance Constructors

new ThriftConnectedClient(underlying: FinagledClientFactory, txnAbortTimeout: Duration)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def close(): Unit

def delete(queueName: String): Future[Response]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def flush(queueName: String): Future[Response]

def get(queueName: String, waitUpTo: Duration = 0.seconds): Future[Option[Buf]]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def read(queueName: String): ReadHandle

def read(processResponse: (Seq[Item]) ⇒ Try[Option[(Buf, Long)]], openCommand: (FinagledClosableClient) ⇒ Future[Seq[Item]], closeAndOpenCommand: (Long) ⇒ (FinagledClosableClient) ⇒ Future[Seq[Item]], abortCommand: (Long) ⇒ (FinagledClosableClient) ⇒ Future[Seq[Item]]): ReadHandle

def readReliably(queueName: String): ReadHandle

def readReliably(queueName: String, timer: Timer, retryBackoffs: ⇒ Stream[Duration]): ReadHandle

def set(queueName: String, value: Buf, expiry: Time = Time.epoch): Future[Response]

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

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def write(queueName: String, offer: Offer[Buf]): Future[Throwable]

Inherited from ClientBase[FinagledClosableClient, Seq[Item], Long]

Inherited from Client

Inherited from AnyRef

Inherited from Any

Ungrouped