Packages

c

akka.persistence.journal.leveldb

SharedLeveldbStore

class SharedLeveldbStore extends LeveldbStore

A LevelDB store that can be shared by multiple actor systems. The shared store must be set for each actor system that uses the store via SharedLeveldbJournal.setStore. The shared LevelDB store is for testing only.

Annotations
@deprecated
Deprecated

(Since version 2.6.15) Use another journal implementation or the in-mem journal in combination with the journal-proxy

Source
SharedLeveldbStore.scala
Linear Supertypes
LeveldbStore, LeveldbCompaction, CompactionSegmentManagement, ActorLogging, LeveldbRecovery, AsyncRecovery, LeveldbIdMapping, WriteJournalBase, Actor, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SharedLeveldbStore
  2. LeveldbStore
  3. LeveldbCompaction
  4. CompactionSegmentManagement
  5. ActorLogging
  6. LeveldbRecovery
  7. AsyncRecovery
  8. LeveldbIdMapping
  9. WriteJournalBase
  10. Actor
  11. AnyRef
  12. 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 SharedLeveldbStore()
  2. new SharedLeveldbStore(cfg: Config)

Type Members

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

Value Members

  1. def allPersistenceIds: Set[String]
    Definition Classes
    LeveldbIdMapping
  2. def asyncDeleteMessagesTo(persistenceId: String, toSequenceNr: Long): Future[Unit]
    Definition Classes
    LeveldbStore
  3. def asyncReadHighestSequenceNr(persistenceId: String, fromSequenceNr: Long): Future[Long]

    Plugin API: asynchronously reads the highest stored sequence number for the given persistenceId.

    Plugin API: asynchronously reads the highest stored sequence number for the given persistenceId. The persistent actor will use the highest sequence number after recovery as the starting point when persisting new events. This sequence number is also used as toSequenceNr in subsequent call to #asyncReplayMessages unless the user has specified a lower toSequenceNr. Journal must maintain the highest sequence number and never decrease it.

    This call is protected with a circuit-breaker.

    Please also note that requests for the highest sequence number may be made concurrently to writes executing for the same persistenceId, in particular it is possible that a restarting actor tries to recover before its outstanding writes have completed.

    persistenceId

    persistent actor id.

    fromSequenceNr

    hint where to start searching for the highest sequence number. When a persistent actor is recovering this fromSequenceNr will be the sequence number of the used snapshot or 0L if no snapshot is used.

    Definition Classes
    LeveldbRecovery → AsyncRecovery
  4. def asyncReplayMessages(persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long, max: Long)(replayCallback: (PersistentRepr) => Unit): Future[Unit]

    Plugin API: asynchronously replays persistent messages.

    Plugin API: asynchronously replays persistent messages. Implementations replay a message by calling replayCallback. The returned future must be completed when all messages (matching the sequence number bounds) have been replayed. The future must be completed with a failure if any of the persistent messages could not be replayed.

    The replayCallback must also be called with messages that have been marked as deleted. In this case a replayed message's deleted method must return true.

    The toSequenceNr is the lowest of what was returned by #asyncReadHighestSequenceNr and what the user specified as recovery akka.persistence.Recovery parameter. This does imply that this call is always preceded by reading the highest sequence number for the given persistenceId.

    This call is NOT protected with a circuit-breaker because it may take long time to replay all events. The plugin implementation itself must protect against an unresponsive backend store and make sure that the returned Future is completed with success or failure within reasonable time. It is not allowed to ignore completing the future.

    persistenceId

    persistent actor id.

    fromSequenceNr

    sequence number where replay should start (inclusive).

    toSequenceNr

    sequence number where replay should end (inclusive).

    max

    maximum number of messages to be replayed.

    Definition Classes
    LeveldbRecovery → AsyncRecovery
    See also

    AsyncWriteJournal

  5. def asyncReplayTaggedMessages(tag: String, fromSequenceNr: Long, toSequenceNr: Long, max: Long)(replayCallback: (ReplayedTaggedMessage) => Unit): Future[Unit]
    Definition Classes
    LeveldbRecovery
  6. def asyncWriteMessages(messages: Seq[AtomicWrite]): Future[Seq[Try[Unit]]]
    Definition Classes
    LeveldbStore
  7. val compactionIntervals: Map[String, Long]
    Definition Classes
    LeveldbStore → CompactionSegmentManagement
  8. def compactionLimit(persistenceId: String, toSeqNr: Long): Long
    Definition Classes
    CompactionSegmentManagement
  9. def compactionSegment(persistenceId: String, toSeqNr: Long): Long
    Definition Classes
    CompactionSegmentManagement
  10. val config: Config
    Definition Classes
    LeveldbStore
  11. 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
  12. def isNewPersistenceId(id: String): Boolean
    Definition Classes
    LeveldbIdMapping
  13. val leveldb: DB
    Definition Classes
    LeveldbStore
  14. val leveldbDir: File
    Definition Classes
    LeveldbStore
  15. def leveldbFactory: DBFactory
    Definition Classes
    LeveldbStore
  16. val leveldbOptions: Options
    Definition Classes
    LeveldbStore
  17. def leveldbReadOptions: ReadOptions
    Definition Classes
    LeveldbStore
  18. def leveldbSnapshot(): ReadOptions
    Definition Classes
    LeveldbStore
  19. val leveldbWriteOptions: WriteOptions
    Definition Classes
    LeveldbStore
  20. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  21. def mustCompact(persistenceId: String, toSeqNr: Long): Boolean
    Definition Classes
    CompactionSegmentManagement
  22. val nativeLeveldb: Boolean
    Definition Classes
    LeveldbStore
  23. def numericId(id: String): Int

    Get the mapped numeric id for the specified persistent actor id.

    Get the mapped numeric id for the specified persistent actor id. Creates and stores a new mapping if necessary.

    This method is thread safe and it is allowed to call it from a another thread than the actor's thread. That is necessary for Future composition, e.g. asyncReadHighestSequenceNr followed by asyncReplayMessages.

    Definition Classes
    LeveldbIdMapping
  24. val persistence: Persistence
    Definition Classes
    WriteJournalBase
  25. def persistentFromBytes(a: Array[Byte]): PersistentRepr
    Definition Classes
    LeveldbStore
  26. def persistentToBytes(p: PersistentRepr): Array[Byte]
    Definition Classes
    LeveldbStore
  27. 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])
  28. def postStop(): Unit

    User overridable callback.

    User overridable callback.

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

    Definition Classes
    LeveldbStore → Actor
  29. 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])
  30. 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
    LeveldbStore → LeveldbIdMapping → Actor
  31. def prepareConfig: Config
    Definition Classes
    SharedLeveldbStore → LeveldbStore
  32. def readHighestSequenceNr(persistenceId: Int): Long
    Definition Classes
    LeveldbRecovery
  33. 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
    SharedLeveldbStore → Actor
  34. def receiveCompactionInternal: Receive
    Definition Classes
    LeveldbCompaction
  35. def replayMessages(persistenceId: Int, fromSequenceNr: Long, toSequenceNr: Long, max: Long)(replayCallback: (PersistentRepr) => Unit): Unit
    Definition Classes
    LeveldbRecovery
  36. def replayTaggedMessages(tag: String, tagNid: Int, fromSequenceNr: Long, toSequenceNr: Long, max: Long)(replayCallback: (ReplayedTaggedMessage) => Unit): Unit
    Definition Classes
    LeveldbRecovery
  37. 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
  38. 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
  39. val serialization: Serialization
    Definition Classes
    LeveldbStore
  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. def tagAsPersistenceId(tag: String): String
    Definition Classes
    LeveldbStore
  42. def tagNumericId(tag: String): Int
    Definition Classes
    LeveldbStore
  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. def updateCompactionSegment(persistenceId: String, compactionSegment: Long): Unit
    Definition Classes
    CompactionSegmentManagement
  45. def withBatch[R](body: (WriteBatch) => R): R
    Definition Classes
    LeveldbStore
  46. def withIterator[R](body: (DBIterator) => R): R
    Definition Classes
    LeveldbStore