AbstractEventsourcedProcessor

Instance Constructors

new AbstractEventsourcedProcessor(id: String, eventLog: ActorRef, targetEventLog: ActorRef)

Type Members

type Handler[A] = (Try[A]) ⇒ Unit

Definition Classes
EventsourcedView
type Process = PartialFunction[Any, Seq[Any]]

Type of this processor's event handler.
Type of this processor's event handler.

Definition Classes
EventsourcedProcessor
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
final def aggregateId: Option[String]

Optional aggregate id.
Optional aggregate id. It is used for routing DurableEvents to event-sourced destinations which can be EventsourcedViews or EventsourcedActors. By default, an event is routed to an event-sourced destination with an undefined aggregateId. If a destination's aggregateId is defined it will only receive events with a matching aggregate id in DurableEvent#destinationAggregateIds.

Definition Classes
AbstractEventsourcedComponent → EventsourcedView
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: akka.actor.Actor.Receive, msg: Any): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def commandContext: BehaviorContext

Returns the command BehaviorContext.
Returns the command BehaviorContext.

Definition Classes
EventsourcedView
implicit val context: ActorContext

Definition Classes
Actor
def createOnCommand(): akka.actor.AbstractActor.Receive

Java API of the command handler.
Java API of the command handler.
Returns a receive object that defines the actor's command handling behaviour. Use ReceiveBuilder to define the behaviour.

Definition Classes
AbstractEventsourcedComponent
See also
EventsourcedView
def createOnProcessEvent(): AbstractEventsourcedProcessor.Process

Java API of event-processing handler.
Java API of event-processing handler.
Returns a AbstractEventsourcedProcessor.Process that defines the actor's event processing behaviour. Use ProcessBuilder to define the behaviour.

Definition Classes
EventSourcedProcessorAdapter
See also
EventsourcedProcessor
def createOnRecovery(): ResultHandler[Unit]

Java API of the recovery handler.
Java API of the recovery handler.
Returns a result handler that defines the actor's recover handling behaviour. Use ResultHandler to define the behaviour.

Definition Classes
AbstractEventsourcedComponent
See also
EventsourcedView
def createOnSnapshot(): akka.actor.AbstractActor.Receive

Java API of the snapshot handler.
Java API of the snapshot handler.
Returns a receive object that defines the actor's snapshot handling behaviour. Use ReceiveBuilder to define the behaviour.

Definition Classes
AbstractEventsourcedComponent
See also
EventsourcedView
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
final lazy val eventContext: BehaviorContext

Returns an command BehaviorContext that doesn't allow event handler behavior changes.
Returns an command BehaviorContext that doesn't allow event handler behavior changes. An attempt to change the event handler behavior with eventContext.become() will throw an UnsupportedOperationException.

Definition Classes
EventsourcedProcessor → EventsourcedView
val eventLog: ActorRef

Event log actor.
Event log actor.

Definition Classes
AbstractEventsourcedProcessor → EventsourcedView
def finalize(): Unit

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

Java API of aggregateId.
Java API of aggregateId.

Definition Classes
AbstractEventsourcedComponent
See also
EventsourcedView
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def getCommandContext: AbstractEventsourcedComponent.BehaviorContext

Java API of commandContext.
Java API of commandContext.
Returns the command BehaviorContext.

Definition Classes
AbstractEventsourcedComponent
See also
EventsourcedView
def getContext: ActorContext

Returns this AbstractActor's ActorContext.
Returns this AbstractActor's ActorContext. Mimics AbstractActor.getContext.

Definition Classes
AbstractEventsourcedComponent
final def getEventContext: AbstractEventsourcedComponent.BehaviorContext

Java API of eventContext.
Java API of eventContext.
Returns the event BehaviorContext.

Definition Classes
AbstractEventsourcedComponent
See also
EventsourcedView
final def getLastEmitterAggregateId: Optional[String]

Java API of lastEmitterAggregateId.
Java API of lastEmitterAggregateId.

Definition Classes
AbstractEventsourcedComponent
See also
EventsourcedView
final def getLastEmitterId: String

Java API of lastEmitterId.
Java API of lastEmitterId.

Definition Classes
AbstractEventsourcedComponent
See also
EventsourcedView
final def getLastSequenceNr: Long

Java API of lastSequenceNr.
Java API of lastSequenceNr.

Definition Classes
AbstractEventsourcedComponent
See also
EventsourcedView
final def getLastSystemTimestamp: Long

Java API of lastSystemTimestamp.
Java API of lastSystemTimestamp.

