libs/beast/doc/html/beast/ref/boost__beast__bind_handler.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>bind_handler</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="../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
   9 <link rel="prev" href="boost__beast__bind_front_handler.html" title="bind_front_handler">
  10 <link rel="next" href="boost__beast__buffer_bytes.html" title="buffer_bytes">
  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="boost__beast__bind_front_handler.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__buffer_bytes.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="beast.ref.boost__beast__bind_handler"></a><a class="link" href="boost__beast__bind_handler.html" title="bind_handler">bind_handler</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873514045600"></a>
  31 Bind parameters to a completion handler, creating a new handler.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__bind_handler.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__bind_handler.synopsis"></a></span><a class="link" href="boost__beast__bind_handler.html#beast.ref.boost__beast__bind_handler.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/core/bind_handler.hpp" target="_top">boost/beast/core/bind_handler.hpp</a>&gt;</code>
  39       </p>
  40 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  41     <span class="keyword">class</span> <a href="../../../../../../doc/html/boost_asio/reference/Handler.html" target="_top"><span class="emphasis"><em>Handler</em></span></a><span class="special">,</span>
  42     <span class="keyword">class</span><span class="special">...</span> <span class="identifier">Args</span><span class="special">&gt;</span>
  43 <span class="emphasis"><em>implementation-defined</em></span>
  44 <span class="identifier">bind_handler</span><span class="special">(</span>
  45     <span class="identifier">Handler</span><span class="special">&amp;&amp;</span> <span class="identifier">handler</span><span class="special">,</span>
  46     <span class="identifier">Args</span><span class="special">&amp;&amp;...</span> <span class="identifier">args</span><span class="special">);</span>
  47 </pre>
  48 <h5>
  49 <a name="beast.ref.boost__beast__bind_handler.h1"></a>
  50         <span class="phrase"><a name="beast.ref.boost__beast__bind_handler.description"></a></span><a class="link" href="boost__beast__bind_handler.html#beast.ref.boost__beast__bind_handler.description">Description</a>
  51       </h5>
  52 <p>
  53         This function creates a new handler which, when invoked, calls the original
  54         handler with the list of bound arguments. Any parameters passed in the invocation
  55         will be substituted for placeholders present in the list of bound arguments.
  56         Parameters which are not matched to placeholders are silently discarded.
  57         The passed handler and arguments are forwarded into the returned handler,
  58         whose associated allocator and associated executor will will be the same
  59         as those of the original handler.
  60       </p>
  61 <h5>
  62 <a name="beast.ref.boost__beast__bind_handler.h2"></a>
  63         <span class="phrase"><a name="beast.ref.boost__beast__bind_handler.example"></a></span><a class="link" href="boost__beast__bind_handler.html#beast.ref.boost__beast__bind_handler.example">Example</a>
  64       </h5>
  65 <p>
  66         This function posts the invocation of the specified completion handler with
  67         bound arguments:
  68       </p>
  69 <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">AsyncReadStream</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">ReadHandler</span><span class="special">&gt;</span>
  70 <span class="keyword">void</span>
  71 <span class="identifier">signal_aborted</span> <span class="special">(</span><span class="identifier">AsyncReadStream</span><span class="special">&amp;</span> <span class="identifier">stream</span><span class="special">,</span> <span class="identifier">ReadHandler</span><span class="special">&amp;&amp;</span> <span class="identifier">handler</span><span class="special">)</span>
  72 <span class="special">{</span>
  73     <span class="identifier">net</span><span class="special">::</span><span class="identifier">post</span><span class="special">(</span>
  74         <span class="identifier">stream</span><span class="special">.</span><span class="identifier">get_executor</span><span class="special">(),</span>
  75         <span class="identifier">bind_handler</span> <span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">forward</span> <span class="special">&lt;</span><span class="identifier">ReadHandler</span><span class="special">&gt;</span> <span class="special">(</span><span class="identifier">handler</span><span class="special">),</span>
  76             <span class="identifier">net</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span><span class="special">,</span> <span class="number">0</span><span class="special">));</span>
  77 <span class="special">}</span>
  78 </pre>
  79 <h5>
  80 <a name="beast.ref.boost__beast__bind_handler.h3"></a>
  81         <span class="phrase"><a name="beast.ref.boost__beast__bind_handler.parameters"></a></span><a class="link" href="boost__beast__bind_handler.html#beast.ref.boost__beast__bind_handler.parameters">Parameters</a>
  82       </h5>
  83 <div class="informaltable"><table class="table">
  84 <colgroup>
  85 <col>
  86 <col>
  87 </colgroup>
  88 <thead><tr>
  89 <th>
  90                 <p>
  91                   Name
  92                 </p>
  93               </th>
  94 <th>
  95                 <p>
  96                   Description
  97                 </p>
  98               </th>
  99 </tr></thead>
 100 <tbody>
 101 <tr>
 102 <td>
 103                 <p>
 104                   <code class="computeroutput"><span class="identifier">handler</span></code>
 105                 </p>
 106               </td>
 107 <td>
 108                 <p>
 109                   The handler to wrap. The implementation takes ownership of the
 110                   handler by performing a decay-copy.
 111                 </p>
 112               </td>
 113 </tr>
 114 <tr>
 115 <td>
 116                 <p>
 117                   <code class="computeroutput"><span class="identifier">args</span></code>
 118                 </p>
 119               </td>
 120 <td>
 121                 <p>
 122                   A list of arguments to bind to the handler. The arguments are forwarded
 123                   into the returned object. These arguments may include placeholders,
 124                   which will operate in a fashion identical to a call to <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">bind</span></code>.
 125                 </p>
 126               </td>
 127 </tr>
 128 </tbody>
 129 </table></div>
 130 <p>
 131         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/core.hpp" target="_top">boost/beast/core.hpp</a>&gt;</code>
 132       </p>
 133 </div>
 134 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 135 <td align="left"></td>
 136 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 137       Falco<p>
 138         Distributed under the Boost Software License, Version 1.0. (See accompanying
 139         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>)
 140       </p>
 141 </div></td>
 142 </tr></table>
 143 <hr>
 144 <div class="spirit-nav">
 145 <a accesskey="p" href="boost__beast__bind_front_handler.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__buffer_bytes.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 146 </div>
 147 </body>
 148 </html>