final case class Update[A <: ReplicatedData](key: Key[A], writeConsistency: WriteConsistency, request: Option[Any])(modify: (Option[A]) => A) extends Command[A] with NoSerializationVerificationNeeded with Product with Serializable
- Alphabetic
- By Inheritance
- Update
- Serializable
- Product
- Equals
- NoSerializationVerificationNeeded
- Command
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Update(key: Key[A], initial: A, writeConsistency: WriteConsistency, request: [Any], modify: Function[A, A])
Java API: Modify value of local
Replicator
and replicate with givenwriteConsistency
.Java API: Modify value of local
Replicator
and replicate with givenwriteConsistency
.The current value for the
key
is passed to themodify
function. If there is no current data value for thekey
theinitial
value will be passed to themodify
function.The optional
request
context is included in the reply messages. This is a convenient way to pass contextual information (e.g. original sender) without having to useask
or local correlation data structures. - new Update(key: Key[A], initial: A, writeConsistency: WriteConsistency, modify: Function[A, A])
Java API: Modify value of local
Replicator
and replicate with givenwriteConsistency
.Java API: Modify value of local
Replicator
and replicate with givenwriteConsistency
.The current value for the
key
is passed to themodify
function. If there is no current data value for thekey
theinitial
value will be passed to themodify
function. - new Update(key: Key[A], writeConsistency: WriteConsistency, request: [Any])(modify: (Option[A]) => A)
Send this message to the local
Replicator
to update a data value for the givenkey
. TheReplicator
will reply with one of the UpdateResponse messages.Note that the companion object provides
apply
functions for convenient construction of this message.The current data value for the
key
is passed as parameter to themodify
function. It isNone
if there is no value for thekey
, and otherwiseSome(data)
. The function is supposed to return the new value of the data, which will then be replicated according to the givenwriteConsistency
.The
modify
function is called by theReplicator
actor and must therefore be a pure function that only uses the data parameter and stable fields from enclosing scope. It must for example not accesssender()
reference of an enclosing actor.