Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

zk

package module

Go to main page

Versions in this module

v1

v1.0.12

May 10, 2024

v1.0.11

Nov 2, 2023

Changes in this version

+ type TreeCacheListenerMock struct

+ func NewTreeCacheListenerMock() *TreeCacheListenerMock

+ func (m *TreeCacheListenerMock) NodesCreated() map[string][]byte

+ func (m *TreeCacheListenerMock) NodesDataChanged() map[string][]byte

+ func (m *TreeCacheListenerMock) NodesDeleted() map[string]string

+ func (m *TreeCacheListenerMock) NodesDeleting() map[string][]byte

+ func (m *TreeCacheListenerMock) OnNodeCreated(path string, data []byte, stat *Stat)

+ func (m *TreeCacheListenerMock) OnNodeCreatedCalled() int

+ func (m *TreeCacheListenerMock) OnNodeDataChanged(path string, data []byte, stat *Stat)

+ func (m *TreeCacheListenerMock) OnNodeDataChangedCalled() int

+ func (m *TreeCacheListenerMock) OnNodeDeleted(path string)

+ func (m *TreeCacheListenerMock) OnNodeDeletedCalled() int

+ func (m *TreeCacheListenerMock) OnNodeDeleting(path string, data []byte, stat *Stat)

+ func (m *TreeCacheListenerMock) OnNodeDeletingCalled() int

+ func (m *TreeCacheListenerMock) OnSyncError(err error)

+ func (m *TreeCacheListenerMock) OnSyncErrorCalled() int

+ func (m *TreeCacheListenerMock) OnSyncStarted()

+ func (m *TreeCacheListenerMock) OnSyncStartedCalled() int

+ func (m *TreeCacheListenerMock) OnSyncStopped(err error)

+ func (m *TreeCacheListenerMock) OnSyncStoppedCalled() int

+ func (m *TreeCacheListenerMock) OnTreeSynced(elapsed time.Duration)

+ func (m *TreeCacheListenerMock) OnTreeSyncedCalled() int

v1.0.10

Sep 13, 2023

v1.0.9

Sep 8, 2023

v1.0.8

Jul 18, 2023

v1.0.6

Jul 12, 2023

v1.0.5

Jul 12, 2023

v1.0.4

Jul 12, 2023

Changes in this version

+ const DefaultPort

+ const FlagEphemeral

+ const FlagSequence

+ const FlagTTL

+ const PermAdmin

+ const PermAll

+ const PermCreate

+ const PermDelete

+ const PermRead

+ const PermWrite

+ var ErrAPIError = errors.New("zk: api error")

+ var ErrAuthFailed = errors.New("zk: client authentication failed")

+ var ErrBadArguments = errors.New("invalid arguments")

+ var ErrBadVersion = errors.New("zk: version conflict")

+ var ErrClosing = errors.New("zk: zookeeper is closing")

+ var ErrConnectionClosed = errors.New("zk: connection closed")

+ var ErrDeadlock = errors.New("zk: trying to acquire a lock twice")

+ var ErrInvalidACL = errors.New("zk: invalid ACL specified")

+ var ErrInvalidCallback = errors.New("zk: invalid callback specified")

+ var ErrInvalidFlags = errors.New("zk: invalid flags specified")

+ var ErrInvalidPath = errors.New("zk: invalid path")

+ var ErrNoAuth = errors.New("zk: not authenticated")

+ var ErrNoChildrenForEphemerals = errors.New("zk: ephemeral nodes may not have children")

+ var ErrNoNode = errors.New("zk: node does not exist")

+ var ErrNoServer = errors.New("zk: could not connect to a server")

+ var ErrNoWatcher = errors.New("watcher does not exist")

+ var ErrNodeExists = errors.New("zk: node already exists")

+ var ErrNotEmpty = errors.New("zk: node has children")

+ var ErrNotLocked = errors.New("zk: not locked")

+ var ErrNothing = errors.New("zk: no server responses to process")

+ var ErrPersistentWatcherStalled = fmt.Errorf("persistent watcher has stalled")