Definition Classes
AbstractEventsourcedComponent
See also
EventsourcedView
final def getLastVectorTimestamp: VectorTime

Java API of lastVectorTimestamp.
Java API of lastVectorTimestamp.

Definition Classes
AbstractEventsourcedComponent
See also
EventsourcedView
def getSelf: ActorRef

Returns the ActorRef for this actor.
Returns the ActorRef for this actor. Mimics AbstractActor.getSelf.

Definition Classes
AbstractEventsourcedComponent
def getSender: ActorRef

The reference sender Actor of the currently processed message.
The reference sender Actor of the currently processed message. Mimics AbstractActor.getSender.

Definition Classes
AbstractEventsourcedComponent
final def getSnapshotContext: AbstractEventsourcedComponent.BehaviorContext

Java API of snapshotContext.
Java API of snapshotContext.
Returns the snapshot BehaviorContext.

Definition Classes
AbstractEventsourcedComponent
See also
EventsourcedView
def hashCode(): Int

Definition Classes
AnyRef → Any
val id: String

Global unique actor id.
Global unique actor id.

Definition Classes
AbstractEventsourcedProcessor → EventsourcedView
val instanceId: Int

Definition Classes
EventsourcedView
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def isRecovering: Boolean

Java API of lastEmirecoveringterId.
Java API of lastEmirecoveringterId.

Definition Classes
AbstractEventsourcedComponent
See also
EventsourcedView
final def lastEmitterAggregateId: Option[String]

Emitter aggregate id of the last handled event.
Emitter aggregate id of the last handled event.

Definition Classes
EventsourcedView
final def lastEmitterId: String

Emitter id of the last handled event.
Emitter id of the last handled event.

Definition Classes
EventsourcedView
final def lastProcessId: String

Id of the local event log that initially wrote the event.
Id of the local event log that initially wrote the event.

Definition Classes
EventsourcedView
final def lastSequenceNr: Long

Sequence number of the last handled event.
Sequence number of the last handled event.

Definition Classes
EventsourcedView
final def lastSystemTimestamp: Long

Wall-clock timestamp of the last handled event.
Wall-clock timestamp of the last handled event.

Definition Classes
EventsourcedView
final def lastVectorTimestamp: VectorTime

Vector timestamp of the last handled event.
Vector timestamp of the last handled event.

Definition Classes
EventsourcedView
def log: LoggingAdapter

Definition Classes
ActorLogging
val logger: LoggingAdapter

This actor's logging adapter.
This actor's logging adapter.

Definition Classes
EventsourcedView
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def onCommand: Receive

Command handler.
Command handler.

Definition Classes
AbstractEventsourcedComponent → EventsourcedView
final def onEvent: PartialFunction[Any, Unit]

Collects processed events generated by processEvent.
Collects processed events generated by processEvent.

Definition Classes
EventsourcedProcessor → EventsourcedView
def onReadFailure(cause: Throwable): Unit

Java API of readFailure.
Java API of readFailure.

Definition Classes
EventsourcedWriterFailureHandlerAdapter
See also
EventsourcedWriter
def onReadSuccess(result: Long): Optional[Long]

Java API of readSuccess.
Java API of readSuccess.

See also
EventsourcedProcessor
final def onRecovery: Handler[Unit]

Recovery completion handler.
Recovery completion handler. If called with a Failure, the actor will be stopped in any case, regardless of the action taken by the returned handler. The default handler implementation does nothing and can be overridden by implementations.

Definition Classes
AbstractEventsourcedComponent → EventsourcedView
final def onSnapshot: Receive

Snapshot handler.
Snapshot handler.

Definition Classes
AbstractEventsourcedComponent → EventsourcedView
def onWriteFailure(cause: Throwable): Unit

Java API of writeFailure.
Java API of writeFailure.

Definition Classes
EventsourcedWriterFailureHandlerAdapter
See also
EventsourcedWriter
def onWriteSuccess(result: Long): Unit

Java API of writeSuccess.
Java API of writeSuccess.

Definition Classes
EventsourcedProcessorWriteSuccessHandlerAdapter
See also
EventsourcedProcessor
def postProcessDurableEvent(e: DurableEvent): DurableEvent

Override to allow post-processing of DurableEvent instances wrapping events generated by processEvent.
Override to allow post-processing of DurableEvent instances wrapping events generated by processEvent.
Amongst other things, this can e.g. be used to set different or additional aggregate IDs for custom routing destinations (which by default take the same routing destinations as the original event that was processed).

Definition Classes
EventsourcedProcessor
def postRestart(reason: Throwable): Unit

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

