doc/html/boost_asio/reference/basic_socket/get_option/overload1.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_socket::get_option (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.78.1">
   7 <link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../get_option.html" title="basic_socket::get_option">
   9 <link rel="prev" href="../get_option.html" title="basic_socket::get_option">
  10 <link rel="next" href="overload2.html" title="basic_socket::get_option (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="../get_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_option.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.get_option.overload1"></a><a class="link" href="overload1.html" title="basic_socket::get_option (1 of 2 overloads)">basic_socket::get_option
  28           (1 of 2 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Get an option from the socket.
  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="../../GettableSocketOption.html" title="Gettable socket option requirements">GettableSocketOption</a><span class="special">&gt;</span>
  35 <span class="keyword">void</span> <span class="identifier">get_option</span><span class="special">(</span>
  36     <span class="identifier">GettableSocketOption</span> <span class="special">&amp;</span> <span class="identifier">option</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  37 </pre>
  38 <p>
  39             This function is used to get the current value of an option on the socket.
  40           </p>
  41 <h6>
  42 <a name="boost_asio.reference.basic_socket.get_option.overload1.h0"></a>
  43             <span class="phrase"><a name="boost_asio.reference.basic_socket.get_option.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.get_option.overload1.parameters">Parameters</a>
  44           </h6>
  45 <div class="variablelist">
  46 <p class="title"><b></b></p>
  47 <dl class="variablelist">
  48 <dt><span class="term">option</span></dt>
  49 <dd><p>
  50                   The option value to be obtained from the socket.
  51                 </p></dd>
  52 </dl>
  53 </div>
  54 <h6>
  55 <a name="boost_asio.reference.basic_socket.get_option.overload1.h1"></a>
  56             <span class="phrase"><a name="boost_asio.reference.basic_socket.get_option.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.get_option.overload1.exceptions">Exceptions</a>
  57           </h6>
  58 <div class="variablelist">
  59 <p class="title"><b></b></p>
  60 <dl class="variablelist">
  61 <dt><span class="term">boost::system::system_error</span></dt>
  62 <dd><p>
  63                   Thrown on failure.
  64                 </p></dd>
  65 </dl>
  66 </div>
  67 <h6>
  68 <a name="boost_asio.reference.basic_socket.get_option.overload1.h2"></a>
  69             <span class="phrase"><a name="boost_asio.reference.basic_socket.get_option.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_socket.get_option.overload1.example">Example</a>
  70           </h6>
  71 <p>
  72             Getting the value of the SOL_SOCKET/SO_KEEPALIVE option:
  73           </p>
  74 <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>
  75 <span class="special">...</span>
  76 <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="special">::</span><span class="identifier">keep_alive</span> <span class="identifier">option</span><span class="special">;</span>
  77 <span class="identifier">socket</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span>
  78 <span class="keyword">bool</span> <span class="identifier">is_set</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">value</span><span class="special">();</span>
  79 </pre>
  80 </div>
  81 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  82 <td align="left"></td>
  83 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  84         Distributed under the Boost Software License, Version 1.0. (See accompanying
  85         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>)
  86       </p>
  87 </div></td>
  88 </tr></table>
  89 <hr>
  90 <div class="spirit-nav">
  91 <a accesskey="p" href="../get_option.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_option.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>
  92 </div>
  93 </body>
  94 </html>