startworkflow

Documentation

Index

• Variables
• type BeforeCreateHookFunc
• type Starter
  • func NewStarter(shardContext shard.Context, ...) (*Starter, error)
  • func (s *Starter) Invoke(ctx context.Context, beforeCreateHook BeforeCreateHookFunc) (resp *historyservice.StartWorkflowExecutionResponse, retError error)

Variables

var (
	BeforeCreateHookNoop = func(lease api.WorkflowLease) error { return nil }
)

Types

type BeforeCreateHookFunc

type BeforeCreateHookFunc func(lease api.WorkflowLease) error

type Starter

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

Starter starts a new workflow execution.

func NewStarter

func NewStarter(
	shardContext shard.Context,
	workflowConsistencyChecker api.WorkflowConsistencyChecker,
	tokenSerializer common.TaskTokenSerializer,
	visibilityManager manager.VisibilityManager,
	request *historyservice.StartWorkflowExecutionRequest,
) (*Starter, error)

NewStarter creates a new starter, fails if getting the active namespace fails.

func (*Starter) Invoke

func (s *Starter) Invoke(
	ctx context.Context,
	beforeCreateHook BeforeCreateHookFunc,
) (resp *historyservice.StartWorkflowExecutionResponse, retError error)

Invoke starts a new workflow execution. NOTE: `beforeCreateHook` might be invoked more than once in the case where the workflow policy requires terminating the running workflow first; it is then invoked again on the newly started workflow.