forked from boostorg/beast
Doc fixes
This commit is contained in:
@@ -47,7 +47,6 @@ API Changes:
|
|||||||
* Relax ForwardIterator requirements in FieldSequence
|
* Relax ForwardIterator requirements in FieldSequence
|
||||||
* Fix websocket failure testing
|
* Fix websocket failure testing
|
||||||
* Refine Writer concept and fix exemplar in documentation
|
* Refine Writer concept and fix exemplar in documentation
|
||||||
* Improve websocket example
|
|
||||||
|
|
||||||
API Changes:
|
API Changes:
|
||||||
|
|
||||||
|
@@ -123,7 +123,7 @@ These statements set fields in request and response message objects:
|
|||||||
req.body = "";
|
req.body = "";
|
||||||
|
|
||||||
response<string_body> res;
|
response<string_body> res;
|
||||||
res.version = 10; // HTTP/1.0
|
res.version = 10; // HTTP/1.0
|
||||||
res.status = 404;
|
res.status = 404;
|
||||||
res.reason = "Not Found";
|
res.reason = "Not Found";
|
||||||
res.headers.insert("Server", "Beast.HTTP");
|
res.headers.insert("Server", "Beast.HTTP");
|
||||||
|
@@ -34,7 +34,7 @@
|
|||||||
<member><link linkend="beast.ref.http__basic_parser_v1">basic_parser_v1</link></member>
|
<member><link linkend="beast.ref.http__basic_parser_v1">basic_parser_v1</link></member>
|
||||||
<member><link linkend="beast.ref.http__empty_body">empty_body</link></member>
|
<member><link linkend="beast.ref.http__empty_body">empty_body</link></member>
|
||||||
<member><link linkend="beast.ref.http__headers">headers</link></member>
|
<member><link linkend="beast.ref.http__headers">headers</link></member>
|
||||||
<member><link linkend="beast.ref.http__headers_parser">headers_parser</link></member>
|
<member><link linkend="beast.ref.http__headers_parser_v1">headers_parser_v1</link></member>
|
||||||
<member><link linkend="beast.ref.http__message">message</link></member>
|
<member><link linkend="beast.ref.http__message">message</link></member>
|
||||||
<member><link linkend="beast.ref.http__message_headers">message_headers</link></member>
|
<member><link linkend="beast.ref.http__message_headers">message_headers</link></member>
|
||||||
<member><link linkend="beast.ref.http__parser_v1">parser_v1</link></member>
|
<member><link linkend="beast.ref.http__parser_v1">parser_v1</link></member>
|
||||||
@@ -59,7 +59,6 @@
|
|||||||
<member><link linkend="beast.ref.http__async_parse">async_parse</link></member>
|
<member><link linkend="beast.ref.http__async_parse">async_parse</link></member>
|
||||||
<member><link linkend="beast.ref.http__async_read">async_read</link></member>
|
<member><link linkend="beast.ref.http__async_read">async_read</link></member>
|
||||||
<member><link linkend="beast.ref.http__async_write">async_write</link></member>
|
<member><link linkend="beast.ref.http__async_write">async_write</link></member>
|
||||||
<member><link linkend="beast.ref.http__async_write">async_write</link></member>
|
|
||||||
<member><link linkend="beast.ref.http__is_keep_alive">is_keep_alive</link></member>
|
<member><link linkend="beast.ref.http__is_keep_alive">is_keep_alive</link></member>
|
||||||
<member><link linkend="beast.ref.http__is_upgrade">is_upgrade</link></member>
|
<member><link linkend="beast.ref.http__is_upgrade">is_upgrade</link></member>
|
||||||
<member><link linkend="beast.ref.http__parse">parse</link></member>
|
<member><link linkend="beast.ref.http__parse">parse</link></member>
|
||||||
@@ -74,7 +73,7 @@
|
|||||||
<member><link linkend="beast.ref.http__is_Body">is_Body</link></member>
|
<member><link linkend="beast.ref.http__is_Body">is_Body</link></member>
|
||||||
<member><link linkend="beast.ref.http__is_Parser">is_Parser</link></member>
|
<member><link linkend="beast.ref.http__is_Parser">is_Parser</link></member>
|
||||||
<member><link linkend="beast.ref.http__is_Reader">is_Reader</link></member>
|
<member><link linkend="beast.ref.http__is_Reader">is_Reader</link></member>
|
||||||
<member><link linkend="beast.ref.http__is_Writer">is_Reader</link></member>
|
<member><link linkend="beast.ref.http__is_Writer">is_Writer</link></member>
|
||||||
<member><link linkend="beast.ref.http__has_reader">has_reader</link></member>
|
<member><link linkend="beast.ref.http__has_reader">has_reader</link></member>
|
||||||
<member><link linkend="beast.ref.http__has_writer">has_writer</link></member>
|
<member><link linkend="beast.ref.http__has_writer">has_writer</link></member>
|
||||||
</simplelist>
|
</simplelist>
|
||||||
|
@@ -267,10 +267,10 @@
|
|||||||
select="concat(substring-before($name, '*'), '_star_', substring-after($name, '*'))"/>
|
select="concat(substring-before($name, '*'), '_star_', substring-after($name, '*'))"/>
|
||||||
</xsl:call-template>
|
</xsl:call-template>
|
||||||
</xsl:when>
|
</xsl:when>
|
||||||
<xsl:when test="contains($name, '~')">
|
<xsl:when test="starts-with($name, '~')">
|
||||||
<xsl:call-template name="make-id">
|
<xsl:call-template name="make-id">
|
||||||
<xsl:with-param name="name"
|
<xsl:with-param name="name"
|
||||||
select="concat(substring-before($name, '~'), '_', substring-after($name, '~'))"/>
|
select="concat(substring-after($name, '~'), '_dtor_')"/>
|
||||||
</xsl:call-template>
|
</xsl:call-template>
|
||||||
</xsl:when>
|
</xsl:when>
|
||||||
<xsl:when test="contains($name, ' ')">
|
<xsl:when test="contains($name, ' ')">
|
||||||
|
@@ -40,7 +40,7 @@ struct response_parser_base
|
|||||||
|
|
||||||
This class uses the HTTP/1 wire format parser to
|
This class uses the HTTP/1 wire format parser to
|
||||||
convert a series of octets into a @ref request_headers
|
convert a series of octets into a @ref request_headers
|
||||||
or @ref @response_headers.
|
or @ref response_headers.
|
||||||
|
|
||||||
@note A new instance of the parser is required for each message.
|
@note A new instance of the parser is required for each message.
|
||||||
*/
|
*/
|
||||||
|
@@ -174,7 +174,7 @@ public:
|
|||||||
/** Returns ownership of the parsed message.
|
/** Returns ownership of the parsed message.
|
||||||
|
|
||||||
Ownership is transferred to the caller. Only
|
Ownership is transferred to the caller. Only
|
||||||
valid if @ref complete` would return `true`.
|
valid if @ref complete would return `true`.
|
||||||
|
|
||||||
Requires:
|
Requires:
|
||||||
`message<isRequest, Body, Headers>` is @b MoveConstructible
|
`message<isRequest, Body, Headers>` is @b MoveConstructible
|
||||||
@@ -303,7 +303,7 @@ private:
|
|||||||
@param args Forwarded to the body constructor of the message
|
@param args Forwarded to the body constructor of the message
|
||||||
in the new parser.
|
in the new parser.
|
||||||
|
|
||||||
@return A parser for a message with the specified @ref Body type.
|
@return A parser for a message with the specified @b Body type.
|
||||||
|
|
||||||
@par Example
|
@par Example
|
||||||
@code
|
@code
|
||||||
|
Reference in New Issue
Block a user