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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_socket_acceptor::accept (4 of 4 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="overload3.html" title="basic_socket_acceptor::accept (3 of 4 overloads)">
  10 <link rel="next" href="../assign.html" title="basic_socket_acceptor::assign">
  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="overload3.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="../assign.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.overload4"></a><a class="link" href="overload4.html" title="basic_socket_acceptor::accept (4 of 4 overloads)">basic_socket_acceptor::accept
  28           (4 of 4 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Accept a new connection and obtain the endpoint of the peer.
  32           </p>
  33 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  34     <span class="keyword">typename</span> <a class="link" href="../../SocketService.html" title="Socket service requirements">SocketService</a><span class="special">&gt;</span>
  35 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">accept</span><span class="special">(</span>
  36     <span class="identifier">basic_socket</span><span class="special">&lt;</span> <span class="identifier">protocol_type</span><span class="special">,</span> <span class="identifier">SocketService</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">peer</span><span class="special">,</span>
  37     <span class="identifier">endpoint_type</span> <span class="special">&amp;</span> <span class="identifier">peer_endpoint</span><span class="special">,</span>
  38     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  39 </pre>
  40 <p>
  41             This function is used to accept a new connection from a peer into the
  42             given socket, and additionally provide the endpoint of the remote peer.
  43             The function call will block until a new connection has been accepted
  44             successfully or an error occurs.
  45           </p>
  46 <h6>
  47 <a name="boost_asio.reference.basic_socket_acceptor.accept.overload4.h0"></a>
  48             <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.accept.overload4.parameters"></a></span><a class="link" href="overload4.html#boost_asio.reference.basic_socket_acceptor.accept.overload4.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</span></dt>
  54 <dd><p>
  55                   The socket into which the new connection will be accepted.
  56                 </p></dd>
  57 <dt><span class="term">peer_endpoint</span></dt>
  58 <dd><p>
  59                   An endpoint object which will receive the endpoint of the remote
  60                   peer.
  61                 </p></dd>
  62 <dt><span class="term">ec</span></dt>
  63 <dd><p>
  64                   Set to indicate what error occurred, if any.
  65                 </p></dd>
  66 </dl>
  67 </div>
  68 <h6>
  69 <a name="boost_asio.reference.basic_socket_acceptor.accept.overload4.h1"></a>
  70             <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.accept.overload4.example"></a></span><a class="link" href="overload4.html#boost_asio.reference.basic_socket_acceptor.accept.overload4.example">Example</a>
  71           </h6>
  72 <pre class="programlisting"><span class="identifier">boost</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">acceptor</span> <span class="identifier">acceptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span>
  73 <span class="special">...</span>
  74 <span class="identifier">boost</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>
  75 <span class="identifier">boost</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>
  76 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">ec</span><span class="special">;</span>
  77 <span class="identifier">acceptor</span><span class="special">.</span><span class="identifier">accept</span><span class="special">(</span><span class="identifier">socket</span><span class="special">,</span> <span class="identifier">endpoint</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  78 <span class="keyword">if</span> <span class="special">(</span><span class="identifier">ec</span><span class="special">)</span>
  79 <span class="special">{</span>
  80   <span class="comment">// An error occurred.</span>
  81 <span class="special">}</span>
  82 </pre>
  83 </div>
  84 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  85 <td align="left"></td>
  86 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
  87         Distributed under the Boost Software License, Version 1.0. (See accompanying
  88         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>)
  89       </p>
  90 </div></td>
  91 </tr></table>
  92 <hr>
  93 <div class="spirit-nav">
  94 <a accesskey="p" href="overload3.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="../assign.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  95 </div>
  96 </body>
  97 </html>