cluster

Documentation

Index

• Constants
• Variables
• func DiffEndpoints(curr, next []endpoint.Endpoint, eq, add, del func(i, j int))
• func SortEndpoints(es []endpoint.Endpoint)
• func WithEndpoint(ctx context.Context, endpoint Endpoint) context.Context
• type Cluster
  • func New(ctx context.Context, config config.Config, pool conn.Pool) *Cluster
  • func (c *Cluster) Close(ctx context.Context) (err error)
  • func (c *Cluster) Force()
  • func (c *Cluster) Get(ctx context.Context) (cc conn.Conn, err error)
  • func (c *Cluster) Insert(ctx context.Context, e endpoint.Endpoint, opts ...CrudOption)
  • func (c *Cluster) Pessimize(ctx context.Context, cc conn.Conn, cause error)
  • func (c *Cluster) Remove(ctx context.Context, e endpoint.Endpoint, opts ...CrudOption)
  • func (c *Cluster) SetExplorer(repeater repeater.Repeater)
• type CrudOption
  • func WithoutLock() CrudOption
• type Endpoint
  • func ContextEndpoint(ctx context.Context) (e Endpoint, ok bool)
• type Explorer
• type Getter
• type Inserter
• type Remover

Constants

const (
	MaxGetConnTimeout = 10 * time.Second
)

Variables

var (
	// ErrClusterClosed returned when requested on a closed cluster.
	ErrClusterClosed = xerrors.Wrap(fmt.Errorf("cluster closed"))

	// ErrClusterEmpty returned when no connections left in cluster.
	ErrClusterEmpty = xerrors.Wrap(fmt.Errorf("cluster empty"))
)

Functions

func DiffEndpoints

func DiffEndpoints(curr, next []endpoint.Endpoint, eq, add, del func(i, j int))

func SortEndpoints

func SortEndpoints(es []endpoint.Endpoint)

func WithEndpoint

func WithEndpoint(ctx context.Context, endpoint Endpoint) context.Context

Types

type Cluster

type Cluster struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func New

func New(
	ctx context.Context,
	config config.Config,
	pool conn.Pool,
) *Cluster

func (*Cluster) Close

func (c *Cluster) Close(ctx context.Context) (err error)

func (*Cluster) Force

func (c *Cluster) Force()

Force reexpore cluster

func (*Cluster) Get

func (c *Cluster) Get(ctx context.Context) (cc conn.Conn, err error)

Get returns next available connection. It returns error on given deadline cancellation or when cluster become closed.

func (*Cluster) Insert

func (c *Cluster) Insert(ctx context.Context, e endpoint.Endpoint, opts ...CrudOption)

Insert inserts new connection into the cluster.

func (*Cluster) Pessimize

func (c *Cluster) Pessimize(ctx context.Context, cc conn.Conn, cause error)

Pessimize connection in underling pool

func (*Cluster) Remove

func (c *Cluster) Remove(ctx context.Context, e endpoint.Endpoint, opts ...CrudOption)

Remove removes and closes previously inserted connection.

func (*Cluster) SetExplorer

func (c *Cluster) SetExplorer(repeater repeater.Repeater)

type CrudOption

type CrudOption func(h *crudOptionsHolder)

func WithoutLock

func WithoutLock() CrudOption

type Endpoint

type Endpoint interface {
	NodeID() uint32
}

func ContextEndpoint

func ContextEndpoint(ctx context.Context) (e Endpoint, ok bool)

type Explorer

type Explorer interface {
	SetExplorer(repeater repeater.Repeater)
	Force()
}

type Getter

type Getter interface {
	// Get returns next available connection.
	// It returns error on given deadline cancellation or when cluster become closed.
	Get(ctx context.Context) (cc conn.Conn, err error)
}

type Inserter

type Inserter interface {
	// Insert inserts endpoint to cluster
	Insert(ctx context.Context, endpoint endpoint.Endpoint, opts ...CrudOption)
}

type Remover

type Remover interface {
	// Remove removes endpoint from cluster
	Remove(ctx context.Context, endpoint endpoint.Endpoint, opts ...CrudOption)
}