aboutsummaryrefslogtreecommitdiffstats
path: root/guide
diff options
context:
space:
mode:
Diffstat (limited to 'guide')
-rw-r--r--guide/http.md13
-rw-r--r--guide/protocols.md6
2 files changed, 16 insertions, 3 deletions
diff --git a/guide/http.md b/guide/http.md
index 98a042e..e6b5f64 100644
--- a/guide/http.md
+++ b/guide/http.md
@@ -206,3 +206,16 @@ one for the request this stream is associated with.
Pushed streams typically feature a body. Replying to a pushed
stream is forbidden and Gun will send an error message if
attempted.
+
+Pushed streams can be received like this:
+
+``` erlang
+receive
+ {gun_push, Pid, PushedStreamRef, StreamRef,
+ Method, Host, Path, Headers} ->
+ %% ...
+end
+```
+
+The pushed stream gets a new identifier but you still receive
+the `StreamRef` this stream is associated to.
diff --git a/guide/protocols.md b/guide/protocols.md
index 87ab0cf..c3aef6f 100644
--- a/guide/protocols.md
+++ b/guide/protocols.md
@@ -64,9 +64,9 @@ Messages by protocol
This table lists all messages that can be received depending
on the current protocol.
-| Message | SPDY | HTTP | Websocket |
-| -------------------------------- | ---- | ---- | --------- |
-| {gun_request, ...} | yes | no | no |
+| Message | SPDY | HTTP | Websocket |
+| ------------------------------- | ---- | ---- | --------- |
+| {gun_push, ...} | yes | no | no |
| {gun_response, ...} | yes | yes | no |
| {gun_data, ...} | yes | yes | no |
| {gun_error, _, StreamRef, _} | yes | yes | no |