groupcache

type AtomicInt int64

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

type CacheStats struct {
	Bytes     int64
	Items     int64
	Gets      int64
	Hits      int64
	Evictions int64
}

type CacheType int

type ConfigOpts struct {
	ZkServers string

	ParentZNode string

	SessionTimeout time.Duration
}

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

type Context interface{}

type GCGetter []interface{}

type Getter interface {
	// Get returns the value identified by key, populating dest.
	//
	// The returned data must be unversioned. That is, key must
	// uniquely describe the loaded data, without an implicit
	// current time, and without relying on cache expiration
	// mechanisms.
	Get(ctx Context, key string, dest Sink) error

	GetBatch(ctx Context, kvs []*KeyValue) error
}

type GetterBatchFunc func(ctx Context, kvs []*KeyValue) error

type GetterFunc func(ctx Context, key string, dest Sink) error

type Group struct {

	// Stats are statistics on the group.
	Stats Stats
	// contains filtered or unexported fields
}

type GroupOpts struct {
	PipelineConcurrency int
	PipelineCapacity    int
	PipelineMGetTimeout time.Duration
}

type HTTPPool struct {
	// Context optionally specifies a context for the server to use when it
	// receives a request.
	// If nil, the server uses a nil Context.
	Context func(*http.Request) Context

	// Transport optionally specifies an http.RoundTripper for the client
	// to use when it makes a request.
	// If nil, the client uses http.DefaultTransport.
	Transport func(Context) http.RoundTripper
	// contains filtered or unexported fields
}

type HTTPPoolOptions struct {
	// BasePath specifies the HTTP path that will serve groupcache requests.
	// If blank, it defaults to "/_groupcache/".
	BasePath string

	// Replicas specifies the number of key replicas on the consistent hash.
	// If blank, it defaults to 50.
	Replicas int

	// HashFn specifies the hash function of the consistent hash.
	// If blank, it defaults to crc32.ChecksumIEEE.
	HashFn consistenthash.Hash

	// configurations of a ConfigWatcher
	ConfigOpts
}

type KeyValue struct {
	Key  string
	Idx  int32
	Data []byte // result data
	Dest Sink
	Err  error
	// contains filtered or unexported fields
}

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

type PeerPicker interface {
	// PickPeer returns the peer that owns the specific key
	// and true to indicate that a remote peer was nominated.
	// It returns nil, false if the key owner is the current peer.
	PickPeer(key string) (peer ProtoGetter, ok bool)

	RegisterAndWatch() error
}

type Pipeline struct {
	Concurrency int
	Capacity    int
	Process     ProcessFunc

	MGetTimeout time.Duration
	Group       *Group
	// contains filtered or unexported fields
}

type ProcessFunc func(g *Group, req *Request) *Response

type ProtoGetter interface {
	Get(context Context, in *pb.GetRequest, out *pb.GetResponse) error
	GetBatch(context Context, in *pb.GetBatchRequest, out *pb.GetBatchResponse) error
	Put(context Context, in *pb.PutRequest, out *pb.PutResponse) error
	PutBatch(context Context, in *pb.PutBatchRequest, out *pb.PutBatchResponse) error
}

type Request struct {
	Ctx  Context
	Idx  int
	Key  string
	Sink Sink
	Resp chan *Response
}

type Response struct {
	Idx int
	Err error
}

type Sink interface {
	// SetString sets the value to s.
	SetString(s string) error

	// SetBytes sets the value to the contents of v.
	// The caller retains ownership of v.
	SetBytes(v []byte) error

	// SetProto sets the value to the encoded version of m.
	// The caller retains ownership of m.
	SetProto(m proto.Message) error

	// SetTimestampBytes sets the value to the contents of v, appending the
	// supplied Unix epoch timestamp in seconds.
	SetTimestampBytes(v []byte, timestamp int64) error
	// contains filtered or unexported methods
}

type Stats struct {
	Gets               AtomicInt // any Get request, including from peers
	CacheHits          AtomicInt // either cache was good
	PeerLoads          AtomicInt // either remote load or remote cache hit (not an error)
	PeerErrors         AtomicInt
	Loads              AtomicInt // (gets - cacheHits)
	LoadsDeduped       AtomicInt // after singleflight
	LocalLoads         AtomicInt // total good local loads
	LocalLoadErrs      AtomicInt // total bad local loads
	ServerRequests     AtomicInt // gets that came over the network from peers
	Expires            AtomicInt // times of request expired object
	LoadsDedupedExpire AtomicInt // times of reload expired object
	Cleanups           AtomicInt // times of cleaning expired object
}

type TimeProvider interface {
	// Return the current Unix epoch time in seconds.
	NowUnixSeconds() int64

	// Return the time on a channel after delay d.
	After(d time.Duration) <-chan time.Time
}