doc/html/boost_asio/reference/basic_socket_acceptor/accept/overload12.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_socket_acceptor::accept (12 of 16 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="../accept.html" title="basic_socket_acceptor::accept">
   9 <link rel="prev" href="overload11.html" title="basic_socket_acceptor::accept (11 of 16 overloads)">
  10 <link rel="next" href="overload13.html" title="basic_socket_acceptor::accept (13 of 16 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="overload11.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../accept.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="overload13.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_acceptor.accept.overload12"></a><a class="link" href="overload12.html" title="basic_socket_acceptor::accept (12 of 16 overloads)">basic_socket_acceptor::accept
  28           (12 of 16 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Accept a new connection.
  32           </p>
  33 <pre class="programlisting">Protocol::socket::template rebind_executor&lt; executor_type &gt;::other accept(
  34     endpoint_type &amp; peer_endpoint,
  35     boost::system::error_code &amp; ec);
  36 </pre>
  37 <p>
  38             This function is used to accept a new connection from a peer. The function
  39             call will block until a new connection has been accepted successfully
  40             or an error occurs.
  41           </p>
  42 <p>
  43             This overload requires that the Protocol template parameter satisfy the
  44             AcceptableProtocol type requirements.
  45           </p>
  46 <h6>
  47 <a name="boost_asio.reference.basic_socket_acceptor.accept.overload12.h0"></a>
  48             <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.accept.overload12.parameters"></a></span><a class="link" href="overload12.html#boost_asio.reference.basic_socket_acceptor.accept.overload12.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                   An endpoint object into which the endpoint of the remote peer will
  56                   be written.
  57                 </p></dd>
  58 <dt><span class="term">ec</span></dt>
  59 <dd><p>
  60                   Set to indicate what error occurred, if any.
  61                 </p></dd>
  62 </dl>
  63 </div>
  64 <h6>
  65 <a name="boost_asio.reference.basic_socket_acceptor.accept.overload12.h1"></a>
  66             <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.accept.overload12.return_value"></a></span><a class="link" href="overload12.html#boost_asio.reference.basic_socket_acceptor.accept.overload12.return_value">Return
  67             Value</a>
  68           </h6>
  69 <p>
  70             On success, a socket object representing the newly accepted connection.
  71             On error, a socket object where <code class="computeroutput">is_open()</code> is false.
  72           </p>
  73 <h6>
  74 <a name="boost_asio.reference.basic_socket_acceptor.accept.overload12.h2"></a>
  75             <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.accept.overload12.example"></a></span><a class="link" href="overload12.html#boost_asio.reference.basic_socket_acceptor.accept.overload12.example">Example</a>
  76           </h6>
  77 <pre class="programlisting">boost::asio::ip::tcp::acceptor acceptor(my_context);
  78 ...
  79 boost::asio::ip::tcp::endpoint endpoint;
  80 boost::asio::ip::tcp::socket socket(acceptor.accept(endpoint, ec));
  81 if (ec)
  82 {
  83   // An error occurred.
  84 }
  85 </pre>
  86 </div>
  87 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  88 <td align="left"></td>
  89 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
  90         Distributed under the Boost Software License, Version 1.0. (See accompanying
  91         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>)
  92       </p>
  93 </div></td>
  94 </tr></table>
  95 <hr>
  96 <div class="spirit-nav">
  97 <a accesskey="p" href="overload11.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../accept.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="overload13.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  98 </div>
  99 </body>
 100 </html>