Sets recovering to false before calling super.postStop.
Sets recovering to false before calling super.postStop.

Definition Classes
EventsourcedView → UnrestrictedStash → Actor
def preRestart(reason: Throwable, message: Option[Any]): Unit

Sets recovering to false before calling super.preRestart.
Sets recovering to false before calling super.preRestart.

Definition Classes
EventsourcedView → UnrestrictedStash → Actor
def preStart(): Unit

Initiates recovery.
Initiates recovery.

Definition Classes
EventsourcedView → Actor
final def processBuilder(): ProcessBuilder

creates a new empty ProcessBuilder
creates a new empty ProcessBuilder

Definition Classes
EventSourcedProcessorAdapter
final def processEvent: Process

Definition Classes
EventSourcedProcessorAdapter → EventsourcedProcessorHandlers
final def read(): Future[Long]

Asynchronously reads the processing progress from the target event log.
Asynchronously reads the processing progress from the target event log.

Definition Classes
EventsourcedProcessor → EventsourcedWriter
final def readFailure(cause: Throwable): Unit

Definition Classes
EventsourcedWriterFailureHandlerAdapter → EventsourcedWriterFailureHandlers
final def readSuccess(result: Long): Option[Long]

Sets the read processing progress for this processor and returns it incremented by 1.
Sets the read processing progress for this processor and returns it incremented by 1.

Definition Classes
AbstractEventsourcedProcessor → EventsourcedProcessor → EventsourcedWriter → EventsourcedWriterSuccessHandlers
def readTimeout: FiniteDuration

The default read timeout configured with the eventuate.log.read-timeout parameter.
The default read timeout configured with the eventuate.log.read-timeout parameter. Can be overridden.

Definition Classes
EventsourcedProcessor
final def receive: Receive

Initialization behavior.
Initialization behavior.

Definition Classes
EventsourcedView → Actor
final def receiveBuilder(): ReceiveBuilder

Creates a new empty ReceiveBuilder.
Creates a new empty ReceiveBuilder. Mimics AbstractActor.receiveBuilder.

Definition Classes
AbstractEventsourcedComponent
final def recovering: Boolean

Returns true if this actor is currently recovering internal state by consuming replayed events from the event log.
Returns true if this actor is currently recovering internal state by consuming replayed events from the event log. Returns false after recovery completed and the actor switches to consuming live events.

Definition Classes
EventsourcedView
def replayBatchSize: Int

Maximum number of events to be replayed to this actor before replaying is suspended.
Maximum number of events to be replayed to this actor before replaying is suspended. A suspended replay is resumed automatically after all replayed events haven been handled by this actor's event handler (= backpressure). The default value for the maximum replay batch size is given by configuration item eventuate.log.replay-batch-size. Configured values can be overridden by overriding this method.

Definition Classes
EventsourcedView
final def replayFromSequenceNr: Option[Long]

Disallow for EventsourcedWriter and subclasses as event processing progress is determined by read and readSuccess.
Disallow for EventsourcedWriter and subclasses as event processing progress is determined by read and readSuccess.

Definition Classes
EventsourcedWriter → EventsourcedView
def save(snapshot: Any, handler: ResultHandler[SnapshotMetadata]): Unit

Java API of save.
Java API of save.
Must be supplied with a ResultHandler to process successful or failed results.

Definition Classes
AbstractEventsourcedComponent
See also
EventsourcedView
final def save(snapshot: Any)(handler: Handler[SnapshotMetadata]): Unit

Asynchronously saves the given snapshot and calls handler with the generated snapshot metadata.
Asynchronously saves the given snapshot and calls handler with the generated snapshot metadata. The handler can obtain a reference to the initial message sender with sender().

Definition Classes
EventsourcedView
implicit final val self: ActorRef

Definition Classes
Actor
final def sender(): ActorRef

Definition Classes
Actor
def snapshotContext: BehaviorContext

Returns the snapshot BehaviorContext.
Returns the snapshot BehaviorContext.

Definition Classes
EventsourcedView
def stash(): Unit

Adds the current command to the user's command stash.
Adds the current command to the user's command stash. Must not be used in the event handler.

Definition Classes
EventsourcedView → StashSupport
def supervisorStrategy: SupervisorStrategy

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

Definition Classes
AnyRef
val targetEventLog: ActorRef

This processor's target event log.
This processor's target event log.

Definition Classes
AbstractEventsourcedProcessor → EventsourcedProcessor
def toString(): String

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

Definition Classes
Actor
def unstashAll(): Unit

