state

Documentation

Index

• Constants
• func NewHost(priv crypto.PrivKey, listenAddrs []multiaddr.Multiaddr) (host.Host, error)
• func WipeAndReset(dbConn DBConnector, migrator Migrator) error
• type DBConnector
  • func NewDBConnector(driver string, conn string) (DBConnector, error)
• type Migrator
  • func NewMigrator(driver string) (Migrator, error)
• type RecordUpdateStatus
• type State
  • func NewStateDB(ctx context.Context, dbConn DBConnector, migrator Migrator, logfile string, ...) (State, error)
• type Store

Constants

const ErrNoDeleteInProgressTasks = errorString("can only delete tasks that are not-started or tasks that are scheduled")

const ErrNotAssigned = errorString("tasks must be acquired through pop task")

const ErrTaskNotFound = errorString("task does not exist")

const ErrWrongWorker = errorString("task already acquired by other worker")

Functions

func NewHost

func NewHost(priv crypto.PrivKey, listenAddrs []multiaddr.Multiaddr) (host.Host, error)

func WipeAndReset

func WipeAndReset(dbConn DBConnector, migrator Migrator) error

Types

type DBConnector

type DBConnector interface {
	Connect() error
	Name() string
	RetryableError(error) bool
	SqlDB() *sql.DB
}

DBConnector provides an interface for working with the underlying DB implementations

func NewDBConnector

func NewDBConnector(driver string, conn string) (DBConnector, error)

type Migrator

type Migrator func(*sql.DB) error

func NewMigrator

func NewMigrator(driver string) (Migrator, error)

type RecordUpdateStatus

type RecordUpdateStatus int

const (
	LATEST_UPDATE     RecordUpdateStatus = 1
	PREVIOUS_UPDATE   RecordUpdateStatus = 2
	UNATTACHED_RECORD RecordUpdateStatus = 10
	ATTACHED_RECORD   RecordUpdateStatus = 11
)

type State

type State interface {
	AssignTask(ctx context.Context, req tasks.PopTask) (tasks.Task, error)
	Get(ctx context.Context, uuid string) (tasks.Task, error)
	GetAll(ctx context.Context) ([]tasks.Task, error)
	GetHead(ctx context.Context, walkback int) (tasks.RecordUpdate, error)
	Update(ctx context.Context, uuid string, req tasks.UpdateTask) (tasks.Task, error)
	NewStorageTask(ctx context.Context, storageTask tasks.StorageTask) (tasks.Task, error)
	NewRetrievalTask(ctx context.Context, retrievalTask tasks.RetrievalTask) (tasks.Task, error)
	DrainWorker(ctx context.Context, worker string) error
	UndrainWorker(ctx context.Context, worker string) error
	PublishRecordsFrom(ctx context.Context, worker string) error
	ResetWorkerTasks(ctx context.Context, worker string) error
	Delete(ctx context.Context, uuid string) error
	Store(ctx context.Context) Store
}

State provides an interface for presistence.

func NewStateDB

func NewStateDB(ctx context.Context, dbConn DBConnector, migrator Migrator, logfile string, identity crypto.PrivKey, addrs []multiaddr.Multiaddr, recorder metrics.MetricsRecorder) (State, error)

NewStateDB creates a state instance with a given driver and identity

type Store

type Store interface {
	Head() (cid.Cid, error)
	Has(context.Context, string) (bool, error)
	Get(context.Context, string) ([]byte, error)
	Put(ctx context.Context, key string, content []byte) error
}