client

package

v0.0.33 Latest Latest Go to latest Published: Feb 8, 2024 License: Apache-2.0 Imports: 9 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/sdcio/cache

Links

Open Source Insights

Documentation ¶

Index ¶

type Client
- func New(ctx context.Context, ccfg *ClientConfig) (*Client, error)
type ClientConfig
type ClientOpts

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

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

func New ¶

func New(ctx context.Context, ccfg *ClientConfig) (*Client, error)

func (*Client) Clone ¶

func (c *Client) Clone(ctx context.Context, name, clone string, opts ...grpc.CallOption) error

Clone a cache

func (*Client) Close ¶

func (c *Client) Close() error

func (*Client) Commit ¶

func (c *Client) Commit(ctx context.Context, name, candidate string, opts ...grpc.CallOption) error

func (*Client) Create ¶

func (c *Client) Create(ctx context.Context, name string, opts ...grpc.CallOption) error

Create a new cache instance

func (*Client) CreateCandidate ¶

func (c *Client) CreateCandidate(ctx context.Context, name, candidate, owner string, p int32, opts ...grpc.CallOption) error

Create a Candidate

func (*Client) Delete ¶

func (c *Client) Delete(ctx context.Context, name string, opts ...grpc.CallOption) error

Delete a cache instance

func (*Client) Discard ¶

func (c *Client) Discard(ctx context.Context, name, candidate string, opts ...grpc.CallOption) error

Discard changes made to a candidate

func (*Client) Exists ¶

func (c *Client) Exists(ctx context.Context, name string, opts ...grpc.CallOption) (bool, error)

func (*Client) Get ¶

func (c *Client) Get(ctx context.Context, name string, opts ...grpc.CallOption) (*cachepb.GetResponse, error)

Get a single cache details

func (*Client) GetChanges ¶

func (c *Client) GetChanges(ctx context.Context, name, candidate string, opts ...grpc.CallOption) ([]*cachepb.GetChangesResponse, error)

GetChanges made to a candidate

func (*Client) List ¶

func (c *Client) List(ctx context.Context, opts ...grpc.CallOption) ([]string, error)

List cache instances

func (*Client) Modify ¶

func (c *Client) Modify(ctx context.Context, name string, wo *ClientOpts, dels [][]string, upds []*cachepb.Update, opts ...grpc.CallOption) error

modify a cache instance

func (*Client) Prune ¶

func (c *Client) Prune(ctx context.Context, name string, id string, force bool, opts ...grpc.CallOption) (*cachepb.PruneResponse, error)

func (*Client) Read ¶

func (c *Client) Read(ctx context.Context, name string, ro *ClientOpts, paths [][]string, period time.Duration, opts ...grpc.CallOption) chan *cachepb.ReadResponse

Read value(s) from a cache instance

func (*Client) Watch ¶

func (c *Client) Watch(ctx context.Context, name string, store cache.Store, prefixes [][]string, opts ...grpc.CallOption) (chan *cachepb.WatchResponse, error)

type ClientConfig ¶

type ClientConfig struct {
	// the cache server address
	Address string
	// number of read streams that can be opened concurrently
	// defaults to 1
	MaxReadStream int64
	// number of read streams that can be opened concurrently
	// defaults to 64
	MaxWatchStream int64
	// gRPC dial and unary RPCs timeout
	// defaults to 5s
	Timeout time.Duration
}

type ClientOpts ¶

type ClientOpts struct {
	Store         cache.Store
	Owner         string
	Priority      int32
	PriorityCount uint64
	KeysOnly      bool
}

Source Files ¶

View all Source files

client.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL