Trait/Object

com.metamx.tranquility.beam

Beam

Related Docs: object Beam | package beam

Permalink

trait Beam[MessageType] extends AnyRef

Beams can accept messages and forward them along. The propagate method may throw a DefunctBeamException, which means the beam should be discarded (after calling close()).

Linear Supertypes

AnyRef, Any

Known Subclasses

ClusteredBeam, DruidBeam, HashPartitionBeam, HttpBeam, MemoryBeam, MergingPartitioningBeam, NoopBeam, RoundRobinBeam, TransformingBeam

Ordering

Alphabetic
By inheritance

Inherited

Beam
AnyRef
Any

Hide All
Show all

Visibility

Public
All

Abstract Value Members

abstract def close(): Future[Unit]

Signal that no more messages will be sent.
Signal that no more messages will be sent. Many implementations need this to do proper cleanup. This operation may happen asynchronously.
returns
future that resolves when closing is complete
abstract def sendBatch(messages: Seq[MessageType]): Future[BitSet]

Request propagation of messages.
Request propagation of messages. The returned bitset contains the indexes of messages known to be sent successfully. Note that for some implementations, it is possible for a message to be sent and for the ack to be lost (e.g. if the send is occurring over a network).
messages
a batch of messages
returns
a bitset containing indexes of messages that were sent successfully

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 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( ... )

Deprecated Value Members

final def propagate(messages: Seq[MessageType]): Future[Int]

Request propagation of messages.
Request propagation of messages. The return value indicates the number of messages known to be sent successfully. Note that for some implementations, it is possible for a message to be sent and for the ack to be lost (e.g. if the send is occurring over a network).
messages
a batch of messages
returns
the number of messages propagated

Annotations
@deprecated
Deprecated
(Since version 0.7.0) use sendBatch

Inherited from AnyRef

Inherited from Any

Ungrouped