blob: 2ce0973c2b2e8bbe7957940fa424813eadf0ec9a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>generic::stream_protocol</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="generic__seq_packet_protocol/type.html" title="generic::seq_packet_protocol::type">
<link rel="next" href="generic__stream_protocol/endpoint.html" title="generic::stream_protocol::endpoint">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="generic__seq_packet_protocol/type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="generic__stream_protocol/endpoint.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.generic__stream_protocol"></a><a class="link" href="generic__stream_protocol.html" title="generic::stream_protocol">generic::stream_protocol</a>
</h3></div></div></div>
<p>
Encapsulates the flags needed for a generic stream-oriented socket.
</p>
<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">stream_protocol</span>
</pre>
<h5>
<a name="boost_asio.reference.generic__stream_protocol.h0"></a>
<span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.types"></a></span><a class="link" href="generic__stream_protocol.html#boost_asio.reference.generic__stream_protocol.types">Types</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="generic__stream_protocol/endpoint.html" title="generic::stream_protocol::endpoint"><span class="bold"><strong>endpoint</strong></span></a>
</p>
</td>
<td>
<p>
The type of an endpoint.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="generic__stream_protocol/iostream.html" title="generic::stream_protocol::iostream"><span class="bold"><strong>iostream</strong></span></a>
</p>
</td>
<td>
<p>
The generic socket iostream type.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="generic__stream_protocol/socket.html" title="generic::stream_protocol::socket"><span class="bold"><strong>socket</strong></span></a>
</p>
</td>
<td>
<p>
The generic socket type.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="boost_asio.reference.generic__stream_protocol.h1"></a>
<span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.member_functions"></a></span><a class="link" href="generic__stream_protocol.html#boost_asio.reference.generic__stream_protocol.member_functions">Member
Functions</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="generic__stream_protocol/family.html" title="generic::stream_protocol::family"><span class="bold"><strong>family</strong></span></a>
</p>
</td>
<td>
<p>
Obtain an identifier for the protocol family.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="generic__stream_protocol/protocol.html" title="generic::stream_protocol::protocol"><span class="bold"><strong>protocol</strong></span></a>
</p>
</td>
<td>
<p>
Obtain an identifier for the protocol.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="generic__stream_protocol/stream_protocol.html" title="generic::stream_protocol::stream_protocol"><span class="bold"><strong>stream_protocol</strong></span></a>
</p>
</td>
<td>
<p>
Construct a protocol object for a specific address family and protocol.
</p>
<p>
Construct a generic protocol object from a specific protocol.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="generic__stream_protocol/type.html" title="generic::stream_protocol::type"><span class="bold"><strong>type</strong></span></a>
</p>
</td>
<td>
<p>
Obtain an identifier for the type of the protocol.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="boost_asio.reference.generic__stream_protocol.h2"></a>
<span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.friends"></a></span><a class="link" href="generic__stream_protocol.html#boost_asio.reference.generic__stream_protocol.friends">Friends</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="generic__stream_protocol/operator_not__eq_.html" title="generic::stream_protocol::operator!="><span class="bold"><strong>operator!=</strong></span></a>
</p>
</td>
<td>
<p>
Compare two protocols for inequality.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="generic__stream_protocol/operator_eq__eq_.html" title="generic::stream_protocol::operator=="><span class="bold"><strong>operator==</strong></span></a>
</p>
</td>
<td>
<p>
Compare two protocols for equality.
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
The <a class="link" href="generic__stream_protocol.html" title="generic::stream_protocol"><code class="computeroutput"><span class="identifier">generic</span><span class="special">::</span><span class="identifier">stream_protocol</span></code></a> class contains flags
necessary for stream-oriented sockets of any address family and protocol.
</p>
<h5>
<a name="boost_asio.reference.generic__stream_protocol.h3"></a>
<span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.examples"></a></span><a class="link" href="generic__stream_protocol.html#boost_asio.reference.generic__stream_protocol.examples">Examples</a>
</h5>
<p>
Constructing using a native address family and socket protocol:
</p>
<pre class="programlisting"><span class="identifier">stream_protocol</span> <span class="identifier">p</span><span class="special">(</span><span class="identifier">AF_INET</span><span class="special">,</span> <span class="identifier">IPPROTO_TCP</span><span class="special">);</span>
</pre>
<p>
Constructing from a specific protocol type:
</p>
<pre class="programlisting"><span class="identifier">stream_protocol</span> <span class="identifier">p</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">v4</span><span class="special">());</span>
</pre>
<h5>
<a name="boost_asio.reference.generic__stream_protocol.h4"></a>
<span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.thread_safety"></a></span><a class="link" href="generic__stream_protocol.html#boost_asio.reference.generic__stream_protocol.thread_safety">Thread
Safety</a>
</h5>
<p>
<span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
</p>
<p>
<span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
</p>
<h5>
<a name="boost_asio.reference.generic__stream_protocol.h5"></a>
<span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.requirements"></a></span><a class="link" href="generic__stream_protocol.html#boost_asio.reference.generic__stream_protocol.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/generic/stream_protocol.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2014 Christopher M. Kohlhoff<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="generic__seq_packet_protocol/type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="generic__stream_protocol/endpoint.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
