client

Documentation

Index

• Variables
• type Client
  • func Dial(rpcAddr string, opts ...Option) (*Client, error)
  • func NewClient(opts ...Option) (*Client, error)
  • func (c *Client) Activate(ctx context.Context) error
  • func (c *Client) Attach(ctx context.Context, doc *document.Document) error
  • func (c *Client) Close() error
  • func (c *Client) Deactivate(ctx context.Context) error
  • func (c *Client) Detach(ctx context.Context, doc *document.Document) error
  • func (c *Client) Dial(rpcAddr string) error
  • func (c *Client) IsActive() bool
  • func (c *Client) Metadata() map[string]string
  • func (c *Client) Sync(ctx context.Context, keys ...*key.Key) error
  • func (c *Client) Watch(ctx context.Context, docs ...*document.Document) <-chan WatchResponse
• type Option
• type WatchResponse

Variables

var (
	// ErrClientNotActivated occurs when an inactive client executes a function
	// that can only be executed when activated.
	ErrClientNotActivated = errors.New("client is not activated")

	// ErrDocumentNotAttached occurs when the given document is not attached to
	// this client.
	ErrDocumentNotAttached = errors.New("document is not attached")
)

Types

type Client

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

Client is a normal client that can communicate with the agent. It has documents and sends changes of the document in local to the agent to synchronize with other replicas in remote.

func Dial

func Dial(rpcAddr string, opts ...Option) (*Client, error)

Dial creates an instance of Client and dials the given rpcAddr.

func NewClient

func NewClient(opts ...Option) (*Client, error)

NewClient creates an instance of Client.

func (*Client) Activate

func (c *Client) Activate(ctx context.Context) error

Activate activates this client. That is, it register itself to the agent and receives a unique ID from the agent. The given ID is used to distinguish different clients.

func (*Client) Attach

func (c *Client) Attach(ctx context.Context, doc *document.Document) error

Attach attaches the given document to this client. It tells the agent that this client will synchronize the given document.

func (*Client) Close

func (c *Client) Close() error

Close closes all resources of this client.

func (*Client) Deactivate

func (c *Client) Deactivate(ctx context.Context) error

Deactivate deactivates this client.

func (*Client) Detach

func (c *Client) Detach(ctx context.Context, doc *document.Document) error

Detach detaches the given document from this client. It tells the agent that this client will no longer synchronize the given document.

To collect garbage things like CRDT tombstones left on the document, all the changes should be applied to other replicas before GC time. For this, if the document is no longer used by this client, it should be detached.

func (*Client) Dial

func (c *Client) Dial(rpcAddr string) error

Dial dials the given rpcAddr.

func (*Client) IsActive

func (c *Client) IsActive() bool

IsActive returns whether this client is active or not.

func (*Client) Metadata

func (c *Client) Metadata() map[string]string

Metadata returns the metadata of this client.

func (*Client) Sync

func (c *Client) Sync(ctx context.Context, keys ...*key.Key) error

Sync pushes local changes of the attached documents to the Agent and receives changes of the remote replica from the agent then apply them to local documents.

func (*Client) Watch

func (c *Client) Watch(ctx context.Context, docs ...*document.Document) <-chan WatchResponse

Watch subscribes to events on a given document. If the context "ctx" is canceled or timed out, returned channel is closed, and "WatchResponse" from this closed channel has zero events and nil "Err()".

type Option

type Option struct {
	Key                string
	Metadata           map[string]string
	CertFile           string
	ServerNameOverride string
}

Option configures how we set up the client.

type WatchResponse

type WatchResponse struct {
	Publisher *types.Client
	EventType types.EventType
	Keys      []*key.Key
	Err       error
}

WatchResponse is a structure representing response of Watch.