CliSubprocessCore.RuntimeGateway behaviour (CliSubprocessCore v0.3.0)

Copy Markdown View Source

Complete local CLI process lifecycle boundary.

Summary

Callbacks

cancel(t, term)
end_input(t)
info(t)
send_input(t, iodata)
start_session(t)
subscribe(t, pid)
terminate(t, term)

Callbacks

cancel(t, term)

@callback cancel(CliSubprocessCore.RuntimeGateway.Session.t(), term()) ::
  :ok | {:error, CliSubprocessCore.RuntimeGateway.Error.t()}

end_input(t)

@callback end_input(CliSubprocessCore.RuntimeGateway.Session.t()) ::
  :ok | {:error, CliSubprocessCore.RuntimeGateway.Error.t()}

info(t)

@callback info(CliSubprocessCore.RuntimeGateway.Session.t()) ::
  {:ok, CliSubprocessCore.RuntimeGateway.Status.t()}
  | {:error, CliSubprocessCore.RuntimeGateway.Error.t()}

send_input(t, iodata)

@callback send_input(CliSubprocessCore.RuntimeGateway.Session.t(), iodata()) ::
  :ok | {:error, CliSubprocessCore.RuntimeGateway.Error.t()}

start_session(t)

@callback start_session(CliSubprocessCore.RuntimeGateway.StartRequest.t()) ::
  {:ok, CliSubprocessCore.RuntimeGateway.Session.t()}
  | {:error, CliSubprocessCore.RuntimeGateway.Error.t()}

subscribe(t, pid)

@callback subscribe(CliSubprocessCore.RuntimeGateway.Session.t(), pid()) ::
  :ok | {:error, CliSubprocessCore.RuntimeGateway.Error.t()}

terminate(t, term)

@callback terminate(CliSubprocessCore.RuntimeGateway.Session.t(), term()) ::
  :ok | {:error, CliSubprocessCore.RuntimeGateway.Error.t()}