Replicator

Type Members

1. final case class Changed[A <: ReplicatedData](key: Key[A])(data: A) extends Product with Serializable

   

   The data value is retrieved with #get using the typed key.

   The data value is retrieved with #get using the typed key.

   See also

   Replicator.Subscribe

2. trait Command extends scaladsl.Replicator.Command

   

   Annotations

   @DoNotInherit()

3. final case class DataDeleted[A <: ReplicatedData](key: Key[A], request: Optional[Any]) extends RuntimeException with NoStackTrace with DeleteResponse[A] with Product with Serializable

   

4. final case class Delete[A <: ReplicatedData](key: Key[A], consistency: WriteConsistency, replyTo: ActorRef[DeleteResponse[A]], request: Optional[Any]) extends Command with NoSerializationVerificationNeeded with Product with Serializable

   

   Send this message to the local Replicator to delete a data value for the given key.

   Send this message to the local Replicator to delete a data value for the given key. The Replicator will reply with one of the DeleteResponse messages.

   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 maintain local correlation data structures.

5. sealed trait DeleteResponse[A <: ReplicatedData] extends NoSerializationVerificationNeeded

   

6. final case class DeleteSuccess[A <: ReplicatedData](key: Key[A], request: Optional[Any]) extends DeleteResponse[A] with Product with Serializable

   

7. final case class Get[A <: ReplicatedData](key: Key[A], consistency: ReadConsistency, replyTo: ActorRef[GetResponse[A]], request: Optional[Any]) extends Command with Product with Serializable

   

   Send this message to the local Replicator to retrieve a data value for the given key.

   Send this message to the local Replicator to retrieve a data value for the given key. The Replicator will reply with one of the GetResponse messages.

   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 maintain local correlation data structures.

8. final case class GetFailure[A <: ReplicatedData](key: Key[A], request: Optional[Any]) extends GetResponse[A] with Product with Serializable

   

   The Get request could not be fulfill according to the given consistency level and timeout.

9. final case class GetReplicaCount(replyTo: ActorRef[ReplicaCount]) extends Command with Product with Serializable

   

   Get current number of replicas, including the local replica.

   Get current number of replicas, including the local replica. Will reply to sender with ReplicaCount.

10. sealed abstract class GetResponse[A <: ReplicatedData] extends NoSerializationVerificationNeeded

    

    Annotations

    @DoNotInherit()

11. final case class GetSuccess[A <: ReplicatedData](key: Key[A], request: Optional[Any])(data: A) extends GetResponse[A] with Product with Serializable

    

    Reply from Get.

    Reply from Get. The data value is retrieved with #get using the typed key.

12. final case class ModifyFailure[A <: ReplicatedData](key: Key[A], errorMessage: String, cause: Throwable, request: Optional[Any]) extends UpdateFailure[A] with Product with Serializable

    

    If the modify function of the Update throws an exception the reply message will be this ModifyFailure message.

    If the modify function of the Update throws an exception the reply message will be this ModifyFailure message. The original exception is included as cause.

13. final case class NotFound[A <: ReplicatedData](key: Key[A], request: Optional[Any]) extends GetResponse[A] with Product with Serializable

    

14. final case class ReadAll(timeout: Duration) extends ReadConsistency with Product with Serializable

    

15. sealed trait ReadConsistency extends AnyRef

    

16. final case class ReadFrom(n: Int, timeout: Duration) extends ReadConsistency with Product with Serializable

    

17. final case class ReadMajority(timeout: Duration, minCap: Int = DefaultMajorityMinCap) extends ReadConsistency with Product with Serializable

    

18. final case class ReplicaCount(n: Int) extends Product with Serializable

    

    Current number of replicas.

    Current number of replicas. Reply to GetReplicaCount.

19. final case class ReplicationDeleteFailure[A <: ReplicatedData](key: Key[A], request: Optional[Any]) extends DeleteResponse[A] with Product with Serializable

    

20. final case class StoreFailure[A <: ReplicatedData](key: Key[A], request: Optional[Any]) extends UpdateFailure[A] with DeleteResponse[A] with Product with Serializable

    

    The local store or direct replication of the Update could not be fulfill according to the given consistency level due to durable store errors.

    The local store or direct replication of the Update could not be fulfill according to the given consistency level due to durable store errors. This is only used for entries that have been configured to be durable.

    The Update was still performed in memory locally and possibly replicated to some nodes, but it might not have been written to durable storage. It will eventually be disseminated to other replicas, unless the local replica crashes before it has been able to communicate with other replicas.

21. final case class Subscribe[A <: ReplicatedData](key: Key[A], subscriber: ActorRef[Changed[A]]) extends Command with Product with Serializable

    

    Register a subscriber that will be notified with a Changed message when the value of the given key is changed.

    Register a subscriber that will be notified with a Changed message when the value of the given key is changed. Current value is also sent as a Changed message to a new subscriber.

    Subscribers will be notified periodically with the configured notify-subscribers-interval, and it is also possible to send an explicit FlushChanges message to the Replicator to notify the subscribers immediately.

    The subscriber will automatically be unregistered if it is terminated.

    If the key is deleted the subscriber is notified with a Deleted message.

22. final case class Unsubscribe[A <: ReplicatedData](key: Key[A], subscriber: ActorRef[Changed[A]]) extends Command with Product with Serializable

    

    Unregister a subscriber.

    Unregister a subscriber.

    See also

    Replicator.Subscribe

23. final case class Update[A <: ReplicatedData] extends Command with NoSerializationVerificationNeeded with Product with Serializable

    

    Send this message to the local Replicator to update a data value for the given key.

    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.

    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.

24. sealed abstract class UpdateFailure[A <: ReplicatedData] extends UpdateResponse[A]

    

    Annotations

    @DoNotInherit()

25. sealed abstract class UpdateResponse[A <: ReplicatedData] extends NoSerializationVerificationNeeded

    

    Annotations

    @DoNotInherit()

26. final case class UpdateSuccess[A <: ReplicatedData](key: Key[A], request: Optional[Any]) extends UpdateResponse[A] with DeadLetterSuppression with Product with Serializable

    

27. final case class UpdateTimeout[A <: ReplicatedData](key: Key[A], request: Optional[Any]) extends UpdateFailure[A] with Product with Serializable

    

    The direct replication of the Update could not be fulfill according to the given consistency level and timeout.

    The direct replication of the Update could not be fulfill according to the given consistency level and timeout.

    The Update was still performed locally and possibly replicated to some nodes. It will eventually be disseminated to other replicas, unless the local replica crashes before it has been able to communicate with other replicas.

28. final case class WriteAll(timeout: Duration) extends WriteConsistency with Product with Serializable

    

29. sealed trait WriteConsistency extends AnyRef

    

30. final case class WriteMajority(timeout: Duration, minCap: Int = DefaultMajorityMinCap) extends WriteConsistency with Product with Serializable

    

31. final case class WriteTo(n: Int, timeout: Duration) extends WriteConsistency with Product with Serializable