forked from boostorg/beast
stream_base::timeout::suggested is a nested function
This commit is contained in:
1 parent
b02f59ff91
commit
8f9eed1faf
23 files changed
+103
-64
No files matched your search
@@ -46,15 +46,15 @@ These stream members are used to write websocket messages:
|
||||
[[Function][Description]]
|
||||
[
|
||||
[
|
||||
[link beast.ref.boost__beast__websocket__stream.write `write`],
|
||||
[link beast.ref.boost__beast__websocket__stream.write.overload2 `write`],
|
||||
[link beast.ref.boost__beast__websocket__stream.async_write `async_write`]
|
||||
][
|
||||
Send a buffer sequence as a complete message.
|
||||
]
|
||||
][
|
||||
[
|
||||
[link beast.ref.boost__beast__websocket__stream.write_some `write_some`],
|
||||
[link beast.ref.boost__beast__websocket__stream.async_write `async_write_some`]
|
||||
[link beast.ref.boost__beast__websocket__stream.write_some.overload2 `write_some`],
|
||||
[link beast.ref.boost__beast__websocket__stream.async_write_some `async_write_some`]
|
||||
][
|
||||
Send a buffer sequence as part of a message.
|
||||
]
|
||||
@@ -72,7 +72,7 @@ The same message could be sent in two or more frames thusly.
|
||||
[[Function][Description]]
|
||||
[
|
||||
[
|
||||
[link beast.ref.boost__beast__websocket__stream.read `read`],
|
||||
[link beast.ref.boost__beast__websocket__stream.read.overload2 `read`],
|
||||
[link beast.ref.boost__beast__websocket__stream.async_read `async_read`]
|
||||
][
|
||||
Read a complete message into a __DynamicBuffer__.
|
||||
@@ -80,14 +80,14 @@ The same message could be sent in two or more frames thusly.
|
||||
][
|
||||
[
|
||||
[link beast.ref.boost__beast__websocket__stream.read_some.overload2 `read_some`],
|
||||
[link beast.ref.boost__beast__websocket__stream.async_read.overload1 `async_read_some`]
|
||||
[link beast.ref.boost__beast__websocket__stream.async_read_some.overload1 `async_read_some`]
|
||||
][
|
||||
Read part of a message into a __DynamicBuffer__.
|
||||
]
|
||||
][
|
||||
[
|
||||
[link beast.ref.boost__beast__websocket__stream.read_some.overload4 `read_some`],
|
||||
[link beast.ref.boost__beast__websocket__stream.async_read.overload2 `async_read_some`]
|
||||
[link beast.ref.boost__beast__websocket__stream.async_read_some.overload2 `async_read_some`]
|
||||
][
|
||||
Read part of a message into a __MutableBufferSequence__.
|
||||
]
|
||||
@@ -117,6 +117,6 @@ message ahead of time:
|
||||
For these cases, the partial data oriented interface may be used. This
|
||||
example reads and echoes a complete message using this interface:
|
||||
|
||||
[ws_snippet_16]
|
||||
[code_websocket_4_3]
|
||||
|
||||
[endsect]
|
||||
@@ -7,8 +7,42 @@
|
||||
Official repository: https://github.com/boostorg/beast
|
||||
]
|
||||
|
||||
[section Timeouts __new__]
|
||||
|
||||
[/-----------------------------------------------------------------------------]
|
||||
|
||||
[section Timeouts __new__]
|
||||
|
||||
While
|
||||
[link beast.ref.boost__beast__basic_stream `basic_stream`] and
|
||||
[link beast.ref.boost__beast__basic_stream `tcp_stream`] support timeouts on
|
||||
general logical operations, the websocket stream has a more sophisticated timeout
|
||||
mechanism built-in which may be enabled and configured. The timeout features
|
||||
of the TCP or basic stream should not be used when working with a websocket
|
||||
stream. The interface to these timeout features is show in this table.
|
||||
|
||||
[table WebSocket Timeout Interface
|
||||
[[Name][Description]]
|
||||
[[
|
||||
[link beast.ref.boost__beast__websocket__stream_base__timeout `stream_base::timeout`]
|
||||
][
|
||||
This represents configured timeout settings for a websocket stream.
|
||||
]]
|
||||
[[
|
||||
[link beast.ref.boost__beast__websocket__stream_base__timeout `stream_base::timeout`]
|
||||
][
|
||||
This is the type of the object passed to the decorator to
|
||||
represent HTTP Upgrade response.
|
||||
]]
|
||||
[[
|
||||
[link beast.ref.boost__beast__websocket__stream_base__decorator `stream_base::decorator`]
|
||||
][
|
||||
Objects of this type are used to hold a decorator to be
|
||||
set on the stream using `set_option`.
|
||||
]]
|
||||
[[
|
||||
[link beast.ref.boost__beast__websocket__stream.set_option `stream::set_option`]
|
||||
][
|
||||
This function is used to set a `stream_base::decorator` on the stream.
|
||||
]]
|
||||
]
|
||||
|
||||
[endsect]
|
||||
@@ -138,7 +138,6 @@
|
||||
[import ../../test/doc/exemplars.cpp]
|
||||
[import ../../test/doc/core_snippets.cpp]
|
||||
[import ../../test/doc/http_snippets.cpp]
|
||||
[import ../../test/doc/websocket_snippets.cpp]
|
||||
|
||||
[import ../../test/doc/core_1_refresher.cpp]
|
||||
[import ../../test/doc/core_3_timeouts.cpp]
|
||||
|
||||
@@ -303,7 +303,6 @@
|
||||
<bridgehead renderas="sect3">Options</bridgehead>
|
||||
<simplelist type="vert" columns="1">
|
||||
<member><link linkend="beast.ref.boost__beast__websocket__permessage_deflate">permessage_deflate</link></member>
|
||||
<member><link linkend="beast.ref.boost__beast__websocket__stream_base.suggested_settings">suggested_settings</link> <emphasis role="green">★</emphasis></member>
|
||||
<member><link linkend="beast.ref.boost__beast__websocket__stream_base__decorator">decorator</link> <emphasis role="green">★</emphasis></member>
|
||||
<member><link linkend="beast.ref.boost__beast__websocket__stream_base__timeout">timeout</link> <emphasis role="green">★</emphasis></member>
|
||||
</simplelist>
|
||||
|
||||
Reference in new issue
Block a user