cluster

Documentation

Index

• type Datastore
  • func NewDataStore(ctx context.Context, kvSource staert.KvSource, object Object, ...) (*Datastore, error)
  • func (d *Datastore) Begin() (Transaction, Object, error)
  • func (d *Datastore) Get() Object
  • func (d *Datastore) Load() (Object, error)
• type LeaderListener
• type Leadership
  • func NewLeadership(ctx context.Context, cluster *types.Cluster) *Leadership
  • func (l *Leadership) AddListener(listener LeaderListener)
  • func (l *Leadership) AddRoutes(router *mux.Router)
  • func (l *Leadership) IsLeader() bool
  • func (l *Leadership) Participate(pool *safe.Pool)
  • func (l *Leadership) Resign()
• type Listener
• type Metadata
  • func NewMetadata(object Object) *Metadata
  • func (m *Metadata) Marshall() error
• type Object
• type Store
• type Transaction

Types

type Datastore

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

Datastore holds a struct synced in a KV store

func NewDataStore

func NewDataStore(ctx context.Context, kvSource staert.KvSource, object Object, listener Listener) (*Datastore, error)

NewDataStore creates a Datastore

func (*Datastore) Begin

func (d *Datastore) Begin() (Transaction, Object, error)

Begin creates a transaction with the KV store.

func (*Datastore) Get

func (d *Datastore) Get() Object

Get atomically a struct from the KV store

func (*Datastore) Load

func (d *Datastore) Load() (Object, error)

Load load atomically a struct from the KV store

type LeaderListener

type LeaderListener func(elected bool) error

LeaderListener is called when leadership has changed

type Leadership

type Leadership struct {
	*safe.Pool
	*types.Cluster
	// contains filtered or unexported fields
}

Leadership allows leadership election using a KV store

func NewLeadership

func NewLeadership(ctx context.Context, cluster *types.Cluster) *Leadership

NewLeadership creates a leadership

func (*Leadership) AddListener

func (l *Leadership) AddListener(listener LeaderListener)

AddListener adds a leadership listener

func (*Leadership) AddRoutes

func (l *Leadership) AddRoutes(router *mux.Router)

AddRoutes add dashboard routes on a router

func (*Leadership) IsLeader

func (l *Leadership) IsLeader() bool

IsLeader returns true if current node is leader

func (*Leadership) Participate

func (l *Leadership) Participate(pool *safe.Pool)

Participate tries to be a leader

func (*Leadership) Resign

func (l *Leadership) Resign()

Resign resigns from being a leader

type Listener

type Listener func(Object) error

Listener is called when Object has been changed in KV store

type Metadata

type Metadata struct {
	Object []byte
	Lock   string
	// contains filtered or unexported fields
}

Metadata stores Object plus metadata

func NewMetadata

func NewMetadata(object Object) *Metadata

NewMetadata returns new Metadata

func (*Metadata) Marshall

func (m *Metadata) Marshall() error

Marshall marshalls object

type Object

type Object interface{}

Object is the struct to store

type Store

type Store interface {
	Load() (Object, error)
	Get() Object
	Begin() (Transaction, Object, error)
}

Store is a generic interface to represents a storage

type Transaction

type Transaction interface {
	Commit(object Object) error
}

Transaction allows to set a struct in the KV store