Class Replicator.Subscribe<A extends ReplicatedData>

  • All Implemented Interfaces:
    Replicator.ReplicatorMessage, java.io.Serializable, scala.Equals, scala.Product
    Enclosing class:
    Replicator

    public static final class Replicator.Subscribe<A extends ReplicatedData>
    extends java.lang.Object
    implements Replicator.ReplicatorMessage, scala.Product, java.io.Serializable
    Register a subscriber that will be notified with a Replicator.Changed message when the value of the given key is changed. Current value is also sent as a Replicator.Changed message to a new subscriber.

    In addition to subscribing to individual keys it is possible to subscribe to all keys with a given prefix by using a * at the end of the key id. For example GCounterKey("counter-*"). Notifications will be sent for all matching keys, also new keys added later.

    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 Replicator.Deleted message.

    If the key is expired the subscriber is notified with an Replicator.Expired message.

    See Also:
    Serialized Form
    • Constructor Detail

      • Subscribe

        public Subscribe​(Key<A> key,
                         ActorRef subscriber)
    • Method Detail

      • key

        public Key<A> key()
      • subscriber

        public ActorRef subscriber()
      • productPrefix

        public java.lang.String productPrefix()
        Specified by:
        productPrefix in interface scala.Product
      • productArity

        public int productArity()
        Specified by:
        productArity in interface scala.Product
      • productElement

        public java.lang.Object productElement​(int x$1)
        Specified by:
        productElement in interface scala.Product
      • productIterator

        public scala.collection.Iterator<java.lang.Object> productIterator()
        Specified by:
        productIterator in interface scala.Product
      • canEqual

        public boolean canEqual​(java.lang.Object x$1)
        Specified by:
        canEqual in interface scala.Equals
      • productElementName

        public java.lang.String productElementName​(int x$1)
        Specified by:
        productElementName in interface scala.Product
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object x$1)
        Specified by:
        equals in interface scala.Equals
        Overrides:
        equals in class java.lang.Object