doc/html/boost_asio/reference/Protocol.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Protocol requirements</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../reference.html" title="Reference">
   9 <link rel="prev" href="ProtoAllocator.html" title="Proto-allocator requirements">
  10 <link rel="next" href="RangeConnectHandler.html" title="Range connect handler requirements">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="ProtoAllocator.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="RangeConnectHandler.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_asio.reference.Protocol"></a><a class="link" href="Protocol.html" title="Protocol requirements">Protocol requirements</a>
  28 </h3></div></div></div>
  29 <p>
  30         A type <code class="computeroutput">X</code> meets the <code class="computeroutput">Protocol</code> requirements if it
  31         satisfies the requirements of <code class="computeroutput">Destructible</code> (C++Std [destructible]),
  32         <code class="computeroutput">CopyConstructible</code> (C++Std [copyconstructible]), and <code class="computeroutput">CopyAssignable</code>
  33         (C++Std [copyassignable]), as well as the additional requirements listed
  34         below.
  35       </p>
  36 <div class="table">
  37 <a name="boost_asio.reference.Protocol.t0"></a><p class="title"><b>Table&#160;23.&#160;Protocol requirements</b></p>
  38 <div class="table-contents"><table class="table" summary="Protocol requirements">
  39 <colgroup>
  40 <col>
  41 <col>
  42 <col>
  43 </colgroup>
  44 <thead><tr>
  45 <th>
  46                 <p>
  47                   expression
  48                 </p>
  49               </th>
  50 <th>
  51                 <p>
  52                   return type
  53                 </p>
  54               </th>
  55 <th>
  56                 <p>
  57                   assertion/note<br> pre/post-conditions
  58                 </p>
  59               </th>
  60 </tr></thead>
  61 <tbody><tr>
  62 <td>
  63                 <p>
  64                   <code class="computeroutput">X::endpoint</code>
  65                 </p>
  66               </td>
  67 <td>
  68                 <p>
  69                   type meeting <a class="link" href="Endpoint.html" title="Endpoint requirements">endpoint</a>
  70                   requirements
  71                 </p>
  72               </td>
  73 <td>
  74               </td>
  75 </tr></tbody>
  76 </table></div>
  77 </div>
  78 <br class="table-break"><p>
  79         In the table below, <code class="computeroutput">a</code> denotes a (possibly const) value of type
  80         <code class="computeroutput">X</code>.
  81       </p>
  82 <div class="table">
  83 <a name="boost_asio.reference.Protocol.t1"></a><p class="title"><b>Table&#160;24.&#160;Protocol requirements for extensible implementations</b></p>
  84 <div class="table-contents"><table class="table" summary="Protocol requirements for extensible implementations">
  85 <colgroup>
  86 <col>
  87 <col>
  88 <col>
  89 </colgroup>
  90 <thead><tr>
  91 <th>
  92                 <p>
  93                   expression
  94                 </p>
  95               </th>
  96 <th>
  97                 <p>
  98                   return type
  99                 </p>
 100               </th>
 101 <th>
 102                 <p>
 103                   assertion/note<br> pre/post-conditions
 104                 </p>
 105               </th>
 106 </tr></thead>
 107 <tbody>
 108 <tr>
 109 <td>
 110                 <p>
 111                   <code class="computeroutput">a.family()</code>
 112                 </p>
 113               </td>
 114 <td>
 115                 <p>
 116                   <code class="computeroutput">int</code>
 117                 </p>
 118               </td>
 119 <td>
 120                 <p>
 121                   Returns a value suitable for passing as the <span class="emphasis"><em>domain</em></span>
 122                   argument to <span class="emphasis"><em>POSIX</em></span> <a href="http://www.opengroup.org/onlinepubs/000095399/functions/socket.html" target="_top"><code class="computeroutput"><span class="identifier">socket</span><span class="special">()</span></code></a>
 123                   (or equivalent).
 124                 </p>
 125               </td>
 126 </tr>
 127 <tr>
 128 <td>
 129                 <p>
 130                   <code class="computeroutput">a.type()</code>
 131                 </p>
 132               </td>
 133 <td>
 134                 <p>
 135                   <code class="computeroutput">int</code>
 136                 </p>
 137               </td>
 138 <td>
 139                 <p>
 140                   Returns a value suitable for passing as the <span class="emphasis"><em>type</em></span>
 141                   argument to <span class="emphasis"><em>POSIX</em></span> <a href="http://www.opengroup.org/onlinepubs/000095399/functions/socket.html" target="_top"><code class="computeroutput"><span class="identifier">socket</span><span class="special">()</span></code></a>
 142                   (or equivalent).
 143                 </p>
 144               </td>
 145 </tr>
 146 <tr>
 147 <td>
 148                 <p>
 149                   <code class="computeroutput">a.protocol()</code>
 150                 </p>
 151               </td>
 152 <td>
 153                 <p>
 154                   <code class="computeroutput">int</code>
 155                 </p>
 156               </td>
 157 <td>
 158                 <p>
 159                   Returns a value suitable for passing as the <span class="emphasis"><em>protocol</em></span>
 160                   argument to <span class="emphasis"><em>POSIX</em></span> <a href="http://www.opengroup.org/onlinepubs/000095399/functions/socket.html" target="_top"><code class="computeroutput"><span class="identifier">socket</span><span class="special">()</span></code></a>
 161                   (or equivalent).
 162                 </p>
 163               </td>
 164 </tr>
 165 </tbody>
 166 </table></div>
 167 </div>
 168 <br class="table-break">
 169 </div>
 170 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 171 <td align="left"></td>
 172 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
 173         Distributed under the Boost Software License, Version 1.0. (See accompanying
 174         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>)
 175       </p>
 176 </div></td>
 177 </tr></table>
 178 <hr>
 179 <div class="spirit-nav">
 180 <a accesskey="p" href="ProtoAllocator.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="RangeConnectHandler.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 181 </div>
 182 </body>
 183 </html>