akka.persistence

Interface AtLeastOnceDeliveryLike

All Superinterfaces:

Actor, Eventsourced, PersistenceIdentity, PersistenceRecovery, PersistenceStash, RequiresMessageQueue<DequeBasedMessageQueueSemantics>, Snapshotter, Stash, StashFactory, StashSupport, UnrestrictedStash

All Known Subinterfaces:

AtLeastOnceDelivery

All Known Implementing Classes:

AbstractPersistentActorWithAtLeastOnceDelivery, UntypedPersistentActorWithAtLeastOnceDelivery

public interface AtLeastOnceDeliveryLike
extends Eventsourced

See Also:

AtLeastOnceDelivery

Nested Class Summary

Nested classes/interfaces inherited from interface akka.persistence.Eventsourced

Eventsourced.AsyncHandlerInvocation, Eventsourced.AsyncHandlerInvocation$, Eventsourced.PendingHandlerInvocation, Eventsourced.RecoveryTick, Eventsourced.RecoveryTick$, Eventsourced.StashingHandlerInvocation, Eventsourced.StashingHandlerInvocation$, Eventsourced.State

Nested classes/interfaces inherited from interface akka.actor.Actor

Actor.emptyBehavior$, Actor.ignoringBehavior$

Method Summary

Modifier and Type	Method and Description
void	aroundPostStop() INTERNAL API
void	aroundPreRestart(java.lang.Throwable reason, scala.Option<java.lang.Object> message) INTERNAL API
void	aroundReceive(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive, java.lang.Object message) INTERNAL API
boolean	confirmDelivery(long deliveryId) Call this method when a message has been confirmed by the destination, or to abort re-sending.
void	deliver(ActorPath destination, scala.Function1<java.lang.Object,java.lang.Object> deliveryIdToMessage) Scala API: Send the message created by the deliveryIdToMessage function to the destination actor.
void	deliver(ActorSelection destination, scala.Function1<java.lang.Object,java.lang.Object> deliveryIdToMessage) Scala API: Send the message created by the deliveryIdToMessage function to the destination actor.
AtLeastOnceDelivery.AtLeastOnceDeliverySnapshot	getDeliverySnapshot() Full state of the AtLeastOnceDelivery.
int	maxUnconfirmedMessages() Maximum number of unconfirmed messages that this actor is allowed to hold in memory.
long	nextDeliverySequenceNr()
int	numberOfUnconfirmed() Number of messages that have not been confirmed yet.
void	onReplaySuccess() INTERNAL API.
scala.concurrent.duration.FiniteDuration	redeliverInterval() Interval between redelivery attempts.
void	redeliverOverdue()
int	redeliveryBurstLimit() Maximum number of unconfirmed messages that will be sent at each redelivery burst (burst frequency is half of the redelivery interval).
void	send(long deliveryId, akka.persistence.AtLeastOnceDelivery.Internal.Delivery d, long timestamp)
void	setDeliverySnapshot(AtLeastOnceDelivery.AtLeastOnceDeliverySnapshot snapshot) If snapshot from getDeliverySnapshot() was saved it will be received during recovery in a SnapshotOffer message and should be set with this method.
void	startRedeliverTask()
int	warnAfterNumberOfUnconfirmedAttempts() After this number of delivery attempts an AtLeastOnceDelivery.UnconfirmedWarning message will be sent to self.

Methods inherited from interface akka.persistence.Eventsourced

aroundPostRestart, aroundPreStart, changeState, deferAsync, deleteMessages, flushBatch, flushJournalBatch, journal, lastSequenceNr, log, nextSequenceNr, onPersistFailure, onPersistRejected, onRecoveryFailure, peekApplyHandler, persist, persist, persistAll, persistAllAsync, persistAsync, persistAsync, receiveCommand, receiveRecover, recovering, recoveryFinished, recoveryRunning, recoveryStarted, requestRecoveryPermit, setLastSequenceNr, snapshotSequenceNr, snapshotStore, snapshotterId, startRecovery, stashInternally, unhandled, unstashAll, unstashInternally, updateLastSequenceNr, waitingRecoveryPermit

Methods inherited from interface akka.persistence.Snapshotter

deleteSnapshot, deleteSnapshots, loadSnapshot, saveSnapshot

Methods inherited from interface akka.persistence.PersistenceStash

internalStashOverflowStrategy

