c

org.apache.pekko.remote

AckedSendBuffer

final case class AckedSendBuffer[T <: HasSequenceNumber](capacity: Int, nonAcked: IndexedSeq[T] = Vector.empty[T], nacked: IndexedSeq[T] = Vector.empty[T], maxSeq: SeqNo = SeqNo(-1)) extends Product with Serializable

Implements an immutable resend buffer that buffers messages until they have been acknowledged. Properly removes messages when an ack is received. This buffer works together with pekko.remote.AckedReceiveBuffer on the receiving end.

capacity

Maximum number of messages the buffer is willing to accept. If reached pekko.remote.ResendBufferCapacityReachedException is thrown.

nonAcked

Sequence of messages that has not yet been acknowledged.

nacked

Sequence of messages that has been explicitly negative acknowledged.

maxSeq

The maximum sequence number that has been stored in this buffer. Messages having lower sequence number will be not stored but rejected with java.lang.IllegalArgumentException

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. AckedSendBuffer
  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 AckedSendBuffer(capacity: Int, nonAcked: IndexedSeq[T] = Vector.empty[T], nacked: IndexedSeq[T] = Vector.empty[T], maxSeq: SeqNo = SeqNo(-1))

    capacity

    Maximum number of messages the buffer is willing to accept. If reached pekko.remote.ResendBufferCapacityReachedException is thrown.

    nonAcked

    Sequence of messages that has not yet been acknowledged.

    nacked

    Sequence of messages that has been explicitly negative acknowledged.

    maxSeq

    The maximum sequence number that has been stored in this buffer. Messages having lower sequence number will be not stored but rejected with java.lang.IllegalArgumentException

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 AckedSendBuffer[T] toany2stringadd[AckedSendBuffer[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AckedSendBuffer[T], B)
    Implicit
    This member is added by an implicit conversion from AckedSendBuffer[T] toArrowAssoc[AckedSendBuffer[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def acknowledge(ack: Ack): AckedSendBuffer[T]

    Processes an incoming acknowledgement and returns a new buffer with only unacknowledged elements remaining.

    Processes an incoming acknowledgement and returns a new buffer with only unacknowledged elements remaining.

    ack

    The received acknowledgement

    returns

    An updated buffer containing the remaining unacknowledged messages

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def buffer(msg: T): AckedSendBuffer[T]

    Puts a new message in the buffer.

    Puts a new message in the buffer. Throws java.lang.IllegalArgumentException if an out-of-sequence message is attempted to be stored.

    msg

    The message to be stored for possible future retransmission.

    returns

    The updated buffer

  9. val capacity: Int
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  11. def ensuring(cond: (AckedSendBuffer[T]) => Boolean, msg: => Any): AckedSendBuffer[T]
    Implicit
    This member is added by an implicit conversion from AckedSendBuffer[T] toEnsuring[AckedSendBuffer[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (AckedSendBuffer[T]) => Boolean): AckedSendBuffer[T]
    Implicit
    This member is added by an implicit conversion from AckedSendBuffer[T] toEnsuring[AckedSendBuffer[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): AckedSendBuffer[T]
    Implicit
    This member is added by an implicit conversion from AckedSendBuffer[T] toEnsuring[AckedSendBuffer[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): AckedSendBuffer[T]
    Implicit
    This member is added by an implicit conversion from AckedSendBuffer[T] toEnsuring[AckedSendBuffer[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val maxSeq: SeqNo
  19. val nacked: IndexedSeq[T]
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. val nonAcked: IndexedSeq[T]
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AckedSendBuffer → AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. 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 AckedSendBuffer[T] toStringFormat[AckedSendBuffer[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): (AckedSendBuffer[T], B)
    Implicit
    This member is added by an implicit conversion from AckedSendBuffer[T] toArrowAssoc[AckedSendBuffer[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 fromAckedSendBuffer[T] to any2stringadd[AckedSendBuffer[T]]

Inherited by implicit conversion StringFormat fromAckedSendBuffer[T] to StringFormat[AckedSendBuffer[T]]

Inherited by implicit conversion Ensuring fromAckedSendBuffer[T] to Ensuring[AckedSendBuffer[T]]

Inherited by implicit conversion ArrowAssoc fromAckedSendBuffer[T] to ArrowAssoc[AckedSendBuffer[T]]

Ungrouped