doc/html/boost_asio/reference/ip__multicast__leave_group.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>ip::multicast::leave_group</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="../reference.html" title="Reference">
   9 <link rel="prev" href="ip__multicast__join_group.html" title="ip::multicast::join_group">
  10 <link rel="next" href="ip__multicast__outbound_interface.html" title="ip::multicast::outbound_interface">
  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="ip__multicast__join_group.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="ip__multicast__outbound_interface.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_asio.reference.ip__multicast__leave_group"></a><a class="link" href="ip__multicast__leave_group.html" title="ip::multicast::leave_group">ip::multicast::leave_group</a>
  28 </h3></div></div></div>
  29 <p>
  30         <a class="indexterm" name="id1409062"></a>
  31 Socket option to leave a multicast group on a specified
  32         interface.
  33       </p>
  34 <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">leave_group</span><span class="special">;</span>
  35 </pre>
  36 <p>
  37         Implements the IPPROTO_IP/IP_DROP_MEMBERSHIP socket option.
  38       </p>
  39 <h5>
  40 <a name="boost_asio.reference.ip__multicast__leave_group.h0"></a>
  41         <span><a name="boost_asio.reference.ip__multicast__leave_group.examples"></a></span><a class="link" href="ip__multicast__leave_group.html#boost_asio.reference.ip__multicast__leave_group.examples">Examples</a>
  42       </h5>
  43 <p>
  44         Setting the option to leave a multicast group:
  45       </p>
  46 <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">udp</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>
  47 <span class="special">...</span>
  48 <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">address</span> <span class="identifier">multicast_address</span> <span class="special">=</span>
  49   <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">address</span><span class="special">::</span><span class="identifier">from_string</span><span class="special">(</span><span class="string">"225.0.0.1"</span><span class="special">);</span>
  50 <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">multicast</span><span class="special">::</span><span class="identifier">leave_group</span> <span class="identifier">option</span><span class="special">(</span><span class="identifier">multicast_address</span><span class="special">);</span>
  51 <span class="identifier">socket</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span>
  52 </pre>
  53 <h5>
  54 <a name="boost_asio.reference.ip__multicast__leave_group.h1"></a>
  55         <span><a name="boost_asio.reference.ip__multicast__leave_group.requirements"></a></span><a class="link" href="ip__multicast__leave_group.html#boost_asio.reference.ip__multicast__leave_group.requirements">Requirements</a>
  56       </h5>
  57 <p>
  58         <span class="bold"><strong>Header: </strong></span><code class="literal">boost/asio/ip/multicast.hpp</code>
  59       </p>
  60 <p>
  61         <span class="bold"><strong>Convenience header: </strong></span><code class="literal">boost/asio.hpp</code>
  62       </p>
  63 </div>
  64 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  65 <td align="left"></td>
  66 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2012 Christopher M. Kohlhoff<p>
  67         Distributed under the Boost Software License, Version 1.0. (See accompanying
  68         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>)
  69       </p>
  70 </div></td>
  71 </tr></table>
  72 <hr>
  73 <div class="spirit-nav">
  74 <a accesskey="p" href="ip__multicast__join_group.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="ip__multicast__outbound_interface.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  75 </div>
  76 </body>
  77 </html>