Name

gun_up - The connection is up

Description

{gun_up, ConnPid, Protocol}

ConnPid  :: pid()
Protocol :: http | http2 | raw | socks

The connection is up.

This message informs the owner process that the connection or reconnection completed.

If Gun is configured to connect to a Socks server, then the connection is not usable yet. One or more gun_tunnel_up(3) messages will follow.

Otherwise, Gun will start processing the messages it received while waiting for the connection to be up. If this is a reconnection, then this may not be desirable for all requests. Those requests should be cancelled when the connection goes down, and any subsequent messages ignored.

Elements

ConnPid

The pid of the Gun connection process.

Protocol

The protocol selected for this connection. It can be used to determine the capabilities of the server.

Changelog

  • 1.0: Message introduced.

Examples

Receive a gun_up message in a gen_server
handle_info({gun_up, ConnPid, _Protocol},
            State=#state{conn_pid=ConnPid}) ->
    %% Do something.
    {noreply, State}.

See also

gun(3), gun:open(3), gun:open_unix(3), gun:await_up(3), gun_tunnel_up(3), gun_down(3), gun_error(3)