Apache Pekko
1.1.0-M1
API
Generated with
Apache Pekko/org.apache.pekko.persistence/org.apache.pekko.persistence.journal/org.apache.pekko.persistence.journal.leveldb/SharedLeveldbStore

SharedLeveldbStore

org.apache.pekko.persistence.journal.leveldb.SharedLeveldbStore
class SharedLeveldbStore(cfg: Config)

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.

Attributes

Deprecated
true
Source
SharedLeveldbStore.scala
Graph
Supertypes
trait ActorLogging
trait Actor
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited types

type Receive = Receive

Attributes

Inherited from:
Actor
Source
Actor.scala

Value members

Constructors

def this()

Attributes

Source
SharedLeveldbStore.scala

Concrete methods

override def prepareConfig: Config

Attributes

Definition Classes
LeveldbStore
Source
SharedLeveldbStore.scala
def receive: Receive

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.

Attributes

Source
SharedLeveldbStore.scala

Inherited methods

def allPersistenceIds: Set[String]

Attributes

Inherited from:
LeveldbIdMapping (hidden)
Source
LeveldbIdMapping.scala
def asyncDeleteMessagesTo(persistenceId: String, toSequenceNr: Long): Future[Unit]

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
def asyncReadHighestSequenceNr(persistenceId: String, fromSequenceNr: Long): Future[Long]

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.

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.

Value parameters

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.

persistenceId

persistent actor id.

Attributes

Inherited from:
LeveldbRecovery (hidden)
Source
LeveldbRecovery.scala
def asyncReplayMessages(persistenceId: String, fromSequenceNr: Long, toSequenceNr: Long, max: Long)(replayCallback: PersistentRepr => Unit): Future[Unit]

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.

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 pekko.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.

Value parameters

fromSequenceNr

sequence number where replay should start (inclusive).

max

maximum number of messages to be replayed.

persistenceId

persistent actor id.

recoveryCallback

called to replay a single message. Can be called from any thread.

toSequenceNr

sequence number where replay should end (inclusive).

Attributes

See also
Inherited from:
LeveldbRecovery (hidden)
Source
LeveldbRecovery.scala
def asyncReplayTaggedMessages(tag: String, fromSequenceNr: Long, toSequenceNr: Long, max: Long)(replayCallback: ReplayedTaggedMessage => Unit): Future[Unit]

Attributes

Inherited from:
LeveldbRecovery (hidden)
Source
LeveldbRecovery.scala
def asyncWriteMessages(messages: Seq[AtomicWrite]): Future[Seq[Try[Unit]]]

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
def compactionLimit(persistenceId: String, toSeqNr: Long): Long

Attributes

Inherited from:
CompactionSegmentManagement (hidden)
Source
LeveldbCompaction.scala
def compactionSegment(persistenceId: String, toSeqNr: Long): Long

Attributes

Inherited from:
CompactionSegmentManagement (hidden)
Source
LeveldbCompaction.scala
def isNewPersistenceId(id: String): Boolean

Attributes

Inherited from:
LeveldbIdMapping (hidden)
Source
LeveldbIdMapping.scala
def leveldbFactory: DBFactory

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
def leveldbReadOptions: ReadOptions

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
def leveldbSnapshot(): ReadOptions

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
def log: LoggingAdapter

Attributes

Inherited from:
ActorLogging
Source
Actor.scala
def mustCompact(persistenceId: String, toSeqNr: Long): Boolean

Attributes

Inherited from:
CompactionSegmentManagement (hidden)
Source
LeveldbCompaction.scala
def numericId(id: String): Int

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

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.

Attributes

Inherited from:
LeveldbIdMapping (hidden)
Source
LeveldbIdMapping.scala
def persistentFromBytes(a: Array[Byte]): PersistentRepr

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
def persistentToBytes(p: PersistentRepr): Array[Byte]

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
def postRestart(reason: Throwable): Unit

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

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

Value parameters

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.

Attributes

Inherited from:
Actor
Source
Actor.scala
override def postStop(): Unit

User overridable callback.

User overridable callback.

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

Attributes

Definition Classes
LeveldbStore -> Actor
Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
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().'''

Value parameters

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.

reason

the Throwable that caused the restart to happen

Attributes

Inherited from:
Actor
Source
Actor.scala
override 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.

Attributes

Definition Classes
LeveldbStore -> LeveldbIdMapping -> Actor
Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
protected def preparePersistentBatch(rb: Seq[PersistentEnvelope]): Seq[AtomicWrite]

Attributes

Inherited from:
WriteJournalBase (hidden)
Source
WriteJournalBase.scala
def readHighestSequenceNr(persistenceId: Int): Long

Attributes

Inherited from:
LeveldbRecovery (hidden)
Source
LeveldbRecovery.scala
def receiveCompactionInternal: Receive

Attributes

Inherited from:
LeveldbCompaction (hidden)
Source
LeveldbCompaction.scala
def replayMessages(persistenceId: Int, fromSequenceNr: Long, toSequenceNr: Long, max: Long)(replayCallback: PersistentRepr => Unit): Unit

Attributes

Inherited from:
LeveldbRecovery (hidden)
Source
LeveldbRecovery.scala
def replayTaggedMessages(tag: String, tagNid: Int, fromSequenceNr: Long, toSequenceNr: Long, max: Long)(replayCallback: ReplayedTaggedMessage => Unit): Unit

Attributes

Inherited from:
LeveldbRecovery (hidden)
Source
LeveldbRecovery.scala
final def sender(): ActorRef

The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in pekko.actor.ActorSystem.

The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in pekko.actor.ActorSystem.

WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

Attributes

Inherited from:
Actor
Source
Actor.scala
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.

Attributes

Inherited from:
Actor
Source
Actor.scala
def tagAsPersistenceId(tag: String): String

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
def tagNumericId(tag: String): Int

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
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 pekko.actor.DeathPactException (in case of an unhandled pekko.actor.Terminated message) or publishes an pekko.actor.UnhandledMessage to the actor's system's pekko.event.EventStream

Attributes

Inherited from:
Actor
Source
Actor.scala
def updateCompactionSegment(persistenceId: String, compactionSegment: Long): Unit

Attributes

Inherited from:
CompactionSegmentManagement (hidden)
Source
LeveldbCompaction.scala
def withBatch[R](body: WriteBatch => R): R

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
def withIterator[R](body: DBIterator => R): R

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala

Inherited fields

override val compactionIntervals: Map[String, Long]

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
val config: Config

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
var leveldb: DB

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
val leveldbDir: File

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
val leveldbOptions: Options

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
val leveldbWriteOptions: WriteOptions

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
val nativeLeveldb: Boolean

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala
val persistence: Persistence

Attributes

Inherited from:
WriteJournalBase (hidden)
Source
WriteJournalBase.scala
val serialization: Serialization

Attributes

Inherited from:
LeveldbStore (hidden)
Source
LeveldbStore.scala

Implicits

Inherited implicits

implicit val context: ActorContext

Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

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!

pekko.actor.ActorContext is the Scala API. getContext returns a pekko.actor.AbstractActor.ActorContext, which is the Java API of the actor context.

Attributes

Inherited from:
Actor
Source
Actor.scala
final implicit 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

Attributes

Inherited from:
Actor
Source
Actor.scala
Generated with