doc/html/boost_asio/reference/io_service/wrap.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>io_service::wrap</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="../io_service.html" title="io_service">
   9 <link rel="prev" href="use_service.html" title="io_service::use_service">
  10 <link rel="next" href="_io_service.html" title="io_service::~io_service">
  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="use_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.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="_io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="boost_asio.reference.io_service.wrap"></a><a class="link" href="wrap.html" title="io_service::wrap">io_service::wrap</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp172070736"></a>
  31 Create a new handler that automatically dispatches the wrapped
  32           handler on the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>.
  33         </p>
  34 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  35     <span class="keyword">typename</span> <a class="link" href="../Handler.html" title="Handlers">Handler</a><span class="special">&gt;</span>
  36 <span class="identifier">unspecified</span> <span class="identifier">wrap</span><span class="special">(</span>
  37     <span class="identifier">Handler</span> <span class="identifier">handler</span><span class="special">);</span>
  38 </pre>
  39 <p>
  40           This function is used to create a new handler function object that, when
  41           invoked, will automatically pass the wrapped handler to the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object's dispatch function.
  42         </p>
  43 <h6>
  44 <a name="boost_asio.reference.io_service.wrap.h0"></a>
  45           <span class="phrase"><a name="boost_asio.reference.io_service.wrap.parameters"></a></span><a class="link" href="wrap.html#boost_asio.reference.io_service.wrap.parameters">Parameters</a>
  46         </h6>
  47 <div class="variablelist">
  48 <p class="title"><b></b></p>
  49 <dl class="variablelist">
  50 <dt><span class="term">handler</span></dt>
  51 <dd>
  52 <p>
  53                 The handler to be wrapped. The <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> will make a copy
  54                 of the handler object as required. The function signature of the
  55                 handler must be:
  56 </p>
  57 <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span><span class="identifier">A1</span> <span class="identifier">a1</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">An</span> <span class="identifier">an</span><span class="special">);</span>
  58 </pre>
  59 <p>
  60               </p>
  61 </dd>
  62 </dl>
  63 </div>
  64 <h6>
  65 <a name="boost_asio.reference.io_service.wrap.h1"></a>
  66           <span class="phrase"><a name="boost_asio.reference.io_service.wrap.return_value"></a></span><a class="link" href="wrap.html#boost_asio.reference.io_service.wrap.return_value">Return
  67           Value</a>
  68         </h6>
  69 <p>
  70           A function object that, when invoked, passes the wrapped handler to the
  71           <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>
  72           object's dispatch function. Given a function object with the signature:
  73         </p>
  74 <pre class="programlisting"><span class="identifier">R</span> <span class="identifier">f</span><span class="special">(</span><span class="identifier">A1</span> <span class="identifier">a1</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">An</span> <span class="identifier">an</span><span class="special">);</span>
  75 </pre>
  76 <p>
  77           If this function object is passed to the wrap function like so:
  78         </p>
  79 <pre class="programlisting"><span class="identifier">io_service</span><span class="special">.</span><span class="identifier">wrap</span><span class="special">(</span><span class="identifier">f</span><span class="special">);</span>
  80 </pre>
  81 <p>
  82           then the return value is a function object with the signature
  83         </p>
  84 <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">g</span><span class="special">(</span><span class="identifier">A1</span> <span class="identifier">a1</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">An</span> <span class="identifier">an</span><span class="special">);</span>
  85 </pre>
  86 <p>
  87           that, when invoked, executes code equivalent to:
  88         </p>
  89 <pre class="programlisting"><span class="identifier">io_service</span><span class="special">.</span><span class="identifier">dispatch</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">bind</span><span class="special">(</span><span class="identifier">f</span><span class="special">,</span> <span class="identifier">a1</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">an</span><span class="special">));</span>
  90 </pre>
  91 </div>
  92 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  93 <td align="left"></td>
  94 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  95         Distributed under the Boost Software License, Version 1.0. (See accompanying
  96         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>)
  97       </p>
  98 </div></td>
  99 </tr></table>
 100 <hr>
 101 <div class="spirit-nav">
 102 <a accesskey="p" href="use_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service.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="_io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 103 </div>
 104 </body>
 105 </html>