+ var ErrPtrExpected = errors.New("zk: encode/decode expect a non-nil pointer to struct")

+ var ErrReconfigDisabled = errors.New(...)

+ var ErrSessionExpired = errors.New("zk: session has been expired by the server")

+ var ErrSessionMoved = errors.New("zk: session moved to another server, so operation is ignored")

+ var ErrShortBuffer = errors.New("zk: buffer too small")

+ var ErrUnhandledFieldType = errors.New("zk: unhandled field type")

+ var ErrUnknown = errors.New("zk: unknown error")

+ func FLWRuok(servers []string, timeout time.Duration) []bool

+ func FormatServers(servers []string) []string

+ func WithDialer(dialer Dialer) connOption

+ func WithEventCallback(cb EventCallback) connOption

+ func WithHostProvider(hostProvider HostProvider) connOption

+ func WithLogInfo(logInfo bool) connOption

+ func WithLogger(logger Logger) connOption

+ func WithMaxBufferSize(maxBufferSize int) connOption

+ func WithMaxConnBufferSize(maxBufferSize int) connOption

+ type ACL struct

+ ID string

+ Perms int32

+ Scheme string

+ func AuthACL(perms int32) []ACL

+ func DigestACL(perms int32, user, password string) []ACL

+ func WorldACL(perms int32) []ACL

+ type BatchTreeWalker struct

+ func NewBatchTreeWalker(conn *Conn, path string, batchSize int) *BatchTreeWalker

+ func (w *BatchTreeWalker) Walk(visitor BatchVisitorFunc) error

+ func (w *BatchTreeWalker) WalkChan(bufferSize int) <-chan VisitEvent

+ func (w *BatchTreeWalker) WalkChanCtx(ctx context.Context, bufferSize int) <-chan VisitEvent

+ func (w *BatchTreeWalker) WalkCtx(ctx context.Context, visitor BatchVisitorCtxFunc) error

+ type BatchVisitorCtxFunc func(ctx context.Context, paths []string) error

+ type BatchVisitorFunc func(paths []string) error

+ type CheckVersionRequest PathVersionRequest

+ type ChildrenFunc func(ctx context.Context, path string) ([]string, *Stat, error)

+ type Conn struct

+ func Connect(servers []string, sessionTimeout time.Duration, options ...connOption) (*Conn, <-chan Event, error)

+ func ConnectWithDialer(servers []string, sessionTimeout time.Duration, dialer Dialer) (*Conn, <-chan Event, error)

+ func (c *Conn) AddAuth(scheme string, auth []byte) error

+ func (c *Conn) AddAuthCtx(ctx context.Context, scheme string, auth []byte) error

+ func (c *Conn) AddWatch(path string, recursive bool, options ...WatcherOption) (<-chan Event, error)

+ func (c *Conn) AddWatchCtx(ctx context.Context, path string, recursive bool, options ...WatcherOption) (<-chan Event, error)

+ func (c *Conn) BatchWalker(path string, batchSize int) *BatchTreeWalker

+ func (c *Conn) Children(path string) ([]string, *Stat, error)

+ func (c *Conn) ChildrenCtx(ctx context.Context, path string) ([]string, *Stat, error)

+ func (c *Conn) ChildrenW(path string) ([]string, *Stat, <-chan Event, error)

+ func (c *Conn) ChildrenWCtx(ctx context.Context, path string) ([]string, *Stat, <-chan Event, error)

+ func (c *Conn) Close()

+ func (c *Conn) Create(path string, data []byte, flags int32, acl []ACL) (string, error)

+ func (c *Conn) CreateContainer(path string, data []byte, flags int32, acl []ACL) (string, error)

+ func (c *Conn) CreateContainerCtx(ctx context.Context, path string, data []byte, flags int32, acl []ACL) (string, error)

+ func (c *Conn) CreateCtx(ctx context.Context, path string, data []byte, flags int32, acl []ACL) (string, error)

+ func (c *Conn) CreateProtectedEphemeralSequential(path string, data []byte, acl []ACL) (string, error)

