EntityEffect
in package
Read onlyYes
FinalYes
Tags
Table of Contents
Properties
- $failureHooks : array<string|int, mixed>
- $immediateReplyMessage : object|null
- $immediateReplyRef : ActorRef|null
- $kind : EntityEffectKind
- $replyHooks : array<string|int, mixed>
- $runHooks : array<string|int, mixed>
Methods
- persist() : EntityEffect<string|int, U>
- remove() : EntityEffect<string|int, U>
- reply() : self
- same() : EntityEffect<string|int, U>
- stash() : EntityEffect<string|int, U>
- stop() : EntityEffect<string|int, U>
- thenReply() : self
- thenReplyOnFailure() : self
- Register a reply to fire when the flush (or remove) fails. The runner passes the caught throwable to `$build` so the caller learns the command failed instead of silently waiting out its ask timeout.
- thenRun() : self
Properties
$failureHooks
public
array<string|int, mixed>
$failureHooks
= []
$immediateReplyMessage
public
object|null
$immediateReplyMessage
= null
$immediateReplyRef
public
ActorRef|null
$immediateReplyRef
= null
$kind
public
EntityEffectKind
$kind
$replyHooks
public
array<string|int, mixed>
$replyHooks
= []
$runHooks
public
array<string|int, mixed>
$runHooks
= []
Methods
persist()
public
static persist() : EntityEffect<string|int, U>
Tags
Return values
EntityEffect<string|int, U>remove()
public
static remove() : EntityEffect<string|int, U>
Tags
Return values
EntityEffect<string|int, U>reply()
public
static reply(ActorRef $to, object $message) : self
Parameters
- $to : ActorRef
- $message : object
Return values
selfsame()
public
static same() : EntityEffect<string|int, U>
Tags
Return values
EntityEffect<string|int, U>stash()
public
static stash() : EntityEffect<string|int, U>
Tags
Return values
EntityEffect<string|int, U>stop()
public
static stop() : EntityEffect<string|int, U>
Tags
Return values
EntityEffect<string|int, U>thenReply()
public
thenReply(ActorRef $to, callable(T): object $build) : self
Parameters
- $to : ActorRef
- $build : callable(T): object
Return values
selfthenReplyOnFailure()
Register a reply to fire when the flush (or remove) fails. The runner passes the caught throwable to `$build` so the caller learns the command failed instead of silently waiting out its ask timeout.
public
thenReplyOnFailure(ActorRef $to, callable(Throwable): object $build) : self
Parameters
- $to : ActorRef
- $build : callable(Throwable): object
Return values
selfthenRun()
public
thenRun(callable(T): void $hook) : self
Parameters
- $hook : callable(T): void