Name

gun_notify - Optional event notification

Description

{gun_notify, ConnPid, settings_changed, Settings}

ConnPid  :: pid()
Settings :: map()

Optional event notification.

Only two event notifications currently exist:

  • settings_changed informs the user that the server has modified its connection settings.

  • ping_ack informs the user that acknowledgement for a user ping was received.

Elements

ConnPid

The pid of the Gun connection process.

Event

Identifier for the event. Currently can only be settings_changed or ping_ack.

Data

Data for the event. Currently can only be the new connection settings, or the ping reference.

Changelog

  • 2.2: Message introduced.

Examples

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

See also

gun(3), gun:ping(3)