Message

A message for communicating application events. Application events are not interpreted by the eventsourced library and can have any type. Since the library doesn't make any assumptions about the structure and semantics of event, applications may also choose to send commands with org.eligosource.eventsourced.core.Messages. In other words, the library can be used for both, event-sourcing and command-sourcing.

Messages sent to an org.eligosource.eventsourced.core.Eventsourced processor are called input messages. Processors process input messages and optionally emit (or send) output messages to one or more destinations, usually via org.eligosource.eventsourced.core.Channels. Output messages should be derived from input messages using the copy(...) method. Processors may also reply to initial senders using the actor's current sender reference.

event: Application event (or command).
sequenceNr: Sequence number that is generated when messages are written to the journal. Can also be used for detecting duplicates, in special cases.
timestamp: time the input message was added to the event log.
processorId: Id of the event processor that stored (and emitted) this message.
ack: Whether or not an acknowledgement should be written to the journal during (or after) delivery of this message by a org.eligosource.eventsourced.core.Channel. Used by event processors to indicate a series of output messages (that are derived from a single input message). In this case, output messages 1 to n-1 should have ack set to false and only output message n should have ack set to true (default). If an acknowledgement has been written for a series, all messages of that series will be ignored by the corresponding channel during a replay, otherwise all of them will be delivered again.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Message(event: Any, sequenceNr: Long = 0L, timestamp: Long = 0L, processorId: Int = 0, acks: Seq[Int] = immutable.this.Nil, ack: Boolean = true, senderRef: ActorRef = null, confirmationTarget: ActorRef = null, confirmationPrototype: Confirmation = null)

event
Application event (or command).
sequenceNr
Sequence number that is generated when messages are written to the journal. Can also be used for detecting duplicates, in special cases.
timestamp
time the input message was added to the event log.
processorId
Id of the event processor that stored (and emitted) this message.
ack
Whether or not an acknowledgement should be written to the journal during (or after) delivery of this message by a org.eligosource.eventsourced.core.Channel. Used by event processors to indicate a series of output messages (that are derived from a single input message). In this case, output messages 1 to n-1 should have ack set to false and only output message n should have ack set to true (default). If an acknowledgement has been written for a series, all messages of that series will be ignored by the corresponding channel during a replay, otherwise all of them will be delivered again.

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
val ack: Boolean

Whether or not an acknowledgement should be written to the journal during (or after) delivery of this message by a org.eligosource.eventsourced.core.Channel.
Whether or not an acknowledgement should be written to the journal during (or after) delivery of this message by a org.eligosource.eventsourced.core.Channel. Used by event processors to indicate a series of output messages (that are derived from a single input message). In this case, output messages 1 to n-1 should have ack set to false and only output message n should have ack set to true (default). If an acknowledgement has been written for a series, all messages of that series will be ignored by the corresponding channel during a replay, otherwise all of them will be delivered again.
val acks: Seq[Int]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def confirm(pos: Boolean = true): Unit

Should be called by org.eligosource.eventsourced.core.Channel destinations to (positively or negatively) confirm the receipt of this event message.
Should be called by org.eligosource.eventsourced.core.Channel destinations to (positively or negatively) confirm the receipt of this event message. Destinations may also delegate this call other actors or threads.
pos
true for a positive receipt confirmation, false for a negative one.
val confirmationPrototype: Confirmation
val confirmationTarget: ActorRef
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val event: Any

Application event (or command).
def finalize(): Unit

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

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val processorId: Int

Id of the event processor that stored (and emitted) this message.
val senderRef: ActorRef
val sequenceNr: Long

Sequence number that is generated when messages are written to the journal.
Sequence number that is generated when messages are written to the journal. Can also be used for detecting duplicates, in special cases.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val timestamp: Long

time the input message was added to the event log.
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( ... )
def withAck(ack: Boolean): Message

Returns a copy of this message with an updated ack value.
def withEvent(event: Any): Message

Returns a copy of this message with an updated event value.

case class Message(event: Any, sequenceNr: Long = 0L, timestamp: Long = 0L, processorId: Int = 0, acks: Seq[Int] = immutable.this.Nil, ack: Boolean = true, senderRef: ActorRef = null, confirmationTarget: ActorRef = null, confirmationPrototype: Confirmation = null) extends Product with Serializable

Instance Constructors

new Message(event: Any, sequenceNr: Long = 0L, timestamp: Long = 0L, processorId: Int = 0, acks: Seq[Int] = immutable.this.Nil, ack: Boolean = true, senderRef: ActorRef = null, confirmationTarget: ActorRef = null, confirmationPrototype: Confirmation = null)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

val ack: Boolean

val acks: Seq[Int]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def confirm(pos: Boolean = true): Unit

val confirmationPrototype: Confirmation

val confirmationTarget: ActorRef

final def eq(arg0: AnyRef): Boolean

val event: Any

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val processorId: Int

val senderRef: ActorRef

val sequenceNr: Long

final def synchronized[T0](arg0: ⇒ T0): T0

val timestamp: Long

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withAck(ack: Boolean): Message

def withEvent(event: Any): Message

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped