package zk
import "github.com/docker/libnetwork/Godeps/_workspace/src/github.com/samuel/go-zookeeper/zk"
Index ¶
- Constants
- Variables
- func FLWRuok(servers []string, timeout time.Duration) []bool
- func FormatServers(servers []string) []string
- func StartTracer(listenAddr, serverAddr string)
- type ACL
- func AuthACL(perms int32) []ACL
- func DigestACL(perms int32, user, password string) []ACL
- func WorldACL(perms int32) []ACL
- type CheckVersionRequest
- type Conn
- func Connect(servers []string, sessionTimeout time.Duration) (*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) Children(path string) ([]string, *Stat, error)
- func (c *Conn) ChildrenW(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) CreateProtectedEphemeralSequential(path string, data []byte, acl []ACL) (string, error)
- func (c *Conn) Delete(path string, version int32) error
- func (c *Conn) Exists(path string) (bool, *Stat, error)
- func (c *Conn) ExistsW(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) GetW(path string) ([]byte, *Stat, <-chan Event, error)
- func (c *Conn) Multi(ops ...interface{}) ([]MultiResponse, error)
- 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) State() State
- func (c *Conn) Sync(path string) (string, error)
- type CreateRequest
- type DeleteRequest
- type Dialer
- type ErrCode
- type ErrMissingServerConfigField
- type Event
- type EventType
- type Lock
- func NewLock(c *Conn, path string, acl []ACL) *Lock
- func (l *Lock) Lock() error
- func (l *Lock) Unlock() error
- type Mode
- type MultiResponse
- type PathVersionRequest
- type Server
- type ServerClient
- type ServerClients
- type ServerConfig
- type ServerConfigServer
- type ServerStats
- type SetDataRequest
- type Stat
- type State
- type TestCluster
- func StartTestCluster(size int, stdout, stderr io.Writer) (*TestCluster, error)
- func (ts *TestCluster) Connect(idx int) (*Conn, error)
- func (ts *TestCluster) ConnectAll() (*Conn, <-chan Event, error)
- func (ts *TestCluster) ConnectAllTimeout(sessionTimeout time.Duration) (*Conn, <-chan Event, error)
- func (ts *TestCluster) Stop() error
- type TestServer
Constants ¶
const ( EventNodeCreated = EventType(1) EventNodeDeleted = EventType(2) EventNodeDataChanged = EventType(3) EventNodeChildrenChanged = EventType(4) EventSession = EventType(-1) EventNotWatching = EventType(-2) )
const ( StateUnknown = State(-1) StateDisconnected = State(0) StateConnecting = State(1) StateSyncConnected = State(3) StateAuthFailed = State(4) StateConnectedReadOnly = State(5) StateSaslAuthenticated = State(6) StateExpired = State(-112) StateConnected = State(100) StateHasSession = State(101) )
const ( FlagEphemeral = 1 FlagSequence = 2 )
const ( PermRead = 1 << iota PermWrite PermCreate PermDelete PermAdmin PermAll = 0x1f )
Constants for ACL permissions
const ( DefaultServerTickTime = 2000 DefaultServerInitLimit = 10 DefaultServerSyncLimit = 5 DefaultServerAutoPurgeSnapRetainCount = 3 DefaultPeerPort = 2888 DefaultLeaderElectionPort = 3888 )
const (
DefaultPort = 2181
)
Variables ¶
var ( ErrConnectionClosed = errors.New("zk: connection closed") ErrUnknown = errors.New("zk: unknown error") ErrAPIError = errors.New("zk: api error") ErrNoNode = errors.New("zk: node does not exist") ErrNoAuth = errors.New("zk: not authenticated") ErrBadVersion = errors.New("zk: version conflict") ErrNoChildrenForEphemerals = errors.New("zk: ephemeral nodes may not have children") ErrNodeExists = errors.New("zk: node already exists") ErrNotEmpty = errors.New("zk: node has children") ErrSessionExpired = errors.New("zk: session has been expired by the server") ErrInvalidACL = errors.New("zk: invalid ACL specified") ErrAuthFailed = errors.New("zk: client authentication failed") ErrClosing = errors.New("zk: zookeeper is closing") ErrNothing = errors.New("zk: no server responsees to process") ErrSessionMoved = errors.New("zk: session moved to another server, so operation is ignored") )
var ( ErrDeadlock = errors.New("zk: trying to acquire a lock twice") ErrNotLocked = errors.New("zk: not locked") )
var ( ErrUnhandledFieldType = errors.New("zk: unhandled field type") ErrPtrExpected = errors.New("zk: encode/decode expect a non-nil pointer to struct") ErrShortBuffer = errors.New("zk: buffer too small") )
Functions ¶
func FLWRuok ¶
FLWRuok is a FourLetterWord helper function. In particular, this function pulls the ruok output from each server.
func FormatServers ¶
FormatServers takes a slice of addresses, and makes sure they are in a format that resembles <addr>:<port>. If the server has no port provided, the DefaultPort constant is added to the end.
func StartTracer ¶
func StartTracer(listenAddr, serverAddr string)
Types ¶
type ACL ¶
func AuthACL ¶
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.
func DigestACL ¶
func WorldACL ¶
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.
type CheckVersionRequest ¶
type CheckVersionRequest PathVersionRequest
type Conn ¶
type Conn struct {
// contains filtered or unexported fields
}
func Connect ¶
Connect establishes a new connection to a pool of zookeeper servers using the default net.Dialer. See ConnectWithDialer for further information about session timeout.
func ConnectWithDialer ¶
func ConnectWithDialer(servers []string, sessionTimeout time.Duration, dialer Dialer) (*Conn, <-chan Event, error)
ConnectWithDialer establishes a new connection to a pool of zookeeper servers. The provided session timeout sets the amount of time for which a session is considered valid after losing connection to a server. Within the session timeout it's possible to reestablish a connection to a different server and keep the same session. This is means any ephemeral nodes and watches are maintained.
func (*Conn) AddAuth ¶
func (*Conn) Children ¶
func (*Conn) ChildrenW ¶
func (*Conn) Close ¶
func (c *Conn) Close()
func (*Conn) Create ¶
func (*Conn) CreateProtectedEphemeralSequential ¶
func (c *Conn) CreateProtectedEphemeralSequential(path string, data []byte, acl []ACL) (string, error)
CreateProtectedEphemeralSequential fixes a race condition if the server crashes after it creates the node. On reconnect the session may still be valid so the ephemeral node still exists. Therefore, on reconnect we need to check if a node with a GUID generated on create exists.
func (*Conn) Delete ¶
func (*Conn) Exists ¶
func (*Conn) ExistsW ¶
func (*Conn) Get ¶
func (*Conn) GetACL ¶
func (*Conn) GetW ¶
GetW returns the contents of a znode and sets a watch
func (*Conn) Multi ¶
func (c *Conn) Multi(ops ...interface{}) ([]MultiResponse, error)
Multi executes multiple ZooKeeper operations or none of them. The provided ops must be one of *CreateRequest, *DeleteRequest, *SetDataRequest, or *CheckVersionRequest.
func (*Conn) Set ¶
func (*Conn) SetACL ¶
func (*Conn) State ¶
func (*Conn) Sync ¶
type CreateRequest ¶
type DeleteRequest ¶
type DeleteRequest PathVersionRequest
type Dialer ¶
type ErrCode ¶
type ErrCode int32
type ErrMissingServerConfigField ¶
type ErrMissingServerConfigField string
func (ErrMissingServerConfigField) Error ¶
func (e ErrMissingServerConfigField) Error() string
type Event ¶
type Event struct { Type EventType State State Path string // For non-session events, the path of the watched node. Err error Server string // For connection events }
type EventType ¶
type EventType int32
func (EventType) String ¶
type Lock ¶
type Lock struct {
// contains filtered or unexported fields
}
func NewLock ¶
func (*Lock) Lock ¶
func (*Lock) Unlock ¶
type Mode ¶
type Mode uint8
Mode is used to build custom server modes (leader|follower|standalone).
const ( ModeUnknown Mode = iota ModeLeader Mode = iota ModeFollower Mode = iota ModeStandalone Mode = iota )
func (Mode) String ¶
type MultiResponse ¶
type PathVersionRequest ¶
type Server ¶
type Server struct { JarPath string ConfigPath string Stdout, Stderr io.Writer // contains filtered or unexported fields }
func (*Server) Start ¶
func (*Server) Stop ¶
type ServerClient ¶
type ServerClient struct { Queued int64 Received int64 Sent int64 SessionID int64 Lcxid int64 Lzxid int64 Timeout int32 LastLatency int32 MinLatency int32 AvgLatency int32 MaxLatency int32 Established time.Time LastResponse time.Time Addr string LastOperation string // maybe? Error error }
ServerClient is the information for a single Zookeeper client and its session. This is used to parse/extract the output fo the `cons` command.
type ServerClients ¶
type ServerClients struct { Clients []*ServerClient Error error }
ServerClients is a struct for the FLWCons() function. It's used to provide the list of Clients.
This is needed because FLWCons() takes multiple servers.
func FLWCons ¶
func FLWCons(servers []string, timeout time.Duration) ([]*ServerClients, bool)
FLWCons is a FourLetterWord helper function. In particular, this function pulls the ruok output from each server.
As with FLWSrvr, the boolean value indicates whether one of the requests had an issue. The Clients struct has an Error value that can be checked.
type ServerConfig ¶
type ServerConfig struct { TickTime int // Number of milliseconds of each tick InitLimit int // Number of ticks that the initial synchronization phase can take SyncLimit int // Number of ticks that can pass between sending a request and getting an acknowledgement DataDir string // Direcrory where the snapshot is stored ClientPort int // Port at which clients will connect AutoPurgeSnapRetainCount int // Number of snapshots to retain in dataDir AutoPurgePurgeInterval int // Purge task internal in hours (0 to disable auto purge) Servers []ServerConfigServer }
func (ServerConfig) Marshall ¶
func (sc ServerConfig) Marshall(w io.Writer) error
type ServerConfigServer ¶
type ServerStats ¶
type ServerStats struct { Sent int64 Received int64 NodeCount int64 MinLatency int64 AvgLatency int64 MaxLatency int64 Connections int64 Outstanding int64 Epoch int32 Counter int32 BuildTime time.Time Mode Mode Version string Error error }
ServerStats is the information pulled from the Zookeeper `stat` command.
func FLWSrvr ¶
func FLWSrvr(servers []string, timeout time.Duration) ([]*ServerStats, bool)
FLWSrvr is a FourLetterWord helper function. In particular, this function pulls the srvr output from the zookeeper instances and parses the output. A slice of *ServerStats structs are returned as well as a boolean value to indicate whether this function processed successfully.
If the boolean value is false there was a problem. If the *ServerStats slice is empty or nil, then the error happened before we started to obtain 'srvr' values. Otherwise, one of the servers had an issue and the "Error" value in the struct should be inspected to determine which server had the issue.
type SetDataRequest ¶
type Stat ¶
type Stat struct { Czxid int64 // The zxid of the change that caused this znode to be created. Mzxid int64 // The zxid of the change that last modified this znode. Ctime int64 // The time in milliseconds from epoch when this znode was created. Mtime int64 // The time in milliseconds from epoch when this znode was last modified. Version int32 // The number of changes to the data of this znode. Cversion int32 // The number of changes to the children of this znode. Aversion int32 // The number of changes to the ACL of this znode. EphemeralOwner int64 // The session id of the owner of this znode if the znode is an ephemeral node. If it is not an ephemeral node, it will be zero. DataLength int32 // The length of the data field of this znode. NumChildren int32 // The number of children of this znode. Pzxid int64 // last modified children }
type State ¶
type State int32
func (State) String ¶
type TestCluster ¶
type TestCluster struct { Path string Servers []TestServer }
func StartTestCluster ¶
func StartTestCluster(size int, stdout, stderr io.Writer) (*TestCluster, error)
func (*TestCluster) Connect ¶
func (ts *TestCluster) Connect(idx int) (*Conn, error)
func (*TestCluster) ConnectAll ¶
func (ts *TestCluster) ConnectAll() (*Conn, <-chan Event, error)
func (*TestCluster) ConnectAllTimeout ¶
func (*TestCluster) Stop ¶
func (ts *TestCluster) Stop() error
type TestServer ¶
Source Files ¶
conn.go constants.go flw.go lock.go server_help.go server_java.go structs.go tracer.go util.go
- Version
- v0.6.0-rc3
- Published
- Jan 25, 2016
- Platform
- linux/amd64
- Imports
- 25 packages
- Last checked
- 10 hours ago –
Tools for package owners.