doc/html/boost_asio/reference/add_service.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>add_service</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="../reference.html" title="Reference">
   9 <link rel="prev" href="WriteHandler.html" title="Write handler requirements">
  10 <link rel="next" href="asio_handler_allocate.html" title="asio_handler_allocate">
  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="WriteHandler.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="asio_handler_allocate.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.add_service"></a><a class="link" href="add_service.html" title="add_service">add_service</a>
  28 </h3></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idp89369184"></a>
  31       </p>
  32 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  33     <span class="keyword">typename</span> <a class="link" href="Service.html" title="Service requirements">Service</a><span class="special">&gt;</span>
  34 <span class="keyword">void</span> <span class="identifier">add_service</span><span class="special">(</span>
  35     <span class="identifier">io_service</span> <span class="special">&amp;</span> <span class="identifier">ios</span><span class="special">,</span>
  36     <span class="identifier">Service</span> <span class="special">*</span> <span class="identifier">svc</span><span class="special">);</span>
  37 </pre>
  38 <p>
  39         This function is used to add a service to the <a class="link" href="io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>.
  40       </p>
  41 <h5>
  42 <a name="boost_asio.reference.add_service.h0"></a>
  43         <span class="phrase"><a name="boost_asio.reference.add_service.parameters"></a></span><a class="link" href="add_service.html#boost_asio.reference.add_service.parameters">Parameters</a>
  44       </h5>
  45 <div class="variablelist">
  46 <p class="title"><b></b></p>
  47 <dl class="variablelist">
  48 <dt><span class="term">ios</span></dt>
  49 <dd><p>
  50               The <a class="link" href="io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>
  51               object that owns the service.
  52             </p></dd>
  53 <dt><span class="term">svc</span></dt>
  54 <dd>
  55 <p>
  56               The service object. On success, ownership of the service object is
  57               transferred to the <a class="link" href="io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>. When the <a class="link" href="io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>
  58               object is destroyed, it will destroy the service object by performing:
  59 </p>
  60 <pre class="programlisting"><span class="keyword">delete</span> <span class="keyword">static_cast</span><span class="special">&lt;</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">service</span><span class="special">*&gt;(</span><span class="identifier">svc</span><span class="special">)</span>
  61 </pre>
  62 <p>
  63             </p>
  64 </dd>
  65 </dl>
  66 </div>
  67 <h5>
  68 <a name="boost_asio.reference.add_service.h1"></a>
  69         <span class="phrase"><a name="boost_asio.reference.add_service.exceptions"></a></span><a class="link" href="add_service.html#boost_asio.reference.add_service.exceptions">Exceptions</a>
  70       </h5>
  71 <div class="variablelist">
  72 <p class="title"><b></b></p>
  73 <dl class="variablelist">
  74 <dt><span class="term">boost::asio::service_already_exists</span></dt>
  75 <dd><p>
  76               Thrown if a service of the given type is already present in the <a class="link" href="io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>.
  77             </p></dd>
  78 <dt><span class="term">boost::asio::invalid_service_owner</span></dt>
  79 <dd><p>
  80               Thrown if the service's owning <a class="link" href="io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> is not the <a class="link" href="io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>
  81               object specified by the ios parameter.
  82             </p></dd>
  83 </dl>
  84 </div>
  85 <h5>
  86 <a name="boost_asio.reference.add_service.h2"></a>
  87         <span class="phrase"><a name="boost_asio.reference.add_service.requirements"></a></span><a class="link" href="add_service.html#boost_asio.reference.add_service.requirements">Requirements</a>
  88       </h5>
  89 <p>
  90         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/io_service.hpp</code>
  91       </p>
  92 <p>
  93         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
  94       </p>
  95 </div>
  96 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  97 <td align="left"></td>
  98 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
  99         Distributed under the Boost Software License, Version 1.0. (See accompanying
 100         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>)
 101       </p>
 102 </div></td>
 103 </tr></table>
 104 <hr>
 105 <div class="spirit-nav">
 106 <a accesskey="p" href="WriteHandler.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="asio_handler_allocate.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 107 </div>
 108 </body>
 109 </html>