+ func (c *Conn) CreateProtectedEphemeralSequentialCtx(ctx context.Context, path string, data []byte, acl []ACL) (string, error)

+ func (c *Conn) CreateTTL(path string, data []byte, flags int32, acl []ACL, ttl time.Duration) (string, error)

+ func (c *Conn) CreateTTLCtx(ctx context.Context, path string, data []byte, flags int32, acl []ACL, ...) (string, error)

+ func (c *Conn) Delete(path string, version int32) error

+ func (c *Conn) DeleteCtx(ctx context.Context, path string, version int32) error

+ func (c *Conn) Exists(path string) (bool, *Stat, error)

+ func (c *Conn) ExistsCtx(ctx context.Context, path string) (bool, *Stat, error)

+ func (c *Conn) ExistsW(path string) (bool, *Stat, <-chan Event, error)

+ func (c *Conn) ExistsWCtx(ctx context.Context, path string) (bool, *Stat, <-chan Event, error)

+ func (c *Conn) Get(path string) ([]byte, *Stat, error)

+ func (c *Conn) GetACL(path string) ([]ACL, *Stat, error)

+ func (c *Conn) GetACLCtx(ctx context.Context, path string) ([]ACL, *Stat, error)

+ func (c *Conn) GetCtx(ctx context.Context, path string) ([]byte, *Stat, error)

+ func (c *Conn) GetW(path string) ([]byte, *Stat, <-chan Event, error)

+ func (c *Conn) GetWCtx(ctx context.Context, path string) ([]byte, *Stat, <-chan Event, error)

+ func (c *Conn) IncrementalReconfig(joining, leaving []string, version int64) (*Stat, error)

+ func (c *Conn) IncrementalReconfigCtx(ctx context.Context, joining, leaving []string, version int64) (*Stat, error)

+ func (c *Conn) Multi(ops ...any) ([]MultiResponse, error)

+ func (c *Conn) MultiCtx(ctx context.Context, ops ...any) ([]MultiResponse, error)

+ func (c *Conn) MultiRead(ops ...any) ([]MultiResponse, error)

+ func (c *Conn) MultiReadCtx(ctx context.Context, ops ...any) ([]MultiResponse, error)

+ func (c *Conn) Reconfig(members []string, version int64) (*Stat, error)

+ func (c *Conn) ReconfigCtx(ctx context.Context, members []string, version int64) (*Stat, error)

+ func (c *Conn) RemoveWatch(ech <-chan Event) error

+ func (c *Conn) RemoveWatchCtx(ctx context.Context, ech <-chan Event) error

+ func (c *Conn) Server() string

+ func (c *Conn) SessionID() int64

+ func (c *Conn) Set(path string, data []byte, version int32) (*Stat, error)

+ func (c *Conn) SetACL(path string, acl []ACL, version int32) (*Stat, error)

+ func (c *Conn) SetACLCtx(ctx context.Context, path string, acl []ACL, version int32) (*Stat, error)

+ func (c *Conn) SetCtx(ctx context.Context, path string, data []byte, version int32) (*Stat, error)

+ func (c *Conn) SetLogger(l Logger)

+ func (c *Conn) State() State

+ func (c *Conn) Sync(path string) (string, error)

+ func (c *Conn) SyncCtx(ctx context.Context, path string) (string, error)

+ func (c *Conn) Walker(path string, order TraversalOrder) *TreeWalker

+ type CreateContainerRequest CreateRequest

+ type CreateRequest struct

+ Acl []ACL

+ Data []byte

+ Flags int32

+ Path string

+ type CreateTTLRequest struct

+ Acl []ACL

+ Data []byte

+ Flags int32

+ Path string

+ Ttl int64

+ type DNSHostProvider struct

+ func (hp *DNSHostProvider) Connected()

+ func (hp *DNSHostProvider) Init(servers []string) error

+ func (hp *DNSHostProvider) Len() int

+ func (hp *DNSHostProvider) Next() (server string, retryStart bool)

+ type DeleteRequest PathVersionRequest

+ type Dialer func(network, address string, timeout time.Duration) (net.Conn, error)

+ type ErrCode int32

+ type Event struct

+ Err error

+ Path string

+ Server string

+ State State

+ Type EventType

+ type EventCallback func(Event)

+ type EventType int32

+ const EventNodeChildrenChanged

+ const EventNodeCreated

+ const EventNodeDataChanged

+ const EventNodeDeleted

+ const EventNotWatching

+ const EventSession

+ const EventWatcherStalled

+ func (t EventType) String() string

+ type GetChildrenRequest pathWatchRequest

+ type GetDataRequest pathWatchRequest

+ type HostProvider interface

+ Connected func()

+ Init func(servers []string) error

+ Len func() int

+ Next func() (server string, retryStart bool)

+ func NewRefreshDNSHostProvider() HostProvider

+ type Lock struct

+ func NewLock(c *Conn, path string, acl []ACL) *Lock

+ func (l *Lock) Lock() error

+ func (l *Lock) LockCtx(ctx context.Context) error

+ func (l *Lock) LockWithData(data []byte) error

+ func (l *Lock) LockWithDataCtx(ctx context.Context, data []byte) error

+ func (l *Lock) Unlock() error

+ func (l *Lock) UnlockCtx(ctx context.Context) error

+ type Logger interface

+ Printf func(string, ...any)

+ var DefaultLogger Logger = defaultLogger{}

+ type Mode uint8

+ const ModeFollower

+ const ModeLeader

+ const ModeStandalone

+ const ModeUnknown

+ func (m Mode) String() string

+ type MultiResponse struct

+ Children []string

+ Data []byte

+ Error error

+ Path string

+ Stat *Stat

+ type PathVersionRequest struct

+ Path string

+ Version int32

+ type RefreshDNSHostProvider struct

+ func (hp *RefreshDNSHostProvider) Connected()

+ func (hp *RefreshDNSHostProvider) Init(servers []string) error

+ func (hp *RefreshDNSHostProvider) Next() (server string, retryStart bool)

+ type ServerClient struct

+ Addr string

+ AvgLatency int32

+ Error error

+ Established time.Time

+ LastLatency int32

+ LastOperation string

+ LastResponse time.Time

+ Lcxid int64

+ Lzxid int64

+ MaxLatency int32

+ MinLatency int32

+ Queued int64

+ Received int64

+ Sent int64

+ SessionID int64

+ Timeout int32

+ type ServerClients struct

+ Clients []*ServerClient

+ Error error

+ func FLWCons(servers []string, timeout time.Duration) ([]*ServerClients, bool)

+ type ServerStats struct

+ AvgLatency float64

+ BuildTime time.Time

+ Connections int64

+ Counter int32

+ Epoch int32

+ Error error

+ MaxLatency int64

+ MinLatency int64

+ Mode Mode

+ NodeCount int64

+ Outstanding int64

+ Received int64

+ Sent int64

+ Server string

+ Version string

+ func FLWSrvr(servers []string, timeout time.Duration) ([]*ServerStats, bool)

+ type SetDataRequest struct

+ Data []byte

+ Path string

+ Version int32

+ type Stat struct

+ Aversion int32

+ Ctime int64

+ Cversion int32

+ Czxid int64

+ DataLength int32

+ EphemeralOwner int64

+ Mtime int64

+ Mzxid int64

+ NumChildren int32

+ Pzxid int64

+ Version int32

+ type State int32

+ const StateAuthFailed

+ const StateConnected

+ const StateConnectedReadOnly

+ const StateConnecting

+ const StateDisconnected

+ const StateExpired

+ const StateHasSession

+ const StateSaslAuthenticated

+ const StateUnknown

+ func (s State) String() string

+ type TraversalOrder int

+ const BreadthFirstOrder

+ const DepthFirstOrder

+ type TreeCache struct

+ func NewTreeCache(conn *Conn, path string, options ...TreeCacheOption) *TreeCache

+ func (tc *TreeCache) Children(path string) ([]string, *Stat, error)

+ func (tc *TreeCache) Exists(path string) (bool, *Stat, error)

