Protocol.html 6.89 KB
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Protocol requirements</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="ProtoAllocator.html" title="Proto-allocator requirements">
<link rel="next" href="RangeConnectHandler.html" title="Range connect handler requirements">
</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="ProtoAllocator.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="RangeConnectHandler.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.Protocol"></a><a class="link" href="Protocol.html" title="Protocol requirements">Protocol requirements</a>
</h3></div></div></div>
<p>
        A type <code class="computeroutput">X</code> meets the <code class="computeroutput">Protocol</code> requirements if it
        satisfies the requirements of <code class="computeroutput">Destructible</code> (C++Std [destructible]),
        <code class="computeroutput">CopyConstructible</code> (C++Std [copyconstructible]), and <code class="computeroutput">CopyAssignable</code>
        (C++Std [copyassignable]), as well as the additional requirements listed
        below.
      </p>
<p>
        No copy or move operation of the type <code class="computeroutput">X</code> shall exit via an exception.
      </p>
<div class="table">
<a name="asio.reference.Protocol.t0"></a><p class="title"><b>Table 23. Protocol requirements</b></p>
<div class="table-contents"><table class="table" summary="Protocol requirements">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  expression
                </p>
              </th>
<th>
                <p>
                  return type
                </p>
              </th>
<th>
                <p>
                  assertion/note<br> pre/post-conditions
                </p>
              </th>
</tr></thead>
<tbody><tr>
<td>
                <p>
                  <code class="computeroutput">X::endpoint</code>
                </p>
              </td>
<td>
                <p>
                  type meeting <a class="link" href="Endpoint.html" title="Endpoint requirements">endpoint</a>
                  requirements
                </p>
              </td>
<td>
              </td>
</tr></tbody>
</table></div>
</div>
<br class="table-break"><p>
        In the table below, <code class="computeroutput">a</code> denotes a (possibly const) value of type
        <code class="computeroutput">X</code>.
      </p>
<div class="table">
<a name="asio.reference.Protocol.t1"></a><p class="title"><b>Table 24. Protocol requirements for extensible implementations</b></p>
<div class="table-contents"><table class="table" summary="Protocol requirements for extensible implementations">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  expression
                </p>
              </th>
<th>
                <p>
                  return type
                </p>
              </th>
<th>
                <p>
                  assertion/note<br> pre/post-conditions
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <code class="computeroutput">a.family()</code>
                </p>
              </td>
<td>
                <p>
                  <code class="computeroutput">int</code>
                </p>
              </td>
<td>
                <p>
                  Returns a value suitable for passing as the <span class="emphasis"><em>domain</em></span>
                  argument to <span class="emphasis"><em>POSIX</em></span> <a href="http://www.opengroup.org/onlinepubs/9699919799/functions/socket.html" target="_top"><code class="computeroutput"><span class="identifier">socket</span><span class="special">()</span></code></a>
                  (or equivalent).
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <code class="computeroutput">a.type()</code>
                </p>
              </td>
<td>
                <p>
                  <code class="computeroutput">int</code>
                </p>
              </td>
<td>
                <p>
                  Returns a value suitable for passing as the <span class="emphasis"><em>type</em></span>
                  argument to <span class="emphasis"><em>POSIX</em></span> <a href="http://www.opengroup.org/onlinepubs/9699919799/functions/socket.html" target="_top"><code class="computeroutput"><span class="identifier">socket</span><span class="special">()</span></code></a>
                  (or equivalent).
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <code class="computeroutput">a.protocol()</code>
                </p>
              </td>
<td>
                <p>
                  <code class="computeroutput">int</code>
                </p>
              </td>
<td>
                <p>
                  Returns a value suitable for passing as the <span class="emphasis"><em>protocol</em></span>
                  argument to <span class="emphasis"><em>POSIX</em></span> <a href="http://www.opengroup.org/onlinepubs/9699919799/functions/socket.html" target="_top"><code class="computeroutput"><span class="identifier">socket</span><span class="special">()</span></code></a>
                  (or equivalent).
                </p>
              </td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break">
</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-2020 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="ProtoAllocator.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="RangeConnectHandler.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>