DockerEngineAPI.Api.Session (elixir_dea v1.45.7)

API calls for all endpoints tagged Session.

Summary

Functions

Initialize interactive session Start a new interactive session with a server. Session allows server to call back to the client for advanced capabilities. ### Hijacking This endpoint hijacks the HTTP connection to HTTP2 transport that allows the client to expose gPRC services on that connection. For example, the client sends this request to upgrade the connection: POST /session HTTP/1.1 Upgrade: h2c Connection: Upgrade The Docker daemon responds with a 101 UPGRADED response follow with the raw stream: HTTP/1.1 101 UPGRADED Connection: Upgrade Upgrade: h2c

Functions

Link to this function

session(connection, opts \\ [])

@spec session(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Initialize interactive session Start a new interactive session with a server. Session allows server to call back to the client for advanced capabilities. ### Hijacking This endpoint hijacks the HTTP connection to HTTP2 transport that allows the client to expose gPRC services on that connection. For example, the client sends this request to upgrade the connection: POST /session HTTP/1.1 Upgrade: h2c Connection: Upgrade The Docker daemon responds with a 101 UPGRADED response follow with the raw stream: HTTP/1.1 101 UPGRADED Connection: Upgrade Upgrade: h2c

Parameters

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

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure