akka.persistence.journal

SyncWriteJournal

trait SyncWriteJournal extends Actor with WriteJournalBase with AsyncRecovery

Abstract journal, optimized for synchronous writes.

Source
SyncWriteJournal.scala
Linear Supertypes
AsyncRecovery, WriteJournalBase, Actor, AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SyncWriteJournal
  2. AsyncRecovery
  3. WriteJournalBase
  4. Actor
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Definition Classes
    Actor

Abstract Value Members

  1. abstract 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.

    persistenceId

    persistent actor id.

    fromSequenceNr

    hint where to start searching for the highest sequence number.

    Definition Classes
    AsyncRecovery
  2. abstract 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 channel ids of delivery confirmations that are available for a replayed message must be contained in that message's confirms sequence.

    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.

    replayCallback

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

    Definition Classes
    AsyncRecovery
    See also

    SyncWriteJournal

    AsyncWriteJournal

  3. abstract def deleteMessagesTo(persistenceId: String, toSequenceNr: Long, permanent: Boolean): Unit

    Plugin API: synchronously deletes all persistent messages up to toSequenceNr (inclusive).

    Plugin API: synchronously deletes all persistent messages up to toSequenceNr (inclusive). If permanent is set to false, the persistent messages are marked as deleted, otherwise they are permanently deleted.

  4. abstract def writeMessages(messages: Seq[PersistentRepr]): Unit

    Plugin API: synchronously writes a batch of persistent messages to the journal.

    Plugin API: synchronously writes a batch of persistent messages to the journal. The batch write must be atomic i.e. either all persistent messages in the batch are written or none.

  5. abstract def deleteMessages(messageIds: Seq[PersistentId], permanent: Boolean): Unit

    Plugin API: synchronously deletes messages identified by messageIds from the journal.

    Plugin API: synchronously deletes messages identified by messageIds from the journal. If permanent is set to false, the persistent messages are marked as deleted, otherwise they are permanently deleted.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) deleteMessages will be removed.

  6. abstract def writeConfirmations(confirmations: Seq[PersistentConfirmation]): Unit

    Plugin API: synchronously writes a batch of delivery confirmations to the journal.

    Plugin API: synchronously writes a batch of delivery confirmations to the journal.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) writeConfirmations will be removed, since Channels will be removed.

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from SyncWriteJournal to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (SyncWriteJournal, B)

    Implicit information
    This member is added by an implicit conversion from SyncWriteJournal to ArrowAssoc[SyncWriteJournal] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. def aroundPostRestart(reason: Throwable): Unit

    Can be overridden to intercept calls to postRestart.

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

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

    Can be overridden to intercept calls to postStop.

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

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

    Can be overridden to intercept calls to preRestart.

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

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

    Can be overridden to intercept calls to preStart.

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

    Attributes
    protected[akka]
    Definition Classes
    Actor
  12. 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
  13. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  14. def clone(): AnyRef

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

    Stores the context for this actor, including self, and sender.

    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.UntypedActorContext, which is the Java API of the actor context.

    Definition Classes
    Actor
  16. def ensuring(cond: (SyncWriteJournal) ⇒ Boolean, msg: ⇒ Any): SyncWriteJournal

    Implicit information
    This member is added by an implicit conversion from SyncWriteJournal to Ensuring[SyncWriteJournal] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: (SyncWriteJournal) ⇒ Boolean): SyncWriteJournal

    Implicit information
    This member is added by an implicit conversion from SyncWriteJournal to Ensuring[SyncWriteJournal] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean, msg: ⇒ Any): SyncWriteJournal

    Implicit information
    This member is added by an implicit conversion from SyncWriteJournal to Ensuring[SyncWriteJournal] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean): SyncWriteJournal

    Implicit information
    This member is added by an implicit conversion from SyncWriteJournal to Ensuring[SyncWriteJournal] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from SyncWriteJournal to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. final def getClass(): Class[_]

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

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

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

    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  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

    User overridable callback: By default it disposes of all children and then calls postStop().

    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. def preparePersistentBatch(rb: Seq[Resequenceable]): Seq[PersistentRepr]

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

    This defines the initial actor behavior, it must return a partial function with the actor logic.

    This defines the initial actor behavior, it must return a partial function with the actor logic.

    Definition Classes
    SyncWriteJournalActor
  36. 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
  37. 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
  38. 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
  39. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  40. def toString(): String

    Definition Classes
    AnyRef → Any
  41. 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
  42. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. def [B](y: B): (SyncWriteJournal, B)

    Implicit information
    This member is added by an implicit conversion from SyncWriteJournal to ArrowAssoc[SyncWriteJournal] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from SyncWriteJournal to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (syncWriteJournal: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from SyncWriteJournal to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (syncWriteJournal: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: SyncWriteJournal

    Implicit information
    This member is added by an implicit conversion from SyncWriteJournal to ArrowAssoc[SyncWriteJournal] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (syncWriteJournal: ArrowAssoc[SyncWriteJournal]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: SyncWriteJournal

    Implicit information
    This member is added by an implicit conversion from SyncWriteJournal to Ensuring[SyncWriteJournal] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (syncWriteJournal: Ensuring[SyncWriteJournal]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AsyncRecovery

Inherited from WriteJournalBase

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SyncWriteJournal to StringAdd

Inherited by implicit conversion any2stringfmt from SyncWriteJournal to StringFormat

Inherited by implicit conversion any2ArrowAssoc from SyncWriteJournal to ArrowAssoc[SyncWriteJournal]

Inherited by implicit conversion any2Ensuring from SyncWriteJournal to Ensuring[SyncWriteJournal]

Ungrouped