Packages

abstract class SnapshotStore extends snapshot.SnapshotStore with SnapshotStorePlugin

Java API: abstract snapshot store.

Source
SnapshotStore.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SnapshotStore
  2. SnapshotStorePlugin
  3. SnapshotStore
  4. ActorLogging
  5. Actor
  6. AnyRef
  7. 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 SnapshotStore()

Type Members

  1. type Receive = PartialFunction[Any, Unit]
    Definition Classes
    Actor

Abstract Value Members

  1. abstract def doDeleteAsync(persistenceId: String, criteria: SnapshotSelectionCriteria): Future[Void]

    Java API, Plugin API: deletes all snapshots matching criteria.

    Java API, Plugin API: deletes all snapshots matching criteria.

    persistenceId

    id of the persistent actor.

    criteria

    selection criteria for deleting.

    Definition Classes
    SnapshotStorePlugin
  2. abstract def doDeleteAsync(metadata: SnapshotMetadata): Future[Void]

    Java API, Plugin API: deletes the snapshot identified by metadata.

    Java API, Plugin API: deletes the snapshot identified by metadata.

    metadata

    snapshot metadata.

    Definition Classes
    SnapshotStorePlugin
  3. abstract def doLoadAsync(persistenceId: String, criteria: SnapshotSelectionCriteria): Future[Optional[SelectedSnapshot]]

    Java API, Plugin API: asynchronously loads a snapshot.

    Java API, Plugin API: asynchronously loads a snapshot.

    persistenceId

    id of the persistent actor.

    criteria

    selection criteria for loading.

    Definition Classes
    SnapshotStorePlugin
  4. abstract def doSaveAsync(metadata: SnapshotMetadata, snapshot: Any): Future[Void]

    Java API, Plugin API: asynchronously saves a snapshot.

    Java API, Plugin API: asynchronously saves a snapshot.

    metadata

    snapshot metadata.

    snapshot

    snapshot.

    Definition Classes
    SnapshotStorePlugin

Concrete Value Members

  1. implicit val context: ActorContext

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

    Scala API: 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.AbstractActor.ActorContext, which is the Java API of the actor context.

    Definition Classes
    Actor
  2. final def deleteAsync(persistenceId: String, criteria: SnapshotSelectionCriteria): Future[Unit]

    Plugin API: deletes all snapshots matching criteria.

    Plugin API: deletes all snapshots matching criteria.

    This call is protected with a circuit-breaker.

    persistenceId

    id of the persistent actor.

    criteria

    selection criteria for deleting.

    Definition Classes
    SnapshotStoreSnapshotStore
  3. final def deleteAsync(metadata: SnapshotMetadata): Future[Unit]

    Plugin API: deletes the snapshot identified by metadata.

    Plugin API: deletes the snapshot identified by metadata.

    This call is protected with a circuit-breaker.

    metadata

    snapshot metadata.

    Definition Classes
    SnapshotStoreSnapshotStore
  4. final def loadAsync(persistenceId: String, criteria: SnapshotSelectionCriteria): Future[Option[SelectedSnapshot]]

    Plugin API: asynchronously loads a snapshot.

    Plugin API: asynchronously loads a snapshot.

    If the future Option is None then all events will be replayed, i.e. there was no snapshot. If snapshot could not be loaded the Future should be completed with failure. That is important because events may have been deleted and just replaying the events might not result in a valid state.

    This call is protected with a circuit-breaker.

    persistenceId

    id of the persistent actor.

    criteria

    selection criteria for loading.

    Definition Classes
    SnapshotStoreSnapshotStore
  5. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  6. def postRestart(reason: Throwable): Unit

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

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

    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
    Actor
    Annotations
    @throws( classOf[Exception] )
  7. def postStop(): Unit

    User overridable callback.

    User overridable callback.

    Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

    Definition Classes
    Actor
    Annotations
    @throws( classOf[Exception] )
  8. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Scala API: User overridable callback: By default it disposes of all children and then calls postStop().

    Scala API: User overridable callback: By default it disposes of all children and then calls postStop().

    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
    Actor
    Annotations
    @throws( classOf[Exception] )
  9. def preStart(): Unit

    User overridable callback.

    User overridable callback.

    Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

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

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

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

    Definition Classes
    SnapshotStoreActor
  11. def receivePluginInternal: actor.Actor.Receive

    Plugin API Allows plugin implementers to use f pipeTo self and handle additional messages for implementing advanced features

    Plugin API Allows plugin implementers to use f pipeTo self and handle additional messages for implementing advanced features

    Definition Classes
    SnapshotStore
  12. final val receiveSnapshotStore: actor.Actor.Receive
    Definition Classes
    SnapshotStore
  13. final def saveAsync(metadata: SnapshotMetadata, snapshot: Any): Future[Unit]

    Plugin API: asynchronously saves a snapshot.

    Plugin API: asynchronously saves a snapshot.

    This call is protected with a circuit-breaker.

    metadata

    snapshot metadata.

    snapshot

    snapshot.

    Definition Classes
    SnapshotStoreSnapshotStore
  14. 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
  15. 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
  16. 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
    Actor
  17. 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
    Actor