doc/html/boost_asio/reference/basic_socket_streambuf/connect/overload3.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_socket_streambuf::connect (3 of 3 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="../connect.html" title="basic_socket_streambuf::connect">
   9 <link rel="prev" href="overload2.html" title="basic_socket_streambuf::connect (2 of 3 overloads)">
  10 <link rel="next" href="../debug.html" title="basic_socket_streambuf::debug">
  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="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../connect.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="../debug.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_streambuf.connect.overload3"></a><a class="link" href="overload3.html" title="basic_socket_streambuf::connect (3 of 3 overloads)">basic_socket_streambuf::connect
  28           (3 of 3 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             <span class="emphasis"><em>Inherited from basic_socket.</em></span>
  32           </p>
  33 <p>
  34             Connect the socket to the specified endpoint.
  35           </p>
  36 <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">connect</span><span class="special">(</span>
  37     <span class="keyword">const</span> <span class="identifier">endpoint_type</span> <span class="special">&amp;</span> <span class="identifier">peer_endpoint</span><span class="special">,</span>
  38     <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>
  39 </pre>
  40 <p>
  41             This function is used to connect a socket to the specified remote endpoint.
  42             The function call will block until the connection is successfully made
  43             or an error occurs.
  44           </p>
  45 <p>
  46             The socket is automatically opened if it is not already open. If the
  47             connect fails, and the socket was automatically opened, the socket is
  48             not returned to the closed state.
  49           </p>
  50 <h6>
  51 <a name="boost_asio.reference.basic_socket_streambuf.connect.overload3.h0"></a>
  52             <span class="phrase"><a name="boost_asio.reference.basic_socket_streambuf.connect.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_socket_streambuf.connect.overload3.parameters">Parameters</a>
  53           </h6>
  54 <div class="variablelist">
  55 <p class="title"><b></b></p>
  56 <dl class="variablelist">
  57 <dt><span class="term">peer_endpoint</span></dt>
  58 <dd><p>
  59                   The remote endpoint to which the socket will be connected.
  60                 </p></dd>
  61 <dt><span class="term">ec</span></dt>
  62 <dd><p>
  63                   Set to indicate what error occurred, if any.
  64                 </p></dd>
  65 </dl>
  66 </div>
  67 <h6>
  68 <a name="boost_asio.reference.basic_socket_streambuf.connect.overload3.h1"></a>
  69             <span class="phrase"><a name="boost_asio.reference.basic_socket_streambuf.connect.overload3.example"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_socket_streambuf.connect.overload3.example">Example</a>
  70           </h6>
  71 <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>
  72 <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">endpoint</span> <span class="identifier">endpoint</span><span class="special">(</span>
  73     <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">address</span><span class="special">::</span><span class="identifier">from_string</span><span class="special">(</span><span class="string">"1.2.3.4"</span><span class="special">),</span> <span class="number">12345</span><span class="special">);</span>
  74 <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>
  75 <span class="identifier">socket</span><span class="special">.</span><span class="identifier">connect</span><span class="special">(</span><span class="identifier">endpoint</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  76 <span class="keyword">if</span> <span class="special">(</span><span class="identifier">ec</span><span class="special">)</span>
  77 <span class="special">{</span>
  78   <span class="comment">// An error occurred.</span>
  79 <span class="special">}</span>
  80 </pre>
  81 </div>
  82 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  83 <td align="left"></td>
  84 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  85         Distributed under the Boost Software License, Version 1.0. (See accompanying
  86         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>)
  87       </p>
  88 </div></td>
  89 </tr></table>
  90 <hr>
  91 <div class="spirit-nav">
  92 <a accesskey="p" href="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../connect.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="../debug.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  93 </div>
  94 </body>
  95 </html>