diff options
Diffstat (limited to 'doc/html/boost_asio/reference/strand.html')
| -rw-r--r-- | doc/html/boost_asio/reference/strand.html | 286 |
1 files changed, 171 insertions, 115 deletions
diff --git a/doc/html/boost_asio/reference/strand.html b/doc/html/boost_asio/reference/strand.html index 4e10d2551b..50e592c6df 100644 --- a/doc/html/boost_asio/reference/strand.html +++ b/doc/html/boost_asio/reference/strand.html @@ -7,7 +7,7 @@ <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="stream_socket_service.html" title="stream_socket_service"> +<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> @@ -20,20 +20,55 @@ </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="stream_socket_service.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<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="idp173367936"></a> -(Deprecated: Use <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>.) Typedef for backwards compatibility. + Provides serialised function invocation for any executor type. </p> -<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</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 class="programlisting">template< + typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>> +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> @@ -58,80 +93,151 @@ <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> + <a class="link" href="strand/context.html" title="strand::context"><span class="bold"><strong>context</strong></span></a> </p> </td> <td> <p> - Request the strand to invoke the given handler. + Obtain the underlying execution context. </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> + <a class="link" href="strand/defer.html" title="strand::defer"><span class="bold"><strong>defer</strong></span></a> </p> </td> <td> <p> - Get the io_service associated with the strand. + Request the strand to invoke the given function object. </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> + <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 handler and return immediately. + Request the strand to invoke the given function object. </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> + <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> - Determine whether the strand is running in the current thread. + 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. + </p> + <p> + Converting assignment operator. + </p> + <p> + Move assignment operator. + </p> + <p> + Converting move assignment operator. </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> + <a class="link" href="strand/post.html" title="strand::post"><span class="bold"><strong>post</strong></span></a> </p> </td> <td> <p> - Constructor. + Request the strand to invoke the given function object. </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> + <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> - Create a new handler that automatically dispatches the wrapped - handler on the strand. + 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> + <a class="link" href="strand/strand.html" title="strand::strand"><span class="bold"><strong>strand</strong></span></a> + </p> + </td> +<td> + <p> + Default constructor. + </p> + <p> + Construct a strand for the specified executor. + </p> + <p> + Copy constructor. + </p> + <p> + Converting constructor. + </p> + <p> + Move constructor. + </p> + <p> + 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> </p> </td> <td> @@ -142,106 +248,56 @@ </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="boost_asio.reference.strand.h1"></a> - <span class="phrase"><a name="boost_asio.reference.strand.order_of_handler_invocation"></a></span><a class="link" href="strand.html#boost_asio.reference.strand.order_of_handler_invocation">Order of - handler invocation</a> - </h5> -<p> - Given: - </p> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-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" style="list-style-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="boost_asio.reference.strand.h2"></a> - <span class="phrase"><a name="boost_asio.reference.strand.remarks"></a></span><a class="link" href="strand.html#boost_asio.reference.strand.remarks">Remarks</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> -<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> +<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.thread_safety"></a></span><a class="link" href="strand.html#boost_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="boost_asio.reference.strand.h4"></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> @@ -261,7 +317,7 @@ </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="stream_socket_service.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<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> |