akka.persistence

UntypedPersistentActorWithAtLeastOnceDelivery

abstract class UntypedPersistentActorWithAtLeastOnceDelivery extends UntypedPersistentActor with AtLeastOnceDelivery

Java API: Use this class instead of UntypedPersistentActor to send messages with at-least-once delivery semantics to destinations. Full documentation in AtLeastOnceDelivery.

Source
AtLeastOnceDelivery.scala
See also

AtLeastOnceDelivery

Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UntypedPersistentActorWithAtLeastOnceDelivery
  2. AtLeastOnceDelivery
  3. Processor
  4. UntypedPersistentActor
  5. Eventsourced
  6. ProcessorImpl
  7. Recovery
  8. StashFactory
  9. Stash
  10. RequiresMessageQueue
  11. UnrestrictedStash
  12. StashSupport
  13. Snapshotter
  14. UntypedActor
  15. Actor
  16. AnyRef
  17. 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 UntypedPersistentActorWithAtLeastOnceDelivery()

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Definition Classes
    Actor

Abstract Value Members

  1. abstract def onReceiveCommand(msg: Any): Unit

    Java API: command handler.

    Java API: command handler. Typically validates commands against current state (and/or by communication with other actors). On successful validation, one or more events are derived from a command and these events are then persisted by calling persist. Commands sent to event sourced persistent actors must not be Persistent or PersistentBatch messages. In this case an UnsupportedOperationException is thrown by the persistent actor.

    Definition Classes
    UntypedPersistentActor
    Annotations
    @throws( classOf[Exception] )
  2. abstract def onReceiveRecover(msg: Any): Unit

    Java API: recovery handler that receives persisted events during recovery.

    Java API: recovery handler that receives persisted events during recovery. If a state snapshot has been captured and saved, this handler will receive a SnapshotOffer message followed by events that are younger than the offered snapshot.

    This handler must not have side-effects other than changing persistent actor state i.e. it should not perform actions that may fail, such as interacting with external services, for example.

    If recovery fails, the actor will be stopped. This can be customized by handling RecoveryFailure.

    Definition Classes
    UntypedPersistentActor
    Annotations
    @throws( classOf[Exception] )
    See also

    Recover

