AbstractEventsourcedActor

Instance Constructors

new AbstractEventsourcedActor(id: String, eventLog: ActorRef)

Type Members

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

Definition Classes
EventsourcedView
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 createOnEvent(): akka.actor.AbstractActor.Receive

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

Definition Classes
AbstractEventsourcedView
See also
EventsourcedView
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
def deliver(deliveryId: String, message: Any, destination: ActorPath): Unit

Delivers the given message to a destination.
Delivers the given message to a destination. The delivery of message is identified by the given deliveryId which must be unique in context of the sending actor. The message is tracked as unconfirmed message until delivery is confirmed by persisting a confirmation event with persistConfirmation, using the same deliveryId.

Definition Classes
ConfirmedDelivery
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def eventContext: BehaviorContext

Returns the event BehaviorContext.
Returns the event BehaviorContext.

Definition Classes
EventsourcedView
val eventLog: ActorRef

Event log actor.
Event log actor.

Definition Classes
AbstractEventsourcedView → 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
final def getUnconfirmed: Set[String]

Java API of unconfirmed.
Java API of unconfirmed.

See also
ConfirmedDelivery
def hashCode(): Int

Definition Classes
AnyRef → Any
val id: String

Global unique actor id.
Global unique actor id.

Definition Classes
AbstractEventsourcedView → 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
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: Receive

Event handler.
Event handler.

Definition Classes
AbstractEventsourcedView → EventsourcedView
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
final def persist[A](event: A, customDestinationAggregateIds: Set[String], handler: ResultHandler[A]): Unit

Java API of persist.
Java API of persist.
Calls the given handler with the persist result for the event.
Multiple routing destinations can be defined with the customDestinationAggregateIds.

See also
EventsourcedActor
final def persist[A](event: A, handler: ResultHandler[A]): Unit

Java API of persist.
Java API of persist.
Calls the given handler with the persist result for the event.

See also
EventsourcedActor
final def persist[A](event: A, customDestinationAggregateIds: Set[String] = Set())(handler: Handler[A]): Unit

Asynchronously persists the given event and calls handler with the persist result.
Asynchronously persists the given event and calls handler with the persist result. If persistence was successful, onEvent is called with the persisted event before handler is called. Both, onEvent and handler, are called on a dispatcher thread of this actor, hence, it is safe to modify internal state within them. The handler can also obtain a reference to the initial command sender via sender().
By default, the event is routed to event-sourced destinations with an undefined aggregateId. If this actor's aggregateId is defined it is additionally routed to all actors with the same aggregateId. Further routing destinations can be defined with the customDestinationAggregateIds parameter.

Definition Classes
EventsourcedActor
final def persistConfirmation[A](event: A, deliveryId: String, customDestinationAggregateIds: Set[String], handler: ResultHandler[A]): Unit

Java API of persistConfirmation.
Java API of persistConfirmation.

See also
ConfirmedDelivery
final def persistConfirmation[A](event: A, deliveryId: String, handler: ResultHandler[A]): Unit

Java API of persistConfirmation.
Java API of persistConfirmation.

See also
ConfirmedDelivery
final def persistConfirmation[A](event: A, deliveryId: String, customDestinationAggregateIds: Set[String] = Set())(handler: Handler[A]): Unit

Same semantics as EventsourcedActor.persist plus additional storage of a deliveryId together with the persistent event.
Same semantics as EventsourcedActor.persist plus additional storage of a deliveryId together with the persistent event.

Definition Classes
ConfirmedDelivery
final def persistN[A](events: Iterable[A], onLast: ResultHandler[A], customDestinationAggregateIds: Set[String], handler: ResultHandler[A]): Unit

Java API of persistN.
Java API of persistN.
Calls the given handler with the persist result for each event in the sequence.
Accepts an onLast handler that will be called after persisting the last event of the sequence.
Multiple routing destinations can be defined with the customDestinationAggregateIds.

See also
EventsourcedActor
final def persistN[A](events: Iterable[A], customDestinationAggregateIds: Set[String], handler: ResultHandler[A]): Unit

Java API of persistN.
Java API of persistN.
Calls the given handler with the persist result for each event in the sequence.
Multiple routing destinations can be defined with the customDestinationAggregateIds.

See also
EventsourcedActor
final def persistN[A](events: Iterable[A], onLast: ResultHandler[A], handler: ResultHandler[A]): Unit

Java API of persistN.
Java API of persistN.
Calls the given handler with the persist result for each event in the sequence.
Accepts an onLast handler that will be called after persisting the last event of the sequence.

See also
EventsourcedActor
final def persistN[A](events: Iterable[A], handler: ResultHandler[A]): Unit

Java API of persistN.
Java API of persistN.
Calls the given handler with the persist result for each event in the sequence.

See also
EventsourcedActor
final def persistN[A](events: Seq[A], onLast: Handler[A] = (_: Try[A]) => (), customDestinationAggregateIds: Set[String] = Set())(handler: Handler[A]): Unit

