Continuum.Activity.Context (continuum v0.7.1)

Copy Markdown View Source

Runtime context passed to activities declared with context: true.

Use heartbeat/2 to persist bounded progress and cancelled?/1 between chunks of external work to cooperate with workflow cancellation.

Summary

Types

t()

Functions

cancelled?(context)

Returns true when the run was cancelled or this worker lost its task lease.

heartbeat(context, details)

Persists the latest progress details using the activity task's lease fence.

Types

t()

@type t() :: %Continuum.Activity.Context{
  attempt: pos_integer(),
  instance: Continuum.Runtime.Instance.t(),
  lease_owner: binary() | nil,
  mode: :durable | :inline,
  run_id: binary(),
  task_id: binary()
}

Functions

cancelled?(context)

@spec cancelled?(t()) :: boolean()

Returns true when the run was cancelled or this worker lost its task lease.

heartbeat(context, details)

@spec heartbeat(t(), term()) :: :ok | {:error, :cancelled | :lease_lost}

Persists the latest progress details using the activity task's lease fence.