Concrete 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 UntypedPersistentActorWithAtLeastOnceDelivery to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (UntypedPersistentActorWithAtLeastOnceDelivery, B)

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentActorWithAtLeastOnceDelivery to ArrowAssoc[UntypedPersistentActorWithAtLeastOnceDelivery] 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. def aroundPostRestart(reason: Throwable): Unit

    Can be overridden to intercept calls to postRestart.

    Can be overridden to intercept calls to postRestart. Calls postRestart by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  9. def aroundPostStop(): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    AtLeastOnceDelivery → ProcessorImpl → Actor
  10. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    AtLeastOnceDelivery → ProcessorImpl → Actor
  11. def aroundPreStart(): Unit

    INTERNAL API.

    INTERNAL API.

    Attributes
    protected[akka]
    Definition Classes
    ProcessorImpl → Actor
  12. def aroundReceive(receive: Receive, message: Any): Unit

    INTERNAL API

    INTERNAL API

    receive

    current behavior.

    Attributes
    protected[akka]
    Definition Classes
    AtLeastOnceDeliveryRecoveryActor
  13. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  14. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. def confirmDelivery(deliveryId: Long): Boolean

    Call this method when a message has been confirmed by the destination, or to abort re-sending.

    Call this method when a message has been confirmed by the destination, or to abort re-sending.

    returns

    true the first time the deliveryId is confirmed, i.e. false for duplicate confirm

    Definition Classes
    AtLeastOnceDelivery
    See also

    #deliver

  16. implicit val context: ActorContext

    Stores the context for this actor, including self, and sender.

    Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    akka.actor.ActorContext is the Scala API. getContext returns a akka.actor.UntypedActorContext, which is the Java API of the actor context.

    Definition Classes
    Actor
  17. final def defer[A](events: Iterable[A])(handler: Procedure[A]): Unit

    Defer the handler execution until all pending handlers have been executed.

    Defer the handler execution until all pending handlers have been executed. Allows to define logic within the actor, which will respect the invocation-order-guarantee in respect to persistAsync calls. That is, if persistAsync was invoked before defer, the corresponding handlers will be invoked in the same order as they were registered in.

    This call will NOT result in event being persisted, please use persist or persistAsync, if the given event should possible to replay.

    If there are no pending persist handler calls, the handler will be called immediatly.

    In the event of persistence failures (indicated by PersistenceFailure messages being sent to the PersistentActor, you can handle these messages, which in turn will enable the deferred handlers to run afterwards. If persistence failure messages are left unhandled, the default behavior is to stop the Actor, thus the handlers will not be run.

    events

    event to be handled in the future, when preceeding persist operations have been processes

    handler

    handler for each event

    Definition Classes
    UntypedPersistentActor
  18. final def defer[A](event: A)(handler: Procedure[A]): Unit

    Defer the handler execution until all pending handlers have been executed.

    Defer the handler execution until all pending handlers have been executed. Allows to define logic within the actor, which will respect the invocation-order-guarantee in respect to persistAsync calls. That is, if persistAsync was invoked before defer, the corresponding handlers will be invoked in the same order as they were registered in.

    This call will NOT result in event being persisted, please use persist or persistAsync, if the given event should possible to replay.

    If there are no pending persist handler calls, the handler will be called immediatly.

    In the event of persistence failures (indicated by PersistenceFailure messages being sent to the PersistentActor, you can handle these messages, which in turn will enable the deferred handlers to run afterwards. If persistence failure messages are left unhandled, the default behavior is to stop the Actor, thus the handlers will not be run.

    event

    event to be handled in the future, when preceeding persist operations have been processes

    handler

    handler for the given event

    Definition Classes
    UntypedPersistentActor
  19. final def defer[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Defer the handler execution until all pending handlers have been executed.

    Defer the handler execution until all pending handlers have been executed. Allows to define logic within the actor, which will respect the invocation-order-guarantee in respect to persistAsync calls. That is, if persistAsync was invoked before defer, the corresponding handlers will be invoked in the same order as they were registered in.

    This call will NOT result in event being persisted, please use persist or persistAsync, if the given event should possible to replay.

    If there are no pending persist handler calls, the handler will be called immediatly.

    In the event of persistence failures (indicated by PersistenceFailure messages being sent to the PersistentActor, you can handle these messages, which in turn will enable the deferred handlers to run afterwards. If persistence failure messages are left unhandled, the default behavior is to stop the Actor, thus the handlers will not be run.

    events

    event to be handled in the future, when preceeding persist operations have been processes

    handler

    handler for each event

    Definition Classes
    Eventsourced
  20. final def defer[A](event: A)(handler: (A) ⇒ Unit): Unit

    Defer the handler execution until all pending handlers have been executed.

    Defer the handler execution until all pending handlers have been executed. Allows to define logic within the actor, which will respect the invocation-order-guarantee in respect to persistAsync calls. That is, if persistAsync was invoked before defer, the corresponding handlers will be invoked in the same order as they were registered in.

    This call will NOT result in event being persisted, please use persist or persistAsync, if the given event should possible to replay.

    If there are no pending persist handler calls, the handler will be called immediatly.

    In the event of persistence failures (indicated by PersistenceFailure messages being sent to the PersistentActor, you can handle these messages, which in turn will enable the deferred handlers to run afterwards. If persistence failure messages are left unhandled, the default behavior is to stop the Actor, thus the handlers will not be run.

    event

    event to be handled in the future, when preceeding persist operations have been processes

    handler

    handler for the given event

    Definition Classes
    Eventsourced
  21. def deleteMessages(toSequenceNr: Long, permanent: Boolean): Unit

    Deletes all persistent messages with sequence numbers less than or equal toSequenceNr.

    Deletes all persistent messages with sequence numbers less than or equal toSequenceNr. If permanent is set to false, the persistent messages are marked as deleted in the journal, otherwise they permanently deleted from the journal.

    toSequenceNr

    upper sequence number bound of persistent messages to be deleted.

    permanent

    if false, the message is marked as deleted, otherwise it is permanently deleted.

    Definition Classes
    ProcessorImpl
  22. def deleteMessages(toSequenceNr: Long): Unit

    Permanently deletes all persistent messages with sequence numbers less than or equal toSequenceNr.

    Permanently deletes all persistent messages with sequence numbers less than or equal toSequenceNr.

    toSequenceNr

    upper sequence number bound of persistent messages to be deleted.

    Definition Classes
    ProcessorImpl
  23. def deleteSnapshot(sequenceNr: Long, timestamp: Long): Unit

    Deletes a snapshot identified by sequenceNr and timestamp.

    Deletes a snapshot identified by sequenceNr and timestamp.

    Definition Classes
    Snapshotter
  24. def deleteSnapshots(criteria: SnapshotSelectionCriteria): Unit

    Deletes all snapshots matching criteria.

    Deletes all snapshots matching criteria.

    Definition Classes
    Snapshotter
  25. def deliver(destination: ActorPath, deliveryIdToMessage: Function[Long, AnyRef]): Unit

    Java API: Send the message created by the deliveryIdToMessage function to the destination actor.

    Java API: Send the message created by the deliveryIdToMessage function to the destination actor. It will retry sending the message until the delivery is confirmed with #confirmDelivery. Correlation between deliver and confirmDelivery is performed with the deliveryId that is provided as parameter to the deliveryIdToMessage function. The deliveryId is typically passed in the message to the destination, which replies with a message containing the same deliveryId.

    The deliveryId is a strictly monotonically increasing sequence number without gaps. The same sequence is used for all destinations, i.e. when sending to multiple destinations the destinations will see gaps in the sequence if no translation is performed.

    During recovery this method will not send out the message, but it will be sent later if no matching confirmDelivery was performed.

    This method will throw AtLeastOnceDelivery.MaxUnconfirmedMessagesExceededException if numberOfUnconfirmed is greater than or equal to #maxUnconfirmedMessages.

  26. def deliver(destination: ActorPath, deliveryIdToMessage: (Long) ⇒ Any): Unit

    Scala API: Send the message created by the deliveryIdToMessage function to the destination actor.

    Scala API: Send the message created by the deliveryIdToMessage function to the destination actor. It will retry sending the message until the delivery is confirmed with #confirmDelivery. Correlation between deliver and confirmDelivery is performed with the deliveryId that is provided as parameter to the deliveryIdToMessage function. The deliveryId is typically passed in the message to the destination, which replies with a message containing the same deliveryId.

    The deliveryId is a strictly monotonically increasing sequence number without gaps. The same sequence is used for all destinations of the actor, i.e. when sending to multiple destinations the destinations will see gaps in the sequence if no translation is performed.

    During recovery this method will not send out the message, but it will be sent later if no matching confirmDelivery was performed.

    This method will throw AtLeastOnceDelivery.MaxUnconfirmedMessagesExceededException if numberOfUnconfirmed is greater than or equal to #maxUnconfirmedMessages.

    Definition Classes
    AtLeastOnceDelivery
  27. def ensuring(cond: (UntypedPersistentActorWithAtLeastOnceDelivery) ⇒ Boolean, msg: ⇒ Any): UntypedPersistentActorWithAtLeastOnceDelivery

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

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

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

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

    Definition Classes
    AnyRef
  32. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  33. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any
  36. def getContext(): UntypedActorContext

    Returns this UntypedActor's UntypedActorContext The UntypedActorContext is not thread safe so do not expose it outside of the UntypedActor.

    Returns this UntypedActor's UntypedActorContext The UntypedActorContext is not thread safe so do not expose it outside of the UntypedActor.

    Definition Classes
    UntypedActor
  37. def getDeliverySnapshot: AtLeastOnceDeliverySnapshot

    Full state of the AtLeastOnceDelivery.

    Full state of the AtLeastOnceDelivery. It can be saved with PersistentActor#saveSnapshot. During recovery the snapshot received in SnapshotOffer should be set with #setDeliverySnapshot.

    The AtLeastOnceDeliverySnapshot contains the full delivery state, including unconfirmed messages. If you need a custom snapshot for other parts of the actor state you must also include the AtLeastOnceDeliverySnapshot. It is serialized using protobuf with the ordinary Akka serialization mechanism. It is easiest to include the bytes of the AtLeastOnceDeliverySnapshot as a blob in your custom snapshot.

    Definition Classes
    AtLeastOnceDelivery
  38. def getSelf(): ActorRef

    Returns the ActorRef for this actor.

    Returns the ActorRef for this actor.

    Definition Classes
    UntypedActor
  39. def getSender(): ActorRef

    The reference sender Actor of the currently processed message.

    The reference sender Actor of the currently processed message. This is always a legal destination to send to, even if there is no logical recipient for the reply, in which case it will be sent to the dead letter mailbox.

    Definition Classes
    UntypedActor
  40. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  41. val initialBehavior: Receive

    INTERNAL API.

    INTERNAL API.

    Only here for binary compatibility in 2.3.x.

    Attributes
    protected[akka.persistence]
    Definition Classes
    Eventsourced
  42. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  43. def lastSequenceNr: Long

    Highest received sequence number so far or 0L if this actor hasn't received a persistent message yet.

    Highest received sequence number so far or 0L if this actor hasn't received a persistent message yet. Usually equal to the sequence number of currentPersistentMessage (unless a receiver implementation is about to re-order persistent messages using stash() and unstash()).

    Definition Classes
    Recovery
  44. def loadSnapshot(persistenceId: String, criteria: SnapshotSelectionCriteria, toSequenceNr: Long): Unit

    Definition Classes
    Snapshotter
  45. def maxUnconfirmedMessages: Int

    Maximum number of unconfirmed messages that this actor is allowed to hold in memory.

    Maximum number of unconfirmed messages that this actor is allowed to hold in memory. If this number is exceed #deliver will not accept more messages and it will throw AtLeastOnceDelivery.MaxUnconfirmedMessagesExceededException.

    The default value can be configured with the akka.persistence.at-least-once-delivery.max-unconfirmed-messages configuration key. This method can be overridden by implementation classes to return non-default values.

    Definition Classes
    AtLeastOnceDelivery
  46. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  49. def numberOfUnconfirmed: Int

    Number of messages that have not been confirmed yet.

    Number of messages that have not been confirmed yet.

    Definition Classes
    AtLeastOnceDelivery
  50. final def onReceive(message: Any): Unit

    To be implemented by concrete UntypedActor, this defines the behavior of the UntypedActor.

    To be implemented by concrete UntypedActor, this defines the behavior of the UntypedActor.

    Definition Classes
    UntypedPersistentActorUntypedActor
  51. final def persist[A](events: Iterable[A], handler: Procedure[A]): Unit

    Java API: asynchronously persists events in specified order.

    Java API: asynchronously persists events in specified order. This is equivalent to calling persist[A](event: A, handler: Procedure[A]) multiple times with the same handler, except that events are persisted atomically with this method.

    events

    events to be persisted.

    handler

    handler for each persisted events

    Definition Classes
    UntypedPersistentActor
  52. final def persist[A](event: A, handler: Procedure[A]): Unit

    Java API: asynchronously persists event.

    Java API: asynchronously persists event. On successful persistence, handler is called with the persisted event. It is guaranteed that no new commands will be received by a persistent actor between a call to persist and the execution of its handler. This also holds for multiple persist calls per received command. Internally, this is achieved by stashing new commands and unstashing them when the event has been persisted and handled. The stash used for that is an internal stash which doesn't interfere with the inherited user stash.

    An event handler may close over persistent actor state and modify it. The getSender() of a persisted event is the sender of the corresponding command. This means that one can reply to a command sender within an event handler.

    Within an event handler, applications usually update persistent actor state using persisted event data, notify listeners and reply to command senders.

    If persistence of an event fails, the persistent actor will be stopped. This can be customized by handling PersistenceFailure in onReceiveCommand.

    event

    event to be persisted.

    handler

    handler for each persisted event

    Definition Classes
    UntypedPersistentActor
  53. final def persist[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Asynchronously persists events in specified order.

    Asynchronously persists events in specified order. This is equivalent to calling persist[A](event: A)(handler: A => Unit) multiple times with the same handler, except that events are persisted atomically with this method.

    events

    events to be persisted

    handler

    handler for each persisted events

    Definition Classes
    Eventsourced
  54. final def persist[A](event: A)(handler: (A) ⇒ Unit): Unit

    Asynchronously persists event.

    Asynchronously persists event. On successful persistence, handler is called with the persisted event. It is guaranteed that no new commands will be received by a persistent actor between a call to persist and the execution of its handler. This also holds for multiple persist calls per received command. Internally, this is achieved by stashing new commands and unstashing them when the event has been persisted and handled. The stash used for that is an internal stash which doesn't interfere with the inherited user stash.

    An event handler may close over persistent actor state and modify it. The sender of a persisted event is the sender of the corresponding command. This means that one can reply to a command sender within an event handler.

    Within an event handler, applications usually update persistent actor state using persisted event data, notify listeners and reply to command senders.

    If persistence of an event fails, the persistent actor will be stopped. This can be customized by handling PersistenceFailure in receiveCommand.

    event

    event to be persisted

    handler

    handler for each persisted event

    Definition Classes
    Eventsourced
  55. final def persistAsync[A](events: Iterable[A])(handler: (A) ⇒ Unit): Unit

    JAVA API: asynchronously persists events in specified order.

    JAVA API: asynchronously persists events in specified order. This is equivalent to calling persistAsync[A](event: A)(handler: A => Unit) multiple times with the same handler, except that events are persisted atomically with this method.

    events

    events to be persisted

    handler

    handler for each persisted events

    Definition Classes
    UntypedPersistentActor
  56. final def persistAsync[A](event: A)(handler: Procedure[A]): Unit

    JAVA API: asynchronously persists event.

    JAVA API: asynchronously persists event. On successful persistence, handler is called with the persisted event.

    Unlike persist the persistent actor will continue to receive incomming commands between the call to persist and executing it's handler. This asynchronous, non-stashing, version of of persist should be used when you favor throughput over the "command-2 only processed after command-1 effects' have been applied" guarantee, which is provided by the plain persist method.

    An event handler may close over persistent actor state and modify it. The sender of a persisted event is the sender of the corresponding command. This means that one can reply to a command sender within an event handler.

    If persistence of an event fails, the persistent actor will be stopped. This can be customized by handling PersistenceFailure in receiveCommand.

    event

    event to be persisted

    handler

    handler for each persisted event

    Definition Classes
    UntypedPersistentActor
  57. final def persistAsync[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Asynchronously persists events in specified order.

    Asynchronously persists events in specified order. This is equivalent to calling persistAsync[A](event: A)(handler: A => Unit) multiple times with the same handler, except that events are persisted atomically with this method.

    events

    events to be persisted

    handler

    handler for each persisted events

    Definition Classes
    Eventsourced
  58. final def persistAsync[A](event: A)(handler: (A) ⇒ Unit): Unit

    Asynchronously persists event.

    Asynchronously persists event. On successful persistence, handler is called with the persisted event.

    Unlike persist the persistent actor will continue to receive incomming commands between the call to persist and executing it's handler. This asynchronous, non-stashing, version of of persist should be used when you favor throughput over the "command-2 only processed after command-1 effects' have been applied" guarantee, which is provided by the plain persist method.

    An event handler may close over persistent actor state and modify it. The sender of a persisted event is the sender of the corresponding command. This means that one can reply to a command sender within an event handler.

    If persistence of an event fails, the persistent actor will be stopped. This can be customized by handling PersistenceFailure in receiveCommand.

    event

    event to be persisted

    handler

    handler for each persisted event

    Definition Classes
    Eventsourced
  59. def persistenceId: String

    Persistence id.

    Persistence id. Defaults to this persistent-actors's path and can be overridden.

    Definition Classes
    ProcessorRecovery
  60. def postRestart(reason: Throwable): Unit

    User overridable callback: By default it calls preStart().

    User overridable callback: By default it calls preStart().

    Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

    reason

    the Throwable that caused the restart to happen

    Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

    Definition Classes
    UntypedActorActor
    Annotations
    @throws( classOf[Exception] )
  61. def postStop(): Unit

    Calls super.postStop then unstashes all messages from the internal stash.

    Calls super.postStop then unstashes all messages from the internal stash.

    Definition Classes
    Eventsourced → UnrestrictedStashActor
  62. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Calls super.preRestart then unstashes all messages from the internal stash.

    Calls super.preRestart then unstashes all messages from the internal stash.

    reason

    the Throwable that caused the restart to happen

    message

    optionally the current message the actor processed when failing, if applicable

    Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.

    Definition Classes
    Eventsourced → ProcessorImpl → UnrestrictedStashActor
  63. def preRestartDefault(reason: Throwable, message: Option[Any]): Unit

    Calls preRestart and then super.preRestart().

    Calls preRestart and then super.preRestart(). If processor implementation classes want to opt out from stopping child actors, they should override this method and call preRestart only.

    Definition Classes
    ProcessorImpl
  64. def preStart(): Unit

    User-overridable callback.

    User-overridable callback. Called when a processor is started. Default implementation sends a Recover() to self.

    Definition Classes
    ProcessorImpl → Actor
    Annotations
    @throws( classOf[Exception] )
  65. final def receive: PartialFunction[Any, Unit]

    This defines the initial actor behavior, it must return a partial function with the actor logic.

    This defines the initial actor behavior, it must return a partial function with the actor logic.

    Definition Classes
    UntypedActorActor
  66. final def receiveCommand: Receive

    Command handler.

    Command handler. Typically validates commands against current state (and/or by communication with other actors). On successful validation, one or more events are derived from a command and these events are then persisted by calling persist. Commands sent to event sourced persistent actors should not be Persistent messages.

    Definition Classes
    UntypedPersistentActor → Eventsourced
  67. final def receiveRecover: Receive

    Recovery handler that receives persisted events during recovery.

    Recovery handler that receives persisted events during recovery. If a state snapshot has been captured and saved, this handler will receive a SnapshotOffer message followed by events that are younger than the offered snapshot.

    This handler must not have side-effects other than changing persistent actor state i.e. it should not perform actions that may fail, such as interacting with external services, for example.

    If recovery fails, the actor will be stopped. This can be customized by handling RecoveryFailure.

    Definition Classes
    UntypedPersistentActor → Eventsourced
    See also

    Recover

  68. def recoveryFinished: Boolean

    Returns true if this processor has successfully finished recovery.

    Returns true if this processor has successfully finished recovery.

    Definition Classes
    ProcessorImpl
  69. def recoveryRunning: Boolean

    Returns true if this processor is currently recovering.

    Returns true if this processor is currently recovering.

    Definition Classes
    ProcessorImpl
  70. def redeliverInterval: FiniteDuration

    Interval between redelivery attempts.

    Interval between redelivery attempts.

    The default value can be configured with the akka.persistence.at-least-once-delivery.redeliver-interval configuration key. This method can be overridden by implementation classes to return non-default values.

    Definition Classes
    AtLeastOnceDelivery
  71. def saveSnapshot(snapshot: Any): Unit

    Saves a snapshot of this snapshotter's state.

    Saves a snapshot of this snapshotter's state. If saving succeeds, this snapshotter will receive a SaveSnapshotSuccess message, otherwise a SaveSnapshotFailure message.

    Definition Classes
    Snapshotter
  72. implicit final val self: ActorRef

    The 'self' field holds the ActorRef for this actor.

    The 'self' field holds the ActorRef for this actor.

    Can be used to send messages to itself:

    self ! message
    

    Definition Classes
    Actor
  73. final def sender(): ActorRef

    The reference sender Actor of the last received message.

    The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in akka.actor.ActorSystem.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    Definition Classes
    Actor
  74. def setDeliverySnapshot(snapshot: AtLeastOnceDeliverySnapshot): Unit

    If snapshot from #getDeliverySnapshot was saved it will be received during recovery in a SnapshotOffer message and should be set with this method.

    If snapshot from #getDeliverySnapshot was saved it will be received during recovery in a SnapshotOffer message and should be set with this method.

    Definition Classes
    AtLeastOnceDelivery
  75. def snapshotSequenceNr: Long

    Returns lastSequenceNr.

    Returns lastSequenceNr.

    Definition Classes
    RecoverySnapshotter
  76. def snapshotterId: String

    Returns persistenceId.

    Returns persistenceId.

    Definition Classes
    ProcessorImpl → Snapshotter
  77. def stash(): Unit

    Adds the current message (the message that the actor received last) to the actor's stash.

    Adds the current message (the message that the actor received last) to the actor's stash.

    Definition Classes
    StashSupport
    Exceptions thrown
    IllegalStateException

    if the same message is stashed more than once

    StashOverflowException

    in case of a stash capacity violation

  78. def supervisorStrategy: SupervisorStrategy

    User overridable definition the strategy to use for supervising child actors.

    User overridable definition the strategy to use for supervising child actors.

    Definition Classes
    UntypedActorActor
  79. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  80. def toString(): String

    Definition Classes
    AnyRef → Any
  81. def unhandled(message: Any): Unit

    User overridable callback.

    User overridable callback.

    Is called when a message isn't handled by the current behavior of the actor by default it fails with either a akka.actor.DeathPactException (in case of an unhandled akka.actor.Terminated message) or publishes an akka.actor.UnhandledMessage to the actor's system's akka.event.EventStream

    Definition Classes
    ProcessorImpl → Actor
  82. def unstashAll(): Unit

    Prepends all messages in the stash to the mailbox, and then clears the stash.

    Prepends all messages in the stash to the mailbox, and then clears the stash.

    Messages from the stash are enqueued to the mailbox until the capacity of the mailbox (if any) has been reached. In case a bounded mailbox overflows, a MessageQueueAppendFailedException is thrown.

    The stash is guaranteed to be empty after calling unstashAll().

    Definition Classes
    Eventsourced → StashSupport
  83. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  86. def warnAfterNumberOfUnconfirmedAttempts: Int

    After this number of delivery attempts a AtLeastOnceDelivery.UnconfirmedWarning message will be sent to self.

    After this number of delivery attempts a AtLeastOnceDelivery.UnconfirmedWarning message will be sent to self. The count is reset after a restart.

    The default value can be configured with the akka.persistence.at-least-once-delivery.warn-after-number-of-unconfirmed-attempts configuration key. This method can be overridden by implementation classes to return non-default values.

    Definition Classes
    AtLeastOnceDelivery
  87. def [B](y: B): (UntypedPersistentActorWithAtLeastOnceDelivery, B)

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentActorWithAtLeastOnceDelivery to ArrowAssoc[UntypedPersistentActorWithAtLeastOnceDelivery] 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 UntypedPersistentActorWithAtLeastOnceDelivery to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (untypedPersistentActorWithAtLeastOnceDelivery: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentActorWithAtLeastOnceDelivery to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (untypedPersistentActorWithAtLeastOnceDelivery: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. implicit def currentPersistentMessage: Option[Persistent]

    Returns the current persistent message if there is any.

    Returns the current persistent message if there is any.

    Definition Classes
    Recovery
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) currentPersistentMessage will be removed, sequence number can be retrieved with lastSequenceNr.

  2. def deleteMessage(sequenceNr: Long, permanent: Boolean): Unit

    Deletes a persistent message identified by sequenceNr.

    Deletes a persistent message identified by sequenceNr. If permanent is set to false, the persistent message is marked as deleted in the journal, otherwise it is permanently deleted from the journal. A deleted message is not replayed during recovery. This method is usually called inside preRestartProcessor when a persistent message caused an exception. Processors that want to re-receive that persistent message during recovery should not call this method.

    sequenceNr

    sequence number of the persistent message to be deleted.

    permanent

    if false, the message is marked as deleted, otherwise it is permanently deleted.

    Definition Classes
    ProcessorImpl
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) deleteMessage(sequenceNr) will be removed. Instead, validate before persist, and use deleteMessages for pruning.

  3. def deleteMessage(sequenceNr: Long): Unit

    Marks a persistent message, identified by sequenceNr, as deleted.

    Marks a persistent message, identified by sequenceNr, as deleted. A message marked as deleted is not replayed during recovery. This method is usually called inside preRestartProcessor when a persistent message caused an exception. Processors that want to re-receive that persistent message during recovery should not call this method.

    sequenceNr

    sequence number of the persistent message to be deleted.

    Definition Classes
    ProcessorImpl
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) deleteMessage(sequenceNr) will be removed. Instead, validate before persist, and use deleteMessages for pruning.

  4. def getCurrentPersistentMessage: Persistent

    Java API: returns the current persistent message or null if there is none.

    Java API: returns the current persistent message or null if there is none.

    Definition Classes
    Recovery
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) getCurrentPersistentMessage will be removed, sequence number can be retrieved with lastSequenceNr.

  5. def processorId: String

    Processor id.

    Processor id. Defaults to this processor's path and can be overridden.

    Definition Classes
    ProcessorImpl → Recovery
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) Override persistenceId: String instead. Processor will be removed.

  6. def x: UntypedPersistentActorWithAtLeastOnceDelivery

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentActorWithAtLeastOnceDelivery to ArrowAssoc[UntypedPersistentActorWithAtLeastOnceDelivery] 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:
    (untypedPersistentActorWithAtLeastOnceDelivery: ArrowAssoc[UntypedPersistentActorWithAtLeastOnceDelivery]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  7. def x: UntypedPersistentActorWithAtLeastOnceDelivery

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentActorWithAtLeastOnceDelivery to Ensuring[UntypedPersistentActorWithAtLeastOnceDelivery] 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:
    (untypedPersistentActorWithAtLeastOnceDelivery: Ensuring[UntypedPersistentActorWithAtLeastOnceDelivery]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AtLeastOnceDelivery

Inherited from Processor

Inherited from UntypedPersistentActor

Inherited from Eventsourced

Inherited from ProcessorImpl

Inherited from Recovery

Inherited from StashFactory

Inherited from Stash

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from Snapshotter

Inherited from UntypedActor

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from UntypedPersistentActorWithAtLeastOnceDelivery to StringAdd

Inherited by implicit conversion any2stringfmt from UntypedPersistentActorWithAtLeastOnceDelivery to StringFormat

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

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

Ungrouped