TemporalSdk.Activity (temporal_sdk v0.2.11)

View Source

Temporal activity task module.

Summary

Functions

activity_paused()

@spec activity_paused() :: boolean() | no_return()

await_data(ets_pattern)

@spec await_data(ets_pattern :: term()) ::
  {:ok, :temporal_sdk_activity.data()}
  | :timeout
  | :invalid_pattern
  | no_return()

await_data(ets_pattern, timeout)

@spec await_data(ets_pattern :: term(), timeout :: :erlang.timeout()) ::
  {:ok, :temporal_sdk_activity.data()}
  | :timeout
  | :invalid_pattern
  | no_return()

cancel(canceled_details)

@spec cancel(canceled_details :: :temporal_sdk.term_to_payloads()) :: no_return()

cancel_requested()

@spec cancel_requested() :: boolean() | no_return()

complete(result)

@spec complete(result :: :temporal_sdk.term_to_payloads()) :: no_return()

elapsed_time()

@spec elapsed_time() :: native_time :: non_neg_integer() | no_return()

elapsed_time(unit)

@spec elapsed_time(unit :: :erlang.time_unit()) :: non_neg_integer() | no_return()

fail(application_failure)

fail(class, reason, stacktrace)

@spec fail(
  class :: :error | :exit | :throw | :temporal_sdk.serializable(),
  reason :: term() | :temporal_sdk.serializable(),
  stacktrace :: :erlang.raise_stacktrace() | :temporal_sdk.serializable()
) :: no_return()

get_data()

@spec get_data() :: data :: :temporal_sdk_activity.data() | no_return()

heartbeat()

@spec heartbeat() :: :ok

heartbeat(heartbeat)

@spec heartbeat(heartbeat :: :temporal_sdk_activity.heartbeat()) :: :ok

last_heartbeat()

@spec last_heartbeat() ::
  last_heartbeat :: :temporal_sdk_activity.heartbeat() | no_return()

remaining_time()

@spec remaining_time() :: native_time :: non_neg_integer() | :infinity | no_return()

remaining_time(unit)

@spec remaining_time(unit :: :erlang.time_unit()) ::
  non_neg_integer() | :infinity | no_return()

set_data(task_data)

@spec set_data(task_data :: term()) :: :ok