Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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

client

package

Go to main page

Versions in this module

v0

v0.14.1

Mar 26, 2025

v0.14.0

Feb 19, 2025

v0.13.1

Feb 19, 2025

v0.13.0

Jan 29, 2025

v0.12.0

Oct 21, 2024

v0.11.0

Mar 20, 2024

Changes in this version

type Destination

+ Encoding gpb.Encoding

type Query

+ Encoding gpb.Encoding

v0.10.0

Jun 8, 2023

v0.9.1

Jan 27, 2023

v0.9.0

Jan 26, 2023

v0.8.0

Jan 26, 2023

Changes in this version

+ var ErrClientInit = errors.New("Subscribe() must be called before any operations on client")

+ var ErrStopReading = errors.New("stop the result reading loop")

+ var ErrUnsupported = errors.New("operation not supported by client implementation")

+ var RetryBaseDelay = time.Second

+ var RetryMaxDelay = time.Minute

+ var RetryRandomization = 0.5

+ func Register(t string, f InitImpl) error

+ func RegisterTest(t string, f InitImpl) error

+ func RegisteredImpls() []string

+ func ResetRegisteredImpls()

+ type BaseClient struct

+ func (c *BaseClient) Close() error

+ func (c *BaseClient) Impl() (Impl, error)

+ func (c *BaseClient) Poll() error

+ func (c *BaseClient) Subscribe(ctx context.Context, q Query, clientType ...string) error

+ type CacheClient struct

+ func New() *CacheClient

+ func (c *CacheClient) Leaves() Leaves

+ func (c *CacheClient) Poll() error

+ func (c *CacheClient) Subscribe(ctx context.Context, q Query, clientType ...string) error

+ func (c *CacheClient) Synced() <-chan struct{}

+ type Client interface

+ Close func() error

+ Impl func() (Impl, error)

+ Poll func() error

+ Subscribe func(ctx context.Context, q Query, clientType ...string) error

+ type Connected struct

+ type Credentials struct

+ Password string

+ Username string

+ type Delete Leaf

+ type Destination struct

+ Addrs []string

+ Credentials *Credentials

+ Extra map[string]string

+ Replica int

+ TLS *tls.Config

+ Target string

+ Timeout time.Duration

+ TunnelConn *tunnel.Conn

+ func (d Destination) Validate() error

+ type Error struct

+ func NewError(s string) Error

+ func (e Error) Error() string

+ type Impl interface

+ Close func() error

+ Poll func() error

+ Recv func() error

+ Subscribe func(context.Context, Query) error

+ func NewImpl(ctx context.Context, d Destination, clientType ...string) (Impl, error)

+ type InitImpl func(context.Context, Destination) (Impl, error)

+ type Leaf struct

+ Dups uint32

+ Path Path

+ TS time.Time

+ Val interface{}

+ type Leaves []Leaf

+ func (pv Leaves) Len() int

+ func (pv Leaves) Less(i, j int) bool

+ func (pv Leaves) Swap(i, j int)

+ type Notification interface

+ type NotificationHandler func(Notification) error

+ type Path []string

+ func (p Path) Equal(p2 Path) bool

+ func (p Path) Less(p2 Path) bool

+ type ProtoHandler func(proto.Message) error

+ type Query struct

+ AddressChains [][]string

+ Addrs []string

+ Credentials *Credentials

+ Extra map[string]string

+ NotificationHandler NotificationHandler

+ ProtoHandler ProtoHandler

+ Queries []Path

+ Replica int

+ SubReq *gpb.SubscribeRequest

+ TLS *tls.Config

+ Target string

+ Timeout time.Duration

+ TunnelConn *tunnel.Conn

+ Type Type

+ UpdatesOnly bool

+ func NewQuery(sr *gpb.SubscribeRequest) (Query, error)

+ func (q Query) Destination() Destination

+ func (q Query) Validate() error

+ type ReconnectClient struct

+ func Reconnect(c Client, disconnect, reset func()) *ReconnectClient

+ func (p *ReconnectClient) Close() error

+ func (p *ReconnectClient) Impl() (Impl, error)

+ func (p *ReconnectClient) Poll() error

+ func (p *ReconnectClient) Subscribe(ctx context.Context, q Query, clientType ...string) error

+ type Sync struct

+ type TreeVal struct

+ TS time.Time

+ Val interface{}

+ type Type int

+ const Once

+ const Poll

+ const Stream

+ const Unknown

+ func NewType(s string) Type

+ func (q Type) String() string

+ type Update Leaf