feedc0de/boost_beast
1
0
Fork 0
forked from boostorg/beast
Code Pull Requests Activity
Files
04a0c9d91d6ea9c54c38d2e3e8f16c60a3ba4e8b
boost_beast/doc/quickref.xml

265 lines
15 KiB
XML
Raw Normal View History

Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" "boostbook.dtd">
<!--
Copyright (c) 2013-2016 Vinnie Falco (vinnie dot falco at gmail dot com)
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-->
<informaltable frame="all">
<tgroup cols="4">
<colspec colname="a"/>
<colspec colname="b"/>
<colspec colname="c"/>
<colspec colname="d"/>
<thead>
<row>
Tidy up documentation: fix #135 * Fix broken references * Move doc debug headers to extras/ * Add rfc7230 utility classes to quick reference
2016-10-15 21:39:24 -04:00
<entry valign="center" namest="a" nameend="c">
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<bridgehead renderas="sect2">HTTP</bridgehead>
</entry>
Tidy up documentation: fix #135 * Fix broken references * Move doc debug headers to extras/ * Add rfc7230 utility classes to quick reference
2016-10-15 21:39:24 -04:00
<entry valign="center" namest="d" nameend="d">
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<bridgehead renderas="sect2">WebSocket</bridgehead>
</entry>
</row>
</thead>
<tbody>
<row>
<entry valign="top">
<bridgehead renderas="sect3">Classes</bridgehead>
<simplelist type="vert" columns="1">
Rename concept to DynamicBuffer (API change): Conform to the Networking TS by renaming the Streambuf concept to DynamicBuffer in all places. Values of types meeting the requirements of DynamicBuffer are renamed to dynabuf. See: http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/n4478.html#requirements.dynamic_buffers * Headers renamed * Formal parameter names renamed * Template argument types renamed * Documentation updated
2016-05-28 09:23:54 -04:00
<member><link linkend="beast.ref.http__basic_dynabuf_body">basic_dynabuf_body</link></member>
Refactor HTTP identifier names (API Change): fix #171 Several names and HTTP identifiers are renamed to be more consistent, self-explanatory, and concise: * "Fields" is a collection of HTTP header fields (rfc7230 section 3.2) * "Header" is the Start Line plus Fields. Another way to look at it is, the HTTP message minus the body. * `basic_fields` replaces `basic_headers` * `fields` replaces `headers` * `Fields` replaces `Headers` in template parameter lists * `header` replaces `message_headers` * `header::fields` replaces `message_headers::fields` The changes are cosmetic and do not affect run-time behavior.
2016-11-10 05:34:49 -05:00
<member><link linkend="beast.ref.http__basic_fields">basic_fields</link></member>
Tidy up tests, build scripts, and documentation: * Concepts split up into individual files * Function definitions moved to .ipp files * Add more tests to fill gaps in coverage * Fix documentation Xsl
2016-05-01 12:33:35 -04:00
<member><link linkend="beast.ref.http__basic_parser_v1">basic_parser_v1</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.http__empty_body">empty_body</link></member>
Refactor HTTP identifier names (API Change): fix #171 Several names and HTTP identifiers are renamed to be more consistent, self-explanatory, and concise: * "Fields" is a collection of HTTP header fields (rfc7230 section 3.2) * "Header" is the Start Line plus Fields. Another way to look at it is, the HTTP message minus the body. * `basic_fields` replaces `basic_headers` * `fields` replaces `headers` * `Fields` replaces `Headers` in template parameter lists * `header` replaces `message_headers` * `header::fields` replaces `message_headers::fields` The changes are cosmetic and do not affect run-time behavior.
2016-11-10 05:34:49 -05:00
<member><link linkend="beast.ref.http__fields">fields</link></member>
<member><link linkend="beast.ref.http__header">header</link></member>
<member><link linkend="beast.ref.http__header_parser_v1">header_parser_v1</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.http__message">message</link></member>
Tidy up documentation: fix #135 * Fix broken references * Move doc debug headers to extras/ * Add rfc7230 utility classes to quick reference
2016-10-15 21:39:24 -04:00
<member><link linkend="beast.ref.http__parser_v1">parser_v1</link></member>
Refine message class hierarchy: Two new objects, request_headers and response_headers, represent the portion of HTTP messages excluding the body.
2016-10-09 06:34:35 -04:00
<member><link linkend="beast.ref.http__request">request</link></member>
Refactor HTTP identifier names (API Change): fix #171 Several names and HTTP identifiers are renamed to be more consistent, self-explanatory, and concise: * "Fields" is a collection of HTTP header fields (rfc7230 section 3.2) * "Header" is the Start Line plus Fields. Another way to look at it is, the HTTP message minus the body. * `basic_fields` replaces `basic_headers` * `fields` replaces `headers` * `Fields` replaces `Headers` in template parameter lists * `header` replaces `message_headers` * `header::fields` replaces `message_headers::fields` The changes are cosmetic and do not affect run-time behavior.
2016-11-10 05:34:49 -05:00
<member><link linkend="beast.ref.http__request_header">request_header</link></member>
Refine message class hierarchy: Two new objects, request_headers and response_headers, represent the portion of HTTP messages excluding the body.
2016-10-09 06:34:35 -04:00
<member><link linkend="beast.ref.http__response">response</link></member>
Refactor HTTP identifier names (API Change): fix #171 Several names and HTTP identifiers are renamed to be more consistent, self-explanatory, and concise: * "Fields" is a collection of HTTP header fields (rfc7230 section 3.2) * "Header" is the Start Line plus Fields. Another way to look at it is, the HTTP message minus the body. * `basic_fields` replaces `basic_headers` * `fields` replaces `headers` * `Fields` replaces `Headers` in template parameter lists * `header` replaces `message_headers` * `header::fields` replaces `message_headers::fields` The changes are cosmetic and do not affect run-time behavior.
2016-11-10 05:34:49 -05:00
<member><link linkend="beast.ref.http__response_header">response_header</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.http__resume_context">resume_context</link></member>
<member><link linkend="beast.ref.http__streambuf_body">streambuf_body</link></member>
<member><link linkend="beast.ref.http__string_body">string_body</link></member>
</simplelist>
Tidy up documentation: fix #135 * Fix broken references * Move doc debug headers to extras/ * Add rfc7230 utility classes to quick reference
2016-10-15 21:39:24 -04:00
<bridgehead renderas="sect3">rfc7230</bridgehead>
rfc7230 compliance, limits, and tests for basic_parser_v1: New parser set_option function for controlling independent size limits on headers and body. By default request and response parsers are set up with reasonable limits to prevent resource exhaustion attacks. * Parser adheres strictly to rfc7230 * Increased test coverage * Headers and body maximum size limit options
2016-06-03 11:40:55 -04:00
<simplelist type="vert" columns="1">
Refactor HTTP identifier names (API Change): fix #171 Several names and HTTP identifiers are renamed to be more consistent, self-explanatory, and concise: * "Fields" is a collection of HTTP header fields (rfc7230 section 3.2) * "Header" is the Start Line plus Fields. Another way to look at it is, the HTTP message minus the body. * `basic_fields` replaces `basic_headers` * `fields` replaces `headers` * `Fields` replaces `Headers` in template parameter lists * `header` replaces `message_headers` * `header::fields` replaces `message_headers::fields` The changes are cosmetic and do not affect run-time behavior.
2016-11-10 05:34:49 -05:00
Tidy up documentation: fix #135 * Fix broken references * Move doc debug headers to extras/ * Add rfc7230 utility classes to quick reference
2016-10-15 21:39:24 -04:00
<member><link linkend="beast.ref.http__ext_list">ext_list</link></member>
<member><link linkend="beast.ref.http__param_list">param_list</link></member>
<member><link linkend="beast.ref.http__token_list">token_list</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
</simplelist>
</entry>
<entry valign="top">
<bridgehead renderas="sect3">Functions</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="beast.ref.http__async_read">async_read</link></member>
Refactor HTTP identifier names (API Change): fix #171 Several names and HTTP identifiers are renamed to be more consistent, self-explanatory, and concise: * "Fields" is a collection of HTTP header fields (rfc7230 section 3.2) * "Header" is the Start Line plus Fields. Another way to look at it is, the HTTP message minus the body. * `basic_fields` replaces `basic_headers` * `fields` replaces `headers` * `Fields` replaces `Headers` in template parameter lists * `header` replaces `message_headers` * `header::fields` replaces `message_headers::fields` The changes are cosmetic and do not affect run-time behavior.
2016-11-10 05:34:49 -05:00
<member><link linkend="beast.ref.http__async_parse">async_parse</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.http__async_write">async_write</link></member>
Make chunk_encode public: fix #154, fix #156 This adds public interfaces for transforming buffer sequences into their chunk-encoded equivalents. The transformations are O(1) in space and time.
2016-11-07 16:57:41 -05:00
<member><link linkend="beast.ref.http__chunk_encode">chunk_encode</link></member>
<member><link linkend="beast.ref.http__chunk_encode_final">chunk_encode_final</link></member>
Refactor HTTP identifier names (API Change): fix #171 Several names and HTTP identifiers are renamed to be more consistent, self-explanatory, and concise: * "Fields" is a collection of HTTP header fields (rfc7230 section 3.2) * "Header" is the Start Line plus Fields. Another way to look at it is, the HTTP message minus the body. * `basic_fields` replaces `basic_headers` * `fields` replaces `headers` * `Fields` replaces `Headers` in template parameter lists * `header` replaces `message_headers` * `header::fields` replaces `message_headers::fields` The changes are cosmetic and do not affect run-time behavior.
2016-11-10 05:34:49 -05:00
<member><link linkend="beast.ref.http__swap">swap</link></member>
Refine message class hierarchy: Two new objects, request_headers and response_headers, represent the portion of HTTP messages excluding the body.
2016-10-09 06:34:35 -04:00
<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>
Refactor HTTP identifier names (API Change): fix #171 Several names and HTTP identifiers are renamed to be more consistent, self-explanatory, and concise: * "Fields" is a collection of HTTP header fields (rfc7230 section 3.2) * "Header" is the Start Line plus Fields. Another way to look at it is, the HTTP message minus the body. * `basic_fields` replaces `basic_headers` * `fields` replaces `headers` * `Fields` replaces `Headers` in template parameter lists * `header` replaces `message_headers` * `header::fields` replaces `message_headers::fields` The changes are cosmetic and do not affect run-time behavior.
2016-11-10 05:34:49 -05:00
<member><link linkend="beast.ref.http__operator_ls_">operator&lt;&lt;</link></member>
Update documentation: * http parse functions * Parser concept * More detail on concepts * Better hyperlinking
2016-05-11 08:36:29 -04:00
<member><link linkend="beast.ref.http__parse">parse</link></member>
Tidy up tests, build scripts, and documentation: * Concepts split up into individual files * Function definitions moved to .ipp files * Add more tests to fill gaps in coverage * Fix documentation Xsl
2016-05-01 12:33:35 -04:00
<member><link linkend="beast.ref.http__prepare">prepare</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.http__read">read</link></member>
Refactor HTTP identifier names (API Change): fix #171 Several names and HTTP identifiers are renamed to be more consistent, self-explanatory, and concise: * "Fields" is a collection of HTTP header fields (rfc7230 section 3.2) * "Header" is the Start Line plus Fields. Another way to look at it is, the HTTP message minus the body. * `basic_fields` replaces `basic_headers` * `fields` replaces `headers` * `Fields` replaces `Headers` in template parameter lists * `header` replaces `message_headers` * `header::fields` replaces `message_headers::fields` The changes are cosmetic and do not affect run-time behavior.
2016-11-10 05:34:49 -05:00
<member><link linkend="beast.ref.http__reason_string">reason_string</link></member>
Add headers_parser: This allows just the HTTP headers to be parsed, and the choice of body to be deferred to a subsequent call to parse.
2016-10-16 19:28:35 -04:00
<member><link linkend="beast.ref.http__with_body">with_body</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.http__write">write</link></member>
</simplelist>
Tidy up documentation: fix #135 * Fix broken references * Move doc debug headers to extras/ * Add rfc7230 utility classes to quick reference
2016-10-15 21:39:24 -04:00
<bridgehead renderas="sect3">Type Traits</bridgehead>
<simplelist type="vert" columns="1">
<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_Reader">is_Reader</link></member>
Doc fixes
2016-10-19 16:54:50 -04:00
<member><link linkend="beast.ref.http__is_Writer">is_Writer</link></member>
Tidy up documentation: fix #135 * Fix broken references * Move doc debug headers to extras/ * Add rfc7230 utility classes to quick reference
2016-10-15 21:39:24 -04:00
<member><link linkend="beast.ref.http__has_reader">has_reader</link></member>
<member><link linkend="beast.ref.http__has_writer">has_writer</link></member>
</simplelist>
</entry>
<entry valign="top">
<bridgehead renderas="sect3">Options</bridgehead>
<simplelist type="vert" columns="1">
Refactor HTTP identifier names (API Change): fix #171 Several names and HTTP identifiers are renamed to be more consistent, self-explanatory, and concise: * "Fields" is a collection of HTTP header fields (rfc7230 section 3.2) * "Header" is the Start Line plus Fields. Another way to look at it is, the HTTP message minus the body. * `basic_fields` replaces `basic_headers` * `fields` replaces `headers` * `Fields` replaces `Headers` in template parameter lists * `header` replaces `message_headers` * `header::fields` replaces `message_headers::fields` The changes are cosmetic and do not affect run-time behavior.
2016-11-10 05:34:49 -05:00
<member><link linkend="beast.ref.http__header_max_size">header_max_size</link></member>
Tidy up documentation: fix #135 * Fix broken references * Move doc debug headers to extras/ * Add rfc7230 utility classes to quick reference
2016-10-15 21:39:24 -04:00
<member><link linkend="beast.ref.http__body_max_size">body_max_size</link></member>
<member><link linkend="beast.ref.http__skip_body">skip_body</link></member>
</simplelist>
Tidy up tests, build scripts, and documentation: * Concepts split up into individual files * Function definitions moved to .ipp files * Add more tests to fill gaps in coverage * Fix documentation Xsl
2016-05-01 12:33:35 -04:00
<bridgehead renderas="sect3">Constants</bridgehead>
<simplelist type="vert" columns="1">
Add pause option to on_headers interface: * on_headers returns enum body_what * body_what::pause lets caller receive headers during the parse
2016-10-10 07:55:39 -04:00
<member><link linkend="beast.ref.http__body_what">body_what</link></member>
Tidy up tests, build scripts, and documentation: * Concepts split up into individual files * Function definitions moved to .ipp files * Add more tests to fill gaps in coverage * Fix documentation Xsl
2016-05-01 12:33:35 -04:00
<member><link linkend="beast.ref.http__connection">connection</link></member>
Refactor HTTP identifier names (API Change): fix #171 Several names and HTTP identifiers are renamed to be more consistent, self-explanatory, and concise: * "Fields" is a collection of HTTP header fields (rfc7230 section 3.2) * "Header" is the Start Line plus Fields. Another way to look at it is, the HTTP message minus the body. * `basic_fields` replaces `basic_headers` * `fields` replaces `headers` * `Fields` replaces `Headers` in template parameter lists * `header` replaces `message_headers` * `header::fields` replaces `message_headers::fields` The changes are cosmetic and do not affect run-time behavior.
2016-11-10 05:34:49 -05:00
<member><link linkend="beast.ref.http__no_content_length">no_content_length</link></member>
<member><link linkend="beast.ref.http__parse_error">parse_error</link></member>
<member><link linkend="beast.ref.http__parse_flag">parse_flag</link></member>
Tidy up tests, build scripts, and documentation: * Concepts split up into individual files * Function definitions moved to .ipp files * Add more tests to fill gaps in coverage * Fix documentation Xsl
2016-05-01 12:33:35 -04:00
</simplelist>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<bridgehead renderas="sect3">Concepts</bridgehead>
<simplelist type="vert" columns="1">
Update and tidy documentation
2016-09-25 11:19:51 -04:00
<member><link linkend="beast.ref.Body">Body</link></member>
<member><link linkend="beast.ref.Field">Field</link></member>
<member><link linkend="beast.ref.FieldSequence">FieldSequence</link></member>
<member><link linkend="beast.ref.Parser">Parser</link></member>
<member><link linkend="beast.ref.Reader">Reader</link></member>
<member><link linkend="beast.ref.Writer">Writer</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
</simplelist>
</entry>
<entry valign="top">
<bridgehead renderas="sect3">Classes</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="beast.ref.websocket__close_reason">close_reason</link></member>
WebSocket ping, fixes, coverage: * Improve test coverage * tests for invokable in composed ops * Update documentation * Add License badge to README * Target Windows 7 SDK and later * Make role_type private * Remove extra unused masking functions * Allow stream reuse / reconnect after failure * Restructure logic of composed operations * Allow 0 for read_message_max meaning no limit * Respect keep alive when building HTTP responses * Check version in upgrade request * Response with 426 status on unsupported WebSocket version * Remove unnecessary Sec-WebSocket-Key in HTTP responses * Rename to mask_buffer_size * Remove maybe_throw * Add ping, async_ping, async_on_pong * Add ping_op * Add pong_op * Fix crash in accept_op * Fix suspend in close_op * Fix read_frame_op logic * Fix crash in read_op * Fix races in echo sync and async echo servers
2016-05-15 16:22:25 -04:00
<member><link linkend="beast.ref.websocket__ping_data">ping_data</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.websocket__stream">stream</link></member>
WebSocket ping, fixes, coverage: * Improve test coverage * tests for invokable in composed ops * Update documentation * Add License badge to README * Target Windows 7 SDK and later * Make role_type private * Remove extra unused masking functions * Allow stream reuse / reconnect after failure * Restructure logic of composed operations * Allow 0 for read_message_max meaning no limit * Respect keep alive when building HTTP responses * Check version in upgrade request * Response with 426 status on unsupported WebSocket version * Remove unnecessary Sec-WebSocket-Key in HTTP responses * Rename to mask_buffer_size * Remove maybe_throw * Add ping, async_ping, async_on_pong * Add ping_op * Add pong_op * Fix crash in accept_op * Fix suspend in close_op * Fix read_frame_op logic * Fix crash in read_op * Fix races in echo sync and async echo servers
2016-05-15 16:22:25 -04:00
<member><link linkend="beast.ref.websocket__reason_string">reason_string</link></member>
Fixes and documentation for teardown and use with SSL: This solves a problem where clang and gcc locate the deleted version of teardown and async_teardown instead of the overloaded version. It requires overloads to add `teardown_tag` into the signature so that the rules for argument dependent lookup can find the right function. Improve documentation of teardown requirements The documentation is updated to clearly explain the need for including <beast/websocket/ssl.hpp> to use SSL streams with WebSocket. The default implementations of teardown and async_teardown now use static_assert to alert the user of improper usage, with comments providing guidance for resolving the error.
2016-06-08 11:18:22 -04:00
<member><link linkend="beast.ref.websocket__teardown_tag">teardown_tag</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
</simplelist>
Tidy up documentation: fix #135 * Fix broken references * Move doc debug headers to extras/ * Add rfc7230 utility classes to quick reference
2016-10-15 21:39:24 -04:00
<bridgehead renderas="sect3">Functions</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="beast.ref.websocket__async_teardown">async_teardown</link></member>
<member><link linkend="beast.ref.websocket__teardown">teardown</link></member>
</simplelist>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<bridgehead renderas="sect3">Options</bridgehead>
<simplelist type="vert" columns="1">
Make auto_fragment a boolean option
2016-06-10 15:48:39 -04:00
<member><link linkend="beast.ref.websocket__auto_fragment">auto_fragment</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.websocket__decorate">decorate</link></member>
<member><link linkend="beast.ref.websocket__keep_alive">keep_alive</link></member>
WebSocket ping, fixes, coverage: * Improve test coverage * tests for invokable in composed ops * Update documentation * Add License badge to README * Target Windows 7 SDK and later * Make role_type private * Remove extra unused masking functions * Allow stream reuse / reconnect after failure * Restructure logic of composed operations * Allow 0 for read_message_max meaning no limit * Respect keep alive when building HTTP responses * Check version in upgrade request * Response with 426 status on unsupported WebSocket version * Remove unnecessary Sec-WebSocket-Key in HTTP responses * Rename to mask_buffer_size * Remove maybe_throw * Add ping, async_ping, async_on_pong * Add ping_op * Add pong_op * Fix crash in accept_op * Fix suspend in close_op * Fix read_frame_op logic * Fix crash in read_op * Fix races in echo sync and async echo servers
2016-05-15 16:22:25 -04:00
<member><link linkend="beast.ref.websocket__message_type">message_type</link></member>
Add permessage-deflate WebSocket extension: This implements the permessage-deflate WebSocket extension as described in HyBi Working Group draft-ietf-hybi-permessage-compression-28: https://tools.ietf.org/html/draft-ietf-hybi-permessage-compression-28 This extension allows messages to be compressed using the raw "deflate" algorithm described in RFC 1951, "DEFLATE Compressed Data Format Specification version 1.3": https://www.ietf.org/rfc/rfc1951.txt
2016-10-24 18:41:25 -04:00
<member><link linkend="beast.ref.websocket__permessage_deflate">permessage_deflate</link></member>
Invoke callback on pings and pongs (API Change): fix #248 This additionally invokes the pong callback for received pings, allowing callers to more efficiently detect when a connection is still lively: * pong_callback renamed to ping_callback * Callback signature has an extra `bool` to indicate if the received control frame is a ping or pong.
2017-02-03 16:22:28 -05:00
<member><link linkend="beast.ref.websocket__ping_callback">ping_callback</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.websocket__read_buffer_size">read_buffer_size</link></member>
<member><link linkend="beast.ref.websocket__read_message_max">read_message_max</link></member>
Rename to write_buffer_size
2016-06-10 13:20:41 -04:00
<member><link linkend="beast.ref.websocket__write_buffer_size">write_buffer_size</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
</simplelist>
<bridgehead renderas="sect3">Constants</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="beast.ref.websocket__close_code">close_code</link></member>
WebSocket ping, fixes, coverage: * Improve test coverage * tests for invokable in composed ops * Update documentation * Add License badge to README * Target Windows 7 SDK and later * Make role_type private * Remove extra unused masking functions * Allow stream reuse / reconnect after failure * Restructure logic of composed operations * Allow 0 for read_message_max meaning no limit * Respect keep alive when building HTTP responses * Check version in upgrade request * Response with 426 status on unsupported WebSocket version * Remove unnecessary Sec-WebSocket-Key in HTTP responses * Rename to mask_buffer_size * Remove maybe_throw * Add ping, async_ping, async_on_pong * Add ping_op * Add pong_op * Fix crash in accept_op * Fix suspend in close_op * Fix read_frame_op logic * Fix crash in read_op * Fix races in echo sync and async echo servers
2016-05-15 16:22:25 -04:00
<member><link linkend="beast.ref.websocket__error">error</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.websocket__opcode">opcode</link></member>
</simplelist>
</entry>
</row>
</tbody>
</tgroup>
<tgroup cols="4">
<colspec colname="a"/>
<colspec colname="b"/>
<colspec colname="c"/>
<colspec colname="d"/>
Add zlib module: The zlib module is a port of ZLib's raw deflate algorithm to header-only C++11.
2016-10-18 19:43:36 -04:00
<colspec colname="e"/>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<thead>
<row>
<entry valign="center" namest="a" nameend="d">
<bridgehead renderas="sect2">Core</bridgehead>
</entry>
Add zlib module: The zlib module is a port of ZLib's raw deflate algorithm to header-only C++11.
2016-10-18 19:43:36 -04:00
<entry valign="center" namest="e" nameend="e">
<bridgehead renderas="sect2">ZLib</bridgehead>
</entry>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
</row>
</thead>
<tbody>
<row>
<entry valign="top">
<bridgehead renderas="sect3">Classes</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="beast.ref.async_completion">async_completion</link></member>
<member><link linkend="beast.ref.basic_streambuf">basic_streambuf</link></member>
<member><link linkend="beast.ref.buffers_adapter">buffers_adapter</link></member>
<member><link linkend="beast.ref.consuming_buffers">consuming_buffers</link></member>
Rename concept to DynamicBuffer (API change): Conform to the Networking TS by renaming the Streambuf concept to DynamicBuffer in all places. Values of types meeting the requirements of DynamicBuffer are renamed to dynabuf. See: http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/n4478.html#requirements.dynamic_buffers * Headers renamed * Formal parameter names renamed * Template argument types renamed * Documentation updated
2016-05-28 09:23:54 -04:00
<member><link linkend="beast.ref.dynabuf_readstream">dynabuf_readstream</link></member>
Tidy up error types: * Restructure header material * Clean up namespace type injections * Remove extraneous 'success' constants
2016-10-04 18:00:11 -04:00
<member><link linkend="beast.ref.errc">errc</link></member>
<member><link linkend="beast.ref.error_category">error_category</link></member>
Tidy up core sources: The core headers are moved to their own directory (but remain in the same namespace).
2016-05-07 14:57:15 -04:00
<member><link linkend="beast.ref.error_code">error_code</link></member>
Tidy up error types: * Restructure header material * Clean up namespace type injections * Remove extraneous 'success' constants
2016-10-04 18:00:11 -04:00
<member><link linkend="beast.ref.error_condition">error_condition</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.handler_alloc">handler_alloc</link></member>
Implement asio dealloc-before-invoke guarantee: fix #215 This change guarantees that temporary memory allocated through the asio hooks by the Beast implementation is deallocated before invoking the final handler when performing composed operations. The change is accomplished by replacing std::shared_ptr with a thread-safe custom container handler_ptr to manage composed operation state. The container tracks other instances which manage the same object and resets them in a safe way before invoking the final handler. handler_ptr is provided as a public interface so that users of this library can utilize the same idiom to write their own composed operations.
2017-01-02 13:29:48 -05:00
<member><link linkend="beast.ref.handler_ptr">handler_ptr</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.static_streambuf">static_streambuf</link></member>
<member><link linkend="beast.ref.static_streambuf_n">static_streambuf_n</link></member>
Tidy up tests, build scripts, and documentation: * Concepts split up into individual files * Function definitions moved to .ipp files * Add more tests to fill gaps in coverage * Fix documentation Xsl
2016-05-01 12:33:35 -04:00
<member><link linkend="beast.ref.static_string">static_string</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.streambuf">streambuf</link></member>
Tidy up core sources: The core headers are moved to their own directory (but remain in the same namespace).
2016-05-07 14:57:15 -04:00
<member><link linkend="beast.ref.system_error">system_error</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
</simplelist>
</entry>
<entry valign="top">
<bridgehead renderas="sect3">Functions</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="beast.ref.bind_handler">bind_handler</link></member>
<member><link linkend="beast.ref.buffer_cat">buffer_cat</link></member>
<member><link linkend="beast.ref.prepare_buffer">prepare_buffer</link></member>
<member><link linkend="beast.ref.prepare_buffers">prepare_buffers</link></member>
Tidy up tests, build scripts, and documentation: * Concepts split up into individual files * Function definitions moved to .ipp files * Add more tests to fill gaps in coverage * Fix documentation Xsl
2016-05-01 12:33:35 -04:00
<member><link linkend="beast.ref.to_string">to_string</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.write">write</link></member>
</simplelist>
</entry>
<entry valign="top">
<bridgehead renderas="sect3">Type Traits</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="beast.ref.is_AsyncReadStream">is_AsyncReadStream</link></member>
<member><link linkend="beast.ref.is_AsyncWriteStream">is_AsyncWriteStream</link></member>
WebSocket refactoring and tests: websocket: * Move echo server to test/ * Fix warnings * Fix maskgen being uncopyable * Simplify utf8_checker special member declarations * Fix stream move assignable when owning the next layer * Add javadocs for stream special members * Add stream unit tests * Move throwing member definitions to the .ipp file * Use get_lowest_layer in stream declaration * Perform type checks at each call site instead of constructor * Demote close_code to a non-class enum: Otherwise, application specific close codes cannot be assigned without using static_cast. core: * Add streambuf_readstream special members tests * Add move assignment operator to streambuf_readstream * Add detail/get_lowest_layer trait * Add static_string tests * Move static_string from websocket to core
2016-04-30 13:00:33 -04:00
<member><link linkend="beast.ref.is_AsyncStream">is_AsyncStream</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.is_BufferSequence">is_BufferSequence</link></member>
Tidy up tests, build scripts, and documentation: * Concepts split up into individual files * Function definitions moved to .ipp files * Add more tests to fill gaps in coverage * Fix documentation Xsl
2016-05-01 12:33:35 -04:00
<member><link linkend="beast.ref.is_CompletionHandler">is_CompletionHandler</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.is_ConstBufferSequence">is_ConstBufferSequence</link></member>
Rename concept to DynamicBuffer (API change): Conform to the Networking TS by renaming the Streambuf concept to DynamicBuffer in all places. Values of types meeting the requirements of DynamicBuffer are renamed to dynabuf. See: http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/n4478.html#requirements.dynamic_buffers * Headers renamed * Formal parameter names renamed * Template argument types renamed * Documentation updated
2016-05-28 09:23:54 -04:00
<member><link linkend="beast.ref.is_DynamicBuffer">is_DynamicBuffer</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.is_MutableBufferSequence">is_MutableBufferSequence</link></member>
<member><link linkend="beast.ref.is_SyncReadStream">is_SyncReadStream</link></member>
WebSocket refactoring and tests: websocket: * Move echo server to test/ * Fix warnings * Fix maskgen being uncopyable * Simplify utf8_checker special member declarations * Fix stream move assignable when owning the next layer * Add javadocs for stream special members * Add stream unit tests * Move throwing member definitions to the .ipp file * Use get_lowest_layer in stream declaration * Perform type checks at each call site instead of constructor * Demote close_code to a non-class enum: Otherwise, application specific close codes cannot be assigned without using static_cast. core: * Add streambuf_readstream special members tests * Add move assignment operator to streambuf_readstream * Add detail/get_lowest_layer trait * Add static_string tests * Move static_string from websocket to core
2016-04-30 13:00:33 -04:00
<member><link linkend="beast.ref.is_SyncStream">is_SyncStream</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
<member><link linkend="beast.ref.is_SyncWriteStream">is_SyncWriteStream</link></member>
</simplelist>
</entry>
<entry valign="top">
<bridgehead renderas="sect3">Concepts</bridgehead>
<simplelist type="vert" columns="1">
Update and tidy documentation
2016-09-25 11:19:51 -04:00
<member><link linkend="beast.ref.streams.AsyncStream">AsyncStream</link></member>
<member><link linkend="beast.ref.BufferSequence">BufferSequence</link></member>
<member><link linkend="beast.ref.DynamicBuffer">DynamicBuffer</link></member>
<member><link linkend="beast.ref.streams.Stream">Stream</link></member>
<member><link linkend="beast.ref.streams.SyncStream">SyncStream</link></member>
Tidy up tests, build scripts, and documentation: * Concepts split up into individual files * Function definitions moved to .ipp files * Add more tests to fill gaps in coverage * Fix documentation Xsl
2016-05-01 12:33:35 -04:00
</simplelist>
</entry>
Add zlib module: The zlib module is a port of ZLib's raw deflate algorithm to header-only C++11.
2016-10-18 19:43:36 -04:00
<entry valign="top">
<bridgehead renderas="sect3">Classes</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="beast.ref.zlib__deflate_stream">deflate_stream</link></member>
<member><link linkend="beast.ref.zlib__inflate_stream">inflate_stream</link></member>
<member><link linkend="beast.ref.zlib__z_params">z_params</link></member>
</simplelist>
<bridgehead renderas="sect3">Functions</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="beast.ref.zlib__deflate_upper_bound">deflate_upper_bound</link></member>
</simplelist>
<bridgehead renderas="sect3">Constants</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="beast.ref.zlib__error">error</link></member>
<member><link linkend="beast.ref.zlib__Flush">Flush</link></member>
<member><link linkend="beast.ref.zlib__Strategy">Strategy</link></member>
</simplelist>
</entry>
Tidy up tests, build scripts, and documentation: * Concepts split up into individual files * Function definitions moved to .ipp files * Add more tests to fill gaps in coverage * Fix documentation Xsl
2016-05-01 12:33:35 -04:00
</row>
</tbody>
</tgroup>
<tgroup cols="1">
<colspec colname="a"/>
<thead>
<row>
<entry valign="center" namest="a" nameend="a">
<bridgehead renderas="sect2">Diagnostic</bridgehead>
</entry>
</row>
</thead>
<tbody>
<row>
<entry valign="top">
<simplelist type="vert" columns="1">
<member><link linkend="beast.ref.doc_debug">doc_debug</link></member>
<member><link linkend="beast.ref.nested__nested_doc_debug">nested_doc_debug</link></member>
Truncate history, version 1.0.0-b2
2017-07-20 08:01:46 -07:00
</simplelist>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
Copy Permalink