+ func (tc *TreeCache) Get(path string) ([]byte, *Stat, error)

+ func (tc *TreeCache) Sync(ctx context.Context) (err error)

+ func (tc *TreeCache) WaitForInitialSync(ctx context.Context) error

+ func (tc *TreeCache) Walker(path string, order TraversalOrder) *TreeWalker

+ type TreeCacheListener interface

+ OnNodeCreated func(path string, data []byte, stat *Stat)

+ OnNodeDataChanged func(path string, data []byte, stat *Stat)

+ OnNodeDeleted func(path string)

+ OnNodeDeleting func(path string)

+ OnSyncError func(err error)

+ OnSyncStarted func()

+ OnSyncStopped func(err error)

+ OnTreeSynced func(elapsed time.Duration)

+ type TreeCacheListenerFuncs struct

+ OnNodeCreatedFunc func(path string, data []byte, stat *Stat)

+ OnNodeDataChangedFunc func(path string, data []byte, stat *Stat)

+ OnNodeDeletedFunc func(path string)

+ OnNodeDeletingFunc func(path string)

+ OnSyncErrorFunc func(err error)

+ OnSyncStartedFunc func()

+ OnSyncStoppedFunc func(err error)

+ OnTreeSyncedFunc func(elapsed time.Duration)

+ func (l *TreeCacheListenerFuncs) OnNodeCreated(path string, data []byte, stat *Stat)

+ func (l *TreeCacheListenerFuncs) OnNodeDataChanged(path string, data []byte, stat *Stat)

+ func (l *TreeCacheListenerFuncs) OnNodeDeleted(path string)

+ func (l *TreeCacheListenerFuncs) OnNodeDeleting(path string)

+ func (l *TreeCacheListenerFuncs) OnSyncError(err error)

+ func (l *TreeCacheListenerFuncs) OnSyncStarted()

+ func (l *TreeCacheListenerFuncs) OnSyncStopped(err error)

+ func (l *TreeCacheListenerFuncs) OnTreeSynced(elapsed time.Duration)

+ type TreeCacheOption func(*TreeCache)

+ func WithTreeCacheAbsolutePaths(absolutePaths bool) TreeCacheOption

+ func WithTreeCacheBatchSize(batchSize int) TreeCacheOption

+ func WithTreeCacheIncludeData(includeData bool) TreeCacheOption

+ func WithTreeCacheListener(listener TreeCacheListener) TreeCacheOption

+ func WithTreeCacheLogger(logger Logger) TreeCacheOption

+ func WithTreeCacheReservoirLimit(reservoirLimit int) TreeCacheOption

+ type TreeWalker struct

+ func NewTreeWalker(fetcher ChildrenFunc, path string, order TraversalOrder) *TreeWalker

+ func (w *TreeWalker) Walk(visitor VisitorFunc) error

+ func (w *TreeWalker) WalkChan(bufferSize int) <-chan VisitEvent

+ func (w *TreeWalker) WalkChanCtx(ctx context.Context, bufferSize int) <-chan VisitEvent

+ func (w *TreeWalker) WalkCtx(ctx context.Context, visitor VisitorCtxFunc) error

+ type Version struct

+ Major int

+ Minor int

+ Patch int

+ func ParseVersion(vs string) Version

+ func ParseVersionErr(vs string) (Version, error)

+ func (v Version) Equal(other Version) bool

+ func (v Version) GreaterThan(other Version) bool

+ func (v Version) IsValid() bool

+ func (v Version) LessThan(other Version) bool

+ func (v Version) String() string

+ type VisitEvent struct

+ Err error

+ Path string

+ Stat *Stat

+ type VisitorCtxFunc func(ctx context.Context, path string, stat *Stat) error

+ type VisitorFunc func(path string, stat *Stat) error

+ type WatcherOption func(*watcherOptions)

+ func WithStallCallback(stallCallback func()) WatcherOption

+ func WithWatcherInvalidateOnDisconnect() WatcherOption

+ func WithWatcherReservoirLimit(reservoirLimit int) WatcherOption