karigo

type Action func(*Checkpoint)

type Checkpoint struct {
	Res jsonapi.Resource
	// contains filtered or unexported fields
}

type Config struct {
	// Server
	Port uint

	// Node
	Hosts   []string
	Journal map[string]string
	Sources map[string]map[string]string
}

type Journal interface {
	Service

	// Reset empties the whole journal. The next append
	// will add an entry add index 0.
	Reset() error

	// Append appends an entry to the journal.
	Append([]byte) error

	// Oldest returns the oldest known entry.
	Oldest() (uint, []byte, error)

	// Newest returns the newest entry.
	Newest() (uint, []byte, error)

	// At returns the entry indexed at i, or none if it
	// does not exist.
	At(i uint) ([]byte, error)

	// Cut removes all entries from the oldest one to
	// the one at i minus one.
	//
	// If i is lower than the oldest known index,
	// nothing gets cut. If i is greater than the newest
	// index, it will be interpreted as the newest index,
	// and therefore everything will be cut except i,
	// leaving a journal of length one.
	Cut(i uint) error

	// Range returns a slice of entries from indexes f
	// to t (inclusively).
	//
	// It returns an error if it can't return the range,
	// whether it is because the journal's history starts
	// after f or t is greater than the newest index.
	Range(f uint, t uint) ([][]byte, error)
}

type Node struct {
	Name string

	Hosts   []string
	Journal map[string]string
	Sources map[string]map[string]string

	sync.Mutex
	// contains filtered or unexported fields
}

type Request struct {
	ID string

	Method string
	URL    *jsonapi.URL

	Body []byte
	Doc  *jsonapi.Document

	Logger zerolog.Logger
}

type Server struct {
	Config

	Nodes map[string]*Node
	// contains filtered or unexported fields
}

type Service interface {
	// Connect instantiates a connection to the service behind
	// the source.
	//
	// Implementations should document the elements they expect
	// in the map.
	Connect(map[string]string) error

	// Ping reports whether there is an active connection or not.
	Ping() bool
}

type Source interface {
	Service

	// Reset wipes all data and brings the underlying database
	// to a clean state.
	//
	// A clean state represents the given schema.
	Reset(*jsonapi.Schema) error

	// NewTx returns a new Tx object.
	NewTx() (query.Tx, error)
}