BeamConsoleWeb.Console.RecordingControlClient (beam_console v0.5.0)

Copy Markdown View Source

Provides an outage-safe boundary around operator recording control.

Summary

Functions

Pauses recording through the authoritative control process.

Resumes recording through the authoritative control process.

Returns authoritative recording control state when available.

Subscribes the caller to authoritative recording-state transitions.

Types

call_error()

@type call_error() :: {:error, :timeout | :unavailable}

server()

@type server() :: GenServer.server() | nil

Functions

pause(server \\ Control, timeout \\ 250)

@spec pause(server(), timeout()) ::
  {:ok, BeamConsole.Recording.Status.t()} | call_error()

Pauses recording through the authoritative control process.

resume(server \\ Control, timeout \\ 250)

@spec resume(server(), timeout()) ::
  {:ok, BeamConsole.Recording.Status.t()} | call_error()

Resumes recording through the authoritative control process.

status(server \\ Control, timeout \\ 250)

@spec status(server(), timeout()) ::
  {:ok, BeamConsole.Recording.Status.t()} | call_error()

Returns authoritative recording control state when available.

subscribe(server \\ Control, timeout \\ 250)

@spec subscribe(server(), timeout()) ::
  {:ok, BeamConsole.Recording.Status.t()} | call_error()

Subscribes the caller to authoritative recording-state transitions.