package
0.7.5
Repository: https://github.com/mikolajb/cadence-client.git
Documentation: pkg.go.dev

# Functions

ExecuteActivity requests activity execution in the context of a workflow.
ExecuteChildWorkflow requests child workflow execution in the context of a workflow.
ExecuteLocalActivity requests to run a local activity.
GetInfo extracts info of a current workflow from a context.
GetLogger returns a logger to be used in workflow's context.
GetMetricsScope returns a metrics scope to be used in workflow's context.
GetSignalChannel returns channel corresponding to the signal name.
GetVersion is used to safely perform backwards incompatible changes to workflow definitions.
Go creates a new coroutine.
GoNamed creates a new coroutine with a given human readable name.
IsReplaying returns whether the current workflow code is replaying.
MutableSideEffect executes the provided function once, then it looks up the history for the value with the given id.
NewBufferedChannel create new buffered Channel instance.
NewChannel create new Channel instance.
NewContinueAsNewError creates ContinueAsNewError instance If the workflow main function returns this error then the current execution is ended and the new execution with same workflow ID is started automatically with options provided to this function.
NewDisconnectedContext returns a new context that won't propagate parent's cancellation to the new child context.
NewFuture creates a new future as well as associated Settable that is used to set its value.
NewHeartbeatTimeoutError creates TimeoutError instance WARNING: This function is public only to support unit testing of workflows.
NewNamedBufferedChannel create new BufferedChannel instance with a given human readable name.
NewNamedChannel create new Channel instance with a given human readable name.
NewNamedSelector creates a new Selector instance with a given human readable name.
NewSelector creates a new Selector instance.
NewTimeoutError creates TimeoutError instance.
NewTimer returns immediately and the future becomes ready after the specified duration d.
Now returns the current time when the decision is started or replayed.
Register - registers a workflow function with the framework.
RegisterWithOptions registers the workflow function with options The user can use options to provide an external name for the workflow or leave it empty if no external name is required.
RequestCancelExternalWorkflow can be used to request cancellation of an external workflow.
SetQueryHandler sets the query handler to handle workflow query.
SideEffect executes the provided function once, records its result into the workflow history.
SignalExternalWorkflow can be used to send signal info to an external workflow.
Sleep pauses the current workflow for at least the duration d.
WithActivityOptions adds all options to the copy of the context.
WithCancel returns a copy of parent with a new Done channel.
WithChildOptions adds all workflow options to the context.
WithChildPolicy adds a ChildWorkflowPolicy to the context.
WithDataConverter adds DataConverter to the context.
WithExecutionStartToCloseTimeout adds a workflow execution timeout to the context.
WithHeartbeatTimeout adds a timeout to the copy of the context.
WithLocalActivityOptions adds options for local activity to context.
WithScheduleToCloseTimeout adds a timeout to the copy of the context.
WithScheduleToStartTimeout adds a timeout to the copy of the context.
WithStartToCloseTimeout adds a timeout to the copy of the context.
WithTaskList adds a task list to the copy of the context.
WithValue returns a copy of parent in which the value associated with key is val.
WithWaitForCancellation adds wait for the cacellation to the copy of the context.
WithWorkflowDomain adds a domain to the context.
WithWorkflowID adds a workflowID to the context.
WithWorkflowTaskList adds a task list to the context.
WithWorkflowTaskStartToCloseTimeout adds a decision timeout to the context.

# Constants

ChildWorkflowPolicyAbandon is policy that will have no impact to child workflow execution when parent workflow is terminated.
ChildWorkflowPolicyRequestCancel is policy that will send cancel request to all open child workflows when parent workflow is terminated.
ChildWorkflowPolicyTerminate is policy that will terminate all child workflows when parent workflow is terminated.
DefaultVersion is a version returned by GetVersion for code that wasn't versioned before.

# Variables

ErrCanceled is the error returned by Context.Err when the context is canceled.
ErrDeadlineExceeded is the error returned by Context.Err when the context's deadline passes.

# Type aliases

ActivityOptions stores all activity-specific invocation parameters that will be stored inside of a context.
A CancelFunc tells an operation to abandon its work.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Context is a clone of context.Context with Done() returning Channel instead of native channel.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
LocalActivityOptions doc.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author