123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260 |
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
- <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="stream_socket_service.html" title="stream_socket_service">
- </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="stream_socket_service.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>
- <a class="indexterm" name="idp160421088"></a>
- Typedef for backwards compatibility.
- </p>
- <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">strand</span> <span class="identifier">strand</span><span class="special">;</span>
- </pre>
- <h5>
- <a name="asio.reference.strand.h0"></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="io_service__strand/dispatch.html" title="io_service::strand::dispatch"><span class="bold"><strong>dispatch</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Request the strand to invoke the given handler.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="io_service__strand/get_io_service.html" title="io_service::strand::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Get the io_service associated with the strand.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="io_service__strand/post.html" title="io_service::strand::post"><span class="bold"><strong>post</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Request the strand to invoke the given handler and return immediately.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="io_service__strand/running_in_this_thread.html" title="io_service::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="io_service__strand/strand.html" title="io_service::strand::strand"><span class="bold"><strong>strand</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Constructor.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="io_service__strand/wrap.html" title="io_service::strand::wrap"><span class="bold"><strong>wrap</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Create a new handler that automatically dispatches the wrapped
- handler on the strand.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <p>
- <a class="link" href="io_service__strand/_strand.html" title="io_service::strand::~strand"><span class="bold"><strong>~strand</strong></span></a>
- </p>
- </td>
- <td>
- <p>
- Destructor.
- </p>
- </td>
- </tr>
- </tbody>
- </table></div>
- <p>
- The <a class="link" href="io_service__strand.html" title="io_service::strand"><code class="computeroutput"><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">strand</span></code></a>
- class provides the ability to post and dispatch handlers with the guarantee
- that none of those handlers will execute concurrently.
- </p>
- <h5>
- <a name="asio.reference.strand.h1"></a>
- <span><a name="asio.reference.strand.order_of_handler_invocation"></a></span><a class="link" href="strand.html#asio.reference.strand.order_of_handler_invocation">Order
- of handler invocation</a>
- </h5>
- <p>
- Given:
- </p>
- <div class="itemizedlist"><ul class="itemizedlist" type="disc">
- <li class="listitem">
- a strand object <code class="computeroutput"><span class="identifier">s</span></code>
- </li>
- <li class="listitem">
- an object <code class="computeroutput"><span class="identifier">a</span></code> meeting completion
- handler requirements
- </li>
- <li class="listitem">
- an object <code class="computeroutput"><span class="identifier">a1</span></code> which is
- an arbitrary copy of <code class="computeroutput"><span class="identifier">a</span></code>
- made by the implementation
- </li>
- <li class="listitem">
- an object <code class="computeroutput"><span class="identifier">b</span></code> meeting completion
- handler requirements
- </li>
- <li class="listitem">
- an object <code class="computeroutput"><span class="identifier">b1</span></code> which is
- an arbitrary copy of <code class="computeroutput"><span class="identifier">b</span></code>
- made by the implementation
- </li>
- </ul></div>
- <p>
- if any of the following conditions are true:
- </p>
- <div class="itemizedlist"><ul class="itemizedlist" type="disc">
- <li class="listitem">
- <code class="computeroutput"><span class="identifier">s</span><span class="special">.</span><span class="identifier">post</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code>
- happens-before <code class="computeroutput"><span class="identifier">s</span><span class="special">.</span><span class="identifier">post</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>
- </li>
- <li class="listitem">
- <code class="computeroutput"><span class="identifier">s</span><span class="special">.</span><span class="identifier">post</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code>
- happens-before <code class="computeroutput"><span class="identifier">s</span><span class="special">.</span><span class="identifier">dispatch</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>,
- where the latter is performed outside the strand
- </li>
- <li class="listitem">
- <code class="computeroutput"><span class="identifier">s</span><span class="special">.</span><span class="identifier">dispatch</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code>
- happens-before <code class="computeroutput"><span class="identifier">s</span><span class="special">.</span><span class="identifier">post</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>,
- where the former is performed outside the strand
- </li>
- <li class="listitem">
- <code class="computeroutput"><span class="identifier">s</span><span class="special">.</span><span class="identifier">dispatch</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code>
- happens-before <code class="computeroutput"><span class="identifier">s</span><span class="special">.</span><span class="identifier">dispatch</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>,
- where both are performed outside the strand
- </li>
- </ul></div>
- <p>
- then <code class="computeroutput"><span class="identifier">asio_handler_invoke</span><span class="special">(</span><span class="identifier">a1</span><span class="special">,</span>
- <span class="special">&</span><span class="identifier">a1</span><span class="special">)</span></code> happens-before <code class="computeroutput"><span class="identifier">asio_handler_invoke</span><span class="special">(</span><span class="identifier">b1</span><span class="special">,</span>
- <span class="special">&</span><span class="identifier">b1</span><span class="special">)</span></code>.
- </p>
- <p>
- Note that in the following case:
- </p>
- <pre class="programlisting"><span class="identifier">async_op_1</span><span class="special">(...,</span> <span class="identifier">s</span><span class="special">.</span><span class="identifier">wrap</span><span class="special">(</span><span class="identifier">a</span><span class="special">));</span>
- <span class="identifier">async_op_2</span><span class="special">(...,</span> <span class="identifier">s</span><span class="special">.</span><span class="identifier">wrap</span><span class="special">(</span><span class="identifier">b</span><span class="special">));</span>
- </pre>
- <p>
- the completion of the first async operation will perform <code class="computeroutput"><span class="identifier">s</span><span class="special">.</span><span class="identifier">dispatch</span><span class="special">(</span><span class="identifier">a</span><span class="special">)</span></code>,
- and the second will perform <code class="computeroutput"><span class="identifier">s</span><span class="special">.</span><span class="identifier">dispatch</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>,
- but the order in which those are performed is unspecified. That is, you cannot
- state whether one happens-before the other. Therefore none of the above conditions
- are met and no ordering guarantee is made.
- </p>
- <h5>
- <a name="asio.reference.strand.h2"></a>
- <span><a name="asio.reference.strand.remarks"></a></span><a class="link" href="strand.html#asio.reference.strand.remarks">Remarks</a>
- </h5>
- <p>
- The implementation makes no guarantee that handlers posted or dispatched
- through different <code class="computeroutput"><span class="identifier">strand</span></code>
- objects will be invoked concurrently.
- </p>
- <h5>
- <a name="asio.reference.strand.h3"></a>
- <span><a name="asio.reference.strand.thread_safety"></a></span><a class="link" href="strand.html#asio.reference.strand.thread_safety">Thread
- Safety</a>
- </h5>
- <p>
- <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
- </p>
- <p>
- <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
- </p>
- <h5>
- <a name="asio.reference.strand.h4"></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-2014 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="stream_socket_service.html"><img src="../../next.png" alt="Next"></a>
- </div>
- </body>
- </html>
|