Prepends all stashed commands to the actor's mailbox and then clears the command stash.
Prepends all stashed commands to the actor's mailbox and then clears the command stash. Has no effect if the actor is recovering i.e. if recovering returns true.

Definition Classes
EventsourcedView → StashSupport
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
final def write(): Future[Long]

Asynchronously writes processed events that have been collected since the last write together with the current processing progress.
Asynchronously writes processed events that have been collected since the last write together with the current processing progress. If the number of processed events since the last write is greater than the configured eventuate.log.write-batch-size multiple batches with a size less than or equal to eventuate.log.write-batch-size will be written sequentially. When splitting into multiple batches it is guaranteed that the processing result of a single event is part of the same batch i.e. it is guaranteed that the processing result of a single event is written atomically. If the processing result of a single event is larger than eventuate.log.write-batch-size, write write does not split that batch into smaller batches.

Definition Classes
EventsourcedProcessor → EventsourcedWriter
final def writeFailure(cause: Throwable): Unit

Definition Classes
EventsourcedWriterFailureHandlerAdapter → EventsourcedWriterFailureHandlers
final def writeSuccess(result: Long): Unit

Definition Classes
EventsourcedProcessorWriteSuccessHandlerAdapter → EventsourcedWriterSuccessHandlers
def writeTimeout: FiniteDuration

The default write timeout configured with the eventuate.log.write-timeout parameter.
The default write timeout configured with the eventuate.log.write-timeout parameter. Can be overridden.

Definition Classes
EventsourcedProcessor

Related Docs: object AbstractEventsourcedProcessor | package eventuate

class AbstractEventsourcedProcessor extends AbstractEventsourcedComponent with EventsourcedProcessor with EventSourcedProcessorAdapter with EventsourcedProcessorWriteSuccessHandlerAdapter

Instance Constructors

new AbstractEventsourcedProcessor(id: String, eventLog: ActorRef, targetEventLog: ActorRef)

Type Members

type Handler[A] = (Try[A]) ⇒ Unit

type Process = PartialFunction[Any, Seq[Any]]

type Receive = PartialFunction[Any, Unit]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def aggregateId: Option[String]

def aroundPostRestart(reason: Throwable): Unit

def aroundPostStop(): Unit

def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

def aroundPreStart(): Unit

def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def commandContext: BehaviorContext

implicit val context: ActorContext

def createOnCommand(): akka.actor.AbstractActor.Receive

def createOnProcessEvent(): AbstractEventsourcedProcessor.Process

def createOnRecovery(): ResultHandler[Unit]

def createOnSnapshot(): akka.actor.AbstractActor.Receive

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final lazy val eventContext: BehaviorContext

val eventLog: ActorRef

def finalize(): Unit

def getAggregateId: Optional[String]

final def getClass(): Class[_]

final def getCommandContext: AbstractEventsourcedComponent.BehaviorContext

def getContext: ActorContext

final def getEventContext: AbstractEventsourcedComponent.BehaviorContext

final def getLastEmitterAggregateId: Optional[String]

final def getLastEmitterId: String

final def getLastSequenceNr: Long

final def getLastSystemTimestamp: Long

final def getLastVectorTimestamp: VectorTime

def getSelf: ActorRef

def getSender: ActorRef

final def getSnapshotContext: AbstractEventsourcedComponent.BehaviorContext

def hashCode(): Int

val id: String

val instanceId: Int

final def isInstanceOf[T0]: Boolean

final def isRecovering: Boolean

final def lastEmitterAggregateId: Option[String]

final def lastEmitterId: String

final def lastProcessId: String

final def lastSequenceNr: Long

final def lastSystemTimestamp: Long

final def lastVectorTimestamp: VectorTime

def log: LoggingAdapter

val logger: LoggingAdapter

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def onCommand: Receive

final def onEvent: PartialFunction[Any, Unit]

def onReadFailure(cause: Throwable): Unit

def onReadSuccess(result: Long): Optional[Long]

final def onRecovery: Handler[Unit]

final def onSnapshot: Receive

def onWriteFailure(cause: Throwable): Unit

def onWriteSuccess(result: Long): Unit

def postProcessDurableEvent(e: DurableEvent): DurableEvent

def postRestart(reason: Throwable): Unit

def postStop(): Unit

def preRestart(reason: Throwable, message: Option[Any]): Unit

def preStart(): Unit

final def processBuilder(): ProcessBuilder

final def processEvent: Process

final def read(): Future[Long]

final def readFailure(cause: Throwable): Unit

final def readSuccess(result: Long): Option[Long]

def readTimeout: FiniteDuration