aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2017-12-13 12:43:28 +0100
committerLoïc Hoguin <[email protected]>2017-12-13 12:43:28 +0100
commit572d38082f177a9b975153569b928375a5902b48 (patch)
treed9ff192b722fdd57dc411746a30edb4be49166c5 /doc
parent34473bc247138fb66d4a6739317340f4e7197625 (diff)
downloadcowboy-572d38082f177a9b975153569b928375a5902b48.tar.gz
cowboy-572d38082f177a9b975153569b928375a5902b48.tar.bz2
cowboy-572d38082f177a9b975153569b928375a5902b48.zip
Document the missing inform stream handler command2.2.0
Diffstat (limited to 'doc')
-rw-r--r--doc/src/manual/cowboy_stream.asciidoc22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_stream.asciidoc b/doc/src/manual/cowboy_stream.asciidoc
index 54983bf..ffce10b 100644
--- a/doc/src/manual/cowboy_stream.asciidoc
+++ b/doc/src/manual/cowboy_stream.asciidoc
@@ -90,6 +90,19 @@ the `early_error/5` callback must return a response command.
The following commands are defined:
+[[inform_command]]
+=== inform
+
+Send an informational response to the client.
+
+[source,erlang]
+----
+{inform, cowboy:http_status(), cowboy:http_headers()}
+----
+
+Any number of informational responses may be sent,
+but only until the final response is sent.
+
[[response_command]]
=== response
@@ -277,6 +290,15 @@ This is the raw exit message without any modification.
// TODO receive the message, and perhaps *identify* which process
// TODO gets it?
+=== inform
+
+Same as the xref:inform_command[inform command].
+
+Sent when the request process reads the body and an
+expect: 100-continue header was present in the request,
+or when the request process sends an informational
+response on its own.
+
=== response
Same as the xref:response_command[response command].