akka.remote

Class AckedReceiveBuffer<T extends HasSequenceNumber>

java.lang.Object

akka.remote.AckedReceiveBuffer<T>

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

public final class AckedReceiveBuffer<T extends HasSequenceNumber>
extends java.lang.Object
implements scala.Product, scala.Serializable

Implements an immutable receive buffer that buffers incoming messages until they can be safely delivered. This buffer works together with a AckedSendBuffer on the sender() side.

param: lastDelivered Sequence number of the last message that has been delivered. param: cumulativeAck The highest sequence number received so far. param: buf Buffer of messages that are waiting for delivery

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AckedReceiveBuffer(SeqNo lastDelivered, SeqNo cumulativeAck, scala.collection.immutable.SortedSet<T> buf, scala.math.Ordering<T> seqOrdering)

Method Summary

Modifier and Type	Method and Description
scala.collection.immutable.SortedSet<T>	buf()
abstract static boolean	canEqual(java.lang.Object that)
SeqNo	cumulativeAck()
abstract static boolean	equals(java.lang.Object that)
scala.Tuple3<AckedReceiveBuffer<T>,scala.collection.immutable.Seq<T>,Ack>	extractDeliverable() Extract all messages that could be safely delivered, an updated ack to be sent to the sender(), and an updated buffer that has the messages removed that can be delivered.
SeqNo	lastDelivered()
AckedReceiveBuffer<T>	mergeFrom(AckedReceiveBuffer<T> that) Merges two receive buffers.
abstract static int	productArity()
abstract static java.lang.Object	productElement(int n)
static scala.collection.Iterator<java.lang.Object>	productIterator()
static java.lang.String	productPrefix()
AckedReceiveBuffer<T>	receive(T arrivedMsg) Puts a sequenced message in the receive buffer returning a new buffer.
scala.math.Ordering<T>	seqOrdering()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

AckedReceiveBuffer

public AckedReceiveBuffer(SeqNo lastDelivered,
                          SeqNo cumulativeAck,
                          scala.collection.immutable.SortedSet<T> buf,
                          scala.math.Ordering<T> seqOrdering)

Method Detail

canEqual

public abstract static boolean canEqual(java.lang.Object that)

equals

public abstract static boolean equals(java.lang.Object that)

productElement

public abstract static java.lang.Object productElement(int n)

productArity

public abstract static int productArity()

productIterator

public static scala.collection.Iterator<java.lang.Object> productIterator()

productPrefix

public static java.lang.String productPrefix()

lastDelivered

public SeqNo lastDelivered()

cumulativeAck

public SeqNo cumulativeAck()

buf

public scala.collection.immutable.SortedSet<T> buf()

seqOrdering

public scala.math.Ordering<T> seqOrdering()

receive

public AckedReceiveBuffer<T> receive(T arrivedMsg)

Puts a sequenced message in the receive buffer returning a new buffer.

Parameters:

arrivedMsg - message to be put into the buffer.

Returns:

The updated buffer containing the message.

extractDeliverable

public scala.Tuple3<AckedReceiveBuffer<T>,scala.collection.immutable.Seq<T>,Ack> extractDeliverable()

Extract all messages that could be safely delivered, an updated ack to be sent to the sender(), and an updated buffer that has the messages removed that can be delivered.

Returns:

Triplet of the updated buffer, messages that can be delivered and the updated acknowledgement.

mergeFrom

public AckedReceiveBuffer<T> mergeFrom(AckedReceiveBuffer<T> that)

Merges two receive buffers. Merging preserves sequencing of messages, and drops all messages that has been safely acknowledged by any of the participating buffers. Also updates the expected sequence numbers.

Parameters:

that - The receive buffer to merge with

Returns:

The merged receive buffer.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object