ReadHandle

An ongoing transactional read (from {{read}}).

A common usage pattern is to attach asynchronous handlers to messages and error by invoking Offer.foreach on them. For example:

val readHandle: ReadHandle = ...
readHandle.messages.foreach { msg =>
  try {
    System.out.println(msg.bytes.toString("UTF-8"))
  } finally {
    msg.ack() // if we don't do this, no more msgs will come to us
  }
}
readHandle.error.foreach { System.error.println("zomg! got an error " + _.getMessage) }

Linear Supertypes

AnyRef, Any

Instance Constructors

new ReadHandle()

Abstract Value Members

abstract def close(): Unit

Closes the read.
Closes the read. Closes are signaled as an error with {{ReadClosedException}} when the close has completed.
abstract val error: Offer[Throwable]

Indicates an error in the read.
abstract val messages: Offer[ReadMessage]

An offer to synchronize on the next message.
An offer to synchronize on the next message. A new message is available only when the previous one has been acknowledged (through {{ReadMessage.ack()}})

Concrete 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 buffered(howmany: Int): ReadHandle

A copy of this {{ReadHandle}} that is buffered: it will make available {{howmany}} messages at once, proactively acknowledging them.
A copy of this {{ReadHandle}} that is buffered: it will make available {{howmany}} messages at once, proactively acknowledging them. This allows a consumer to process {{howmany}} items in parallel from one handle.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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] )
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
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( ... )

Related Docs: object ReadHandle | package kestrel

abstract class ReadHandle extends AnyRef

Instance Constructors

new ReadHandle()

Abstract Value Members

abstract def close(): Unit

abstract val error: Offer[Throwable]

abstract val messages: Offer[ReadMessage]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def buffered(howmany: Int): ReadHandle

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped