class MongoJournal extends AsyncWriteJournal
- Alphabetic
- By Inheritance
- MongoJournal
- AsyncWriteJournal
- AsyncRecovery
- WriteJournalBase
- Actor
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new MongoJournal(config: Config)
Type Members
-
type
Receive = PartialFunction[Any, Unit]
- Definition Classes
- Actor
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
aroundPostRestart(reason: Throwable): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
-
def
aroundPostStop(): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
-
def
aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
-
def
aroundPreStart(): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
-
def
aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asyncDeleteMessagesTo(persistenceId: String, toSequenceNr: Long): Future[Unit]
Plugin API: asynchronously deletes all persistent messages up to
toSequenceNr
(inclusive).Plugin API: asynchronously deletes all persistent messages up to
toSequenceNr
(inclusive).- Definition Classes
- MongoJournal → AsyncWriteJournal
-
def
asyncReadHighestSequenceNr(processorId: String, fromSequenceNr: Long): Future[Long]
Plugin API: asynchronously reads the highest stored sequence number for the given
processorId
.Plugin API: asynchronously reads the highest stored sequence number for the given
processorId
.- processorId
processor id.
- fromSequenceNr
hint where to start searching for the highest sequence number.
- Definition Classes
- MongoJournal → AsyncRecovery
-
def
asyncReplayMessages(processorId: 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'sdeleted
method must returntrue
.The channel ids of delivery confirmations that are available for a replayed message must be contained in that message's
confirms
sequence.- processorId
processor 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.
- replayCallback
called to replay a single message. Can be called from any thread.
- Definition Classes
- MongoJournal → AsyncRecovery
-
def
asyncWriteMessages(messages: Seq[AtomicWrite]): Future[Seq[Try[Unit]]]
Plugin API: asynchronously writes a batch (
Seq
) of persistent messages to the journal.Plugin API: asynchronously writes a batch (
Seq
) of persistent messages to the journal.The batch is only for performance reasons, i.e. all messages don't have to be written atomically. Higher throughput can typically be achieved by using batch inserts of many records compared inserting records one-by-one, but this aspect depends on the underlying data store and a journal implementation can implement it as efficient as possible with the assumption that the messages of the batch are unrelated.
Each
AtomicWrite
message contains the singlePersistentRepr
that corresponds to the event that was passed to thepersist
method of thePersistentActor
, or it contains severalPersistentRepr
that corresponds to the events that were passed to thepersistAll
method of thePersistentActor
. AllPersistentRepr
of theAtomicWrite
must be written to the data store atomically, i.e. all or none must be stored. If the journal (data store) cannot support atomic writes of multiple events it should reject such writes with aTry
Failure
with anUnsupportedOperationException
describing the issue. This limitation should also be documented by the journal plugin.If there are failures when storing any of the messages in the batch the returned
Future
must be completed with failure. TheFuture
must only be completed with success when all messages in the batch have been confirmed to be stored successfully, i.e. they will be readable, and visible, in a subsequent replay. If there is uncertainty about if the messages were stored or not theFuture
must be completed with failure.Data store connection problems must be signaled by completing the
Future
with failure.The journal can also signal that it rejects individual messages (
AtomicWrite
) by the returnedimmutable.Seq[Try[Unit]]
. The returnedSeq
must have as many elements as the inputmessages
Seq
. EachTry
element signals if the correspondingAtomicWrite
is rejected or not, with an exception describing the problem. Rejecting a message means it was not stored, i.e. it must not be included in a later replay. Rejecting a message is typically done before attempting to store it, e.g. because of serialization error.Data store connection problems must not be signaled as rejections.
Note that it is possible to reduce number of allocations by caching some result
Seq
for the happy path, i.e. when no messages are rejected.- Definition Classes
- MongoJournal → AsyncWriteJournal
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
implicit
val
context: ActorContext
- Definition Classes
- Actor
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
val
persistence: Persistence
- Definition Classes
- WriteJournalBase
-
def
postRestart(reason: Throwable): Unit
- Definition Classes
- Actor
- Annotations
- @throws( classOf[java.lang.Exception] )
-
def
postStop(): Unit
- Definition Classes
- Actor
- Annotations
- @throws( classOf[java.lang.Exception] )
-
def
preRestart(reason: Throwable, message: Option[Any]): Unit
- Definition Classes
- Actor
- Annotations
- @throws( classOf[java.lang.Exception] )
-
def
preStart(): Unit
- Definition Classes
- Actor
- Annotations
- @throws( classOf[java.lang.Exception] )
-
def
preparePersistentBatch(rb: Seq[PersistentEnvelope]): Seq[AtomicWrite]
- Attributes
- protected
- Definition Classes
- WriteJournalBase
-
final
def
receive: PartialFunction[Any, Unit]
- Definition Classes
- AsyncWriteJournal → Actor
-
def
receivePluginInternal: actor.Actor.Receive
Plugin API
Plugin API
Allows plugin implementers to use
f pipeTo self
and handle additional messages for implementing advanced features- Definition Classes
- MongoJournal → AsyncWriteJournal
-
final
val
receiveWriteJournal: actor.Actor.Receive
- Definition Classes
- AsyncWriteJournal
-
implicit final
val
self: ActorRef
- Definition Classes
- Actor
-
final
def
sender(): ActorRef
- Definition Classes
- Actor
-
def
supervisorStrategy: SupervisorStrategy
- Definition Classes
- Actor
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
unhandled(message: Any): Unit
- Definition Classes
- Actor
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )