client

Documentation

Index

• Variables
• func GetWorkflowResult[T any](ctx context.Context, c Client, instance *workflow.Instance, ...) (T, error)
• type Client
  • func New(backend backend.Backend) Client
• type WorkflowInstanceOptions

Variables

var ErrWorkflowCanceled = errors.New("workflow canceled")

var ErrWorkflowTerminated = errors.New("workflow terminated")

Functions

func GetWorkflowResult

func GetWorkflowResult[T any](ctx context.Context, c Client, instance *workflow.Instance, timeout time.Duration) (T, error)

GetWorkflowResult gets the workflow result for the given workflow result. It first waits for the workflow to finish or until the given timeout has expired.

Types

type Client

type Client interface {
	CreateWorkflowInstance(ctx context.Context, options WorkflowInstanceOptions, wf workflow.Workflow, args ...interface{}) (*workflow.Instance, error)

	CancelWorkflowInstance(ctx context.Context, instance *workflow.Instance) error

	RemoveWorkflowInstance(ctx context.Context, instance *workflow.Instance) error

	WaitForWorkflowInstance(ctx context.Context, instance *workflow.Instance, timeout time.Duration) error

	SignalWorkflow(ctx context.Context, instanceID string, name string, arg interface{}) error
}

func New

func New(backend backend.Backend) Client

type WorkflowInstanceOptions

type WorkflowInstanceOptions struct {
	InstanceID string
}