akka.persistence
Interface Snapshotter

All Superinterfaces:

Actor

All Known Subinterfaces:

AtLeastOnceDelivery, Eventsourced, EventsourcedProcessor, PersistentActor, PersistentView, Processor, ProcessorImpl, Recovery, View

All Known Implementing Classes:

AbstractEventsourcedProcessor, AbstractPersistentActor, AbstractPersistentActorWithAtLeastOnceDelivery, AbstractPersistentView, AbstractProcessor, AbstractView, JournalPerfSpec.BenchActor, RequestReader, RequestWriter, ShardCoordinator, UntypedEventsourcedProcessor, UntypedPersistentActor, UntypedPersistentActorWithAtLeastOnceDelivery, UntypedPersistentView, UntypedProcessor, UntypedView

public interface Snapshotter
extends Actor

Snapshot API on top of the internal snapshot protocol.

Nested Class Summary

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

Actor.emptyBehavior$

Method Summary

void	deleteSnapshot(long sequenceNr, long timestamp) Deletes a snapshot identified by sequenceNr and timestamp.
void	deleteSnapshots(SnapshotSelectionCriteria criteria) Deletes all snapshots matching criteria.
void	loadSnapshot(java.lang.String persistenceId, SnapshotSelectionCriteria criteria, long toSequenceNr)
void	saveSnapshot(java.lang.Object snapshot) Saves a snapshot of this snapshotter's state.
long	snapshotSequenceNr() Sequence number to use when taking a snapshot.
ActorRef	snapshotStore()
java.lang.String	snapshotterId() Snapshotter id.

Methods inherited from interface akka.actor.Actor

aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, postRestart, postStop, preRestart, preStart, receive, self, sender, supervisorStrategy, unhandled

Method Detail

snapshotStore

ActorRef snapshotStore()

snapshotterId

java.lang.String snapshotterId()

Snapshotter id.

Returns:

(undocumented)

snapshotSequenceNr

long snapshotSequenceNr()

Sequence number to use when taking a snapshot.

Returns:

(undocumented)

loadSnapshot

void loadSnapshot(java.lang.String persistenceId,
                  SnapshotSelectionCriteria criteria,
                  long toSequenceNr)

saveSnapshot

void saveSnapshot(java.lang.Object snapshot)

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

Parameters:

snapshot - (undocumented)

deleteSnapshot

void deleteSnapshot(long sequenceNr,
                    long timestamp)

Deletes a snapshot identified by sequenceNr and timestamp.

Parameters:

sequenceNr - (undocumented)

timestamp - (undocumented)

deleteSnapshots

void deleteSnapshots(SnapshotSelectionCriteria criteria)

Deletes all snapshots matching criteria.

Parameters:

criteria - (undocumented)