From 572d38082f177a9b975153569b928375a5902b48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 13 Dec 2017 12:43:28 +0100 Subject: Document the missing inform stream handler command --- doc/src/manual/cowboy_stream.asciidoc | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'doc') 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]. -- cgit v1.2.3