HostKit.Workspace.Agent.Client behaviour (host_kit v0.1.0-beta.0)

Copy Markdown View Source

Client boundary for communicating with workspace agents.

Summary

Callbacks

exec(t, list, keyword)
run_checks(t, list, keyword)
status(t, keyword)

Callbacks

exec(t, list, keyword)

@callback exec(String.t(), [String.t()], keyword()) :: {:ok, map()} | {:error, term()}

run_checks(t, list, keyword)

@callback run_checks(String.t(), [HostKit.Monitor.Check.t()], keyword()) ::
  {:ok, [HostKit.Monitor.Result.t()]} | {:error, term()}

status(t, keyword)

@callback status(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}