akka.persistence

PersistentChannelSettings

case class PersistentChannelSettings(redeliverMax: Int = 5, redeliverInterval: FiniteDuration = ..., redeliverFailureListener: Option[ActorRef] = scala.None, replyPersistent: Boolean = false, pendingConfirmationsMax: Long = scala.Long.MaxValue, pendingConfirmationsMin: Long = scala.Long.MaxValue, idleTimeout: FiniteDuration = ...) extends Product with Serializable

A PersistentChannel configuration object.

redeliverMax

Maximum number of redelivery attempts.

redeliverInterval

Interval between redelivery attempts.

redeliverFailureListener

Receiver of RedeliverFailure notifications which are sent when the number of redeliveries reaches redeliverMax for a sequence of messages. To enforce a redelivery of these messages, the listener has to Reset the persistent channel. Alternatively, it can also confirm these messages, preventing further redeliveries.

replyPersistent

If true the sender will receive the successfully stored Persistent message that has been submitted with a Deliver request, or a PersistenceFailure message in case of a persistence failure.

pendingConfirmationsMax

Message delivery is suspended by a channel if the number of pending reaches the specified value and is resumed again if the number of pending confirmations falls below pendingConfirmationsMin.

pendingConfirmationsMin

Message delivery is resumed if the number of pending confirmations falls below this limit. It is suspended again if it reaches pendingConfirmationsMax. Message delivery is enabled for a channel if the number of pending confirmations is below this limit, or, is resumed again if it falls below this limit.

idleTimeout

Maximum interval between read attempts made by a persistent channel. This settings applies, for example, after a journal failed to serve a read request. The next read request is then made after the configured timeout.

Annotations
@SerialVersionUID( 1L ) @deprecated
Deprecated

(Since version 2.3.4) PersistentChannel will be removed, see akka.persistence.AtLeastOnceDelivery instead.

