doc/html/boost_asio/reference/basic_stream_socket/remote_endpoint/overload1.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_stream_socket::remote_endpoint (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.76.1">
   7 <link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../remote_endpoint.html" title="basic_stream_socket::remote_endpoint">
   9 <link rel="prev" href="../remote_endpoint.html" title="basic_stream_socket::remote_endpoint">
  10 <link rel="next" href="overload2.html" title="basic_stream_socket::remote_endpoint (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="../remote_endpoint.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../remote_endpoint.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.remote_endpoint.overload1"></a><a class="link" href="overload1.html" title="basic_stream_socket::remote_endpoint (1 of 2 overloads)">basic_stream_socket::remote_endpoint
  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             Get the remote endpoint of the socket.
  35           </p>
  36 <pre class="programlisting"><span class="identifier">endpoint_type</span> <span class="identifier">remote_endpoint</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
  37 </pre>
  38 <p>
  39             This function is used to obtain the remote endpoint of the socket.
  40           </p>
  41 <h6>
  42 <a name="boost_asio.reference.basic_stream_socket.remote_endpoint.overload1.h0"></a>
  43             <span><a name="boost_asio.reference.basic_stream_socket.remote_endpoint.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.remote_endpoint.overload1.return_value">Return
  44             Value</a>
  45           </h6>
  46 <p>
  47             An object that represents the remote endpoint of the socket.
  48           </p>
  49 <h6>
  50 <a name="boost_asio.reference.basic_stream_socket.remote_endpoint.overload1.h1"></a>
  51             <span><a name="boost_asio.reference.basic_stream_socket.remote_endpoint.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.remote_endpoint.overload1.exceptions">Exceptions</a>
  52           </h6>
  53 <div class="variablelist">
  54 <p class="title"><b></b></p>
  55 <dl>
  56 <dt><span class="term">boost::system::system_error</span></dt>
  57 <dd><p>
  58                   Thrown on failure.
  59                 </p></dd>
  60 </dl>
  61 </div>
  62 <h6>
  63 <a name="boost_asio.reference.basic_stream_socket.remote_endpoint.overload1.h2"></a>
  64             <span><a name="boost_asio.reference.basic_stream_socket.remote_endpoint.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_stream_socket.remote_endpoint.overload1.example">Example</a>
  65           </h6>
  66 <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">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span>
  67 <span class="special">...</span>
  68 <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> <span class="identifier">socket</span><span class="special">.</span><span class="identifier">remote_endpoint</span><span class="special">();</span>
  69 </pre>
  70 </div>
  71 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  72 <td align="left"></td>
  73 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2012 Christopher M. Kohlhoff<p>
  74         Distributed under the Boost Software License, Version 1.0. (See accompanying
  75         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>)
  76       </p>
  77 </div></td>
  78 </tr></table>
  79 <hr>
  80 <div class="spirit-nav">
  81 <a accesskey="p" href="../remote_endpoint.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../remote_endpoint.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>
  82 </div>
  83 </body>
  84 </html>