chord

type Error struct {
	// contains filtered or unexported fields
}

type HashFn func([]byte) uint64

type KV interface {
	SimpleKV
	PrefixKV
	LeaseKV
	// Import is used when a node is transferring its KV to a remote node.
	// Used when a new node joins or a node leaves gracefully
	Import(ctx context.Context, keys [][]byte, values []*protocol.KVTransfer) error
	// ListKeys is used when a node is traversing the network to list keys
	// based on a prefix
	ListKeys(ctx context.Context, prefix []byte) ([]*protocol.KeyComposite, error)
}

type KVProvider interface {
	KV
	// Export is used when a Local node is retrieving relevant keys to transfer.
	// Only used locally, not used for RPC
	Export(ctx context.Context, keys [][]byte) ([]*protocol.KVTransfer, error)
	// RangeKeys retrieve actual byte values of the keys, given the [low, high]
	// range of key hashes.
	// Only used locally, not used for RPC
	RangeKeys(ctx context.Context, low, high uint64) ([][]byte, error)
	// RemoveKeys hard delete keys from local node.
	// Only used locally, not used for RPC
	RemoveKeys(ctx context.Context, keys [][]byte) error
}

type LeaseKV interface {
	// Acquire obtains a lease with given time-to-live, and returns a token for
	// later renewal and release.
	// On conflicting lease acquisition, ErrKVLeaseConflict error is returned.
	// If ttl is less than a second, ErrKVLeaseInvalidTTL error is returned.
	// Not to be confused with memory ordering acquire/release semantics.
	Acquire(ctx context.Context, lease []byte, ttl time.Duration) (token uint64, err error)
	// Renew extends the lease with given time-to-live, given that prevToken
	// is still valid. If the renewal occurs after a previous acquire
	// has expired and a different lease was acquired, ErrKVLeaseExpired error is returned.
	// If ttl is less than a second, ErrKVLeaseInvalidTTL error is returned.
	Renew(ctx context.Context, lease []byte, ttl time.Duration, prevToken uint64) (newToken uint64, err error)
	// Release relinquish the lease held previously by the given token.
	// If the lease holder has changed, ErrKVLeaseExpired error is returned.
	// Not to be confused with memory ordering acquire/release semantics.
	Release(ctx context.Context, lease []byte, token uint64) error
}

type PrefixKV interface {
	// PrefixAppend appends the child under the prefix. This is useful for tracking
	// hierarchical structure such as directories.
	// If the child already exist, ErrKVPrefixConflict error is returned.
	// Note that Prefix methods can share the same keyspace as Put/Get, and
	// Delete will not remove the Prefix children.
	PrefixAppend(ctx context.Context, prefix []byte, child []byte) error
	// PrefixList returns the children under the prefix.
	PrefixList(ctx context.Context, prefix []byte) (children [][]byte, err error)
	// PrefixContains checks if the child is in the prefix children
	PrefixContains(ctx context.Context, prefix []byte, child []byte) (bool, error)
	// PrefixRemove removes the matching child under the prefix.
	// If the child did not exist, this is an no-op
	PrefixRemove(ctx context.Context, prefix []byte, child []byte) error
}

type SimpleKV interface {
	// Put will store the value to a node in the Chord network responsible for the given key.
	// If the key did not exist, a new entry will be added.
	// If the key already exist, the value will be overwrriten.
	// If the key was concurrently modified by another request, ErrKVSimpleConflict error is returned.
	Put(ctx context.Context, key, value []byte) error
	// Get will fetch the value from a node in the Chord network.
	Get(ctx context.Context, key []byte) (value []byte, err error)
	// Delete will hard delete the key from the Chord network.
	// If the key was concurrently modified by another request, ErrKVSimpleConflict error is returned.
	// Note that Put/Get methods can share the same keyspace as Prefix methods, and
	// Delete will not remove the Prefix children.
	Delete(ctx context.Context, key []byte) error
}

type State uint64

type VNode interface {
	KV

	ID() uint64
	Identity() *protocol.Node

	Ping() error
	Notify(predecessor VNode) error

	FindSuccessor(key uint64) (VNode, error)
	GetSuccessors() ([]VNode, error)
	GetPredecessor() (VNode, error)

	VNodeMembership
}

type VNodeMembership interface {
	RequestToJoin(joiner VNode) (predecessor VNode, succList []VNode, err error)
	FinishJoin(stabilize bool, release bool) error

	RequestToLeave(leaver VNode) error
	FinishLeave(stabilize bool, release bool) error
}