Source
PersistentChannel.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PersistentChannelSettings
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PersistentChannelSettings(redeliverMax: Int = 5, redeliverInterval: FiniteDuration = ..., redeliverFailureListener: Option[ActorRef] = scala.None, replyPersistent: Boolean = false, pendingConfirmationsMax: Long = scala.Long.MaxValue, pendingConfirmationsMin: Long = scala.Long.MaxValue, idleTimeout: FiniteDuration = ...)

    redeliverMax

    Maximum number of redelivery attempts.

    redeliverInterval

    Interval between redelivery attempts.

    redeliverFailureListener

    Receiver of RedeliverFailure notifications which are sent when the number of redeliveries reaches redeliverMax for a sequence of messages. To enforce a redelivery of these messages, the listener has to Reset the persistent channel. Alternatively, it can also confirm these messages, preventing further redeliveries.

    replyPersistent

    If true the sender will receive the successfully stored Persistent message that has been submitted with a Deliver request, or a PersistenceFailure message in case of a persistence failure.

    pendingConfirmationsMax

    Message delivery is suspended by a channel if the number of pending reaches the specified value and is resumed again if the number of pending confirmations falls below pendingConfirmationsMin.

    pendingConfirmationsMin

    Message delivery is resumed if the number of pending confirmations falls below this limit. It is suspended again if it reaches pendingConfirmationsMax. Message delivery is enabled for a channel if the number of pending confirmations is below this limit, or, is resumed again if it falls below this limit.

    idleTimeout

    Maximum interval between read attempts made by a persistent channel. This settings applies, for example, after a journal failed to serve a read request. The next read request is then made after the configured timeout.

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. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from PersistentChannelSettings to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (PersistentChannelSettings, B)

    Implicit information
    This member is added by an implicit conversion from PersistentChannelSettings to ArrowAssoc[PersistentChannelSettings] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

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

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (PersistentChannelSettings) ⇒ Boolean, msg: ⇒ Any): PersistentChannelSettings

    Implicit information
    This member is added by an implicit conversion from PersistentChannelSettings to Ensuring[PersistentChannelSettings] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (PersistentChannelSettings) ⇒ Boolean): PersistentChannelSettings

    Implicit information
    This member is added by an implicit conversion from PersistentChannelSettings to Ensuring[PersistentChannelSettings] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): PersistentChannelSettings

    Implicit information
    This member is added by an implicit conversion from PersistentChannelSettings to Ensuring[PersistentChannelSettings] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): PersistentChannelSettings

    Implicit information
    This member is added by an implicit conversion from PersistentChannelSettings to Ensuring[PersistentChannelSettings] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from PersistentChannelSettings to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  18. val idleTimeout: FiniteDuration

    Maximum interval between read attempts made by a persistent channel.

    Maximum interval between read attempts made by a persistent channel. This settings applies, for example, after a journal failed to serve a read request. The next read request is then made after the configured timeout.

  19. final def isInstanceOf[T0]: Boolean

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

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

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

    Definition Classes
    AnyRef
  23. val pendingConfirmationsMax: Long

    Message delivery is suspended by a channel if the number of pending reaches the specified value and is resumed again if the number of pending confirmations falls below pendingConfirmationsMin.

  24. val pendingConfirmationsMin: Long

    Message delivery is resumed if the number of pending confirmations falls below this limit.

    Message delivery is resumed if the number of pending confirmations falls below this limit. It is suspended again if it reaches pendingConfirmationsMax. Message delivery is enabled for a channel if the number of pending confirmations is below this limit, or, is resumed again if it falls below this limit.

  25. val redeliverFailureListener: Option[ActorRef]

    Receiver of RedeliverFailure notifications which are sent when the number of redeliveries reaches redeliverMax for a sequence of messages.

    Receiver of RedeliverFailure notifications which are sent when the number of redeliveries reaches redeliverMax for a sequence of messages. To enforce a redelivery of these messages, the listener has to Reset the persistent channel. Alternatively, it can also confirm these messages, preventing further redeliveries.

  26. val redeliverInterval: FiniteDuration

    Interval between redelivery attempts.

  27. val redeliverMax: Int

    Maximum number of redelivery attempts.

  28. val replyPersistent: Boolean

    If true the sender will receive the successfully stored Persistent message that has been submitted with a Deliver request, or a PersistenceFailure message in case of a persistence failure.

  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  30. def toChannelSettings: ChannelSettings

    Converts this configuration object to ChannelSettings.

  31. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def withIdleTimeout(idleTimeout: FiniteDuration): PersistentChannelSettings

    Java API.

  35. def withPendingConfirmationsMax(pendingConfirmationsMax: Long): PersistentChannelSettings

    Java API.

  36. def withPendingConfirmationsMin(pendingConfirmationsMin: Long): PersistentChannelSettings

    Java API.

  37. def withRedeliverFailureListener(redeliverFailureListener: ActorRef): PersistentChannelSettings

    Java API.

  38. def withRedeliverInterval(redeliverInterval: FiniteDuration): PersistentChannelSettings

    Java API.

  39. def withRedeliverMax(redeliverMax: Int): PersistentChannelSettings

    Java API.

  40. def withReplyPersistent(replayPersistent: Boolean): PersistentChannelSettings

    Java API.

  41. def [B](y: B): (PersistentChannelSettings, B)

    Implicit information
    This member is added by an implicit conversion from PersistentChannelSettings to ArrowAssoc[PersistentChannelSettings] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from PersistentChannelSettings to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (persistentChannelSettings: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from PersistentChannelSettings to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (persistentChannelSettings: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: PersistentChannelSettings

    Implicit information
    This member is added by an implicit conversion from PersistentChannelSettings to ArrowAssoc[PersistentChannelSettings] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (persistentChannelSettings: ArrowAssoc[PersistentChannelSettings]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: PersistentChannelSettings

    Implicit information
    This member is added by an implicit conversion from PersistentChannelSettings to Ensuring[PersistentChannelSettings] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (persistentChannelSettings: Ensuring[PersistentChannelSettings]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from PersistentChannelSettings to StringAdd

Inherited by implicit conversion any2stringfmt from PersistentChannelSettings to StringFormat

Inherited by implicit conversion any2ArrowAssoc from PersistentChannelSettings to ArrowAssoc[PersistentChannelSettings]

Inherited by implicit conversion any2Ensuring from PersistentChannelSettings to Ensuring[PersistentChannelSettings]

Ungrouped