k8s v2.0.0-rc.6

View Source K8s.Client.Mint.Request (k8s v2.0.0-rc.6)

Maintains the state of a HTTP or Websocket request.

Link to this section Summary

Types

request_modes()

Describes the mode the request is currently in.

t()

Defines the state of the request.

Functions

map_frame(arg)
map_outgoing_frame(data)
map_response(arg)
maybe_terminate_request(request)
new(fields)
put_response(request, response)
receive_upgrade_response(conn, ref)
recv(request, from)

Link to this section Types

Link to this type

request_modes()

View Source 
@type request_modes() :: :receiving | :closing | :terminating | :closed

Describes the mode the request is currently in.

  • :receiving - The request is currently receiving response parts / frames
  • :closing - Websocket requests only: The :close frame was received but the process wasn't terminated yet
  • :terminating - HTTP requests only: The :done part was received but the request isn't cleaned up yet
  • :closed - The websocket request is closed. The process is going to terminate any moment now
Link to this type

t()

View Source 
@type t() :: %K8s.Client.Mint.Request{
  buffer: list(),
  caller_ref: reference(),
  mode: request_modes(),
  pool: pid() | nil,
  stream_to: pid() | {pid(), reference()} | nil,
  websocket: Mint.WebSocket.t() | nil
}

Defines the state of the request.

  • :caller_ref - ,onitor reference of the calling process.
  • :stream_to - the process expecting response parts sent to.
  • :pool - the PID of the pool so we can checkin after the last part is sent.
  • :websocket - for WebSocket requests: The websocket state (Mint.WebSocket.t()).
  • :mode - defines what mode the request is currently in.
  • :buffer - Holds the buffered response parts or frames that haven't been sent to / received by the caller yet

Link to this section Functions

Link to this function

map_frame(arg)

View Source 
@spec map_frame({:binary, binary()} | {:close, any(), any()}) ::
  {:close, {integer(), binary()}}
  | {:error, binary()}
  | {:stderr, binary()}
  | {:stdout, binary()}
Link to this function

map_outgoing_frame(data)

View Source 
@spec map_outgoing_frame(
  {:stdin, binary()}
  | {:close, integer(), binary()}
  | :close
  | :exit
) ::
  {:ok, :close | {:text, binary()} | {:close, integer(), binary()}}
  | K8s.Client.HTTPError.t()
Link to this function

map_response(arg)

View Source 
@spec map_response({:done, reference()} | {atom(), reference(), any()}) ::
  {:done | {atom(), any()}, reference()}
Link to this function

maybe_terminate_request(request)

View Source 
@spec maybe_terminate_request(t()) :: {t() | :stop, t()} | :pop
Link to this function

new(fields)

View Source 
@spec new(keyword()) :: t()
Link to this function

put_response(request, response)

View Source 
@spec put_response(t(), :done | {atom(), any()}) :: :pop | {t() | :stop, t()}
Link to this function

receive_upgrade_response(conn, ref)

View Source 
@spec receive_upgrade_response(Mint.HTTP.t(), reference()) ::
  {:ok, Mint.HTTP.t(), map()} | {:error, Mint.HTTP.t(), Mint.Types.error()}
Link to this function

recv(request, from)

View Source 
@spec recv(t(), GenServer.from()) :: :pop | {t() | :stop, t()}