Packages

mint

1.2.0
1.9.3 1.9.2 1.9.1 1.9.0 1.8.0 1.7.1 1.7.0 1.6.2 1.6.1 1.6.0 1.5.2 1.5.1 1.5.0 1.4.2 1.4.1 1.4.0 1.3.0 1.2.1 1.2.0 1.1.0 1.0.0 0.5.0 0.4.0 0.3.0 0.2.1 0.2.0 0.1.0

Small and composable HTTP client.

Security advisory: This version has known vulnerabilities. View advisories
HexDocs

Current section

Files

Jump to
Readme
27 Versions
1 Dependency
111 Dependants
Files
8 Advisories
Activity
mint lib mint core transport.ex
Raw

lib/mint/core/transport.ex 

defmodule Mint.Core.Transport do

  @moduledoc false



  @type error() :: {:error, %Mint.TransportError{}}



  alias Mint.Types



  @callback connect(host :: String.t(), port :: :inet.port_number(), opts :: keyword()) ::

              {:ok, Types.socket()} | error()



  @callback upgrade(

              Types.socket(),

              original_scheme :: Types.scheme(),

              hostname :: String.t(),

              :inet.port_number(),

              opts :: keyword()

            ) :: {:ok, Types.socket()} | error()



  @callback negotiated_protocol(Types.socket()) ::

              {:ok, protocol :: binary()} | {:error, :protocol_not_negotiated}



  @callback send(Types.socket(), payload :: iodata()) :: :ok | error()



  @callback close(Types.socket()) :: :ok | error()



  @callback recv(Types.socket(), bytes :: non_neg_integer(), timeout()) ::

              {:ok, binary()} | error()



  @callback controlling_process(Types.socket(), pid()) :: :ok | error()



  @callback setopts(Types.socket(), opts :: keyword()) :: :ok | error()



  @callback getopts(Types.socket(), opts :: keyword()) :: {:ok, opts :: keyword()} | error()



  @callback wrap_error(reason :: term()) :: %Mint.TransportError{}

end