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

Send this message to the local Replicator to update a data value for the given key. The Replicator 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 the modify function. It is None if there is no value for the key, and otherwise Some(data). The function is supposed to return the new value of the data, which will then be replicated according to the given writeConsistency.

The modify function is called by the Replicator 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 access sender() reference of an enclosing actor.

Source
Replicator.scala
Linear Supertypes
Serializable, Product, Equals, NoSerializationVerificationNeeded, Command[A], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Update
  2. Serializable
  3. Product
  4. Equals
  5. NoSerializationVerificationNeeded
  6. Command
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Update(key: Key[A], initial: A, writeConsistency: WriteConsistency, request: Optional[Any], modify: Function[A, A])

    Java API: Modify value of local Replicator and replicate with given writeConsistency.

    Java API: Modify value of local Replicator and replicate with given writeConsistency.

    The current value for the key is passed to the modify function. If there is no current data value for the key the initial value will be passed to the modify 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 use ask or local correlation data structures.

  2. new Update(key: Key[A], initial: A, writeConsistency: WriteConsistency, modify: Function[A, A])

    Java API: Modify value of local Replicator and replicate with given writeConsistency.

    Java API: Modify value of local Replicator and replicate with given writeConsistency.

    The current value for the key is passed to the modify function. If there is no current data value for the key the initial value will be passed to the modify function.

  3. new Update(key: Key[A], writeConsistency: WriteConsistency, request: Option[Any])(modify: (Option[A]) => A)

Value Members

  1. val key: Key[A]
    Definition Classes
    Update → Command
  2. val modify: (Option[A]) => A
  3. def productElementNames: Iterator[String]
    Definition Classes
    Product
  4. val request: Option[Any]
  5. val writeConsistency: WriteConsistency