Packages

abstract class AsyncRecovery extends journal.AsyncRecovery with AsyncRecoveryPlugin

Java API: asynchronous message replay and sequence number recovery interface.

Self Type
AsyncRecovery with Actor
Source
AsyncRecovery.scala
Linear Supertypes
AsyncRecoveryPlugin, journal.AsyncRecovery, AnyRef, Any
Known Subclasses
AsyncWriteJournal
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AsyncRecovery
  2. AsyncRecoveryPlugin
  3. AsyncRecovery
  4. AnyRef
  5. 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 AsyncRecovery()

Abstract Value Members

  1. abstract def doAsyncReadHighestSequenceNr(persistenceId: String, fromSequenceNr: Long): Future[Long]

    Java API, Plugin API: asynchronously reads the highest stored sequence number for the given persistenceId.

    Java API, 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 as toSequenceNr in subsequent call to #asyncReplayMessages unless the user has specified a lower toSequenceNr.

    persistenceId

    id of the persistent actor.

    fromSequenceNr

    hint where to start searching for the highest sequence number.

    Definition Classes
    AsyncRecoveryPlugin
  2. abstract def doAsyncReplayMessages(persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long, max: Long, replayCallback: Consumer[PersistentRepr]): Future[Void]

    Java API, Plugin API: asynchronously replays persistent messages.

    Java API, 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's deleted method must return true.

    The toSequenceNr is the lowest of what was returned by #doAsyncReadHighestSequenceNr and what the user specified as recovery akka.persistence.Recovery parameter.

    persistenceId

    id of the persistent actor.

    fromSequenceNr

    sequence number where replay should start (inclusive).

    toSequenceNr

    sequence number where replay should end (inclusive).

    max

    maximum number of messages to be replayed.

    replayCallback

    called to replay a single message. Can be called from any thread.

    Definition Classes
    AsyncRecoveryPlugin

Concrete Value Members

  1. final 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 as toSequenceNr in subsequent call to #asyncReplayMessages unless the user has specified a lower toSequenceNr. 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 or 0L if no snapshot is used.

    Definition Classes
    AsyncRecovery → AsyncRecovery
  2. final def asyncReplayMessages(persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long, max: Long)(replayCallback: (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's deleted method must return true.

    The toSequenceNr is the lowest of what was returned by #asyncReadHighestSequenceNr and what the user specified as recovery akka.persistence.Recovery parameter. This does imply that this call is always preceded by reading the highest sequence number for the given persistenceId.

    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.

    Definition Classes
    AsyncRecovery → AsyncRecovery
    See also

    AsyncWriteJournal