doc/html/boost_asio/reference/thread_pool__executor_type/post.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>thread_pool::executor_type::post</title>
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../thread_pool__executor_type.html" title="thread_pool::executor_type">
<link rel="prev" href="operator_eq__eq_.html" title="thread_pool::executor_type::operator==">
<link rel="next" href="running_in_this_thread.html" title="thread_pool::executor_type::running_in_this_thread">
</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="operator_eq__eq_.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../thread_pool__executor_type.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="running_in_this_thread.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.thread_pool__executor_type.post"></a><a class="link" href="post.html" title="thread_pool::executor_type::post">thread_pool::executor_type::post</a>
</h4></div></div></div>
<p>
          <a class="indexterm" name="boost_asio.indexterm.thread_pool__executor_type.post"></a> 
Request
          the thread pool to invoke the given function object.
        </p>
<pre class="programlisting">template&lt;
    typename Function,
    typename Allocator&gt;
void post(
    Function &amp;&amp; f,
    const Allocator &amp; a) const;
</pre>
<p>
          This function is used to ask the thread pool to execute the given function
          object. The function object will never be executed inside <code class="computeroutput">post()</code>.
          Instead, it will be scheduled to run on the thread pool.
        </p>
<h6>
<a name="boost_asio.reference.thread_pool__executor_type.post.h0"></a>
          <span class="phrase"><a name="boost_asio.reference.thread_pool__executor_type.post.parameters"></a></span><a class="link" href="post.html#boost_asio.reference.thread_pool__executor_type.post.parameters">Parameters</a>
        </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">f</span></dt>
<dd>
<p>
                The function object to be called. The executor will make a copy of
                the handler object as required. The function signature of the function
                object must be:
</p>
<pre class="programlisting">void function();
</pre>
<p>
              </p>
</dd>
<dt><span class="term">a</span></dt>
<dd><p>
                An allocator that may be used by the executor to allocate the internal
                storage needed for function invocation.
              </p></dd>
</dl>
</div>
</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 &#169; 2003-2019 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="operator_eq__eq_.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../thread_pool__executor_type.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="running_in_this_thread.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>