ExecutionPlane.Runtime.Client behaviour (execution_plane v0.2.0)

Copy Markdown View Source

Consumer-to-node admitted interactive lifecycle.

start/2 owns admission and returns only opaque execution/session identity. Implementations must not expose provider or transport process identifiers.

Summary

Callbacks

cancel(t, keyword)

@callback cancel(
  ExecutionPlane.ExecutionRef.t(),
  keyword()
) :: :ok | {:error, term()}

end_input(t, keyword)

@callback end_input(
  ExecutionPlane.ExecutionRef.t(),
  keyword()
) :: :ok | {:error, term()}

send_input(t, arg2, keyword)

@callback send_input(ExecutionPlane.ExecutionRef.t(), iodata() | map(), keyword()) ::
  :ok | {:error, term()}

start(t, keyword)

@callback start(
  ExecutionPlane.Admission.Request.t(),
  keyword()
) :: {:ok, ExecutionPlane.ActiveExecution.t()} | {:error, term()}

status(t, keyword)

@callback status(
  ExecutionPlane.ExecutionRef.t(),
  keyword()
) :: {:ok, ExecutionPlane.Runtime.Status.t()} | {:error, term()}

subscribe(t, pid, keyword)

@callback subscribe(ExecutionPlane.ExecutionRef.t(), pid(), keyword()) ::
  :ok | {:error, term()}