doc/html/boost_asio/reference/basic_socket/open/overload2.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_socket::open (2 of 2 overloads)</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="../open.html" title="basic_socket::open">
   9 <link rel="prev" href="overload1.html" title="basic_socket::open (1 of 2 overloads)">
  10 <link rel="next" href="../operator_eq_.html" title="basic_socket::operator=">
  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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../open.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="../operator_eq_.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="boost_asio.reference.basic_socket.open.overload2"></a><a class="link" href="overload2.html" title="basic_socket::open (2 of 2 overloads)">basic_socket::open
  28           (2 of 2 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Open the socket using the specified protocol.
  32           </p>
  33 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">open</span><span class="special">(</span>
  34     <span class="keyword">const</span> <span class="identifier">protocol_type</span> <span class="special">&amp;</span> <span class="identifier">protocol</span><span class="special">,</span>
  35     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  36 </pre>
  37 <p>
  38             This function opens the socket so that it will use the specified protocol.
  39           </p>
  40 <h6>
  41 <a name="boost_asio.reference.basic_socket.open.overload2.h0"></a>
  42             <span class="phrase"><a name="boost_asio.reference.basic_socket.open.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.open.overload2.parameters">Parameters</a>
  43           </h6>
  44 <div class="variablelist">
  45 <p class="title"><b></b></p>
  46 <dl class="variablelist">
  47 <dt><span class="term">protocol</span></dt>
  48 <dd><p>
  49                   An object specifying which protocol is to be used.
  50                 </p></dd>
  51 <dt><span class="term">ec</span></dt>
  52 <dd><p>
  53                   Set to indicate what error occurred, if any.
  54                 </p></dd>
  55 </dl>
  56 </div>
  57 <h6>
  58 <a name="boost_asio.reference.basic_socket.open.overload2.h1"></a>
  59             <span class="phrase"><a name="boost_asio.reference.basic_socket.open.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_socket.open.overload2.example">Example</a>
  60           </h6>
  61 <pre class="programlisting"><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">tcp</span><span class="special">::</span><span class="identifier">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span>
  62 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">ec</span><span class="special">;</span>
  63 <span class="identifier">socket</span><span class="special">.</span><span class="identifier">open</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">tcp</span><span class="special">::</span><span class="identifier">v4</span><span class="special">(),</span> <span class="identifier">ec</span><span class="special">);</span>
  64 <span class="keyword">if</span> <span class="special">(</span><span class="identifier">ec</span><span class="special">)</span>
  65 <span class="special">{</span>
  66   <span class="comment">// An error occurred.</span>
  67 <span class="special">}</span>
  68 </pre>
  69 </div>
  70 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  71 <td align="left"></td>
  72 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  73         Distributed under the Boost Software License, Version 1.0. (See accompanying
  74         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>)
  75       </p>
  76 </div></td>
  77 </tr></table>
  78 <hr>
  79 <div class="spirit-nav">
  80 <a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../open.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="../operator_eq_.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  81 </div>
  82 </body>
  83 </html>