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 DirectoryCreator
• type ObjectStore
  • func NewFileObjectStore(basePath string) ObjectStore
  • func NewS3ObjectStore(s3 *s3.S3, bucket string) ObjectStore
• type Operation
• type RiggedService
  • func NewRiggedService(service Service, objectStore ObjectStore, prefix string) (*RiggedService, error)
  • func (rs *RiggedService) Apply(op Operation, waitUntilDurable bool) error
  • func (rs *RiggedService) Flush() (int, error)
  • func (rs *RiggedService) Recover() error
  • func (rs *RiggedService) Snapshot() error
  • func (rs *RiggedService) SnapshotVersion() uint64
• type Service

Types

type DirectoryCreator

type DirectoryCreator interface {
	CreateDirectory(string) error
}

type ObjectStore

type ObjectStore interface {
	GetObject(name string) (io.ReadCloser, error)
	DeleteObject(name string) error
	PutObject(name string, data io.ReadSeeker, size int64) error
}

func NewFileObjectStore

func NewFileObjectStore(basePath string) ObjectStore

func NewS3ObjectStore

func NewS3ObjectStore(s3 *s3.S3, bucket string) ObjectStore

type Operation

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

type RiggedService

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

func NewRiggedService

func NewRiggedService(service Service, objectStore ObjectStore, prefix string) (*RiggedService, error)

func (*RiggedService) Apply

func (rs *RiggedService) Apply(op Operation, waitUntilDurable bool) error

Apply applies an operation.

func (*RiggedService) Flush

func (rs *RiggedService) Flush() (int, error)

func (*RiggedService) Recover

func (rs *RiggedService) Recover() error

func (*RiggedService) Snapshot

func (rs *RiggedService) Snapshot() error

func (*RiggedService) SnapshotVersion

func (rs *RiggedService) SnapshotVersion() uint64

type Service

type Service interface {
	Version() (uint64, error)
	Validate(Operation) error
	Apply(uint64, Operation) error
	Snapshot() (io.ReadSeeker, int64, error)
	Restore(uint64, io.Reader) error
}