kv

type KeyValue struct {
	Key      string
	Value    []byte
	Revision uint64
}

type LockOption func(*LockOptions)

type LockOptions struct {
	Value     []byte        // Optional, value to associate with the lock
	TTL       time.Duration // Optional, expiration time associated with the lock
	RenewLock chan struct{} // Optional, chan used to control and stop the session ttl renewal for the lock
}

type Locker interface {
	Lock(stopChan chan struct{}) (<-chan struct{}, error)
	Unlock() error
}

type PutOption func(*PutOptions)

type PutOptions struct {
	IsPrefix bool          // Optional, indicate if the given key is a prefix
	TTL      time.Duration // Optional, expiration time associated with the key
}

type Store interface {
	// Put a value with the specified key
	Put(key string, value []byte, opts ...PutOption) error

	// AtomicPut puts a single value and gets previous one if exists.
	// Pass previous = nil to create a new key.
	AtomicPut(key string, value []byte, expected *KeyValue, opts ...PutOption) (*KeyValue, error)

	// Get a value with given key
	Get(key string) (*KeyValue, error)

	// List the content with given prefix
	List(prefix string) ([]*KeyValue, error)

	// Delete the value with the specified key
	Delete(key string) error

	// Atomic delete of a single value
	AtomicDelete(key string, expected *KeyValue) (bool, error)

	// DeleteTree deletes a range of keys under a given prefix
	DeleteTree(prefix string) error

	// Exists checks if a key exists in the backend
	Exists(key string) (bool, error)

	// Watch for changes on a key
	Watch(key string, stopCh <-chan struct{}) (<-chan *KeyValue, error)

	// WatchTree watches for changes on child nodes under a given prefix
	WatchTree(prefix string, stopCh <-chan struct{}) (<-chan []*KeyValue, error)

	// Lock locks the given key.
	// The returned Locker is not held and must be acquired
	Lock(key string, opts ...LockOption) (Locker, error)

	// Close the connection
	Close()
}