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.78.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="ObjectHandleService.html" title="Object handle service requirements">
  10 <link rel="next" href="RandomAccessHandleService.html" title="Random access handle service 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="ObjectHandleService.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="RandomAccessHandleService.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 protocol must meet the requirements of <code class="computeroutput"><span class="identifier">CopyConstructible</span></code>
  31         types (C++ Std, 20.1.3), and the requirements of <code class="computeroutput"><span class="identifier">Assignable</span></code>
  32         types (C++ Std, 23.1).
  33       </p>
  34 <p>
  35         In the table below, <code class="computeroutput"><span class="identifier">X</span></code> denotes
  36         a protocol class, and <code class="computeroutput"><span class="identifier">a</span></code> denotes
  37         a value of <code class="computeroutput"><span class="identifier">X</span></code>.
  38       </p>
  39 <div class="table">
  40 <a name="boost_asio.reference.Protocol.t0"></a><p class="title"><b>Table&#160;20.&#160;Protocol requirements</b></p>
  41 <div class="table-contents"><table class="table" summary="Protocol requirements">
  42 <colgroup>
  43 <col>
  44 <col>
  45 <col>
  46 </colgroup>
  47 <thead><tr>
  48 <th>
  49                 <p>
  50                   expression
  51                 </p>
  52               </th>
  53 <th>
  54                 <p>
  55                   return type
  56                 </p>
  57               </th>
  58 <th>
  59                 <p>
  60                   assertion/note<br> pre/post-conditions
  61                 </p>
  62               </th>
  63 </tr></thead>
  64 <tbody>
  65 <tr>
  66 <td>
  67                 <p>
  68                   <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">endpoint</span></code>
  69                 </p>
  70               </td>
  71 <td>
  72                 <p>
  73                   type meeting <a class="link" href="Endpoint.html" title="Endpoint requirements">endpoint</a>
  74                   requirements
  75                 </p>
  76               </td>
  77 <td>
  78               </td>
  79 </tr>
  80 <tr>
  81 <td>
  82                 <p>
  83                   <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">family</span><span class="special">()</span></code>
  84                 </p>
  85               </td>
  86 <td>
  87                 <p>
  88                   <code class="computeroutput"><span class="keyword">int</span></code>
  89                 </p>
  90               </td>
  91 <td>
  92                 <p>
  93                   Returns a value suitable for passing as the <span class="emphasis"><em>domain</em></span>
  94                   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>
  95                   (or equivalent).
  96                 </p>
  97               </td>
  98 </tr>
  99 <tr>
 100 <td>
 101                 <p>
 102                   <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">type</span><span class="special">()</span></code>
 103                 </p>
 104               </td>
 105 <td>
 106                 <p>
 107                   <code class="computeroutput"><span class="keyword">int</span></code>
 108                 </p>
 109               </td>
 110 <td>
 111                 <p>
 112                   Returns a value suitable for passing as the <span class="emphasis"><em>type</em></span>
 113                   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>
 114                   (or equivalent).
 115                 </p>
 116               </td>
 117 </tr>
 118 <tr>
 119 <td>
 120                 <p>
 121                   <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">protocol</span><span class="special">()</span></code>
 122                 </p>
 123               </td>
 124 <td>
 125                 <p>
 126                   <code class="computeroutput"><span class="keyword">int</span></code>
 127                 </p>
 128               </td>
 129 <td>
 130                 <p>
 131                   Returns a value suitable for passing as the <span class="emphasis"><em>protocol</em></span>
 132                   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>
 133                   (or equivalent).
 134                 </p>
 135               </td>
 136 </tr>
 137 </tbody>
 138 </table></div>
 139 </div>
 140 <br class="table-break">
 141 </div>
 142 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 143 <td align="left"></td>
 144 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
 145         Distributed under the Boost Software License, Version 1.0. (See accompanying
 146         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>)
 147       </p>
 148 </div></td>
 149 </tr></table>
 150 <hr>
 151 <div class="spirit-nav">
 152 <a accesskey="p" href="ObjectHandleService.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="RandomAccessHandleService.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 153 </div>
 154 </body>
 155 </html>