com.metamx.tranquility.beam

Beam

trait Beam[MessageType] extends AnyRef

Beams accept messages and forward them along.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Beam
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. 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

  2. abstract def sendAll(messages: Seq[MessageType]): Seq[Future[SendResult]]

    Request propagation of messages.

    Request propagation of messages. The returned futures contains the results of sending these messages, in a Seq in the same order as the original messages. 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).

    If any of the the returned Futures resolves to a DefunctBeamException, this means the beam should be discarded (after calling close()).

    messages

    a batch of messages

    returns

    futures containing send result of each message

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  18. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

    If the returned Future resolves to a DefunctBeamException, this means the beam should be discarded (after calling close()).

    messages

    a batch of messages

    returns

    the number of messages propagated

    Annotations
    @deprecated
    Deprecated

    (Since version 0.7.0) use sendBatch

  2. final 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).

    If the returned Future resolves to a DefunctBeamException, this means the beam should be discarded (after calling close()).

    messages

    a batch of messages

    returns

    a bitset containing indexes of messages that were sent successfully

    Annotations
    @deprecated
    Deprecated

    (Since version 0.8.0) use sendAll

Inherited from AnyRef

Inherited from Any

Ungrouped