operations

Documentation

Index

• func ErrTernary(err error, ifErr, ifNoError core.OpPhase) core.OpPhase
• func RunWithOperationContext(ctx context.Context, fn func(ctx context.Context) error) error
• type ConflictError
• type Manager
  • func NewOperationsManager(ctx context.Context, ns string, di database.Plugin, txHelper txcommon.Helper, ...) (Manager, error)
• type OperationHandler

Functions

func ErrTernary

func ErrTernary(err error, ifErr, ifNoError core.OpPhase) core.OpPhase

func RunWithOperationContext

func RunWithOperationContext(ctx context.Context, fn func(ctx context.Context) error) error

Types

type ConflictError

type ConflictError interface {
	IsConflictError() bool
}

ConflictError can be implemented by connectors to prevent an operation being overridden to failed

type Manager

type Manager interface {
	RegisterHandler(ctx context.Context, handler OperationHandler, ops []core.OpType)
	PrepareOperation(ctx context.Context, op *core.Operation) (*core.PreparedOperation, error)
	RunOperation(ctx context.Context, op *core.PreparedOperation, idempotentSubmit bool) (fftypes.JSONObject, error)
	RetryOperation(ctx context.Context, opID *fftypes.UUID) (*core.Operation, error)
	ResubmitOperations(ctx context.Context, txID *fftypes.UUID) (total int, resubmit []*core.Operation, err error)
	AddOrReuseOperation(ctx context.Context, op *core.Operation, hooks ...database.PostCompletionHook) error
	BulkInsertOperations(ctx context.Context, ops ...*core.Operation) error
	SubmitOperationUpdate(update *core.OperationUpdate)
	GetOperationByIDCached(ctx context.Context, opID *fftypes.UUID) (*core.Operation, error)
	ResolveOperationByID(ctx context.Context, opID *fftypes.UUID, op *core.OperationUpdateDTO) error
	Start() error
	WaitStop()
}

func NewOperationsManager

func NewOperationsManager(ctx context.Context, ns string, di database.Plugin, txHelper txcommon.Helper, cacheManager cache.Manager) (Manager, error)

type OperationHandler

type OperationHandler interface {
	core.Named
	PrepareOperation(ctx context.Context, op *core.Operation) (*core.PreparedOperation, error)
	RunOperation(ctx context.Context, op *core.PreparedOperation) (outputs fftypes.JSONObject, phase core.OpPhase, err error)
	OnOperationUpdate(ctx context.Context, op *core.Operation, update *core.OperationUpdate) error
}