store

Documentation

Index

• Constants
• Variables
• type Event
• type EventType
• type Storer
  • func New(ends []string) (Storer, error)
• type Watcher

Constants

const Timeout = time.Second * 30

Timeout defines the default database dial timeout.

Variables

var (
	ErrWatchCanceled = errors.New("watch canceled by the server")
	ErrWatchClosed   = errors.New("watch closed by the client")
)

var ErrKeyNotFound = errors.New("key not found")

Types

type Event

type Event struct {
	Type    EventType
	Val     []byte
	Version int64
}

Event is a database agnostic event object.

type EventType

type EventType string

const (
	EventAdded    EventType = "ADDED"
	EventModified EventType = "MODIFIED"
	EventDeleted  EventType = "DELETED"
)

type Storer

type Storer interface {
	Put(string, []byte) (int64, error)
	Get(string) ([]byte, int64, error)
	GetKeysWithPrefix(string) ([]string, error)
	Delete(string) error
	Watcher(context.Context, string) Watcher
}

Storer defines behaviour all storage implementations must have.

func New

func New(ends []string) (Storer, error)

New returns a new storage implememtation.

type Watcher

type Watcher interface {
	// Start starts watching specified resource.
	Start()
	// Stop stops the watcher.
	Stop()
	// EventChan returns events as they occur.
	EventChan() <-chan *Event
	// ErrChan returns an error, if any. The watcher is terminated on
	// receiving an error.
	ErrChan() <-chan error
}

Watcher defines behaviour all watchers must have.