Packages

c

akka.persistence.snapshot

NoSnapshotStore

final class NoSnapshotStore extends SnapshotStore

Used as default snapshot-store in case no other store was configured.

If a akka.persistence.PersistentActor calls the akka.persistence.PersistentActor#saveSnapshot method, and at the same time does not configure a specific snapshot-store to be used *and* no default snapshot-store is available, then the NoSnapshotStore will be used to signal a snapshot store failure.

Source
NoSnapshotStore.scala
Linear Supertypes
SnapshotStore, ActorLogging, Actor, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NoSnapshotStore
  2. SnapshotStore
  3. ActorLogging
  4. Actor
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new NoSnapshotStore()

Type Members

  1. final class NoSnapshotStoreException extends RuntimeException
  2. type Receive = PartialFunction[Any, Unit]
    Definition Classes
    Actor

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from NoSnapshotStore toany2stringadd[NoSnapshotStore] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (NoSnapshotStore, B)
    Implicit
    This member is added by an implicit conversion from NoSnapshotStore toArrowAssoc[NoSnapshotStore] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def aroundPostRestart(reason: Throwable): Unit

    INTERNAL API.

    INTERNAL API.

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

    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  7. def aroundPostStop(): Unit

    INTERNAL API.

    INTERNAL API.

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

    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  8. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    INTERNAL API.

    INTERNAL API.

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

    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  9. def aroundPreStart(): Unit

    INTERNAL API.

    INTERNAL API.

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

    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  10. def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to this actor's current behavior.

    receive

    current behavior.

    msg

    current message.

    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  13. 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
  14. 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
    NoSnapshotStore → SnapshotStore
  15. 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
    NoSnapshotStore → SnapshotStore
  16. def ensuring(cond: (NoSnapshotStore) => Boolean, msg: => Any): NoSnapshotStore
    Implicit
    This member is added by an implicit conversion from NoSnapshotStore toEnsuring[NoSnapshotStore] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: (NoSnapshotStore) => Boolean): NoSnapshotStore
    Implicit
    This member is added by an implicit conversion from NoSnapshotStore toEnsuring[NoSnapshotStore] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean, msg: => Any): NoSnapshotStore
    Implicit
    This member is added by an implicit conversion from NoSnapshotStore toEnsuring[NoSnapshotStore] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean): NoSnapshotStore
    Implicit
    This member is added by an implicit conversion from NoSnapshotStore toEnsuring[NoSnapshotStore] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. 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
    NoSnapshotStore → SnapshotStore
  26. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  30. 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])
  31. 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])
  32. 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])
  33. 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])
  34. 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
    SnapshotStore → Actor
  35. 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
  36. final val receiveSnapshotStore: actor.Actor.Receive
    Definition Classes
    SnapshotStore
  37. 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
    NoSnapshotStore → SnapshotStore
  38. 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
  39. 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
  40. 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
  41. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  42. def toString(): String
    Definition Classes
    AnyRef → Any
  43. 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
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from NoSnapshotStore toStringFormat[NoSnapshotStore] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (NoSnapshotStore, B)
    Implicit
    This member is added by an implicit conversion from NoSnapshotStore toArrowAssoc[NoSnapshotStore] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from SnapshotStore

Inherited from ActorLogging

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromNoSnapshotStore to any2stringadd[NoSnapshotStore]

Inherited by implicit conversion StringFormat fromNoSnapshotStore to StringFormat[NoSnapshotStore]

Inherited by implicit conversion Ensuring fromNoSnapshotStore to Ensuring[NoSnapshotStore]

Inherited by implicit conversion ArrowAssoc fromNoSnapshotStore to ArrowAssoc[NoSnapshotStore]

Ungrouped