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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Update[A] toany2stringadd[Update[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Update[A], B)
    Implicit
    This member is added by an implicit conversion from Update[A] toArrowAssoc[Update[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (Update[A]) => Boolean, msg: => Any): Update[A]
    Implicit
    This member is added by an implicit conversion from Update[A] toEnsuring[Update[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Update[A]) => Boolean): Update[A]
    Implicit
    This member is added by an implicit conversion from Update[A] toEnsuring[Update[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Update[A]
    Implicit
    This member is added by an implicit conversion from Update[A] toEnsuring[Update[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Update[A]
    Implicit
    This member is added by an implicit conversion from Update[A] toEnsuring[Update[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val key: Key[A]
    Definition Classes
    Update → Command
  16. val modify: (Option[A]) => A
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. val request: Option[Any]
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. val writeConsistency: WriteConsistency

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Update[A] toStringFormat[Update[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (Update[A], B)
    Implicit
    This member is added by an implicit conversion from Update[A] toArrowAssoc[Update[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from NoSerializationVerificationNeeded

Inherited from Command[A]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromUpdate[A] to any2stringadd[Update[A]]

Inherited by implicit conversion StringFormat fromUpdate[A] to StringFormat[Update[A]]

Inherited by implicit conversion Ensuring fromUpdate[A] to Ensuring[Update[A]]

Inherited by implicit conversion ArrowAssoc fromUpdate[A] to ArrowAssoc[Update[A]]

Ungrouped