Class

akka.contrib.persistence.mongodb

MongoJournal

Related Doc: package mongodb

Permalink

class MongoJournal extends AsyncWriteJournal

Linear Supertypes
AsyncWriteJournal, AsyncRecovery, WriteJournalBase, Actor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MongoJournal
  2. AsyncWriteJournal
  3. AsyncRecovery
  4. WriteJournalBase
  5. Actor
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MongoJournal()

    Permalink

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Permalink
    Definition Classes
    Actor

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def aroundPostRestart(reason: Throwable): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
  5. def aroundPostStop(): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
  6. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
  7. def aroundPreStart(): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
  8. def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def asyncDeleteMessagesTo(persistenceId: String, toSequenceNr: Long): Future[Unit]

    Permalink

    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
  11. def asyncReadHighestSequenceNr(processorId: String, fromSequenceNr: Long): Future[Long]

    Permalink

    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
  12. def asyncReplayMessages(processorId: String, fromSequenceNr: Long, toSequenceNr: Long, max: Long)(replayCallback: (PersistentRepr) ⇒ Unit): Future[Unit]

    Permalink

    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 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
  13. def asyncWriteMessages(messages: Seq[AtomicWrite]): Future[Seq[Try[Unit]]]

    Permalink

    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 single PersistentRepr that corresponds to the event that was passed to the persist method of the PersistentActor, or it contains several PersistentRepr that corresponds to the events that were passed to the persistAll method of the PersistentActor. All PersistentRepr of the AtomicWrite 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 a Try Failure with an UnsupportedOperationException 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. The Future 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 the Future 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 returned immutable.Seq[Try[Unit]]. The returned Seq must have as many elements as the input messages Seq. Each Try element signals if the corresponding AtomicWrite 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
  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. implicit val context: ActorContext

    Permalink
    Definition Classes
    Actor
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. val persistence: Persistence

    Permalink
    Definition Classes
    WriteJournalBase
  26. def postRestart(reason: Throwable): Unit

    Permalink
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  27. def postStop(): Unit

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

    Permalink
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  29. def preStart(): Unit

    Permalink
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  30. def preparePersistentBatch(rb: Seq[PersistentEnvelope]): Seq[AtomicWrite]

    Permalink
    Attributes
    protected
    Definition Classes
    WriteJournalBase
  31. final def receive: PartialFunction[Any, Unit]

    Permalink
    Definition Classes
    AsyncWriteJournal → Actor
  32. def receivePluginInternal: actor.Actor.Receive

    Permalink

    Plugin API

    Plugin API

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

    Definition Classes
    MongoJournal → AsyncWriteJournal
  33. final val receiveWriteJournal: actor.Actor.Receive

    Permalink
    Definition Classes
    AsyncWriteJournal
  34. implicit final val self: ActorRef

    Permalink
    Definition Classes
    Actor
  35. final def sender(): ActorRef

    Permalink
    Definition Classes
    Actor
  36. def supervisorStrategy: SupervisorStrategy

    Permalink
    Definition Classes
    Actor
  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  38. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  39. def unhandled(message: Any): Unit

    Permalink
    Definition Classes
    Actor
  40. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AsyncWriteJournal

Inherited from AsyncRecovery

Inherited from WriteJournalBase

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped