<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>basic_socket_streambuf::async_connect</title> <link rel="stylesheet" href="../../../boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.73.2"> <link rel="start" href="../../../index.html" title="Asio"> <link rel="up" href="../basic_socket_streambuf.html" title="basic_socket_streambuf"> <link rel="prev" href="assign/overload2.html" title="basic_socket_streambuf::assign (2 of 2 overloads)"> <link rel="next" href="at_mark.html" title="basic_socket_streambuf::at_mark"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="assign/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket_streambuf.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="at_mark.html"><img src="../../../next.png" alt="Next"></a> </div> <div class="section" lang="en"> <div class="titlepage"><div><div><h4 class="title"> <a name="asio.reference.basic_socket_streambuf.async_connect"></a><a class="link" href="async_connect.html" title="basic_socket_streambuf::async_connect">basic_socket_streambuf::async_connect</a> </h4></div></div></div> <p> <span class="emphasis"><em>Inherited from basic_socket.</em></span> </p> <p> <a class="indexterm" name="id881529"></a> Start an asynchronous connect. </p> <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <a class="link" href="../ConnectHandler.html" title="Connect handler requirements">ConnectHandler</a><span class="special">></span> <span class="keyword">void</span> <span class="identifier">async_connect</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">endpoint_type</span> <span class="special">&</span> <span class="identifier">peer_endpoint</span><span class="special">,</span> <span class="identifier">ConnectHandler</span> <span class="identifier">handler</span><span class="special">);</span> </pre> <p> This function is used to asynchronously connect a socket to the specified remote endpoint. The function call always returns immediately. </p> <p> The socket is automatically opened if it is not already open. If the connect fails, and the socket was automatically opened, the socket is not returned to the closed state. </p> <a name="asio.reference.basic_socket_streambuf.async_connect.parameters"></a><h6> <a name="id881649"></a> <a class="link" href="async_connect.html#asio.reference.basic_socket_streambuf.async_connect.parameters">Parameters</a> </h6> <div class="variablelist"> <p class="title"><b></b></p> <dl> <dt><span class="term">peer_endpoint</span></dt> <dd><p> The remote endpoint to which the socket will be connected. Copies will be made of the endpoint object as required. </p></dd> <dt><span class="term">handler</span></dt> <dd> <p> The handler to be called when the connection operation completes. Copies will be made of the handler as required. The function signature of the handler must be: </p> <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">error</span> <span class="comment">// Result of operation </span><span class="special">);</span> </pre> <p> Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using <code class="computeroutput"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">post</span><span class="special">()</span></code>. </p> </dd> </dl> </div> <a name="asio.reference.basic_socket_streambuf.async_connect.example"></a><h6> <a name="id881801"></a> <a class="link" href="async_connect.html#asio.reference.basic_socket_streambuf.async_connect.example">Example</a> </h6> <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">connect_handler</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">error</span><span class="special">)</span> <span class="special">{</span> <span class="keyword">if</span> <span class="special">(!</span><span class="identifier">error</span><span class="special">)</span> <span class="special">{</span> <span class="comment">// Connect succeeded. </span> <span class="special">}</span> <span class="special">}</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> <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> <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> <span class="identifier">socket</span><span class="special">.</span><span class="identifier">async_connect</span><span class="special">(</span><span class="identifier">endpoint</span><span class="special">,</span> <span class="identifier">connect_handler</span><span class="special">);</span> </pre> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> <td align="left"></td> <td align="right"><div class="copyright-footer">Copyright © 2003 - 2010 Christopher M. Kohlhoff<p> Distributed under the Boost Software License, Version 1.0. (See accompanying 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>) </p> </div></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="assign/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket_streambuf.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="at_mark.html"><img src="../../../next.png" alt="Next"></a> </div> </body> </html>