Browse Source

Document the missing inform stream handler command

Loïc Hoguin 7 years ago
parent
commit
cf5e96a25b
1 changed files with 22 additions and 0 deletions
  1. 22 0
      doc/src/manual/cowboy_stream.asciidoc

+ 22 - 0
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:
 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_command]]
 === response
 === response
 
 
@@ -277,6 +290,15 @@ This is the raw exit message without any modification.
 // TODO receive the message, and perhaps *identify* which process
 // TODO receive the message, and perhaps *identify* which process
 // TODO gets it?
 // 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
 === response
 
 
 Same as the xref:response_command[response command].
 Same as the xref:response_command[response command].