ZkRequestProtocol

Type Members

1. final case class AddAuthInfo(scheme: String, authInfo: Array[Byte]) extends Request with Product with Serializable

   

   Add the specified scheme:auth information to this connection.

2. final case class Connect(connectionString: String = ..., connectionAttempts: Int = ..., sessionTimeout: FiniteDuration = ..., sessionId: Option[Long] = ZkClientProtocolDefaults.SessionId, sessionPassword: Option[Array[Byte]] = ..., canBeReadOnly: Boolean = ...) extends Request with Product with Serializable

   

   Connect to the server.

   Connect to the server.

   connectionString

   comma separated host:port pairs, each corresponding to a zk server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002" If the optional chroot suffix is used the example would look like: "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002/app/a" where the client would be rooted at "/app/a" and all paths would be relative to this root - ie getting/setting/etc... "/foo/bar" would result in operations being run on "/app/a/foo/bar" (from the server perspective).

   connectionAttempts

   how many times to retry a failed connect attempt

   sessionTimeout

   session timeout

   sessionId

   specific session id to use if reconnecting

   sessionPassword

   password for this session

   canBeReadOnly

   whether the created client is allowed to go to read-only mode in case of partitioning. Read-only mode basically means that if the client can't find any majority servers but there's partitioned server it could reach, it connects to one in read-only mode, i.e. read requests are allowed while write requests are not. It continues seeking for majority in the background.

3. final case class CountChildren(path: String) extends Request with Product with Serializable

   

   Return the number the children of the node of the given path.

   Return the number the children of the node of the given path.

   path

   the given path for the node

4. final case class CreateEphemeral(path: String, data: Option[Any] = None, acl: List[ACL] = ..., sequential: Boolean = false, createParents: Boolean = false) extends CreateRequest with Product with Serializable

   

   Create an ephemeral node with the given path.

   Create an ephemeral node with the given path.

   path

   the given path for the node

   data

   the initial data for the node

   acl

   the acl for the node

   sequential

   should the node be sequential

   createParents

   create parent nodes, if necessary; any parent node created will be a permanent node as ephemeral nodes can't have children

5. final case class CreatePersistent(path: String, data: Option[Any] = None, acl: List[ACL] = ..., sequential: Boolean = false, createParents: Boolean = false) extends CreateRequest with Product with Serializable

   

   Create a persistent node with the given path.

   Create a persistent node with the given path.

   path

   the given path for the node

   data

   the initial data for the node

   acl

   the acl for the node

   sequential

   should the node be sequential

   createParents

   create parent nodes, if necessary

6. sealed trait CreateRequest extends Request

   

   ZooKeeper client node creation request.

7. final case class CreatedWhen(path: String) extends Request with Product with Serializable

   

   Get the timestamp of when the node has been created.

   Get the timestamp of when the node has been created.

   path

   the given path for the node

8. final case class Delete(path: String, version: Int = 1, recursive: Boolean = false) extends Request with Product with Serializable

   

   Delete a node with a given path.

   Delete a node with a given path.

   Recursive delete notes:
   Recursive delete is partially synchronous. Children collection is synchronous while the removal uses actual asynchronous calls. Recursive delete only checks the version of the top node to be deleted, any child will be removed regardless of the version.

   path

   the given path for the node

   version

   the expected node version for the top node to remove

9. final case class GetAcl(path: String) extends Request with Product with Serializable

   

   Return the ACL and stat of the node of the given path.

   Return the ACL and stat of the node of the given path.

   path

   the given path for the node

10. final case class GetChildren(path: String, watch: Option[Boolean] = None) extends Request with Product with Serializable

    

    Return the list of the children of the node of the given path.

    Return the list of the children of the node of the given path.

    path

    the given path for the node

    watch

    watch for changes

11. final case class IsExisting(path: String) extends Request with Product with Serializable

    

    Check if the node exists.

    Check if the node exists.

    path

    the given path for the node

12. final case class IsSaslEnabled() extends Request with Product with Serializable

    

    Check if SASL is enabled.

13. final case class Metrics() extends Request with Product with Serializable

    

    Request metrics snapshot.

14. final case class Multi(ops: List[Op]) extends Request with Product with Serializable

    

    Executes multiple ZooKeeper operations or none of them.

    Executes multiple ZooKeeper operations or none of them.

    ops

    An iterable that contains the operations to be done. These should be created using the factory methods on Op.

15. final case class ReadData(path: String, noneIfNoPath: Boolean = false) extends Request with Product with Serializable

    

    Return the data and the stat of the node of the given path.

    Return the data and the stat of the node of the given path.

    path

    the given path for the node

    noneIfNoPath

    return None if node at path does not exist instead of returning an OperationError

16. sealed trait Request extends AnyRef

    

    ZooKeeper client request.

17. final case class SetAcl(path: String, acl: List[ACL]) extends Request with Product with Serializable

    

    Set the ACL for the node of the given path if such a node exists and the given version matches the version of the node.

    Set the ACL for the node of the given path if such a node exists and the given version matches the version of the node.

    path

    the given path for the node

    acl

    the new acl for the node

18. final case class SetSerializer(serializer: ZkSerializer) extends Request with Product with Serializable

    

    Set the read / write serializer for this client.

    Set the read / write serializer for this client.

    serializer

    the serializer

19. final case class Stop() extends Product with Serializable

    

    Stop the ZooKeeper client.

    Stop the ZooKeeper client. Disconnect from ZooKeeper, if necessary. Will stop the actor.

20. final case class SubscribeChildChanges(path: String) extends SubscribeRequest with Product with Serializable

    

    Subscribe to the children changes of the znode at the path.

    Subscribe to the children changes of the znode at the path.

    path

    the given path for the node

21. final case class SubscribeDataChanges(path: String) extends SubscribeRequest with Product with Serializable

    

    Subscribe to the data changes of the znode at the path.

    Subscribe to the data changes of the znode at the path.

    path

    the given path for the node

22. sealed trait SubscribeRequest extends Request

    

    ZooKeeper client subscription request.

23. final case class UnsubscribeChildChanges(path: String) extends UnsubscribeRequest with Product with Serializable

    

    Unsubscribe from the children changes of the znode at the path.

    Unsubscribe from the children changes of the znode at the path.

    path

    the given path for the node

24. final case class UnsubscribeDataChanges(path: String) extends UnsubscribeRequest with Product with Serializable

    

    Unsubscribe from the data changes of the znode at the path.

    Unsubscribe from the data changes of the znode at the path.

    path

    the given path for the node

25. sealed trait UnsubscribeRequest extends Request

    

    ZooKeeper client unsubscription request.

26. final case class WriteData(path: String, data: Option[Any], expectedVersion: Int = 1) extends Request with Product with Serializable

    

    Set the data for the node of the given path if such a node exists and the given version matches the version of the node (if the given version is -1, it matches any node's versions).

    Set the data for the node of the given path if such a node exists and the given version matches the version of the node (if the given version is -1, it matches any node's versions).

    path

    the given path for the node

    data

    new data for the node

    expectedVersion

    expected version