doc/html/boost_asio/reference/basic_stream_socket/async_connect.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_stream_socket::async_connect</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="../basic_stream_socket.html" title="basic_stream_socket">
   9 <link rel="prev" href="assign/overload2.html" title="basic_stream_socket::assign (2 of 2 overloads)">
  10 <link rel="next" href="async_read_some.html" title="basic_stream_socket::async_read_some">
  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="assign/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_socket.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="async_read_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_asio.reference.basic_stream_socket.async_connect"></a><a class="link" href="async_connect.html" title="basic_stream_socket::async_connect">basic_stream_socket::async_connect</a>
  28 </h4></div></div></div>
  29 <p>
  30           <span class="emphasis"><em>Inherited from basic_socket.</em></span>
  31         </p>
  32 <p>
  33           <a class="indexterm" name="boost_asio.indexterm.basic_stream_socket.async_connect"></a>
  34 Start
  35           an asynchronous connect.
  36         </p>
  37 <pre class="programlisting">template&lt;
  38     typename <a class="link" href="../ConnectHandler.html" title="Connect handler requirements">ConnectHandler</a> = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
  39 <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_connect(
  40     const endpoint_type &amp; peer_endpoint,
  41     ConnectHandler &amp;&amp; handler = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
  42 </pre>
  43 <p>
  44           This function is used to asynchronously connect a socket to the specified
  45           remote endpoint. The function call always returns immediately.
  46         </p>
  47 <p>
  48           The socket is automatically opened if it is not already open. If the connect
  49           fails, and the socket was automatically opened, the socket is not returned
  50           to the closed state.
  51         </p>
  52 <h6>
  53 <a name="boost_asio.reference.basic_stream_socket.async_connect.h0"></a>
  54           <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.async_connect.parameters"></a></span><a class="link" href="async_connect.html#boost_asio.reference.basic_stream_socket.async_connect.parameters">Parameters</a>
  55         </h6>
  56 <div class="variablelist">
  57 <p class="title"><b></b></p>
  58 <dl class="variablelist">
  59 <dt><span class="term">peer_endpoint</span></dt>
  60 <dd><p>
  61                 The remote endpoint to which the socket will be connected. Copies
  62                 will be made of the endpoint object as required.
  63               </p></dd>
  64 <dt><span class="term">handler</span></dt>
  65 <dd>
  66 <p>
  67                 The handler to be called when the connection operation completes.
  68                 Copies will be made of the handler as required. The function signature
  69                 of the handler must be:
  70 </p>
  71 <pre class="programlisting">void handler(
  72   const boost::system::error_code&amp; error // Result of operation
  73 );
  74 </pre>
  75 <p>
  76                 Regardless of whether the asynchronous operation completes immediately
  77                 or not, the handler will not be invoked from within this function.
  78                 On immediate completion, invocation of the handler will be performed
  79                 in a manner equivalent to using <a class="link" href="../post.html" title="post"><code class="computeroutput">post</code></a>.
  80               </p>
  81 </dd>
  82 </dl>
  83 </div>
  84 <h6>
  85 <a name="boost_asio.reference.basic_stream_socket.async_connect.h1"></a>
  86           <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.async_connect.example"></a></span><a class="link" href="async_connect.html#boost_asio.reference.basic_stream_socket.async_connect.example">Example</a>
  87         </h6>
  88 <pre class="programlisting">void connect_handler(const boost::system::error_code&amp; error)
  89 {
  90   if (!error)
  91   {
  92     // Connect succeeded.
  93   }
  94 }
  95
  96 ...
  97
  98 boost::asio::ip::tcp::socket socket(my_context);
  99 boost::asio::ip::tcp::endpoint endpoint(
 100     boost::asio::ip::address::from_string("1.2.3.4"), 12345);
 101 socket.async_connect(endpoint, connect_handler);
 102 </pre>
 103 </div>
 104 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 105 <td align="left"></td>
 106 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
 107         Distributed under the Boost Software License, Version 1.0. (See accompanying
 108         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>)
 109       </p>
 110 </div></td>
 111 </tr></table>
 112 <hr>
 113 <div class="spirit-nav">
 114 <a accesskey="p" href="assign/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_stream_socket.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="async_read_some.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 115 </div>
 116 </body>
 117 </html>