c

org.apache.pekko.remote

AckedReceiveBuffer

final case class AckedReceiveBuffer[T <: HasSequenceNumber](lastDelivered: SeqNo = SeqNo(-1), cumulativeAck: SeqNo = SeqNo(-1), buf: SortedSet[T] = TreeSet.empty[T])(implicit seqOrdering: Ordering[T]) extends Product with Serializable

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

lastDelivered

Sequence number of the last message that has been delivered.

cumulativeAck

The highest sequence number received so far.

buf

Buffer of messages that are waiting for delivery

Annotations
@deprecated
Deprecated

(Since version Akka 2.6.0) Classic remoting is deprecated, use Artery

Source
AckedDelivery.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AckedReceiveBuffer
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AckedReceiveBuffer(lastDelivered: SeqNo = SeqNo(-1), cumulativeAck: SeqNo = SeqNo(-1), buf: SortedSet[T] = TreeSet.empty[T])(implicit seqOrdering: Ordering[T])

    lastDelivered

    Sequence number of the last message that has been delivered.

    cumulativeAck

    The highest sequence number received so far.

    buf

    Buffer of messages that are waiting for delivery

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from AckedReceiveBuffer[T] toany2stringadd[AckedReceiveBuffer[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AckedReceiveBuffer[T], B)
    Implicit
    This member is added by an implicit conversion from AckedReceiveBuffer[T] toArrowAssoc[AckedReceiveBuffer[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val buf: SortedSet[T]
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. val cumulativeAck: SeqNo
  10. def ensuring(cond: (AckedReceiveBuffer[T]) => Boolean, msg: => Any): AckedReceiveBuffer[T]
    Implicit
    This member is added by an implicit conversion from AckedReceiveBuffer[T] toEnsuring[AckedReceiveBuffer[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (AckedReceiveBuffer[T]) => Boolean): AckedReceiveBuffer[T]
    Implicit
    This member is added by an implicit conversion from AckedReceiveBuffer[T] toEnsuring[AckedReceiveBuffer[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): AckedReceiveBuffer[T]
    Implicit
    This member is added by an implicit conversion from AckedReceiveBuffer[T] toEnsuring[AckedReceiveBuffer[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): AckedReceiveBuffer[T]
    Implicit
    This member is added by an implicit conversion from AckedReceiveBuffer[T] toEnsuring[AckedReceiveBuffer[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def extractDeliverable: (AckedReceiveBuffer[T], Seq[T], Ack)

    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.

    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.

  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val lastDelivered: SeqNo
  19. def mergeFrom(that: AckedReceiveBuffer[T]): AckedReceiveBuffer[T]

    Merges two receive buffers.

    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.

    that

    The receive buffer to merge with

    returns

    The merged receive buffer.

  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. def receive(arrivedMsg: T): AckedReceiveBuffer[T]

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

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

    arrivedMsg

    message to be put into the buffer.

    returns

    The updated buffer containing the message.

  25. implicit val seqOrdering: Ordering[T]
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AckedReceiveBuffer → AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AckedReceiveBuffer[T] toStringFormat[AckedReceiveBuffer[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (AckedReceiveBuffer[T], B)
    Implicit
    This member is added by an implicit conversion from AckedReceiveBuffer[T] toArrowAssoc[AckedReceiveBuffer[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAckedReceiveBuffer[T] to any2stringadd[AckedReceiveBuffer[T]]

Inherited by implicit conversion StringFormat fromAckedReceiveBuffer[T] to StringFormat[AckedReceiveBuffer[T]]

Inherited by implicit conversion Ensuring fromAckedReceiveBuffer[T] to Ensuring[AckedReceiveBuffer[T]]

Inherited by implicit conversion ArrowAssoc fromAckedReceiveBuffer[T] to ArrowAssoc[AckedReceiveBuffer[T]]

Ungrouped