Skip to content

Commit ed594e2

Browse files
committed
Correct StreamType concept in the docs.
Summary: Resolves #40 {F3809560} Reviewers: ivica Reviewed By: ivica Subscribers: miljen Differential Revision: https://repo.mireo.local/D37895
1 parent 68ac835 commit ed594e2

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

doc/qbk/00_main.qbk

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
[template refmem[class mem][reflink2 [class].[mem] [class]::[mem]]]
3434
[template refmemunq[class mem][reflink2 [class].[mem] [mem]]]
3535
[template asioreflink[id term][@boost:/doc/html/boost_asio/reference/[id].html [^boost::asio::[term]]]]
36+
[template asioreflink2[id term][@boost:/doc/html/boost_asio/reference/[id].html [term]]]
3637
[template beastreflink[id term][@boost:/libs/beast/doc/html/beast/ref/[id].html [^boost::beast::[term]]]]
3738
[template beastconceptslink[id term][@boost:/libs/beast/doc/html/beast/concepts/[id].html [term]]]
3839
[template mqttlink[id text][@https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc[id] [text]]]

doc/qbk/reference/concepts/StreamType.qbk

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,15 @@
1010

1111
`StreamType` should meet the [beastconceptslink streams AsyncStream] concept.
1212

13+
[note
14+
Because __WEBSOCKET_STREAM__ does not satisfy [asioreflink2 AsyncWriteStream [^AsyncWriteStream]],
15+
requirements were relaxed to allow a stream to provide [*`async_write`] operation instead of [*`async_write_some`].
16+
17+
With [asioreflink2 ConstBufferSequence [^ConstBufferSequence]] cb and __CompletionToken__ t,
18+
[*`s.async_write(cb, t)`] should meet the requirements of an [asioreflink2 asynchronous_operations asynchronous operation]
19+
with the completion signature `void(error_code ec, size_t n)` and should write all the supplied data to the stream.
20+
]
21+
1322
It should follow Asio's layered stream model by having a `lowest_layer_type` member type,
1423
and a `lowest_layer` member function, returing a `lowest_layer_type&`.
1524
The `lowest_layer_type` should inherit from __TCP_SOCKET__.

0 commit comments

Comments
 (0)