ExDaytona.Api.Port (ex_daytona v0.2.0)

Copy Markdown View Source

API calls for all endpoints tagged Port.

Summary

Functions

get_ports(connection, opts \\ [])

Get active ports Get a list of all currently active ports

is_port_in_use(connection, port, opts \\ [])

Check if port is in use Check if a specific port is currently in use

Functions

get_ports(connection, opts \\ [])

@spec get_ports(
  Tesla.Env.client(),
  keyword()
) :: {:ok, ExDaytona.Model.PortList.t()} | {:error, Tesla.Env.t()}

Get active ports Get a list of all currently active ports

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExDaytona.Model.PortList.t} on success
  • {:error, Tesla.Env.t} on failure

is_port_in_use(connection, port, opts \\ [])

@spec is_port_in_use(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, ExDaytona.Model.ErrorResponse.t()}
  | {:ok, ExDaytona.Model.IsPortInUseResponse.t()}
  | {:error, Tesla.Env.t()}

Check if port is in use Check if a specific port is currently in use

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • port (integer()): Port number (3000-9999)
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExDaytona.Model.IsPortInUseResponse.t} on success
  • {:error, Tesla.Env.t} on failure