trait CommandContext extends EventSourcedContext with ClientActionContext with EffectContext
An event sourced command context.
Methods annotated with CommandHandler may take this is a parameter. It allows emitting new events in response
to a command, along with forwarding the result to other entities, and performing side effects on other entities.
- Alphabetic
- By Inheritance
- CommandContext
- EffectContext
- ClientActionContext
- EventSourcedContext
- EntityContext
- Context
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
commandId(): Long
The id of the command being executed.
The id of the command being executed.
- returns
The id of the command.
-
abstract
def
commandName(): String
The name of the command being executed.
The name of the command being executed.
- returns
The name of the command.
-
abstract
def
effect(effect: ServiceCall, synchronous: Boolean): Unit
Invoke the referenced service call as an effect once this action is completed.
Invoke the referenced service call as an effect once this action is completed.
- effect
The service call to make as an effect effect.
- synchronous
Whether the effect should be performed synchronously (ie, wait till it has finished before sending a reply) or asynchronously.
- Definition Classes
- EffectContext
-
abstract
def
emit(event: Any): Unit
Emit the given event.
Emit the given event. The event will be persisted, and the handler of the event defined in the current behavior will immediately be executed to pick it up.
- event
The event to emit.
-
abstract
def
entityId(): String
The id of the entity that this context is for.
The id of the entity that this context is for.
- returns
The entity id.
- Definition Classes
- EntityContext
-
abstract
def
fail(errorMessage: String): Unit
Fail the command with the given message.
Fail the command with the given message.
- errorMessage
The error message to send to the client.
- Definition Classes
- ClientActionContext
-
abstract
def
forward(to: ServiceCall): Unit
Instruct the proxy to forward handling of this command to another entity served by this stateful function.
Instruct the proxy to forward handling of this command to another entity served by this stateful function.
The command will be forwarded after successful completion of handling this command, including any persistence that this command does.
- to
The service call to forward command processing to.
- Definition Classes
- ClientActionContext
-
abstract
def
sequenceNumber(): Long
The current sequence number of events in this entity.
The current sequence number of events in this entity.
- returns
The current sequence number.
-
abstract
def
serviceCallFactory(): ServiceCallFactory
Get the service call factory for this stateful service.
Get the service call factory for this stateful service.
- Definition Classes
- Context
Concrete 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
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
effect(effect: ServiceCall): Unit
Invoke the referenced service call as an effect once this action is completed.
Invoke the referenced service call as an effect once this action is completed.
The effect will be performed asynchronously, ie, the proxy won't wait for the effect to finish before sending the reply.
- effect
The service call to make as an effect effect.
- Definition Classes
- EffectContext
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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( ... ) @native()