kvstore

Sep 30, 2020

Changes in this version

+ const BaseKeyPrefix

+ const CapabilityCreateIfExists

+ const CapabilityDeleteOnZeroCount

+ const ConsulAddrOption

+ const ConsulOptionConfig

+ const EtcdAddrOption

+ const EtcdBackendName

+ const EtcdOptionConfig

+ const EtcdRateLimitOption

+ const InitLockPath

+ var Debug string

+ var ErrLockLeaseExpired = errors.New("transaction did not succeed: lock lease expired")

+ var RetryInterval = 1 * time.Minute

+ func Close()

+ func ConsulDummyAddress() string

+ func ConsulDummyConfigFile() string

+ func CreateIfExists(condKey, key string, value []byte, lease bool) error

+ func CreateOnly(ctx context.Context, key string, value []byte, lease bool) (bool, error)

+ func CreateOnlyIfLocked(ctx context.Context, key string, value []byte, lease bool, lock KVLocker) (bool, error)

+ func Decode(in string) ([]byte, error)

+ func Delete(key string) error

+ func DeleteIfLocked(key string, lock KVLocker) error

+ func DeletePrefix(prefix string) error

+ func EnableTracing()

+ func Encode(in []byte) string

+ func EtcdDummyAddress() string

+ func Get(key string) ([]byte, error)

+ func GetIfLocked(key string, lock KVLocker) ([]byte, error)

+ func GetPrefix(ctx context.Context, prefix string) (k string, v []byte, err error)

+ func GetPrefixIfLocked(ctx context.Context, prefix string, lock KVLocker) (k string, v []byte, err error)

+ func Hint(err error) error

+ func IsEtcdOperator(selectedBackend string, opts map[string]string, k8sNamespace string) (string, bool)

+ func RunLockGC()

+ func Set(key string, value []byte) error

+ func Setup(selectedBackend string, opts map[string]string, goOpts *ExtraOptions) error

+ func SetupDummy(dummyBackend string)

+ func SplitK8sServiceURL(address string) (string, string, error)

+ func Trace(format string, err error, fields logrus.Fields, a ...interface{})

+ func Update(ctx context.Context, key string, value []byte, lease bool) error

+ func UpdateIfDifferent(ctx context.Context, key string, value []byte, lease bool) (bool, error)

+ func UpdateIfDifferentIfLocked(ctx context.Context, key string, value []byte, lease bool, lock KVLocker) (bool, error)

+ type BackendOperations interface

+ Close func()

+ Connected func() <-chan struct{}

+ CreateIfExists func(condKey, key string, value []byte, lease bool) error

+ CreateOnly func(ctx context.Context, key string, value []byte, lease bool) (bool, error)

+ CreateOnlyIfLocked func(ctx context.Context, key string, value []byte, lease bool, lock KVLocker) (bool, error)

+ Decode func(in string) ([]byte, error)

+ Delete func(key string) error

+ DeleteIfLocked func(key string, lock KVLocker) error

+ DeletePrefix func(path string) error

+ Disconnected func() <-chan struct{}

+ Encode func(in []byte) string

+ Get func(key string) ([]byte, error)

+ GetCapabilities func() Capabilities

+ GetIfLocked func(key string, lock KVLocker) ([]byte, error)

+ GetPrefix func(ctx context.Context, prefix string) (string, []byte, error)

+ GetPrefixIfLocked func(ctx context.Context, prefix string, lock KVLocker) (string, []byte, error)

+ ListAndWatch func(name, prefix string, chanSize int) *Watcher

+ ListPrefix func(prefix string) (KeyValuePairs, error)

+ ListPrefixIfLocked func(prefix string, lock KVLocker) (KeyValuePairs, error)

+ LockPath func(ctx context.Context, path string) (KVLocker, error)

+ Set func(key string, value []byte) error

+ Status func() (string, error)

+ Update func(ctx context.Context, key string, value []byte, lease bool) error

+ UpdateIfDifferent func(ctx context.Context, key string, value []byte, lease bool) (bool, error)

+ UpdateIfDifferentIfLocked func(ctx context.Context, key string, value []byte, lease bool, lock KVLocker) (bool, error)

+ UpdateIfLocked func(ctx context.Context, key string, value []byte, lease bool, lock KVLocker) error

+ Watch func(w *Watcher)

+ func Client() BackendOperations

+ func NewClient(selectedBackend string, opts map[string]string, options *ExtraOptions) (BackendOperations, chan error)

+ type Capabilities uint32

+ func GetCapabilities() Capabilities

+ type ConsulLocker struct

+ func (cl *ConsulLocker) Comparator() interface{}

+ type EventChan chan KeyValueEvent

+ type EventType int

+ const EventTypeCreate

+ const EventTypeDelete

+ const EventTypeListDone

+ const EventTypeModify

+ func (t EventType) String() string

+ type ExtraOptions struct

+ ClusterSizeDependantInterval func(baseInterval time.Duration) time.Duration

+ DialOption []grpc.DialOption

+ func (e *ExtraOptions) StatusCheckInterval(allConnected bool) time.Duration

+ type KVLocker interface

+ Comparator func() interface{}

+ Unlock func() error

+ type KeyValueEvent struct

+ Key string

+ Typ EventType

+ Value []byte

+ type KeyValuePairs map[string]Value

+ func ListPrefix(prefix string) (KeyValuePairs, error)

+ func ListPrefixIfLocked(prefix string, lock KVLocker) (KeyValuePairs, error)

+ type Lock struct

+ func LockPath(ctx context.Context, backend BackendOperations, path string) (l *Lock, err error)

+ func (l *Lock) Comparator() interface{}

+ func (l *Lock) Unlock() error

+ type Value struct

+ Data []byte

+ LeaseID int64

+ ModRevision uint64

+ SessionID string

+ type Watcher struct

+ Events EventChan

+ func ListAndWatch(name, prefix string, chanSize int) *Watcher

+ func (w *Watcher) Stop()

+ func (w *Watcher) String() string