generic-library/boost
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
boost/doc/html/boost_asio/reference/strand.html
Edouard DUPIN d0115b733d [DEV] add v1.76.0
2021-10-05 21:37:46 +02:00

359 lines
12 KiB
HTML
Raw Permalink Blame History

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>strand</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="../reference.html" title="Reference">
<link rel="prev" href="steady_timer.html" title="steady_timer">
<link rel="next" href="strand/context.html" title="strand::context">
</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="steady_timer.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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/context.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.strand"></a><a class="link" href="strand.html" title="strand">strand</a>
</h3></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.strand"></a>
</p>
<p>
Provides serialised function invocation for any executor type.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>&gt;
class strand
</pre>
<h5>
<a name="boost_asio.reference.strand.h0"></a>
<span class="phrase"><a name="boost_asio.reference.strand.types"></a></span><a class="link" href="strand.html#boost_asio.reference.strand.types">Types</a>
</h5>
<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="strand/inner_executor_type.html" title="strand::inner_executor_type"><span class="bold"><strong>inner_executor_type</strong></span></a>
</p>
</td>
<td>
<p>
The type of the underlying executor.
</p>
</td>
</tr></tbody>
</table></div>
<h5>
<a name="boost_asio.reference.strand.h1"></a>
<span class="phrase"><a name="boost_asio.reference.strand.member_functions"></a></span><a class="link" href="strand.html#boost_asio.reference.strand.member_functions">Member
Functions</a>
</h5>
<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="strand/context.html" title="strand::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="strand/defer.html" title="strand::defer"><span class="bold"><strong>defer</strong></span></a>
</p>
</td>
<td>
<p>
Request the strand to invoke the given function object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="strand/dispatch.html" title="strand::dispatch"><span class="bold"><strong>dispatch</strong></span></a>
</p>
</td>
<td>
<p>
Request the strand to invoke the given function object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="strand/execute.html" title="strand::execute"><span class="bold"><strong>execute</strong></span></a>
</p>
</td>
<td>
<p>
Request the strand to invoke the given function object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="strand/get_inner_executor.html" title="strand::get_inner_executor"><span class="bold"><strong>get_inner_executor</strong></span></a>
</p>
</td>
<td>
<p>
Obtain the underlying executor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="strand/on_work_finished.html" title="strand::on_work_finished"><span class="bold"><strong>on_work_finished</strong></span></a>
</p>
</td>
<td>
<p>
Inform the strand that some work is no longer outstanding.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="strand/on_work_started.html" title="strand::on_work_started"><span class="bold"><strong>on_work_started</strong></span></a>
</p>
</td>
<td>
<p>
Inform the strand that it has some outstanding work to do.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="strand/operator_eq_.html" title="strand::operator="><span class="bold"><strong>operator=</strong></span></a>
</p>
</td>
<td>
<p>
Assignment operator. <br> <span class="silver"> —</span><br> Converting assignment operator.
<br> <span class="silver"> —</span><br> Move assignment operator. <br> <span class="silver"> —</span><br> Converting
move assignment operator.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="strand/post.html" title="strand::post"><span class="bold"><strong>post</strong></span></a>
</p>
</td>
<td>
<p>
Request the strand to invoke the given function object.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="strand/prefer.html" title="strand::prefer"><span class="bold"><strong>prefer</strong></span></a>
</p>
</td>
<td>
<p>
Forward a preference to the underlying executor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="strand/query.html" title="strand::query"><span class="bold"><strong>query</strong></span></a>
</p>
</td>
<td>
<p>
Forward a query to the underlying executor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="strand/require.html" title="strand::require"><span class="bold"><strong>require</strong></span></a>
</p>
</td>
<td>
<p>
Forward a requirement to the underlying executor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="strand/running_in_this_thread.html" title="strand::running_in_this_thread"><span class="bold"><strong>running_in_this_thread</strong></span></a>
</p>
</td>
<td>
<p>
Determine whether the strand is running in the current thread.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="strand/strand.html" title="strand::strand"><span class="bold"><strong>strand</strong></span></a>
<span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Default constructor. <br> <span class="silver"> —</span><br> Construct a strand for the specified
executor. <br> <span class="silver"> —</span><br> Copy constructor. <br> <span class="silver"> —</span><br> Converting
constructor. <br> <span class="silver"> —</span><br> Move constructor. <br> <span class="silver"> —</span><br> Converting
move constructor.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="strand/_strand.html" title="strand::~strand"><span class="bold"><strong>~strand</strong></span></a>
<span class="silver">[destructor]</span>
</p>
</td>
<td>
<p>
Destructor.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="boost_asio.reference.strand.h2"></a>
<span class="phrase"><a name="boost_asio.reference.strand.friends"></a></span><a class="link" href="strand.html#boost_asio.reference.strand.friends">Friends</a>
</h5>
<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="strand/operator_not__eq_.html" title="strand::operator!="><span class="bold"><strong>operator!=</strong></span></a>
</p>
</td>
<td>
<p>
Compare two strands for inequality.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="strand/operator_eq__eq_.html" title="strand::operator=="><span class="bold"><strong>operator==</strong></span></a>
</p>
</td>
<td>
<p>
Compare two strands for equality.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="boost_asio.reference.strand.h3"></a>
<span class="phrase"><a name="boost_asio.reference.strand.requirements"></a></span><a class="link" href="strand.html#boost_asio.reference.strand.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/strand.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 © 2003-2021 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="steady_timer.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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/context.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink