Temporalex.Client (Temporalex v0.4.2)

Copy Markdown View Source

Client owner and public API for workflow operations.

A client owns the backend connection resources. Workflow operations resolve a current backend handle from the client process and then call the backend directly; the client process is not a request proxy.

Summary

Functions

cancel_workflow(handle, opts \\ [])
cancel_workflow(client, workflow_id, opts)
child_spec(init_arg)

Returns a specification to start this module under a supervisor.

connection(connection)
describe_workflow(handle, opts \\ [])
describe_workflow(client, workflow_id, opts)
fetch_workflow_history(handle, opts \\ [])

Fetches a workflow's history as an opaque binary.

fetch_workflow_history(client, workflow_id, opts)
get_result(handle, opts \\ [])
query_workflow(handle, query_name)
query_workflow(handle, query_name, args)
query_workflow(handle, query_name, args, opts)
query_workflow(client, workflow_id, query_name, args, opts \\ [])
signal_workflow(handle, signal_name)
signal_workflow(handle, signal_name, args)
signal_workflow(handle, signal_name, args, opts)
signal_workflow(client, workflow_id, signal_name, args, opts \\ [])
start_link(opts)
start_workflow(client, workflow, input, opts \\ [])
terminate_workflow(handle, opts \\ [])
terminate_workflow(client, workflow_id, opts)
update_workflow(handle, update_name)
update_workflow(handle, update_name, args)
update_workflow(handle, update_name, args, opts)
update_workflow(client, workflow_id, update_name, args, opts \\ [])

Functions

cancel_workflow(handle, opts \\ [])

cancel_workflow(client, workflow_id, opts)

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

connection(connection)

describe_workflow(handle, opts \\ [])

describe_workflow(client, workflow_id, opts)

fetch_workflow_history(handle, opts \\ [])

Fetches a workflow's history as an opaque binary.

Feed the result to Temporalex.Replay to check current workflow code against a real execution, or write it to a file as a replay fixture. Treat it as opaque — it is encoded protobuf, and parsing it in application code would put backend transport detail somewhere it does not belong.

fetch_workflow_history(client, workflow_id, opts)

get_result(handle, opts \\ [])

query_workflow(handle, query_name)

query_workflow(handle, query_name, args)

query_workflow(handle, query_name, args, opts)

query_workflow(client, workflow_id, query_name, args, opts \\ [])

signal_workflow(handle, signal_name)

signal_workflow(handle, signal_name, args)

signal_workflow(handle, signal_name, args, opts)

signal_workflow(client, workflow_id, signal_name, args, opts \\ [])

start_link(opts)

start_workflow(client, workflow, input, opts \\ [])

terminate_workflow(handle, opts \\ [])

terminate_workflow(client, workflow_id, opts)

update_workflow(handle, update_name)

update_workflow(handle, update_name, args)

update_workflow(handle, update_name, args, opts)

update_workflow(client, workflow_id, update_name, args, opts \\ [])