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
• func WithoutLock() crudOption
• type Cluster
  • func New(ctx context.Context, config config.Config, pool conn.Pool) Cluster
• type Endpoint
  • func ContextEndpoint(ctx context.Context) (e Endpoint, ok bool)
• type Explorer
• type Getter
• type Inserter
• type InserterRemoverExplorerLocker
• 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

func WithoutLock

func WithoutLock() crudOption

Types

type Cluster

type Cluster interface {
	closer.Closer
	Getter
	Inserter
	Remover
	Explorer
	sync.Locker
	conn.Pessimizer
}

func New

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

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 gets conn from cluster
	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 InserterRemoverExplorerLocker

type InserterRemoverExplorerLocker interface {
	Inserter
	Remover
	Explorer
	sync.Locker
}

type Remover

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