SynchronousZookeeper

Abstract Value Members

abstract def async: AsynchronousZookeeper

Returns a view of this client in which operations are performed asynchronously.
Returns a view of this client in which operations are performed asynchronously.
returns
an asynchronous view of this client

Definition Classes
Zookeeper
abstract def children(path: String): Seq[String]

Returns the children of the node specified by the given path.
Returns the children of the node specified by the given path.
path
the path of the node
returns
an unordered sequence containing the names of each child node

Exceptions thrown
NoNodeException
if the node does not exist
abstract 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.

Definition Classes
Zookeeper
abstract def create(path: String, data: Array[Byte], acl: Seq[ACL], disp: Disposition): String

Creates a new node at the given path.
Creates a new node at the given path.
If a sequential disposition is provided in disp, then path is appended with a monotonically increasing sequence, thus guaranteeing that all sequential nodes are unique with path as their prefix.
path
the path of the node to create
data
the data to associate with the node, which may be empty, but not null
acl
an access control list to apply to the node, which must not be empty
disp
the disposition of the node
returns
the final path of the created node, which will differ from path if disp is either PersistentSequential or EphemeralSequential
abstract def delete(path: String, version: Option[Int]): Unit

Deletes the node specified by the given path.
Deletes the node specified by the given path.
path
the path of the node
version
a Some containing the expected version of the node or None if a version match is not required

Exceptions thrown
BadVersionException
if version is specified and does not match the node version
NoNodeException
if the node does not exist
NotEmptyException
if the node contains children
abstract 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.
returns
a future that completes when the node is synchronized across the cluster

Definition Classes
Zookeeper
abstract def exists(path: String): Option[Status]

Returns the status of the node specified by the given path if it exists.
Returns the status of the node specified by the given path if it exists.
path
the path of the node
returns
a Some containing the node status or None if the node does not exist
abstract def get(path: String): (Array[Byte], Status)

Returns the data and status of the node specified by the given path.
Returns the data and status of the node specified by the given path.
path
the path of the node
returns
a tuple containing the data and status of the node

Exceptions thrown
NoNodeException
if the node does not exist
abstract def getACL(path: String): (Seq[ACL], Status)

Returns the ACL and status of the node specified by the given path.
Returns the ACL and status of the node specified by the given path.
path
the path of the node
returns
a tuple containing the ACL and status of the node

Exceptions thrown
NoNodeException
if the node does not exist
abstract def set(path: String, data: Array[Byte], version: Option[Int]): Status

Sets the data for the node specified by the given path.
Sets the data for the node specified by the given path.
path
the path of the node
data
the data to associate with the node, which may be empty, but not null
version
a Some containing the expected version of the node or None if a version match is not required
returns
the status of the node

Exceptions thrown
BadVersionException
if version is specified and does not match the node version
NoNodeException
if the node does not exist
abstract def setACL(path: String, acl: Seq[ACL], version: Option[Int]): Status

Sets the ACL for the node specified by the given path.
Sets the ACL for the node specified by the given path.
path
the path of the node
acl
an access control list to apply to the node, which must not be empty
version
a Some containing the expected version of the node or None if a version match is not required
returns
the status of the node

Exceptions thrown
BadVersionException
if version is specified and does not match the node version
NoNodeException
if the node does not exist
abstract def sync: SynchronousZookeeper

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

Definition Classes
Zookeeper
abstract def transact(ops: Seq[Operation]): Either[Seq[Problem], Seq[Result]]

Atomically performs a set of operations, either committing all or none.
Atomically performs a set of operations, either committing all or none.
The set of operations are applied by ZooKeeper in sequential order. If successful, this method returns a Right containing a sequence of results that positionally correlate to the sequence of operations. Otherwise, it returns a Left similarly containing a sequence of problems.
Example:
```
val ops = CheckOperation("/foo", None) ::
          CreateOperation("/bar", Array(), ACL.EveryoneAll, Persistent) :: Nil
zk transact ops match {
  case Right(results) => ...
  case Left(problems) => ...
}
```
abstract def watch(fn: PartialFunction[Event, Unit]): SynchronousWatchableZookeeper

Returns a synchronous client in which operations implicitly attach the specified watch function.
Returns a synchronous client in which operations implicitly attach the specified watch function.
The partial function fn is invoked when a watch is triggered or the session state changes. This method is typically used in a transient manner to introduce a watch function prior to performing a watchable ZooKeeper operation.
Example:
```
val zk = SynchronousZookeeper(config)
val (data, node) = zk watch {
  case e: NodeEvent => ...
  case e: StateEvent => ...
} get "/foo"
```

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

trait SynchronousZookeeper extends Zookeeper

Abstract Value Members

abstract def async: AsynchronousZookeeper

abstract def children(path: String): Seq[String]

abstract def close(): Unit

abstract def create(path: String, data: Array[Byte], acl: Seq[ACL], disp: Disposition): String

abstract def delete(path: String, version: Option[Int]): Unit

abstract def ensure(path: String): Future[Unit]

abstract def exists(path: String): Option[Status]

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

abstract def getACL(path: String): (Seq[ACL], Status)

abstract def set(path: String, data: Array[Byte], version: Option[Int]): Status

abstract def setACL(path: String, acl: Seq[ACL], version: Option[Int]): Status

abstract def sync: SynchronousZookeeper

abstract def transact(ops: Seq[Operation]): Either[Seq[Problem], Seq[Result]]

abstract def watch(fn: PartialFunction[Event, Unit]): SynchronousWatchableZookeeper

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Zookeeper

Inherited from AnyRef

Inherited from Any

Ungrouped