strand.html 9.92 KB
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>strand</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="steady_timer.html" title="steady_timer">
<link rel="next" href="strand/defer.html" title="strand::defer">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="steady_timer.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="strand/defer.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.strand"></a><a class="link" href="strand.html" title="strand">strand</a>
</h3></div></div></div>
<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="asio.reference.strand.h0"></a>
        <span><a name="asio.reference.strand.types"></a></span><a class="link" href="strand.html#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="asio.reference.strand.h1"></a>
        <span><a name="asio.reference.strand.member_functions"></a></span><a class="link" href="strand.html#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/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>
              </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/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>
              </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>
              </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="asio.reference.strand.h2"></a>
        <span><a name="asio.reference.strand.friends"></a></span><a class="link" href="strand.html#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="asio.reference.strand.h3"></a>
        <span><a name="asio.reference.strand.requirements"></a></span><a class="link" href="strand.html#asio.reference.strand.requirements">Requirements</a>
      </h5>
<p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">asio/strand.hpp</code>
      </p>
<p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">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-2020 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="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="strand/defer.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>