Categorygithub.com/linkedin/go-zk
modulepackage
0.1.4
Repository: https://github.com/linkedin/go-zk.git
Documentation: pkg.go.dev

# README

Native Go Zookeeper Client Library

GoDoc Build status Coverage Status

License

3-clause BSD. See LICENSE file.

# Functions

AuthACL produces an ACL list containing a single ACL which uses the provided permissions, with the scheme "auth", and ID "", which is used by ZooKeeper to represent any authenticated user.
Connect establishes a new connection to a pool of zookeeper servers.
No description provided by the author
FLWCons is a FourLetterWord helper function.
FLWRuok is a FourLetterWord helper function.
FLWSrvr is a FourLetterWord helper function.
FormatServers takes a slice of addresses, and makes sure they are in a format that resembles <addr>:<port>.
IsConnClosing checks if the given error returned by a Conn function is due to Close having been called on the Conn, which is fatal in that no subsequent Conn operations will succeed.
No description provided by the author
NewLock creates a new lock instance using the provided connection, path, and acl.
No description provided by the author
No description provided by the author
WithDialer returns a connection option specifying a non-default Dialer.
WithEventCallback returns a connection option that specifies an event callback.
WithHostProvider returns a connection option specifying a non-default HostProvider.
WithMaxBufferSize sets the maximum buffer size used to read and decode packets received from the Zookeeper server.
WithMaxConnBufferSize sets maximum buffer size used to send and encode packets to Zookeeper server.
No description provided by the author
WorldACL produces an ACL list containing a single ACL which uses the provided permissions, with the scheme "world", and ID "anyone", which is used by ZooKeeper to represent any user at all.

# Constants

No description provided by the author
No description provided by the author
DefaultPort is the default port listened by server.
No description provided by the author
EventNodeCreated represents a node is created.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
EventSession represents a session event.
No description provided by the author
FlagEphemeral means the node is ephemeral.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Constants for ACL permissions.
Constants for ACL permissions.
Constants for ACL permissions.
Constants for ACL permissions.
PermRead represents the permission needed to read a znode.
Constants for ACL permissions.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
StateUnknown means the session state is unknown.
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrConnectionClosed means the connection has been closed.
ErrDeadlock is returned by Lock when trying to lock twice without unlocking first.
No description provided by the author
No description provided by the author
No description provided by the author
ErrInvalidPath indicates that an operation was being attempted on an invalid path.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrNoServer indicates that an operation cannot be completed because attempts to connect to all servers in the list failed.
No description provided by the author
No description provided by the author
ErrNotLocked is returned by Unlock when trying to release a lock that has not first be acquired.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
Conn is the client connection and tracks all details for communication with the server.
No description provided by the author
No description provided by the author
DNSHostProvider is a simple implementation of a HostProvider.
Event is an Znode event sent by the server.
Lock is a mutual exclusion lock.
No description provided by the author
MultiResponse is the result of a Multi call.
No description provided by the author
ServerClient is the information for a single Zookeeper client and its session.
ServerClients is a struct for the FLWCons() function.
ServerStats is the information pulled from the Zookeeper `stat` command.
No description provided by the author
No description provided by the author
StaticHostProvider is the default HostProvider, and replaces the now deprecated DNSHostProvider.
No description provided by the author

# Interfaces

ConnOption represents a connection option.
Dialer is an interface implemented by the standard [net.Dialer] but also by [crypto/tls.Dialer].
HostProvider is used to represent a set of hosts a ZooKeeper client should connect to.
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

AddWatchMode asd.
No description provided by the author
No description provided by the author
No description provided by the author
ErrCode is the error code defined by server.
EventCallback is a function that is called when an Event occurs.
EventType represents the event type sent by server.
No description provided by the author
No description provided by the author
Mode is used to build custom server modes (leader|follower|standalone).
State is the session state.
No description provided by the author