diff options
| author | DongHun Kwak <dh0128.kwak@samsung.com> | 2017-09-13 11:08:07 +0900 |
|---|---|---|
| committer | DongHun Kwak <dh0128.kwak@samsung.com> | 2017-09-13 11:09:00 +0900 |
| commit | b5c87084afaef42b2d058f68091be31988a6a874 (patch) | |
| tree | adef9a65870a41181687e11d57fdf98e7629de3c /doc/html/boost_asio/reference/io_service__strand | |
| parent | 34bd32e225e2a8a94104489b31c42e5801cc1f4a (diff) | |
| download | boost-b5c87084afaef42b2d058f68091be31988a6a874.tar.gz boost-b5c87084afaef42b2d058f68091be31988a6a874.tar.bz2 boost-b5c87084afaef42b2d058f68091be31988a6a874.zip | |
Imported Upstream version 1.64.0upstream/1.64.0
Change-Id: Id9212edd016dd55f21172c427aa7894d1d24148b
Signed-off-by: DongHun Kwak <dh0128.kwak@samsung.com>
Diffstat (limited to 'doc/html/boost_asio/reference/io_service__strand')
7 files changed, 524 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/io_service__strand/_strand.html b/doc/html/boost_asio/reference/io_service__strand/_strand.html new file mode 100644 index 0000000000..92c47a7494 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service__strand/_strand.html @@ -0,0 +1,56 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::strand::~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="../io_service__strand.html" title="io_service::strand"> +<link rel="prev" href="wrap.html" title="io_service::strand::wrap"> +<link rel="next" href="../io_service__work.html" title="io_service::work"> +</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="wrap.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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="../io_service__work.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.io_service__strand._strand"></a><a class="link" href="_strand.html" title="io_service::strand::~strand">io_service::strand::~strand</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp146030992"></a> +Destructor. + </p> +<pre class="programlisting"><span class="special">~</span><span class="identifier">strand</span><span class="special">();</span> +</pre> +<p> + Destroys a strand. + </p> +<p> + Handlers posted through the strand that have not yet been invoked will + still be dispatched in a way that meets the guarantee of non-concurrency. + </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-2017 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="wrap.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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="../io_service__work.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service__strand/dispatch.html b/doc/html/boost_asio/reference/io_service__strand/dispatch.html new file mode 100644 index 0000000000..3e3fd44f1d --- /dev/null +++ b/doc/html/boost_asio/reference/io_service__strand/dispatch.html @@ -0,0 +1,88 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::strand::dispatch</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="../io_service__strand.html" title="io_service::strand"> +<link rel="prev" href="../io_service__strand.html" title="io_service::strand"> +<link rel="next" href="get_io_service.html" title="io_service::strand::get_io_service"> +</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="../io_service__strand.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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="get_io_service.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.io_service__strand.dispatch"></a><a class="link" href="dispatch.html" title="io_service::strand::dispatch">io_service::strand::dispatch</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp145893120"></a> +Request the strand to invoke the given handler. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../CompletionHandler.html" title="Completion handler requirements">CompletionHandler</a><span class="special">></span> +<a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function"><span class="emphasis"><em>void-or-deduced</em></span></a> <span class="identifier">dispatch</span><span class="special">(</span> + <span class="identifier">CompletionHandler</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + This function is used to ask the strand to execute the given handler. + </p> +<p> + The strand object guarantees that handlers posted or dispatched through + the strand will not be executed concurrently. The handler may be executed + inside this function if the guarantee can be met. If this function is called + from within a handler that was posted or dispatched through the same strand, + then the new handler will be executed immediately. + </p> +<p> + The strand's guarantee is in addition to the guarantee provided by the + underlying <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>. The <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> guarantees that the + handler will only be called in a thread in which the io_service's run member + function is currently being invoked. + </p> +<h6> +<a name="boost_asio.reference.io_service__strand.dispatch.h0"></a> + <span class="phrase"><a name="boost_asio.reference.io_service__strand.dispatch.parameters"></a></span><a class="link" href="dispatch.html#boost_asio.reference.io_service__strand.dispatch.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">handler</span></dt> +<dd> +<p> + The handler to be called. The strand will make a copy of the handler + object as required. The function signature of the handler must be: +</p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">();</span> +</pre> +<p> + </p> +</dd> +</dl> +</div> +</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-2017 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="../io_service__strand.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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="get_io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service__strand/get_io_service.html b/doc/html/boost_asio/reference/io_service__strand/get_io_service.html new file mode 100644 index 0000000000..a482e2d82b --- /dev/null +++ b/doc/html/boost_asio/reference/io_service__strand/get_io_service.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::strand::get_io_service</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="../io_service__strand.html" title="io_service::strand"> +<link rel="prev" href="dispatch.html" title="io_service::strand::dispatch"> +<link rel="next" href="post.html" title="io_service::strand::post"> +</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="dispatch.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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="post.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.io_service__strand.get_io_service"></a><a class="link" href="get_io_service.html" title="io_service::strand::get_io_service">io_service::strand::get_io_service</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp145915104"></a> +Get the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> associated with the + strand. + </p> +<pre class="programlisting"><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">get_io_service</span><span class="special">();</span> +</pre> +<p> + This function may be used to obtain the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that the strand + uses to dispatch handlers for asynchronous operations. + </p> +<h6> +<a name="boost_asio.reference.io_service__strand.get_io_service.h0"></a> + <span class="phrase"><a name="boost_asio.reference.io_service__strand.get_io_service.return_value"></a></span><a class="link" href="get_io_service.html#boost_asio.reference.io_service__strand.get_io_service.return_value">Return + Value</a> + </h6> +<p> + A reference to the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that the strand + will use to dispatch handlers. Ownership is not transferred to the caller. + </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-2017 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="dispatch.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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="post.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service__strand/post.html b/doc/html/boost_asio/reference/io_service__strand/post.html new file mode 100644 index 0000000000..c49ca8e47d --- /dev/null +++ b/doc/html/boost_asio/reference/io_service__strand/post.html @@ -0,0 +1,84 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::strand::post</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="../io_service__strand.html" title="io_service::strand"> +<link rel="prev" href="get_io_service.html" title="io_service::strand::get_io_service"> +<link rel="next" href="running_in_this_thread.html" title="io_service::strand::running_in_this_thread"> +</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="get_io_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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="running_in_this_thread.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.io_service__strand.post"></a><a class="link" href="post.html" title="io_service::strand::post">io_service::strand::post</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp145930144"></a> +Request the strand to invoke the given handler and + return immediately. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../CompletionHandler.html" title="Completion handler requirements">CompletionHandler</a><span class="special">></span> +<a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function"><span class="emphasis"><em>void-or-deduced</em></span></a> <span class="identifier">post</span><span class="special">(</span> + <span class="identifier">CompletionHandler</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + This function is used to ask the strand to execute the given handler, but + without allowing the strand to call the handler from inside this function. + </p> +<p> + The strand object guarantees that handlers posted or dispatched through + the strand will not be executed concurrently. The strand's guarantee is + in addition to the guarantee provided by the underlying <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a>. The <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> guarantees that the + handler will only be called in a thread in which the io_service's run member + function is currently being invoked. + </p> +<h6> +<a name="boost_asio.reference.io_service__strand.post.h0"></a> + <span class="phrase"><a name="boost_asio.reference.io_service__strand.post.parameters"></a></span><a class="link" href="post.html#boost_asio.reference.io_service__strand.post.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">handler</span></dt> +<dd> +<p> + The handler to be called. The strand will make a copy of the handler + object as required. The function signature of the handler must be: +</p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">();</span> +</pre> +<p> + </p> +</dd> +</dl> +</div> +</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-2017 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="get_io_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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="running_in_this_thread.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service__strand/running_in_this_thread.html b/doc/html/boost_asio/reference/io_service__strand/running_in_this_thread.html new file mode 100644 index 0000000000..008f324d8e --- /dev/null +++ b/doc/html/boost_asio/reference/io_service__strand/running_in_this_thread.html @@ -0,0 +1,62 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::strand::running_in_this_thread</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="../io_service__strand.html" title="io_service::strand"> +<link rel="prev" href="post.html" title="io_service::strand::post"> +<link rel="next" href="strand.html" title="io_service::strand::strand"> +</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="post.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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.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.io_service__strand.running_in_this_thread"></a><a class="link" href="running_in_this_thread.html" title="io_service::strand::running_in_this_thread">io_service::strand::running_in_this_thread</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp145951072"></a> +Determine whether the strand is + running in the current thread. + </p> +<pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">running_in_this_thread</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.io_service__strand.running_in_this_thread.h0"></a> + <span class="phrase"><a name="boost_asio.reference.io_service__strand.running_in_this_thread.return_value"></a></span><a class="link" href="running_in_this_thread.html#boost_asio.reference.io_service__strand.running_in_this_thread.return_value">Return + Value</a> + </h6> +<p> + <code class="computeroutput"><span class="keyword">true</span></code> if the current thread + is executing a handler that was submitted to the strand using <code class="computeroutput"><span class="identifier">post</span><span class="special">()</span></code>, + <code class="computeroutput"><span class="identifier">dispatch</span><span class="special">()</span></code> + or <code class="computeroutput"><span class="identifier">wrap</span><span class="special">()</span></code>. + Otherwise returns <code class="computeroutput"><span class="keyword">false</span></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-2017 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="post.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service__strand/strand.html b/doc/html/boost_asio/reference/io_service__strand/strand.html new file mode 100644 index 0000000000..8bb0df8727 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service__strand/strand.html @@ -0,0 +1,67 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::strand::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="../io_service__strand.html" title="io_service::strand"> +<link rel="prev" href="running_in_this_thread.html" title="io_service::strand::running_in_this_thread"> +<link rel="next" href="wrap.html" title="io_service::strand::wrap"> +</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="running_in_this_thread.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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="wrap.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.io_service__strand.strand"></a><a class="link" href="strand.html" title="io_service::strand::strand">io_service::strand::strand</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp145966640"></a> +Constructor. + </p> +<pre class="programlisting"><span class="identifier">strand</span><span class="special">(</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">io_service</span><span class="special">);</span> +</pre> +<p> + Constructs the strand. + </p> +<h6> +<a name="boost_asio.reference.io_service__strand.strand.h0"></a> + <span class="phrase"><a name="boost_asio.reference.io_service__strand.strand.parameters"></a></span><a class="link" href="strand.html#boost_asio.reference.io_service__strand.strand.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">io_service</span></dt> +<dd><p> + The <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that the + strand will use to dispatch handlers that are ready to be run. + </p></dd> +</dl> +</div> +</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-2017 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="running_in_this_thread.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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="wrap.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/io_service__strand/wrap.html b/doc/html/boost_asio/reference/io_service__strand/wrap.html new file mode 100644 index 0000000000..0f188d8891 --- /dev/null +++ b/doc/html/boost_asio/reference/io_service__strand/wrap.html @@ -0,0 +1,104 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>io_service::strand::wrap</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="../io_service__strand.html" title="io_service::strand"> +<link rel="prev" href="strand.html" title="io_service::strand::strand"> +<link rel="next" href="_strand.html" title="io_service::strand::~strand"> +</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="strand.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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.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.io_service__strand.wrap"></a><a class="link" href="wrap.html" title="io_service::strand::wrap">io_service::strand::wrap</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp145981600"></a> +Create a new handler that automatically dispatches + the wrapped handler on the strand. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../Handler.html" title="Handlers">Handler</a><span class="special">></span> +<span class="identifier">unspecified</span> <span class="identifier">wrap</span><span class="special">(</span> + <span class="identifier">Handler</span> <span class="identifier">handler</span><span class="special">);</span> +</pre> +<p> + This function is used to create a new handler function object that, when + invoked, will automatically pass the wrapped handler to the strand's dispatch + function. + </p> +<h6> +<a name="boost_asio.reference.io_service__strand.wrap.h0"></a> + <span class="phrase"><a name="boost_asio.reference.io_service__strand.wrap.parameters"></a></span><a class="link" href="wrap.html#boost_asio.reference.io_service__strand.wrap.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">handler</span></dt> +<dd> +<p> + The handler to be wrapped. The strand will make a copy of the handler + object as required. The function signature of the handler must be: +</p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span><span class="identifier">A1</span> <span class="identifier">a1</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">An</span> <span class="identifier">an</span><span class="special">);</span> +</pre> +<p> + </p> +</dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.io_service__strand.wrap.h1"></a> + <span class="phrase"><a name="boost_asio.reference.io_service__strand.wrap.return_value"></a></span><a class="link" href="wrap.html#boost_asio.reference.io_service__strand.wrap.return_value">Return + Value</a> + </h6> +<p> + A function object that, when invoked, passes the wrapped handler to the + strand's dispatch function. Given a function object with the signature: + </p> +<pre class="programlisting"><span class="identifier">R</span> <span class="identifier">f</span><span class="special">(</span><span class="identifier">A1</span> <span class="identifier">a1</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">An</span> <span class="identifier">an</span><span class="special">);</span> +</pre> +<p> + If this function object is passed to the wrap function like so: + </p> +<pre class="programlisting"><span class="identifier">strand</span><span class="special">.</span><span class="identifier">wrap</span><span class="special">(</span><span class="identifier">f</span><span class="special">);</span> +</pre> +<p> + then the return value is a function object with the signature + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">g</span><span class="special">(</span><span class="identifier">A1</span> <span class="identifier">a1</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">An</span> <span class="identifier">an</span><span class="special">);</span> +</pre> +<p> + that, when invoked, executes code equivalent to: + </p> +<pre class="programlisting"><span class="identifier">strand</span><span class="special">.</span><span class="identifier">dispatch</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">bind</span><span class="special">(</span><span class="identifier">f</span><span class="special">,</span> <span class="identifier">a1</span><span class="special">,</span> <span class="special">...</span> <span class="identifier">an</span><span class="special">));</span> +</pre> +</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-2017 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="strand.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_service__strand.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.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |