1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_socket::connect (1 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.79.1"> 7<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../connect.html" title="basic_socket::connect"> 9<link rel="prev" href="../connect.html" title="basic_socket::connect"> 10<link rel="next" href="overload2.html" title="basic_socket::connect (2 of 2 overloads)"> 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="../connect.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="overload2.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.connect.overload1"></a><a class="link" href="overload1.html" title="basic_socket::connect (1 of 2 overloads)">basic_socket::connect 28 (1 of 2 overloads)</a> 29</h5></div></div></div> 30<p> 31 Connect the socket to the specified endpoint. 32 </p> 33<pre class="programlisting">void connect( 34 const endpoint_type & peer_endpoint); 35</pre> 36<p> 37 This function is used to connect a socket to the specified remote endpoint. 38 The function call will block until the connection is successfully made 39 or an error occurs. 40 </p> 41<p> 42 The socket is automatically opened if it is not already open. If the 43 connect fails, and the socket was automatically opened, the socket is 44 not returned to the closed state. 45 </p> 46<h6> 47<a name="boost_asio.reference.basic_socket.connect.overload1.h0"></a> 48 <span class="phrase"><a name="boost_asio.reference.basic_socket.connect.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.connect.overload1.parameters">Parameters</a> 49 </h6> 50<div class="variablelist"> 51<p class="title"><b></b></p> 52<dl class="variablelist"> 53<dt><span class="term">peer_endpoint</span></dt> 54<dd><p> 55 The remote endpoint to which the socket will be connected. 56 </p></dd> 57</dl> 58</div> 59<h6> 60<a name="boost_asio.reference.basic_socket.connect.overload1.h1"></a> 61 <span class="phrase"><a name="boost_asio.reference.basic_socket.connect.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.connect.overload1.exceptions">Exceptions</a> 62 </h6> 63<div class="variablelist"> 64<p class="title"><b></b></p> 65<dl class="variablelist"> 66<dt><span class="term">boost::system::system_error</span></dt> 67<dd><p> 68 Thrown on failure. 69 </p></dd> 70</dl> 71</div> 72<h6> 73<a name="boost_asio.reference.basic_socket.connect.overload1.h2"></a> 74 <span class="phrase"><a name="boost_asio.reference.basic_socket.connect.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.connect.overload1.example">Example</a> 75 </h6> 76<pre class="programlisting">boost::asio::ip::tcp::socket socket(my_context); 77boost::asio::ip::tcp::endpoint endpoint( 78 boost::asio::ip::address::from_string("1.2.3.4"), 12345); 79socket.connect(endpoint); 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 © 2003-2020 Christopher M. 85 Kohlhoff<p> 86 Distributed under the Boost Software License, Version 1.0. (See accompanying 87 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>) 88 </p> 89</div></td> 90</tr></table> 91<hr> 92<div class="spirit-nav"> 93<a accesskey="p" href="../connect.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 94</div> 95</body> 96</html> 97
