Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

backend

package

Go to main page

Versions in this module

v1

v1.1.7

Apr 6, 2025

v1.1.5

Apr 5, 2025

v1.1.4

Apr 5, 2025

v1.1.3

Apr 5, 2025

v1.1.2

Apr 5, 2025

v1.1.1

Apr 5, 2025

v1.1.0

Apr 5, 2025

v1.0.6

Apr 5, 2025

v1.0.5

Apr 5, 2025

v1.0.4

Apr 5, 2025

v1.0.2

Apr 5, 2025

v1.0.1

Apr 5, 2025

v1.0.0

Apr 4, 2025

Changes in this version

+ const TracerName

+ var DefaultRemovalOptions = RemovalOptions

+ var ErrInstanceAlreadyExists = errors.New("workflow instance already exists")

+ var ErrInstanceNotFinished = errors.New("workflow instance is not finished")

+ var ErrInstanceNotFound = errors.New("workflow instance not found")

+ type ActivityTask struct

+ ActivityID string

+ Event *history.Event

+ ID string

+ Queue workflow.Queue

+ WorkflowInstance *core.WorkflowInstance

+ type Backend interface

+ CancelWorkflowInstance func(ctx context.Context, instance *workflow.Instance, cancelEvent *history.Event) error

+ Close func() error

+ CompleteActivityTask func(ctx context.Context, task *ActivityTask, result *history.Event) error

+ CompleteWorkflowTask func(ctx context.Context, task *WorkflowTask, state core.WorkflowInstanceState, ...) error

+ CreateWorkflowInstance func(ctx context.Context, instance *workflow.Instance, event *history.Event) error

+ ExtendActivityTask func(ctx context.Context, task *ActivityTask) error

+ ExtendWorkflowTask func(ctx context.Context, task *WorkflowTask) error

+ FeatureSupported func(feature Feature) bool

+ GetActivityTask func(ctx context.Context, queues []workflow.Queue) (*ActivityTask, error)

+ GetStats func(ctx context.Context) (*Stats, error)

+ GetWorkflowInstanceHistory func(ctx context.Context, instance *workflow.Instance, lastSequenceID *int64) ([]*history.Event, error)

+ GetWorkflowInstanceState func(ctx context.Context, instance *workflow.Instance) (core.WorkflowInstanceState, error)

+ GetWorkflowTask func(ctx context.Context, queues []workflow.Queue) (*WorkflowTask, error)

+ Metrics func() metrics.Client

+ Options func() *Options

+ PrepareActivityQueues func(ctx context.Context, queues []workflow.Queue) error

+ PrepareWorkflowQueues func(ctx context.Context, queues []workflow.Queue) error

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

+ RemoveWorkflowInstances func(ctx context.Context, options ...RemovalOption) error

+ SignalWorkflow func(ctx context.Context, instanceID string, event *history.Event) error

+ Tracer func() trace.Tracer

+ type BackendOption func(*Options)

+ func WithContextPropagator(prop workflow.ContextPropagator) BackendOption

+ func WithConverter(converter converter.Converter) BackendOption

+ func WithLogger(logger *slog.Logger) BackendOption

+ func WithMaxHistorySize(size int64) BackendOption

+ func WithMetrics(client metrics.Client) BackendOption

+ func WithRemoveContinuedAsNewInstances() BackendOption

+ func WithStickyTimeout(timeout time.Duration) BackendOption

+ func WithTracerProvider(tp trace.TracerProvider) BackendOption

+ type ErrNotSupported struct

+ Message string

+ func (e ErrNotSupported) Error() string

+ type Feature int

+ const Feature_Expiration

+ type MockBackend struct

+ func NewMockBackend(t mockConstructorTestingTNewMockBackend) *MockBackend

+ func (_m *MockBackend) CancelWorkflowInstance(ctx context.Context, instance *core.WorkflowInstance, ...) error

+ func (_m *MockBackend) Close() error

+ func (_m *MockBackend) CompleteActivityTask(ctx context.Context, task *ActivityTask, result *history.Event) error

+ func (_m *MockBackend) CompleteWorkflowTask(ctx context.Context, task *WorkflowTask, state core.WorkflowInstanceState, ...) error

+ func (_m *MockBackend) CreateWorkflowInstance(ctx context.Context, instance *core.WorkflowInstance, event *history.Event) error

+ func (_m *MockBackend) ExtendActivityTask(ctx context.Context, task *ActivityTask) error

+ func (_m *MockBackend) ExtendWorkflowTask(ctx context.Context, task *WorkflowTask) error

+ func (_m *MockBackend) FeatureSupported(feature Feature) bool

+ func (_m *MockBackend) GetActivityTask(ctx context.Context, queues []core.Queue) (*ActivityTask, error)

+ func (_m *MockBackend) GetStats(ctx context.Context) (*Stats, error)

+ func (_m *MockBackend) GetWorkflowInstanceHistory(ctx context.Context, instance *core.WorkflowInstance, lastSequenceID *int64) ([]*history.Event, error)

+ func (_m *MockBackend) GetWorkflowInstanceState(ctx context.Context, instance *core.WorkflowInstance) (core.WorkflowInstanceState, error)

+ func (_m *MockBackend) GetWorkflowTask(ctx context.Context, queues []core.Queue) (*WorkflowTask, error)

+ func (_m *MockBackend) Metrics() metrics.Client

+ func (_m *MockBackend) Options() *Options

+ func (_m *MockBackend) PrepareActivityQueues(ctx context.Context, queues []core.Queue) error

+ func (_m *MockBackend) PrepareWorkflowQueues(ctx context.Context, queues []core.Queue) error

+ func (_m *MockBackend) RemoveWorkflowInstance(ctx context.Context, instance *core.WorkflowInstance) error

+ func (_m *MockBackend) RemoveWorkflowInstances(ctx context.Context, options ...RemovalOption) error

+ func (_m *MockBackend) SignalWorkflow(ctx context.Context, instanceID string, event *history.Event) error

+ func (_m *MockBackend) Tracer() trace.Tracer

+ type Options struct

+ ActivityLockTimeout time.Duration

+ ContextPropagators []workflow.ContextPropagator

+ Converter converter.Converter

+ Logger *slog.Logger

+ MaxHistorySize int64

+ Metrics metrics.Client

+ RemoveContinuedAsNewInstances bool

+ StickyTimeout time.Duration

+ TracerProvider trace.TracerProvider

+ WorkflowLockTimeout time.Duration

+ var DefaultOptions Options = Options{ ... }

+ func ApplyOptions(opts ...BackendOption) *Options

+ type RemovalOption func(o *RemovalOptions)

+ func RemoveFinishedBatchSize(size int) RemovalOption

+ func RemoveFinishedBefore(t time.Time) RemovalOption

+ type RemovalOptions struct

+ BatchSize int

+ FinishedBefore time.Time

+ type Stats struct

+ ActiveWorkflowInstances int64

+ PendingActivityTasks map[workflow.Queue]int64

+ PendingWorkflowTasks map[workflow.Queue]int64

+ type WorkflowTask struct

+ CustomData any

+ ID string

+ LastSequenceID int64

+ Metadata *metadata.WorkflowMetadata

+ NewEvents []*history.Event

+ Queue workflow.Queue

+ WorkflowInstance *core.WorkflowInstance

+ WorkflowInstanceState core.WorkflowInstanceState