Interface Client

memcache/interface.go:128–247

NOTE(mihnea) - ideally we should be able to separate methods that are state-aware (i.e. GetSentinels / SetSentinels) away from this interface and into a new interface (e.g. StateAwareClient / ConsistentCachingClient). Such an interface should also have fewer methods (e.g. no Increment, Flush, etc.)

// interface (e.g. StateAwareClient / ConsistentCachingClient). Such an interface should also
// have fewer methods (e.g. no Increment, Flush, etc.)
type Client interface {
	// This retrieves a single entry from memcache.
	Get(key string) GetResponse

	// Batch version of the Get method.
	GetMulti(keys []string) map[string]GetResponse

	// *** This method is specific to Dropbox zookeeper-managed memcache ***
	// This is the same as GetMulti.  The only difference is that GetMulti will
	// only read from ACTIVE memcache shards, while GetSentinels will read from
	// both ACTIVE and WRITE_ONLY memcache shards.
	GetSentinels(keys []string) map[string]GetResponse

	// This sets a single entry into memcache.  If the item's data version id
	// (aka CAS) is nonzero, the set operation can only succeed if the item
	// exists in memcache and has a same data version id; otherwise, this will
	// do an unconditional set.
	Set(item *Item) MutateResponse

	// Batch version of the Set method.  Note that the response entries
	// ordering is undefined (i.e., may not match the input ordering).
	SetMulti(items []*Item) []MutateResponse

	// *** This method is specific to Dropbox zookeeper-managed memcache ***
	// This is the same as SetMulti.  The only difference is that SetMulti will
	// only write to ACTIVE memcache shards, while SetSentinels will write to
	// both ACTIVE and WRITE_ONLY memcache shards.
	SetSentinels(items []*Item) []MutateResponse

	// Just like SetMulti, but if item's data version id (aka CAS) is zero,
	// it will do a **conditional** add (will fail if the item already exists
	// in memcache).
	CasMulti(items []*Item) []MutateResponse

	// *** This method is specific to Dropbox zookeeper-managed memcache ***
	// This is the same as CasMulti.  The only difference is that CasMulti will
	// only write to ACTIVE memcache shards, while CasSentinels will write to
	// both ACTIVE and WRITE_ONLY memcache shards.
	CasSentinels(items []*Item) []MutateResponse

	// This adds a single entry into memcache.  Note: Add will fail if the
	// item already exist in memcache.
	Add(item *Item) MutateResponse

	// Batch version of the Add method.  Note that the response entries
	// ordering is undefined (i.e., may not match the input ordering).
	AddMulti(item []*Item) []MutateResponse

	// This replaces a single entry in memcache.  Note: Replace will fail if
	// the does not exist in memcache.
	Replace(item *Item) MutateResponse

	// This delets a single entry from memcache.
	Delete(key string) MutateResponse

	// Batch version of the Delete method.  Note that the response entries
	// ordering is undefined (i.e., may not match the input ordering)
	DeleteMulti(keys []string) []MutateResponse