trait ReplicatedEntities extends AnyRef

Replicated Entities Protocol Note that while this protocol provides support for replicated entities, the data types sent across the protocol are not replicated entities themselves. It is the responsibility of the Kalix proxy to implement the replicated entities, merge functions, vector clocks etc, not the user service. The user service need only hold the current value in memory, and this protocol sends deltas to the user service to update its in memory value as necessary. These deltas have no way of dealing with conflicts, hence it is important that the Kalix proxy always knows what the state of the user service's in memory value is before sending a delta. If the Kalix proxy is not sure what the value is, eg because it has just sent an operation to the user service which may have updated its value as a result, the proxy should wait until it gets the result of the operation back, to ensure its in memory value is in sync with the user service so that it can calculate deltas that won't conflict. The user service is expected to update its value both as the result of receiving deltas from the proxy, as well as when it sends deltas. It must not update its value in any other circumstance, updating the value in response to any other stimuli risks the value becoming out of sync with the Kalix proxy. The user service will not be sent back deltas as a result of its own changes. An invocation of handle is made for each entity being handled. It may be kept alive and used to handle multiple commands, and may subsequently be terminated if that entity becomes idle, or if the entity is deleted. Shutdown is typically done for efficiency reasons, unless the entity is explicitly deleted, and a terminated handle stream does not mean the proxy has stopped tracking the state of the entity in its memory. Special care must be taken when working with maps and sets. The keys/values are google.protobuf.Any, which encodes the value as binary protobuf, however, serialized protobufs are not stable, two semantically equal objects could encode to different bytes. It is the responsibility of the user service to ensure that stable encodings are used.

Annotations
@AkkaGrpcGenerated()
Source
ReplicatedEntities.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReplicatedEntities
  2. AnyRef
  3. 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

Abstract Value Members

  1. abstract def handle(in: Source[ReplicatedEntityStreamIn, NotUsed]): Source[ReplicatedEntityStreamOut, NotUsed]

    After invoking handle, the first message sent will always be a ReplicatedEntityInit message, containing the entity ID, and, if it exists or is available, a delta for the initial state of the entity.

    After invoking handle, the first message sent will always be a ReplicatedEntityInit message, containing the entity ID, and, if it exists or is available, a delta for the initial state of the entity. After that, one or more commands may be sent, as well as deltas as they arrive. The user service must respond with one reply per command in. They do not necessarily have to be sent in the same order that the commands were sent, the command ID is used to correlate commands to replies.

Concrete 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 ReplicatedEntities toany2stringadd[ReplicatedEntities] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ReplicatedEntities, B)
    Implicit
    This member is added by an implicit conversion from ReplicatedEntities toArrowAssoc[ReplicatedEntities] 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]) @native()
  8. def ensuring(cond: (ReplicatedEntities) => Boolean, msg: => Any): ReplicatedEntities
    Implicit
    This member is added by an implicit conversion from ReplicatedEntities toEnsuring[ReplicatedEntities] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ReplicatedEntities) => Boolean): ReplicatedEntities
    Implicit
    This member is added by an implicit conversion from ReplicatedEntities toEnsuring[ReplicatedEntities] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ReplicatedEntities
    Implicit
    This member is added by an implicit conversion from ReplicatedEntities toEnsuring[ReplicatedEntities] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ReplicatedEntities
    Implicit
    This member is added by an implicit conversion from ReplicatedEntities toEnsuring[ReplicatedEntities] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  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()

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 ReplicatedEntities toStringFormat[ReplicatedEntities] 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): (ReplicatedEntities, B)
    Implicit
    This member is added by an implicit conversion from ReplicatedEntities toArrowAssoc[ReplicatedEntities] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromReplicatedEntities to any2stringadd[ReplicatedEntities]

Inherited by implicit conversion StringFormat fromReplicatedEntities to StringFormat[ReplicatedEntities]

Inherited by implicit conversion Ensuring fromReplicatedEntities to Ensuring[ReplicatedEntities]

Inherited by implicit conversion ArrowAssoc fromReplicatedEntities to ArrowAssoc[ReplicatedEntities]

Ungrouped