Methods inherited from interface akka.actor.Actor

context, postRestart, preStart, receive, self, sender, supervisorStrategy

Methods inherited from interface akka.actor.StashSupport

actorCell, clearStash, context, enqueueFirst, mailbox, prepend, self, stash, unstash, unstashAll

Methods inherited from interface akka.actor.StashFactory

createStash

Methods inherited from interface akka.persistence.PersistenceIdentity

journalPluginId, persistenceId, snapshotPluginId

Methods inherited from interface akka.persistence.PersistenceRecovery

recovery

Method Detail

redeliverInterval

scala.concurrent.duration.FiniteDuration redeliverInterval()

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.

Returns:

(undocumented)

redeliveryBurstLimit

int redeliveryBurstLimit()

Maximum number of unconfirmed messages that will be sent at each redelivery burst (burst frequency is half of the redelivery interval). If there's a lot of unconfirmed messages (e.g. if the destination is not available for a long time), this helps to prevent an overwhelming amount of messages to be sent at once.

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

Returns:

(undocumented)

warnAfterNumberOfUnconfirmedAttempts

int warnAfterNumberOfUnconfirmedAttempts()

After this number of delivery attempts an 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.

Returns:

(undocumented)

maxUnconfirmedMessages

int maxUnconfirmedMessages()

Maximum number of unconfirmed messages that this actor is allowed to hold in memory. If this number is exceed deliver(akka.actor.ActorPath, scala.Function1<java.lang.Object, java.lang.Object>) 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.

Returns:

(undocumented)

startRedeliverTask

void startRedeliverTask()

nextDeliverySequenceNr

long nextDeliverySequenceNr()

deliver

void deliver(ActorPath destination,
             scala.Function1<java.lang.Object,java.lang.Object> deliveryIdToMessage)

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(long). 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().

Parameters:

destination - (undocumented)

deliveryIdToMessage - (undocumented)

deliver

void deliver(ActorSelection destination,
             scala.Function1<java.lang.Object,java.lang.Object> deliveryIdToMessage)

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(long). 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().

Parameters:

destination - (undocumented)

deliveryIdToMessage - (undocumented)

confirmDelivery

boolean confirmDelivery(long deliveryId)

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

Parameters:

deliveryId - (undocumented)

Returns:

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

See Also:

deliver(akka.actor.ActorPath, scala.Function1<java.lang.Object, java.lang.Object>)

numberOfUnconfirmed

int numberOfUnconfirmed()

Number of messages that have not been confirmed yet.

Returns:

(undocumented)

redeliverOverdue

void redeliverOverdue()

send

void send(long deliveryId,
          akka.persistence.AtLeastOnceDelivery.Internal.Delivery d,
          long timestamp)

getDeliverySnapshot

AtLeastOnceDelivery.AtLeastOnceDeliverySnapshot getDeliverySnapshot()

Full state of the AtLeastOnceDelivery. It can be saved with Snapshotter.saveSnapshot(java.lang.Object). During recovery the snapshot received in SnapshotOffer should be set with setDeliverySnapshot(akka.persistence.AtLeastOnceDelivery.AtLeastOnceDeliverySnapshot).

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.

Returns:

(undocumented)

setDeliverySnapshot

void setDeliverySnapshot(AtLeastOnceDelivery.AtLeastOnceDeliverySnapshot snapshot)

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

Parameters:

snapshot - (undocumented)

aroundPreRestart

void aroundPreRestart(java.lang.Throwable reason,
                      scala.Option<java.lang.Object> message)

INTERNAL API

Specified by:

aroundPreRestart in interface Actor

Specified by:

aroundPreRestart in interface Eventsourced

Parameters:

reason - (undocumented)

message - (undocumented)

aroundPostStop

void aroundPostStop()

INTERNAL API

Specified by:

aroundPostStop in interface Actor

Specified by:

aroundPostStop in interface Eventsourced

onReplaySuccess

void onReplaySuccess()

Description copied from interface: Eventsourced

INTERNAL API. Called whenever a message replay succeeds. May be implemented by subclass.

Specified by:

onReplaySuccess in interface Eventsourced

aroundReceive

void aroundReceive(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive,
                   java.lang.Object message)

INTERNAL API

Specified by:

aroundReceive in interface Actor

Specified by:

aroundReceive in interface Eventsourced

Parameters:

receive - (undocumented)

message - (undocumented)