AsynchronousWatchableZookeeper

com.loopfor.zookeeper.AsynchronousWatchableZookeeper

A ZooKeeper client with ''asynchronous'' and ''watchable'' operations.

Attributes

Graph
Supertypes
trait Zookeeper
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Abstract methods

Asynchronously gets the children of the node specified by the given path and additionally sets a watch for any changes.

Asynchronously gets the children of the node specified by the given path and additionally sets a watch for any changes.

The watch is triggered when one of the following conditions occur:

  • the session state changes

Attributes

path

the path of the node

Returns:

a future, which upon success, yields an unordered sequence containing the names of each child node, otherwise one of the following exceptions:

  • NoNodeException if the node does not exist

Asynchronously determines the status of the node specified by the given path if it exists and additionally sets a watch for any changes.

Asynchronously determines the status of the node specified by the given path if it exists and additionally sets a watch for any changes.

The watch is triggered when one of the following conditions occur:

  • the data associated with the node changes
  • the node is created
  • the node is deleted
  • the session state changes

Attributes

path

the path of the node

Returns:

a future yielding a Some containing the node status or None if the node does not exist

def get(path: String): Future[(Array[Byte], Status)]

Asynchronously gets the data and status of the node specified by the given path and additionally sets a watch for any changes.

Asynchronously gets the data and status of the node specified by the given path and additionally sets a watch for any changes.

The watch is triggered when one of the following conditions occur:

  • the data associated with the node changes
  • the node is deleted
  • the session state changes

Attributes

path

the path of the node

Returns:

a future, which upon success, yields a tuple containing the data and status of the node, otherwise one of the following exceptions:

  • NoNodeException if the node does not exist
def observe(path: String, recursive: Boolean): Future[Unit]

Asynchronously sets a persistent watch for any changes on the node specified by the given path.

Asynchronously sets a persistent watch for any changes on the node specified by the given path.

For non-recursive watches, the watch function is triggered when the following events occur:

For recursive watches, the watch function is triggered when the following events occur:

  • the data associated with any node in the tree changes DataChanged
  • any child node in the tree is created Created
  • any child node in the tree is deleted Deleted

The watch is always triggered when the following events occur:

Attributes

path

the path of the node

recursive

if the watch should apply to all child nodes

Returns:

a future

def unobserve(path: String, observer: Observer, local: Boolean): Future[Unit]

Removes any watchers matching the observer type on the node specified by the given path.

Removes any watchers matching the observer type on the node specified by the given path.

Attributes

local

indicates that the watcher should be removed locally when there is no server connection

observer

the type of watcher

path

the path of the node

Returns:

a future

Inherited methods

Returns a view of this client in which operations are performed ''asynchronously''.

Returns a view of this client in which operations are performed ''asynchronously''.

Attributes

Returns:

an asynchronous view of this client

Inherited from:
Zookeeper
def close(): Unit

Closes the client connection to the ZooKeeper cluster.

Closes the client connection to the ZooKeeper cluster.

A consequence of closing the connection is that ZooKeeper will expire the corresponding session, which further implies that all ephemeral nodes created by this client will be deleted.

Attributes

Inherited from:
Zookeeper
def ensure(path: String): Future[Unit]

Ensures that the value of a node, specified by the given path, is synchronized across the ZooKeeper cluster.

Ensures that the value of a node, specified by the given path, is synchronized across the ZooKeeper cluster.

'''An important note on consistency''': ZooKeeper does not guarantee, for any given point in time, that all clients will have a consistent view of the cluster. Since reads can be served by any node in the cluster, whereas writes are serialized through the leader, there exists the possibility in which two separate clients may have inconsistent views. This scenario occurs when the leader commits a change once consensus is reached, but the change has not yet propagated across the cluster. Therefore, reads occurring before the commit has propagated will be globally inconsistent. This behavior is normally acceptable, but for some use cases, writes may need to be globally visible before subsequent reads occur.

This method is particularly useful when a ''write'' occurring in one process is followed by a ''read'' in another process. For example, consider the following sequence of operations:

  • process A writes a value
  • process A sends a message to process B
  • process B reads the value

The assumption is that process B expects to see the value written by process A, but as mentioned, ZooKeeper does not make this guarantee. A call to this method before process B attempts to read the value ensures that all prior writes are consistently applied across the cluster, thus observing the write in process A.

Attributes

Returns:

a future that completes when the node is synchronized across the cluster

Inherited from:
Zookeeper

Returns the session associated with ZooKeeper.

Returns the session associated with ZooKeeper.

Note that the connection with ZooKeeper is established asynchronously, which means there is no implied guarantee that the session has connected nor will eventually connect at the time that an instance of this trait is created.

Attributes

Returns:

the session associated with ZooKeeper

Inherited from:
Zookeeper

Returns a view of this client in which operations are performed ''synchronously''.

Returns a view of this client in which operations are performed ''synchronously''.

Attributes

Returns:

a synchronous view of this client

Inherited from:
Zookeeper