doc/html/boost_asio/reference/generic__raw_protocol.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>generic::raw_protocol</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="generic__datagram_protocol/type.html" title="generic::datagram_protocol::type">
  10 <link rel="next" href="generic__raw_protocol/endpoint.html" title="generic::raw_protocol::endpoint">
  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="generic__datagram_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__raw_protocol/endpoint.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.generic__raw_protocol"></a><a class="link" href="generic__raw_protocol.html" title="generic::raw_protocol">generic::raw_protocol</a>
  28 </h3></div></div></div>
  29 <p>
  30         Encapsulates the flags needed for a generic raw socket.
  31       </p>
  32 <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">raw_protocol</span>
  33 </pre>
  34 <h5>
  35 <a name="boost_asio.reference.generic__raw_protocol.h0"></a>
  36         <span class="phrase"><a name="boost_asio.reference.generic__raw_protocol.types"></a></span><a class="link" href="generic__raw_protocol.html#boost_asio.reference.generic__raw_protocol.types">Types</a>
  37       </h5>
  38 <div class="informaltable"><table class="table">
  39 <colgroup>
  40 <col>
  41 <col>
  42 </colgroup>
  43 <thead><tr>
  44 <th>
  45                 <p>
  46                   Name
  47                 </p>
  48               </th>
  49 <th>
  50                 <p>
  51                   Description
  52                 </p>
  53               </th>
  54 </tr></thead>
  55 <tbody>
  56 <tr>
  57 <td>
  58                 <p>
  59                   <a class="link" href="generic__raw_protocol/endpoint.html" title="generic::raw_protocol::endpoint"><span class="bold"><strong>endpoint</strong></span></a>
  60                 </p>
  61               </td>
  62 <td>
  63                 <p>
  64                   The type of an endpoint.
  65                 </p>
  66               </td>
  67 </tr>
  68 <tr>
  69 <td>
  70                 <p>
  71                   <a class="link" href="generic__raw_protocol/socket.html" title="generic::raw_protocol::socket"><span class="bold"><strong>socket</strong></span></a>
  72                 </p>
  73               </td>
  74 <td>
  75                 <p>
  76                   The generic socket type.
  77                 </p>
  78               </td>
  79 </tr>
  80 </tbody>
  81 </table></div>
  82 <h5>
  83 <a name="boost_asio.reference.generic__raw_protocol.h1"></a>
  84         <span class="phrase"><a name="boost_asio.reference.generic__raw_protocol.member_functions"></a></span><a class="link" href="generic__raw_protocol.html#boost_asio.reference.generic__raw_protocol.member_functions">Member
  85         Functions</a>
  86       </h5>
  87 <div class="informaltable"><table class="table">
  88 <colgroup>
  89 <col>
  90 <col>
  91 </colgroup>
  92 <thead><tr>
  93 <th>
  94                 <p>
  95                   Name
  96                 </p>
  97               </th>
  98 <th>
  99                 <p>
 100                   Description
 101                 </p>
 102               </th>
 103 </tr></thead>
 104 <tbody>
 105 <tr>
 106 <td>
 107                 <p>
 108                   <a class="link" href="generic__raw_protocol/family.html" title="generic::raw_protocol::family"><span class="bold"><strong>family</strong></span></a>
 109                 </p>
 110               </td>
 111 <td>
 112                 <p>
 113                   Obtain an identifier for the protocol family.
 114                 </p>
 115               </td>
 116 </tr>
 117 <tr>
 118 <td>
 119                 <p>
 120                   <a class="link" href="generic__raw_protocol/protocol.html" title="generic::raw_protocol::protocol"><span class="bold"><strong>protocol</strong></span></a>
 121                 </p>
 122               </td>
 123 <td>
 124                 <p>
 125                   Obtain an identifier for the protocol.
 126                 </p>
 127               </td>
 128 </tr>
 129 <tr>
 130 <td>
 131                 <p>
 132                   <a class="link" href="generic__raw_protocol/raw_protocol.html" title="generic::raw_protocol::raw_protocol"><span class="bold"><strong>raw_protocol</strong></span></a>
 133                 </p>
 134               </td>
 135 <td>
 136                 <p>
 137                   Construct a protocol object for a specific address family and protocol.
 138                 </p>
 139                 <p>
 140                   Construct a generic protocol object from a specific protocol.
 141                 </p>
 142               </td>
 143 </tr>
 144 <tr>
 145 <td>
 146                 <p>
 147                   <a class="link" href="generic__raw_protocol/type.html" title="generic::raw_protocol::type"><span class="bold"><strong>type</strong></span></a>
 148                 </p>
 149               </td>
 150 <td>
 151                 <p>
 152                   Obtain an identifier for the type of the protocol.
 153                 </p>
 154               </td>
 155 </tr>
 156 </tbody>
 157 </table></div>
 158 <h5>
 159 <a name="boost_asio.reference.generic__raw_protocol.h2"></a>
 160         <span class="phrase"><a name="boost_asio.reference.generic__raw_protocol.friends"></a></span><a class="link" href="generic__raw_protocol.html#boost_asio.reference.generic__raw_protocol.friends">Friends</a>
 161       </h5>
 162 <div class="informaltable"><table class="table">
 163 <colgroup>
 164 <col>
 165 <col>
 166 </colgroup>
 167 <thead><tr>
 168 <th>
 169                 <p>
 170                   Name
 171                 </p>
 172               </th>
 173 <th>
 174                 <p>
 175                   Description
 176                 </p>
 177               </th>
 178 </tr></thead>
 179 <tbody>
 180 <tr>
 181 <td>
 182                 <p>
 183                   <a class="link" href="generic__raw_protocol/operator_not__eq_.html" title="generic::raw_protocol::operator!="><span class="bold"><strong>operator!=</strong></span></a>
 184                 </p>
 185               </td>
 186 <td>
 187                 <p>
 188                   Compare two protocols for inequality.
 189                 </p>
 190               </td>
 191 </tr>
 192 <tr>
 193 <td>
 194                 <p>
 195                   <a class="link" href="generic__raw_protocol/operator_eq__eq_.html" title="generic::raw_protocol::operator=="><span class="bold"><strong>operator==</strong></span></a>
 196                 </p>
 197               </td>
 198 <td>
 199                 <p>
 200                   Compare two protocols for equality.
 201                 </p>
 202               </td>
 203 </tr>
 204 </tbody>
 205 </table></div>
 206 <p>
 207         The <a class="link" href="generic__raw_protocol.html" title="generic::raw_protocol"><code class="computeroutput"><span class="identifier">generic</span><span class="special">::</span><span class="identifier">raw_protocol</span></code></a> class contains flags
 208         necessary for raw sockets of any address family and protocol.
 209       </p>
 210 <h5>
 211 <a name="boost_asio.reference.generic__raw_protocol.h3"></a>
 212         <span class="phrase"><a name="boost_asio.reference.generic__raw_protocol.examples"></a></span><a class="link" href="generic__raw_protocol.html#boost_asio.reference.generic__raw_protocol.examples">Examples</a>
 213       </h5>
 214 <p>
 215         Constructing using a native address family and socket protocol:
 216       </p>
 217 <pre class="programlisting"><span class="identifier">raw_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_ICMP</span><span class="special">);</span>
 218 </pre>
 219 <p>
 220         Constructing from a specific protocol type:
 221       </p>
 222 <pre class="programlisting"><span class="identifier">raw_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">icmp</span><span class="special">::</span><span class="identifier">v4</span><span class="special">());</span>
 223 </pre>
 224 <h5>
 225 <a name="boost_asio.reference.generic__raw_protocol.h4"></a>
 226         <span class="phrase"><a name="boost_asio.reference.generic__raw_protocol.thread_safety"></a></span><a class="link" href="generic__raw_protocol.html#boost_asio.reference.generic__raw_protocol.thread_safety">Thread
 227         Safety</a>
 228       </h5>
 229 <p>
 230         <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 231       </p>
 232 <p>
 233         <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
 234       </p>
 235 <h5>
 236 <a name="boost_asio.reference.generic__raw_protocol.h5"></a>
 237         <span class="phrase"><a name="boost_asio.reference.generic__raw_protocol.requirements"></a></span><a class="link" href="generic__raw_protocol.html#boost_asio.reference.generic__raw_protocol.requirements">Requirements</a>
 238       </h5>
 239 <p>
 240         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/generic/raw_protocol.hpp</code>
 241       </p>
 242 <p>
 243         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 244       </p>
 245 </div>
 246 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 247 <td align="left"></td>
 248 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
 249         Distributed under the Boost Software License, Version 1.0. (See accompanying
 250         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>)
 251       </p>
 252 </div></td>
 253 </tr></table>
 254 <hr>
 255 <div class="spirit-nav">
 256 <a accesskey="p" href="generic__datagram_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__raw_protocol/endpoint.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 257 </div>
 258 </body>
 259 </html>