forked from pachyderm/pachyderm
/
discovery.go
46 lines (42 loc) · 1.83 KB
/
discovery.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
package discovery
import (
"fmt"
)
// ErrCancelled is returned when an action is cancelled by the user
var ErrCancelled = fmt.Errorf("pachyderm: cancelled by user")
// Client defines Pachyderm's interface to key-value stores such as etcd.
type Client interface {
// Close closes the underlying connection.
Close() error
// Get gets the value of a key
// Keys can be directories of the form a/b/c, see etcd for details.
// the error will be non-nil if the key does not exist.
Get(key string) (string, error)
// GetAll returns all of the keys in a directory and its subdirectories as
// a map from absolute keys to values.
// the map will be empty if no keys are found.
GetAll(key string) (map[string]string, error)
// Watch calls callBack with changes to a value
Watch(key string, cancel chan bool, callBack func(string) error) error
// WatchAll calls callBack with changes to a directory
WatchAll(key string, cancel chan bool, callBack func(map[string]string) error) error
// Set sets the value for a key.
// ttl is in seconds.
Set(key string, value string, ttl uint64) error
// Delete deletes a key.
Delete(key string) error
// CheckAndDelete deletes a key only if its value matches oldValue
CheckAndDelete(key string, oldValue string) error
// Create is like Set but only succeeds if the key doesn't already exist.
// ttl is in seconds.
Create(key string, value string, ttl uint64) error
// CreateInDir is like Set but it generates a key inside dir.
CreateInDir(dir string, value string, ttl uint64) error
// CheckAndSet is like Set but only succeeds if the key is already set to oldValue.
// ttl is in seconds.
CheckAndSet(key string, value string, ttl uint64, oldValue string) error
}
// NewEtcdClient creates an etcdClient with the given addresses.
func NewEtcdClient(addresses ...string) Client {
return newEtcdClient(addresses...)
}