264 lines
10 KiB
HTML
264 lines
10 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
|
<title>generic::stream_protocol</title>
|
||
|
|
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
|
||
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
||
|
|
<link rel="home" href="../../index.html" title="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">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
</head>
|
||
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||
|
|
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
|
||
|
|
<hr>
|
||
|
|
<div class="spirit-nav">
|
||
|
|
<a accesskey="p" href="generic__seq_packet_protocol/type.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="generic__stream_protocol/endpoint.html"><img src="../../next.png" alt="Next"></a>
|
||
|
|
</div>
|
||
|
|
<div class="section">
|
||
|
|
<div class="titlepage"><div><div><h3 class="title">
|
||
|
|
<a name="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>
|
||
|
|
<a class="indexterm" name="asio.indexterm.generic__stream_protocol"></a>
|
||
|
|
</p>
|
||
|
|
<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="asio.reference.generic__stream_protocol.h0"></a>
|
||
|
|
<span><a name="asio.reference.generic__stream_protocol.types"></a></span><a class="link" href="generic__stream_protocol.html#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="asio.reference.generic__stream_protocol.h1"></a>
|
||
|
|
<span><a name="asio.reference.generic__stream_protocol.member_functions"></a></span><a class="link" href="generic__stream_protocol.html#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> <span class="silver">[constructor]</span>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Construct a protocol object for a specific address family and protocol.
|
||
|
|
<br> <span class="silver"> —</span><br> 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="asio.reference.generic__stream_protocol.h2"></a>
|
||
|
|
<span><a name="asio.reference.generic__stream_protocol.friends"></a></span><a class="link" href="generic__stream_protocol.html#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="asio.reference.generic__stream_protocol.h3"></a>
|
||
|
|
<span><a name="asio.reference.generic__stream_protocol.examples"></a></span><a class="link" href="generic__stream_protocol.html#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">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="asio.reference.generic__stream_protocol.h4"></a>
|
||
|
|
<span><a name="asio.reference.generic__stream_protocol.thread_safety"></a></span><a class="link" href="generic__stream_protocol.html#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="asio.reference.generic__stream_protocol.h5"></a>
|
||
|
|
<span><a name="asio.reference.generic__stream_protocol.requirements"></a></span><a class="link" href="generic__stream_protocol.html#asio.reference.generic__stream_protocol.requirements">Requirements</a>
|
||
|
|
</h5>
|
||
|
|
<p>
|
||
|
|
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/generic/stream_protocol.hpp</code>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<div class="copyright-footer">Copyright © 2003-2023 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>
|
||
|
|
<hr>
|
||
|
|
<div class="spirit-nav">
|
||
|
|
<a accesskey="p" href="generic__seq_packet_protocol/type.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="generic__stream_protocol/endpoint.html"><img src="../../next.png" alt="Next"></a>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|