worker

Documentation

Index

• Variables
• type ActivityWorker
  • func NewActivityWorker(backend backend.Backend, registry *workflow.Registry, clock clock.Clock, ...) *ActivityWorker
  • func (aw *ActivityWorker) Start(ctx context.Context) error
  • func (aw *ActivityWorker) WaitForCompletion() error
• type Options
• type WorkflowWorker
  • func NewWorkflowWorker(backend backend.Backend, registry *workflow.Registry, options *Options) *WorkflowWorker
  • func (ww *WorkflowWorker) Start(ctx context.Context) error
  • func (ww *WorkflowWorker) WaitForCompletion() error

Variables

var DefaultOptions = Options{
	WorkflowPollers:           2,
	ActivityPollers:           2,
	MaxParallelWorkflowTasks:  0,
	MaxParallelActivityTasks:  0,
	ActivityHeartbeatInterval: 25 * time.Second,
	WorkflowHeartbeatInterval: 25 * time.Second,

	WorkflowExecutorCacheSize: 128,
	WorkflowExecutorCacheTTL:  time.Second * 10,
	WorkflowExecutorCache:     nil,
}

Types

type ActivityWorker

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

func NewActivityWorker

func NewActivityWorker(backend backend.Backend, registry *workflow.Registry, clock clock.Clock, options *Options) *ActivityWorker

func (*ActivityWorker) Start

func (aw *ActivityWorker) Start(ctx context.Context) error

func (*ActivityWorker) WaitForCompletion

func (aw *ActivityWorker) WaitForCompletion() error

type Options

type Options struct {
	// WorkflowsPollers is the number of pollers to start. Defaults to 2.
	WorkflowPollers int

	// MaxParallelWorkflowTasks determines the maximum number of concurrent workflow tasks processed
	// by the worker. The default is 0 which is no limit.
	MaxParallelWorkflowTasks int

	// ActivityPollers is the number of pollers to start. Defaults to 2.
	ActivityPollers int

	// MaxParallelActivityTasks determines the maximum number of concurrent activity tasks processed
	// by the worker. The default is 0 which is no limit.
	MaxParallelActivityTasks int

	// ActivityHeartbeatInterval is the interval between heartbeat attempts for activity tasks. Defaults
	// to 25 seconds
	ActivityHeartbeatInterval time.Duration

	// HeartbeatWorkflowTasks determines if the lock on workflow tasks should be periodically
	// extended while they are being processed. Given that workflow executions should be
	// very quick, this is usually not necessary.
	HeartbeatWorkflowTasks bool

	// WorkflowHeartbeatInterval is the interval between heartbeat attempts on workflow tasks, when enabled.
	WorkflowHeartbeatInterval time.Duration

	// WorkflowExecutorCache is the max size of the workflow executor cache. Defaults to 128
	WorkflowExecutorCacheSize int

	// WorkflowExecutorCache is the max TTL of the workflow executor cache. Defaults to 10 seconds
	WorkflowExecutorCacheTTL time.Duration

	// WorkflowExecutorCache is the cache to use for workflow executors. If nil, a default cache implementation
	// will be used.
	WorkflowExecutorCache workflow.ExecutorCache
}

type WorkflowWorker

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

func NewWorkflowWorker

func NewWorkflowWorker(backend backend.Backend, registry *workflow.Registry, options *Options) *WorkflowWorker

func (*WorkflowWorker) Start

func (ww *WorkflowWorker) Start(ctx context.Context) error

func (*WorkflowWorker) WaitForCompletion

func (ww *WorkflowWorker) WaitForCompletion() error