Vibe.Remote.SSH.Attachment (vibe v0.2.2)

Copy Markdown View Source

Long-polling SSH attachment bridge for session events.

Summary

Types

start_result()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

detach(id)
next_events(id, timeout_ms \\ 30000)
start(session_id)
start_link(opts)

Types

start_result()

@type start_result() ::
  {:ok, %{id: String.t(), state: term(), cursor: non_neg_integer()}}

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

detach(id)

@spec detach(String.t()) :: :ok | {:error, term()}

next_events(id, timeout_ms \\ 30000)

@spec next_events(String.t(), timeout()) :: {:ok, [Vibe.Event.t()]} | {:error, term()}

start(session_id)

@spec start(String.t()) :: start_result() | {:error, term()}

start_link(opts)

@spec start_link(keyword()) :: GenServer.on_start()