summaryrefslogtreecommitdiff
path: root/doc/html/boost_asio/reference/system_context/executor_type.html
blob: 052cc05f00f04c3b88865ed9523c6f3f2828395b (plain)
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>system_context::executor_type</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="../system_context.html" title="system_context">
<link rel="prev" href="destroy.html" title="system_context::destroy">
<link rel="next" href="fork_event.html" title="system_context::fork_event">
</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="destroy.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../system_context.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="fork_event.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.system_context.executor_type"></a><a class="link" href="executor_type.html" title="system_context::executor_type">system_context::executor_type</a>
</h4></div></div></div>
<p>
          <a class="indexterm" name="boost_asio.indexterm.system_context.executor_type"></a> 
The
          executor type associated with the context.
        </p>
<pre class="programlisting">typedef system_executor executor_type;
</pre>
<h6>
<a name="boost_asio.reference.system_context.executor_type.h0"></a>
          <span class="phrase"><a name="boost_asio.reference.system_context.executor_type.member_functions"></a></span><a class="link" href="executor_type.html#boost_asio.reference.system_context.executor_type.member_functions">Member
          Functions</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    <a class="link" href="../system_executor/context.html" title="system_executor::context"><span class="bold"><strong>context</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Obtain the underlying execution context.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../system_executor/defer.html" title="system_executor::defer"><span class="bold"><strong>defer</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Request the system executor to invoke the given function object.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../system_executor/dispatch.html" title="system_executor::dispatch"><span class="bold"><strong>dispatch</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Request the system executor to invoke the given function object.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../system_executor/on_work_finished.html" title="system_executor::on_work_finished"><span class="bold"><strong>on_work_finished</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Inform the executor that some work is no longer outstanding.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../system_executor/on_work_started.html" title="system_executor::on_work_started"><span class="bold"><strong>on_work_started</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Inform the executor that it has some outstanding work to do.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../system_executor/post.html" title="system_executor::post"><span class="bold"><strong>post</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Request the system executor to invoke the given function object.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
<h6>
<a name="boost_asio.reference.system_context.executor_type.h1"></a>
          <span class="phrase"><a name="boost_asio.reference.system_context.executor_type.friends"></a></span><a class="link" href="executor_type.html#boost_asio.reference.system_context.executor_type.friends">Friends</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    <a class="link" href="../system_executor/operator_not__eq_.html" title="system_executor::operator!="><span class="bold"><strong>operator!=</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Compare two executors for inequality.
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    <a class="link" href="../system_executor/operator_eq__eq_.html" title="system_executor::operator=="><span class="bold"><strong>operator==</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Compare two executors for equality.
                  </p>
                </td>
</tr>
</tbody>
</table></div>
<p>
          The system executor represents an execution context where functions are
          permitted to run on arbitrary threads. The <code class="computeroutput">post()</code> and <code class="computeroutput">defer()</code>
          functions schedule the function to run on an unspecified system thread
          pool, and <code class="computeroutput">dispatch()</code> invokes the function immediately.
        </p>
<h6>
<a name="boost_asio.reference.system_context.executor_type.h2"></a>
          <span class="phrase"><a name="boost_asio.reference.system_context.executor_type.requirements"></a></span><a class="link" href="executor_type.html#boost_asio.reference.system_context.executor_type.requirements">Requirements</a>
        </h6>
<p>
          <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/system_context.hpp</code>
        </p>
<p>
          <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
        </p>
</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="destroy.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../system_context.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="fork_event.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>