• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>basic_stream_socket::bind (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="../bind.html" title="basic_stream_socket::bind">
9<link rel="prev" href="../bind.html" title="basic_stream_socket::bind">
10<link rel="next" href="overload2.html" title="basic_stream_socket::bind (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="../bind.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../bind.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_stream_socket.bind.overload1"></a><a class="link" href="overload1.html" title="basic_stream_socket::bind (1 of 2 overloads)">basic_stream_socket::bind
28          (1 of 2 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            Bind the socket to the given local endpoint.
35          </p>
36<pre class="programlisting">void bind(
37    const endpoint_type &amp; endpoint);
38</pre>
39<p>
40            This function binds the socket to the specified endpoint on the local
41            machine.
42          </p>
43<h6>
44<a name="boost_asio.reference.basic_stream_socket.bind.overload1.h0"></a>
45            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.bind.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.bind.overload1.parameters">Parameters</a>
46          </h6>
47<div class="variablelist">
48<p class="title"><b></b></p>
49<dl class="variablelist">
50<dt><span class="term">endpoint</span></dt>
51<dd><p>
52                  An endpoint on the local machine to which the socket will be bound.
53                </p></dd>
54</dl>
55</div>
56<h6>
57<a name="boost_asio.reference.basic_stream_socket.bind.overload1.h1"></a>
58            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.bind.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.bind.overload1.exceptions">Exceptions</a>
59          </h6>
60<div class="variablelist">
61<p class="title"><b></b></p>
62<dl class="variablelist">
63<dt><span class="term">boost::system::system_error</span></dt>
64<dd><p>
65                  Thrown on failure.
66                </p></dd>
67</dl>
68</div>
69<h6>
70<a name="boost_asio.reference.basic_stream_socket.bind.overload1.h2"></a>
71            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.bind.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.bind.overload1.example">Example</a>
72          </h6>
73<pre class="programlisting">boost::asio::ip::tcp::socket socket(my_context);
74socket.open(boost::asio::ip::tcp::v4());
75socket.bind(boost::asio::ip::tcp::endpoint(
76      boost::asio::ip::tcp::v4(), 12345));
77</pre>
78</div>
79<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
80<td align="left"></td>
81<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
82      Kohlhoff<p>
83        Distributed under the Boost Software License, Version 1.0. (See accompanying
84        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>)
85      </p>
86</div></td>
87</tr></table>
88<hr>
89<div class="spirit-nav">
90<a accesskey="p" href="../bind.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../bind.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>
91</div>
92</body>
93</html>
94