Replicator

Type Members

1. type Changed[A <: ReplicatedData] = Replicator.Changed[A]

   

   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 AnyRef

   

3. type DataDeleted[A <: ReplicatedData] = Replicator.DataDeleted[A]

   

4. final case class Delete[A <: ReplicatedData](key: Key[A], consistency: WriteConsistency, replyTo: ActorRef[DeleteResponse[A]], request: Option[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. type DeleteResponse[A <: ReplicatedData] = Replicator.DeleteResponse[A]

   

6. type DeleteSuccess[A <: ReplicatedData] = Replicator.DeleteSuccess[A]

   

7. final case class Get[A <: ReplicatedData](key: Key[A], consistency: ReadConsistency, replyTo: ActorRef[GetResponse[A]], request: Option[Any] = None) 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. type GetFailure[A <: ReplicatedData] = Replicator.GetFailure[A]

   

   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. type GetResponse[A <: ReplicatedData] = Replicator.GetResponse[A]

    

    Reply from Get.

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

11. type GetSuccess[A <: ReplicatedData] = Replicator.GetSuccess[A]

    

12. type ModifyFailure[A <: ReplicatedData] = Replicator.ModifyFailure[A]

    

    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. type NotFound[A <: ReplicatedData] = Replicator.NotFound[A]

    

14. type ReadAll = Replicator.ReadAll

    

15. type ReadConsistency = Replicator.ReadConsistency

    

16. type ReadFrom = Replicator.ReadFrom

    

17. type ReadMajority = Replicator.ReadMajority

    

18. type ReplicaCount = Replicator.ReplicaCount

    

    Current number of replicas.

    Current number of replicas. Reply to GetReplicaCount.

19. type ReplicationDeleteFailure[A <: ReplicatedData] = Replicator.ReplicationDeleteFailure[A]

    

20. type StoreFailure[A <: ReplicatedData] = Replicator.StoreFailure[A]

    

    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](key: Key[A], writeConsistency: WriteConsistency, replyTo: ActorRef[UpdateResponse[A]], request: Option[Any])(modify: (Option[A]) ⇒ A) 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.

    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.

24. type UpdateFailure[A <: ReplicatedData] = Replicator.UpdateFailure[A]

    

25. type UpdateResponse[A <: ReplicatedData] = Replicator.UpdateResponse[A]

    

26. type UpdateSuccess[A <: ReplicatedData] = Replicator.UpdateSuccess[A]

    

27. type UpdateTimeout[A <: ReplicatedData] = Replicator.UpdateTimeout[A]

    

    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. type WriteAll = Replicator.WriteAll

    

29. type WriteConsistency = Replicator.WriteConsistency

    

30. type WriteMajority = Replicator.WriteMajority

    

31. type WriteTo = Replicator.WriteTo