Asynchronously persists a sequence of events and calls handler with the persist result for each event in the sequence.
Asynchronously persists a sequence of events and calls handler with the persist result for each event in the sequence. If persistence was successful, onEvent is called with a persisted event before handler is called. Both, onEvent and handler, are called on a dispatcher thread of this actor, hence, it is safe to modify internal state within them. The handler can also obtain a reference to the initial command sender via sender(). The onLast handler is additionally called for the last event in the sequence.
By default, the event is routed to event-sourced destinations with an undefined aggregateId. If this actor's aggregateId is defined it is additionally routed to all actors with the same aggregateId. Further routing destinations can be defined with the customDestinationAggregateIds parameter.

Definition Classes
EventsourcedActor
final def persistOnEvent[A](event: A, customDestinationAggregateIds: Set[String]): Unit

Java API of persistOnEvent.
Java API of persistOnEvent.
Multiple routing destinations can be defined with the customDestinationAggregateIds.

See also
PersistOnEvent
final def persistOnEvent[A](event: A): Unit

Java API of persistOnEvent.
Java API of persistOnEvent.

See also
PersistOnEvent
final def persistOnEvent[A](event: A, customDestinationAggregateIds: Set[String] = Set()): Unit

Asynchronously persists the given event.
Asynchronously persists the given event. Applications that want to handle the persisted event should define the event handler at that event. By default, the event is routed to event-sourced destinations with an undefined aggregateId. If this actor's aggregateId is defined it is additionally routed to all actors with the same aggregateId. Further routing destinations can be defined with the customDestinationAggregateIds parameter.

Definition Classes
PersistOnEvent
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 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 redeliverUnconfirmed(): Unit

Redelivers all unconfirmed messages.
Redelivers all unconfirmed messages.

Definition Classes
ConfirmedDelivery
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
def replayFromSequenceNr: Option[Long]

Override to provide an application-defined log sequence number from which event replay will start.
Override to provide an application-defined log sequence number from which event replay will start.
If Some(snr) is returned snapshot loading will be skipped and replay will start from the given sequence number snr.
If None is returned the actor proceeds with the regular snapshot loading procedure.

Definition Classes
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 or persist handler.

Definition Classes
EventsourcedActor → EventsourcedView → StashSupport
def stateSync: Boolean

State synchronization.
State synchronization. If set to true, commands see internal state that is consistent with the event log. This is achieved by stashing new commands if this actor is currently writing events. If set to false, commands see internal state that is eventually consistent with the event log.

Definition Classes
EventsourcedActor
def supervisorStrategy: SupervisorStrategy

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

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def unconfirmed: Set[String]

Delivery ids of unconfirmed messages.
Delivery ids of unconfirmed messages.

Definition Classes
ConfirmedDelivery
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
EventsourcedActor → 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( ... )

Related Doc: package eventuate

abstract class AbstractEventsourcedActor extends AbstractEventsourcedView with EventsourcedActor with ConfirmedDelivery with PersistOnEvent

Instance Constructors

new AbstractEventsourcedActor(id: String, eventLog: ActorRef)

Type Members

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

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 createOnEvent(): akka.actor.AbstractActor.Receive

def createOnRecovery(): ResultHandler[Unit]

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

def deliver(deliveryId: String, message: Any, destination: ActorPath): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def 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

final def getUnconfirmed: Set[String]

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

val logger: LoggingAdapter

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def onCommand: Receive

final def onEvent: Receive

final def onRecovery: Handler[Unit]

final def onSnapshot: Receive

final def persist[A](event: A, customDestinationAggregateIds: Set[String], handler: ResultHandler[A]): Unit

final def persist[A](event: A, handler: ResultHandler[A]): Unit

final def persist[A](event: A, customDestinationAggregateIds: Set[String] = Set())(handler: Handler[A]): Unit

final def persistConfirmation[A](event: A, deliveryId: String, customDestinationAggregateIds: Set[String], handler: ResultHandler[A]): Unit

final def persistConfirmation[A](event: A, deliveryId: String, handler: ResultHandler[A]): Unit

final def persistConfirmation[A](event: A, deliveryId: String, customDestinationAggregateIds: Set[String] = Set())(handler: Handler[A]): Unit

final def persistN[A](events: Iterable[A], onLast: ResultHandler[A], customDestinationAggregateIds: Set[String], handler: ResultHandler[A]): Unit

final def persistN[A](events: Iterable[A], customDestinationAggregateIds: Set[String], handler: ResultHandler[A]): Unit

final def persistN[A](events: Iterable[A], onLast: ResultHandler[A], handler: ResultHandler[A]): Unit

final def persistN[A](events: Iterable[A], handler: ResultHandler[A]): Unit

final def persistN[A](events: Seq[A], onLast: Handler[A] = (_: Try[A]) => (), customDestinationAggregateIds: Set[String] = Set())(handler: Handler[A]): Unit

final def persistOnEvent[A](event: A, customDestinationAggregateIds: Set[String]): Unit

final def persistOnEvent[A](event: A): Unit

final def persistOnEvent[A](event: A, customDestinationAggregateIds: Set[String] = Set()): Unit

def postRestart(reason: Throwable): Unit