| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>io_service::strand::wrap</title> |
| <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> |
| <link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> |
| <link rel="up" href="../io_service__strand.html" title="io_service::strand"> |
| <link rel="prev" href="strand.html" title="io_service::strand::strand"> |
| <link rel="next" href="_strand.html" title="io_service::strand::~strand"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> |
| <td align="center"><a href="../../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="strand.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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="_strand.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h4 class="title"> |
| <a name="boost_asio.reference.io_service__strand.wrap"></a><a class="link" href="wrap.html" title="io_service::strand::wrap">io_service::strand::wrap</a> |
| </h4></div></div></div> |
| <p> |
| <a class="indexterm" name="id1167120"></a> |
| Create a new handler that automatically dispatches |
| the wrapped handler on the strand. |
| </p> |
| <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> |
| <span class="keyword">typename</span> <a class="link" href="../Handler.html" title="Handlers">Handler</a><span class="special">></span> |
| <span class="identifier">unspecified</span> <span class="identifier">wrap</span><span class="special">(</span> |
| <span class="identifier">Handler</span> <span class="identifier">handler</span><span class="special">);</span> |
| </pre> |
| <p> |
| This function is used to create a new handler function object that, when |
| invoked, will automatically pass the wrapped handler to the strand's dispatch |
| function. |
| </p> |
| <a name="boost_asio.reference.io_service__strand.wrap.parameters"></a><h6> |
| <a name="id1167210"></a> |
| <a class="link" href="wrap.html#boost_asio.reference.io_service__strand.wrap.parameters">Parameters</a> |
| </h6> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl> |
| <dt><span class="term">handler</span></dt> |
| <dd> |
| <p> |
| The handler to be wrapped. The strand will make a copy of the handler |
| object as required. The function signature of the handler must be: |
| |
| </p> |
| <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> |
| </pre> |
| <p> |
| </p> |
| </dd> |
| </dl> |
| </div> |
| <a name="boost_asio.reference.io_service__strand.wrap.return_value"></a><h6> |
| <a name="id1167309"></a> |
| <a class="link" href="wrap.html#boost_asio.reference.io_service__strand.wrap.return_value">Return |
| Value</a> |
| </h6> |
| <p> |
| A function object that, when invoked, passes the wrapped handler to the |
| strand's dispatch function. Given a function object with the signature: |
| </p> |
| <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> |
| </pre> |
| <p> |
| If this function object is passed to the wrap function like so: |
| </p> |
| <pre class="programlisting"><span class="identifier">strand</span><span class="special">.</span><span class="identifier">wrap</span><span class="special">(</span><span class="identifier">f</span><span class="special">);</span> |
| </pre> |
| <p> |
| then the return value is a function object with the signature |
| </p> |
| <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> |
| </pre> |
| <p> |
| that, when invoked, executes code equivalent to: |
| </p> |
| <pre class="programlisting"><span class="identifier">strand</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> |
| </pre> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2003 - 2010 Christopher M. Kohlhoff<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| 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>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="strand.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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="_strand.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |