• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>bind_front_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 1. 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_handler.html" title="bind_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_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_front_handler"></a><a class="link" href="boost__beast__bind_front_handler.html" title="bind_front_handler">bind_front_handler</a>
28</h4></div></div></div>
29<p>
30        <a class="indexterm" name="idm46057513396400"></a>
31      </p>
32<p>
33        Bind parameters to a completion handler, creating a new handler.
34      </p>
35<h5>
36<a name="beast.ref.boost__beast__bind_front_handler.h0"></a>
37        <span class="phrase"><a name="beast.ref.boost__beast__bind_front_handler.synopsis"></a></span><a class="link" href="boost__beast__bind_front_handler.html#beast.ref.boost__beast__bind_front_handler.synopsis">Synopsis</a>
38      </h5>
39<p>
40        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>
41      </p>
42<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
43    <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>
44    <span class="keyword">class</span><span class="special">...</span> <span class="identifier">Args</span><span class="special">&gt;</span>
45<span class="emphasis"><em>implementation-defined</em></span>
46<span class="identifier">bind_front_handler</span><span class="special">(</span>
47    <span class="identifier">Handler</span><span class="special">&amp;&amp;</span> <span class="identifier">handler</span><span class="special">,</span>
48    <span class="identifier">Args</span><span class="special">&amp;&amp;...</span> <span class="identifier">args</span><span class="special">);</span>
49</pre>
50<h5>
51<a name="beast.ref.boost__beast__bind_front_handler.h1"></a>
52        <span class="phrase"><a name="beast.ref.boost__beast__bind_front_handler.description"></a></span><a class="link" href="boost__beast__bind_front_handler.html#beast.ref.boost__beast__bind_front_handler.description">Description</a>
53      </h5>
54<p>
55        This function creates a new handler which, when invoked, calls the original
56        handler with the list of bound arguments. Any parameters passed in the invocation
57        will be forwarded in the parameter list after the bound arguments. The passed
58        handler and arguments are forwarded into the returned handler, whose associated
59        allocator and associated executor will will be the same as those of the original
60        handler.
61      </p>
62<h5>
63<a name="beast.ref.boost__beast__bind_front_handler.h2"></a>
64        <span class="phrase"><a name="beast.ref.boost__beast__bind_front_handler.example"></a></span><a class="link" href="boost__beast__bind_front_handler.html#beast.ref.boost__beast__bind_front_handler.example">Example</a>
65      </h5>
66<p>
67        This function posts the invocation of the specified completion handler with
68        bound arguments:
69      </p>
70<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>
71<span class="keyword">void</span>
72<span class="identifier">signal_eof</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>
73<span class="special">{</span>
74    <span class="identifier">net</span><span class="special">::</span><span class="identifier">post</span><span class="special">(</span>
75        <span class="identifier">stream</span><span class="special">.</span><span class="identifier">get_executor</span><span class="special">(),</span>
76        <span class="identifier">bind_front_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>
77            <span class="identifier">net</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">eof</span><span class="special">,</span> <span class="number">0</span><span class="special">));</span>
78<span class="special">}</span>
79</pre>
80<h5>
81<a name="beast.ref.boost__beast__bind_front_handler.h3"></a>
82        <span class="phrase"><a name="beast.ref.boost__beast__bind_front_handler.parameters"></a></span><a class="link" href="boost__beast__bind_front_handler.html#beast.ref.boost__beast__bind_front_handler.parameters">Parameters</a>
83      </h5>
84<div class="informaltable"><table class="table">
85<colgroup>
86<col>
87<col>
88</colgroup>
89<thead><tr>
90<th>
91                <p>
92                  Name
93                </p>
94              </th>
95<th>
96                <p>
97                  Description
98                </p>
99              </th>
100</tr></thead>
101<tbody>
102<tr>
103<td>
104                <p>
105                  <code class="computeroutput"><span class="identifier">handler</span></code>
106                </p>
107              </td>
108<td>
109                <p>
110                  The handler to wrap. The implementation takes ownership of the
111                  handler by performing a decay-copy.
112                </p>
113              </td>
114</tr>
115<tr>
116<td>
117                <p>
118                  <code class="computeroutput"><span class="identifier">args</span></code>
119                </p>
120              </td>
121<td>
122                <p>
123                  A list of arguments to bind to the handler. The arguments are forwarded
124                  into the returned object.
125                </p>
126              </td>
127</tr>
128</tbody>
129</table></div>
130</div>
131<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
132<td align="left"></td>
133<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
134      Falco<p>
135        Distributed under the Boost Software License, Version 1.0. (See accompanying
136        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>)
137      </p>
138</div></td>
139</tr></table>
140<hr>
141<div class="spirit-nav">
142<a accesskey="p" href="boost__beast__bind_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>
143</div>
144</body>
145</html>
146