trait AsyncRecovery extends AnyRef
Asynchronous message replay and sequence number recovery interface.
- Source
- AsyncRecovery.scala
- Alphabetic
- By Inheritance
- AsyncRecovery
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def asyncReadHighestSequenceNr(persistenceId: String, fromSequenceNr: Long): Future[Long]
Plugin API: asynchronously reads the highest stored sequence number for the given
persistenceId
.Plugin API: asynchronously reads the highest stored sequence number for the given
persistenceId
. The persistent actor will use the highest sequence number after recovery as the starting point when persisting new events. This sequence number is also used astoSequenceNr
in subsequent call to #asyncReplayMessages unless the user has specified a lowertoSequenceNr
. Journal must maintain the highest sequence number and never decrease it.This call is protected with a circuit-breaker.
Please also note that requests for the highest sequence number may be made concurrently to writes executing for the same
persistenceId
, in particular it is possible that a restarting actor tries to recover before its outstanding writes have completed.- persistenceId
persistent actor id.
- fromSequenceNr
hint where to start searching for the highest sequence number. When a persistent actor is recovering this
fromSequenceNr
will be the sequence number of the used snapshot or0L
if no snapshot is used.
- abstract def asyncReplayMessages(persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long, max: Long)(recoveryCallback: (PersistentRepr) => Unit): Future[Unit]
Plugin API: asynchronously replays persistent messages.
Plugin API: asynchronously replays persistent messages. Implementations replay a message by calling
replayCallback
. The returned future must be completed when all messages (matching the sequence number bounds) have been replayed. The future must be completed with a failure if any of the persistent messages could not be replayed.The
replayCallback
must also be called with messages that have been marked as deleted. In this case a replayed message'sdeleted
method must returntrue
.The
toSequenceNr
is the lowest of what was returned by #asyncReadHighestSequenceNr and what the user specified as recovery pekko.persistence.Recovery parameter. This does imply that this call is always preceded by reading the highest sequence number for the givenpersistenceId
.This call is NOT protected with a circuit-breaker because it may take long time to replay all events. The plugin implementation itself must protect against an unresponsive backend store and make sure that the returned Future is completed with success or failure within reasonable time. It is not allowed to ignore completing the future.
- persistenceId
persistent actor id.
- fromSequenceNr
sequence number where replay should start (inclusive).
- toSequenceNr
sequence number where replay should end (inclusive).
- max
maximum number of messages to be replayed.
- recoveryCallback
called to replay a single message. Can be called from any thread.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from AsyncRecovery toany2stringadd[AsyncRecovery] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (AsyncRecovery, B)
- Implicit
- This member is added by an implicit conversion from AsyncRecovery toArrowAssoc[AsyncRecovery] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def ensuring(cond: (AsyncRecovery) => Boolean, msg: => Any): AsyncRecovery
- Implicit
- This member is added by an implicit conversion from AsyncRecovery toEnsuring[AsyncRecovery] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (AsyncRecovery) => Boolean): AsyncRecovery
- Implicit
- This member is added by an implicit conversion from AsyncRecovery toEnsuring[AsyncRecovery] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): AsyncRecovery
- Implicit
- This member is added by an implicit conversion from AsyncRecovery toEnsuring[AsyncRecovery] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): AsyncRecovery
- Implicit
- This member is added by an implicit conversion from AsyncRecovery toEnsuring[AsyncRecovery] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from AsyncRecovery toStringFormat[AsyncRecovery] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (AsyncRecovery, B)
- Implicit
- This member is added by an implicit conversion from AsyncRecovery toArrowAssoc[AsyncRecovery] 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.