client

Documentation

Index

• type Client
  • func New(address string, opts ...Option) (*Client, error)
  • func NewWithContext(ctx context.Context, address string, opts ...Option) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) GetDatabase(ctx context.Context, name string) (*Database, error)
  • func (c *Client) GetDatabases(ctx context.Context) ([]*Database, error)
  • func (c *Client) Group() *peer.Group
• type Database
  • func (d *Database) GetCounter(ctx context.Context, name string) (counter.Counter, error)
  • func (d *Database) GetElection(ctx context.Context, name string, opts ...election.Option) (election.Election, error)
  • func (d *Database) GetIndexedMap(ctx context.Context, name string) (indexedmap.IndexedMap, error)
  • func (d *Database) GetLeaderLatch(ctx context.Context, name string, opts ...leader.Option) (leader.Latch, error)
  • func (d *Database) GetList(ctx context.Context, name string) (list.List, error)
  • func (d *Database) GetLock(ctx context.Context, name string) (lock.Lock, error)
  • func (d *Database) GetLog(ctx context.Context, name string) (log.Log, error)
  • func (d *Database) GetMap(ctx context.Context, name string, opts ..._map.Option) (_map.Map, error)
  • func (d *Database) GetPrimitives(ctx context.Context, opts ...primitive.MetadataOption) ([]primitive.Metadata, error)
  • func (d *Database) GetSet(ctx context.Context, name string) (set.Set, error)
  • func (d *Database) GetValue(ctx context.Context, name string) (value.Value, error)
• type Option
  • func WithApplication(application string) Option
  • func WithJoinTimeout(timeout time.Duration) Option
  • func WithMemberID(memberID string) Option
  • func WithNamespace(namespace string) Option
  • func WithPeerHost(host string) Option
  • func WithPeerPort(port int) Option
  • func WithPeerServerOption(option grpc.ServerOption) Option
  • func WithPeerService(service peer.Service) Option
  • func WithScope(scope string) Option
  • func WithSessionTimeout(timeout time.Duration) Option

Types

type Client

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

Client is an Atomix client

func New

func New(address string, opts ...Option) (*Client, error)

New creates a new Atomix client

func NewWithContext

func NewWithContext(ctx context.Context, address string, opts ...Option) (*Client, error)

NewWithContext returns a new Atomix client

func (*Client) Close

func (c *Client) Close() error

Close closes the client

func (*Client) GetDatabase

func (c *Client) GetDatabase(ctx context.Context, name string) (*Database, error)

GetDatabase gets a database client by name from the client's namespace

func (*Client) GetDatabases

func (c *Client) GetDatabases(ctx context.Context) ([]*Database, error)

GetDatabases returns a list of all databases in the client's namespace

func (*Client) Group

func (c *Client) Group() *peer.Group

Group returns the peer group

type Database

type Database struct {
	Namespace string
	Name      string
	// contains filtered or unexported fields
}

Database manages the primitives in a set of partitions

func (*Database) GetCounter

func (d *Database) GetCounter(ctx context.Context, name string) (counter.Counter, error)

GetCounter gets or creates a Counter with the given name

func (*Database) GetElection

func (d *Database) GetElection(ctx context.Context, name string, opts ...election.Option) (election.Election, error)

GetElection gets or creates an Election with the given name

func (*Database) GetIndexedMap

func (d *Database) GetIndexedMap(ctx context.Context, name string) (indexedmap.IndexedMap, error)

GetIndexedMap gets or creates a Map with the given name

func (*Database) GetLeaderLatch

func (d *Database) GetLeaderLatch(ctx context.Context, name string, opts ...leader.Option) (leader.Latch, error)

GetLeaderLatch gets or creates a LeaderLatch with the given name

func (*Database) GetList

func (d *Database) GetList(ctx context.Context, name string) (list.List, error)

GetList gets or creates a List with the given name

func (*Database) GetLock

func (d *Database) GetLock(ctx context.Context, name string) (lock.Lock, error)

GetLock gets or creates a Lock with the given name

func (*Database) GetLog

func (d *Database) GetLog(ctx context.Context, name string) (log.Log, error)

GetLog gets or creates a Log with the given name

func (*Database) GetMap

func (d *Database) GetMap(ctx context.Context, name string, opts ..._map.Option) (_map.Map, error)

GetMap gets or creates a Map with the given name

func (*Database) GetPrimitives

func (d *Database) GetPrimitives(ctx context.Context, opts ...primitive.MetadataOption) ([]primitive.Metadata, error)

GetPrimitives gets a list of primitives in the database

func (*Database) GetSet

func (d *Database) GetSet(ctx context.Context, name string) (set.Set, error)

GetSet gets or creates a Set with the given name

func (*Database) GetValue

func (d *Database) GetValue(ctx context.Context, name string) (value.Value, error)

GetValue gets or creates a Value with the given name

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option provides a client option

func WithApplication

func WithApplication(application string) Option

WithApplication configures the application name for the client Deprecated: Use WithScope instead

func WithJoinTimeout

func WithJoinTimeout(timeout time.Duration) Option

WithJoinTimeout configures the client's join timeout

func WithMemberID

func WithMemberID(memberID string) Option

WithMemberID configures the client's member ID

func WithNamespace

func WithNamespace(namespace string) Option

WithNamespace configures the client's partition group namespace

func WithPeerHost

func WithPeerHost(host string) Option

WithPeerHost configures the client's peer host

func WithPeerPort

func WithPeerPort(port int) Option

WithPeerPort configures the client's peer port

func WithPeerServerOption

func WithPeerServerOption(option grpc.ServerOption) Option

WithPeerServerOption configures a server option

func WithPeerService

func WithPeerService(service peer.Service) Option

WithPeerService configures a peer-to-peer service

func WithScope

func WithScope(scope string) Option

WithScope configures the application scope for the client

func WithSessionTimeout

func WithSessionTimeout(timeout time.Duration) Option

WithSessionTimeout sets the session timeout for the client