rig

README

---

Go framework for building stateful, replicated services

Projects that use the Rig

• Transverse uses the Rig to replicate user data.

Documentation

Index

• type HTTPError
• type LogPayload
  • func NewLogPayload(version uint64, op Operation) *LogPayload
• type Operation
  • func NewOperation(method string, data json.RawMessage) Operation
• type Rig
  • func New(logDir string, service Service, applyCommits bool, token, peer string) (*Rig, error)
  • func (r *Rig) DoHandler() http.Handler
  • func (r *Rig) LogHandler() http.Handler
• type Service

Types

type HTTPError

type HTTPError interface {
	StatusCode() int
}

HTTPError represents an HTTP error that has an associated status code.

type LogPayload

type LogPayload struct {
	Version uint64    `json:"version"`
	Op      Operation `json:"op"`
}

LogPayload is request payload for log operations.

func NewLogPayload

func NewLogPayload(version uint64, op Operation) *LogPayload

type Operation

type Operation struct {
	Method string `json:"method"`
	Data   []byte `json:"data"`
}

Operation represents a log operation.

func NewOperation

func NewOperation(method string, data json.RawMessage) Operation

NewOperation returns a new Operation.

type Rig

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

func New

func New(logDir string, service Service, applyCommits bool, token, peer string) (*Rig, error)

New returns a new Rig.

func (*Rig) DoHandler

func (r *Rig) DoHandler() http.Handler

func (*Rig) LogHandler

func (r *Rig) LogHandler() http.Handler

type Service

type Service interface {
	Validate(Operation) error
	Apply(uint64, Operation) error
	LockResources(Operation) bool
	UnlockResources(Operation)
}