Packages

  • package root
    Definition Classes
    root
  • package akka
    Definition Classes
    root
  • package actor
    Definition Classes
    akka
  • package typed
    Definition Classes
    actor
  • package delivery
    Definition Classes
    typed
  • package internal
    Definition Classes
    delivery
  • object ProducerControllerImpl

    INTERNAL API

    INTERNAL API

    Design notes

    The producer will start the flow by sending a ProducerController.Start message to the ProducerController with message adapter reference to convert ProducerController.RequestNext message. The ProducerController sends RequestNext to the producer, which is then allowed to send one message to the ProducerController.

    The producer and ProducerController are supposed to be local so that these messages are fast and not lost.

    The ProducerController sends the first message to the ConsumerController without waiting for a Request from the ConsumerController. The main reason for this is that when used with Cluster Sharding the first message will typically create the ConsumerController. It's also a way to connect the ProducerController and ConsumerController in a dynamic way, for example when the ProducerController is replaced.

    When the first message is received by the ConsumerController it sends back the initial Request, with demand of how many messages it can accept.

    Apart from the first message the ProducerController will not send more messages than requested by the ConsumerController.

    When there is demand from the consumer side the ProducerController sends RequestNext to the actual producer, which is then allowed to send one more message.

    Each message is wrapped by the ProducerController in ConsumerController.SequencedMessage with a monotonically increasing sequence number without gaps, starting at 1.

    In other words, the "request" protocol to the application producer and consumer is one-by-one, but between the ProducerController and ConsumerController it's window of messages in flight.

    The Request message also contains a confirmedSeqNr that is the acknowledgement from the consumer that it has received and processed all messages up to that sequence number.

    The ConsumerController will send ProducerControllerImpl.Resend if a lost message is detected and then the ProducerController will resend all messages from that sequence number. The producer keeps unconfirmed messages in a buffer to be able to resend them. The buffer size is limited by the request window size.

    The resending is optional, and the ConsumerController can be started with resendLost=false to ignore lost messages, and then the ProducerController will not buffer unconfirmed messages. In that mode it provides only flow control but no reliable delivery.

    Definition Classes
    internal
  • Ack
  • InternalCommand
  • Request
  • Resend
  • ResendFirstUnconfirmed
  • UnsealedInternalCommand

final case class Resend(fromSeqNr: SeqNr) extends InternalCommand with DeliverySerializable with DeadLetterSuppression with Product with Serializable

Source
ProducerControllerImpl.scala
Linear Supertypes
Serializable, Product, Equals, DeadLetterSuppression, DeliverySerializable, InternalCommand, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Resend
  2. Serializable
  3. Product
  4. Equals
  5. DeadLetterSuppression
  6. DeliverySerializable
  7. InternalCommand
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Resend(fromSeqNr: SeqNr)

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 Resend toany2stringadd[Resend] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Resend, B)
    Implicit
    This member is added by an implicit conversion from Resend toArrowAssoc[Resend] 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. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (Resend) => Boolean, msg: => Any): Resend
    Implicit
    This member is added by an implicit conversion from Resend toEnsuring[Resend] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Resend) => Boolean): Resend
    Implicit
    This member is added by an implicit conversion from Resend toEnsuring[Resend] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Resend
    Implicit
    This member is added by an implicit conversion from Resend toEnsuring[Resend] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Resend
    Implicit
    This member is added by an implicit conversion from Resend toEnsuring[Resend] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Resend toStringFormat[Resend] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  14. val fromSeqNr: SeqNr
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (Resend, B)
    Implicit
    This member is added by an implicit conversion from Resend toArrowAssoc[Resend] 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 DeadLetterSuppression

Inherited from DeliverySerializable

Inherited from InternalCommand

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromResend to any2stringadd[Resend]

Inherited by implicit conversion StringFormat fromResend to StringFormat[Resend]

Inherited by implicit conversion Ensuring fromResend to Ensuring[Resend]

Inherited by implicit conversion ArrowAssoc fromResend to ArrowAssoc[Resend]

Ungrouped