Exit Zen
2
string ID 12
type: paragraph
English
Networking's __ssl_stream__ is a class template meeting the requirements of both synchronous and asynchronous read and write streams, implemented in terms of a "next layer" object whose type is determined by a class template parameter. The SSL stream constructs an instance of the next layer object internally, while allowing external access through the observer `net::ssl::stream::next_layer()`. This declares an SSL stream which uses a regular TCP/IP socket as the next layer:
478/4780 · 478
3
string ID 22
type: paragraph
English
Objects using this design pattern are referred to in networking as "a stack of stream layers". In Beast we use the term ['layered stream], although the property of having a next layer is not exclusive to streams. As with the SSL stream, __websocket_stream__ is a class template parameterized on a next layer object. This declares a websocket stream which uses a regular TCP/IP socket as the next layer:
402/4020 · 402
4
string ID 31
type: paragraph
English
If a Secure WebSockets stream is desired, this is accomplished simply by changing the type of the next layer and adjusting the constructor arguments to match:
158/1580 · 158
5
string ID 37
type: paragraph
English
Higher level abstractions can be developed in this fashion by nesting stream layers to arbitrary degree. The stack of stream layers effectively forms a compile-time singly linked list. The object at the end of this list is called the ['lowest layer], and is special from the others because it typically represents the underlying socket.
336/3360 · 336
6
string ID 43
type: paragraph
English
Beast comes with several layered stream wrappers, as well as facilities for authoring and working with layered streams:
119/1190 · 119
7
string ID 46
type: table title
English
Layered Stream Algorithms and Types
35/350 · 35
8
string ID 46
type: table cell
English
Name
4/100 · 4
9
string ID 46
type: table cell
English
Description
11/110 · 11
10
string ID 46
type: table cell
English
[link beast.ref.boost__beast__basic_stream `basic_stream`] [link beast.ref.boost__beast__tcp_stream `tcp_stream`]
113/1130 · 113
11
string ID 46
type: table cell
English
This stream can be used for synchronous and asynchronous reading and writing. It allows timeouts to be set on logical operations, and can have an executor associated with the stream which is used to invoke completion handlers. This lets you set a strand on the stream once, which is then used for all asynchronous operations automatically.
339/3390 · 339
12
string ID 46
type: table cell
English
[link beast.ref.boost__beast__buffered_read_stream `buffered_read_stream`]
74/740 · 74
13
string ID 46
type: table cell
English
A buffered read stream meets the requirements for synchronous and asynchronous read and write streams, and additionally implements configurable buffering for reads.
164/1640 · 164
14
string ID 46
type: table cell
English
[link beast.ref.boost__beast__close_socket `close_socket`]
58/580 · 58
15
string ID 46
type: table cell
English
This function closes a socket by performing an unqualified call to the [link beast.ref.boost__beast__beast_close_socket `beast_close_socket`] customization point, allowing sockets to be closed in generic contexts in an extensible fashion.
238/2380 · 238
16
string ID 46
type: table cell
English
[link beast.ref.boost__beast__get_lowest_layer `get_lowest_layer`]
66/660 · 66
17
string ID 46
type: table cell
English
Returns the lowest layer in a stack of stream layers by recursively calling the `next_layer` member function on each object until reaching an object which lacks the member. This example puts a layered stream into non-blocking mode by retrieving the TCP/IP socket in the lowest layer and changing the socket option:

[code_core_4_layers_4]
338/3380 · 338
18
string ID 46
type: table cell
English
[link beast.ref.boost__beast__http__icy_stream `http::icy_stream`]
66/660 · 66
19
string ID 46
type: table cell
English
An ICY stream transparently converts the non-standard "ICY 200 OK" HTTP response from Shoutcast servers into a conforming 200 level HTTP response.
146/1460 · 146
20
string ID 46
type: table cell
English
[link beast.ref.boost__beast__lowest_layer_type `lowest_layer_type`]
68/680 · 68
21
string ID 46
type: table cell
English
A metafunction to return the type of the lowest layer used in a type representing a stack of stream layers. This is the type of reference returned by [link beast.ref.boost__beast__get_lowest_layer `get_lowest_layer`]
216/2160 · 216