gun:stream_info(3)

Name

gun:stream_info - Obtain information about a stream

Description

stream_info(ConnPid, StreamRef) -> {ok, undefined | Info} | {error, not_connected}

ConnPid :: pid()
StreamRef :: gun:stream_ref()
Info :: #{
    ref            => gun:stream_ref(),
    reply_to       => pid(),
    state          => running | stopping,
    intermediaries => [Intermediary],
    tunnel         => Tunnel
}
Intermediary :: #{
    type      => connect | socks5,
    host      => inet:hostname() | inet:ip_address(),
    port      => inet:port_number(),
    transport => tcp | tls,
    protocol  => http | http2 | socks | raw
}
Tunnel :: #{
    transport     => tcp | tls,
    protocol      => http | http2 | socks | raw,
    origin_scheme => binary() | undefined,
    origin_host   => inet:hostname() | inet:ip_address(),
    origin_port   => inet:port_number()
}

Obtain information about a stream.

Arguments

ConnPid

The pid of the Gun connection process.

StreamRef

Identifier of the stream for the original request.

Return value

A map is returned containing various informations about the stream.

Changelog

  • 2.0: Function introduced.

Examples

Obtain information about a stream
Info = gun:stream_info(ConnPid, StreamRef).

See also

gun(3), gun:get(3), gun:head(3), gun:options(3), gun:patch(3), gun:post(3), gun:put(3), gun:delete(3), gun:headers(3), gun:request(3), gun:cancel(3)

Gun 2.0 Function Reference

Navigation

Version select

Like my work? Donate!

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

Recurring payment options are also available via GitHub Sponsors. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.