Backplane.AgentRuntime.Command behaviour (backplane_agent_runtime v1.10.11)

Copy Markdown

Authorized command execution with environment allowlists and output caps.

Shell interpretation is a separate capability. This module never claims OS sandbox guarantees; supported cleanup is declared by the CommandPort backend.

Summary

Types

t()

Callbacks

acknowledge_release(map, map)
cancel(map, map)
cancel_confirmed(map, map, pos_integer)
read(map, map, map, keyword)
reserve(map, map)
start(map, map, keyword)
write(map, map, map, binary)

Functions

acknowledge_release(command, invocation)

Acknowledge consumed cleanup evidence so a backend may retire its pinned receipt.

cancel(command, invocation)
cancel_confirmed(command, invocation, timeout)
new(namespace)
read(command, invocation, job, opts \\ [])
reserve(command, invocation)

Reserve a trusted session before launch; legacy adapters retain uncertain cleanup semantics.

start(command, invocation, opts \\ [])
workspace_conflict?(arg1, arg2)
write(command, invocation, job, chars)

Types

t()

@type t() :: map()

Callbacks

acknowledge_release(map, map)

(optional) 
@callback acknowledge_release(map(), map()) ::
  :ok | {:error, Backplane.AgentRuntime.Error.t()}

cancel(map, map)

@callback cancel(map(), map()) :: :ok | {:error, Backplane.AgentRuntime.Error.t()}

cancel_confirmed(map, map, pos_integer)

(optional) 
@callback cancel_confirmed(map(), map(), pos_integer()) ::
  :ok | {:error, Backplane.AgentRuntime.Error.t()}

read(map, map, map, keyword)

@callback read(map(), map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

reserve(map, map)

(optional) 
@callback reserve(map(), map()) :: :ok | {:error, Backplane.AgentRuntime.Error.t()}

start(map, map, keyword)

@callback start(map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

write(map, map, map, binary)

(optional) 
@callback write(map(), map(), map(), binary()) ::
  :ok | {:error, Backplane.AgentRuntime.Error.t()}

Functions

acknowledge_release(command, invocation)

Acknowledge consumed cleanup evidence so a backend may retire its pinned receipt.

cancel(command, invocation)

@spec cancel(t(), map()) :: :ok | {:error, Backplane.AgentRuntime.Error.t()}

cancel_confirmed(command, invocation, timeout)

@spec cancel_confirmed(t(), map(), pos_integer()) ::
  :ok | {:error, Backplane.AgentRuntime.Error.t()}

new(namespace)

@spec new(map()) :: {:ok, t()} | {:error, Backplane.AgentRuntime.Error.t()}

read(command, invocation, job, opts \\ [])

@spec read(t(), map(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

reserve(command, invocation)

Reserve a trusted session before launch; legacy adapters retain uncertain cleanup semantics.

start(command, invocation, opts \\ [])

@spec start(t(), map(), keyword()) ::
  {:ok, map()} | {:error, Backplane.AgentRuntime.Error.t()}

workspace_conflict?(arg1, arg2)

write(command, invocation, job, chars)

@spec write(t(), map(), map(), binary()) ::
  :ok | {:error, Backplane.AgentRuntime.Error.t()}