aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/gun_trailers.asciidoc
blob: 89214197b4ad63751e08e40dff08bfbaeb77e4c9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
= gun_trailers(3)

== Name

gun_trailers - Response trailers

== Description

[source,erlang]
----
{gun_trailers, ConnPid, StreamRef, Headers}

ConnPid   :: pid()
StreamRef :: reference()
Headers   :: [{binary(), binary()}]
----

Response trailers.

This message informs the relevant process that the server
sent response trailers for the response to the original
request.

A trailers message terminates the response.

== Elements

ConnPid::

The pid of the Gun connection process.

StreamRef::

Identifier of the stream for the original request.

Headers::

Trailing headers sent after the response body.

== Changelog

* *1.0*: Message introduced.

== Examples

.Receive a gun_trailers message in a gen_server
[source,erlang]
----
handle_info({gun_trailers, ConnPid, _StreamRef, _Headers},
            State=#state{conn_pid=ConnPid}) ->
    %% Do something.
    {noreply, State}.
----

== See also

link:man:gun(3)[gun(3)],
link:man:gun:get(3)[gun:get(3)],
link:man:gun:head(3)[gun:head(3)],
link:man:gun:patch(3)[gun:patch(3)],
link:man:gun:post(3)[gun:post(3)],
link:man:gun:put(3)[gun:put(3)],
link:man:gun:delete(3)[gun:delete(3)],
link:man:gun:options(3)[gun:options(3)],
link:man:gun:headers(3)[gun:headers(3)],
link:man:gun:request(3)[gun:request(3)],
link:man:gun_response(3)[gun_response(3)],
link:man:gun_data(3)[gun_data(3)]