etcd

Documentation

Index

• Constants
• type Client
  • func Dial(conf *Config, agentInfo *sync.AgentInfo) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Dial() error
  • func (c *Client) Initialize() error
  • func (c *Client) Members() map[string]*sync.AgentInfo
  • func (c *Client) NewLocker(ctx context.Context, key sync.Key) (sync.Locker, error)
  • func (c *Client) Publish(ctx context.Context, publisherID *time.ActorID, event sync.DocEvent)
  • func (c *Client) PublishToLocal(ctx context.Context, publisherID *time.ActorID, event sync.DocEvent)
  • func (c *Client) Subscribe(ctx context.Context, subscriber types.Client, topics []*key.Key) (*sync.Subscription, map[string][]types.Client, error)
  • func (c *Client) Unsubscribe(ctx context.Context, topics []*key.Key, sub *sync.Subscription)
• type Config

Constants

const (
	// DefaultDialTimeoutSec is the default dial timeout of etcd connection.
	DefaultDialTimeoutSec = 5

	// DefaultLockLeaseTimeSec is the default lease time of lock.
	DefaultLockLeaseTimeSec = 30
)

Types

type Client

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

Client is a client that connects to ETCD.

func Dial

func Dial(conf *Config, agentInfo *sync.AgentInfo) (*Client, error)

Dial creates a new instance of Client and dials the given ETCD.

func (*Client) Close

func (c *Client) Close() error

Close all resources of this client.

func (*Client) Dial

func (c *Client) Dial() error

Dial dials the given ETCD.

func (*Client) Initialize

func (c *Client) Initialize() error

Initialize put this agent to etcd with TTL periodically.

func (*Client) Members

func (c *Client) Members() map[string]*sync.AgentInfo

Members returns the members of this cluster.

func (*Client) NewLocker

func (c *Client) NewLocker(
	ctx context.Context,
	key sync.Key,
) (sync.Locker, error)

NewLocker creates locker of the given key.

func (*Client) Publish

func (c *Client) Publish(
	ctx context.Context,
	publisherID *time.ActorID,
	event sync.DocEvent,
)

Publish publishes the given event to the given Topic.

func (*Client) PublishToLocal

func (c *Client) PublishToLocal(
	ctx context.Context,
	publisherID *time.ActorID,
	event sync.DocEvent,
)

PublishToLocal publishes the given event to the given Topic.

func (*Client) Subscribe

func (c *Client) Subscribe(
	ctx context.Context,
	subscriber types.Client,
	topics []*key.Key,
) (*sync.Subscription, map[string][]types.Client, error)

Subscribe subscribes to the given topics.

func (*Client) Unsubscribe

func (c *Client) Unsubscribe(
	ctx context.Context,
	topics []*key.Key,
	sub *sync.Subscription,
)

Unsubscribe unsubscribes the given topics.

type Config

type Config struct {
	Endpoints      []string      `json:"Endpoints"`
	DialTimeoutSec time.Duration `json:"DialTimeoutSec"`
	Username       string        `json:"Username"`
	Password       string        `json:"Password"`

	LockLeaseTimeSec int `json:"LockLeaseTimeSec"`
}

Config is the configuration for creating a Client instance.