Categorygithub.com/go-zk/zk
modulepackage
1.0.0
Repository: https://github.com/go-zk/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.
ConnectWithDialer establishes a new connection to a pool of zookeeper servers using a custom Dialer.
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>.
NewLock creates a new lock instance using the provided connection, path, and acl.
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.
WithLogger returns a connection option specifying a non-default Logger.
WithLogInfo returns a connection option specifying whether or not information messages shoud be logged.
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.
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
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
No description provided by the author
Constants for ACL permissions.
Constants for ACL permissions.
Constants for ACL permissions.
Constants for ACL permissions.
Constants for ACL permissions.
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
No description provided by the author

# Variables

DefaultLogger uses the stdlib log package for logging.
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
ErrDeadlock is returned by Lock when trying to lock twice without unlocking first.
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

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
DNSHostProvider is the default HostProvider.
No description provided by the author
Lock is a mutual exclusion lock.
No description provided by the author
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

# Interfaces

HostProvider is used to represent a set of hosts a ZooKeeper client should connect to.
Logger is an interface that can be implemented to provide custom log output.

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
EventCallback is a function that is called when an Event occurs.
No description provided by the author
Mode is used to build custom server modes (leader|follower|standalone).
No description provided by the author