Boost-Commit mailing page: [Boost-commit] svn:boost r68960 - in sandbox/interthreads/libs/interthreads/doc: . html html/toward_boost_interthreads html/toward_boost_interthreads/appendices html/toward_boost_interthreads/examples html/toward_boost_interthreads/overview html/toward_boost_interthreads/reference html/toward_boost_interthreads/users

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r68960 - in sandbox/interthreads/libs/interthreads/doc: . html html/toward_boost_interthreads html/toward_boost_interthreads/appendices html/toward_boost_interthreads/examples html/toward_boost_interthreads/overview html/toward_boost_interthreads/reference html/toward_boost_interthreads/users_guide
From: vicente.botet_at_[hidden]
Date: 2011-02-16 14:38:24

Author: viboes
Date: 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
New Revision: 68960
URL: http://svn.boost.org/trac/boost/changeset/68960

Log:
Interthreads: update doc
Text files modified:
   sandbox/interthreads/libs/interthreads/doc/Jamfile.v2 | 17
   sandbox/interthreads/libs/interthreads/doc/html/index.html | 102
   sandbox/interthreads/libs/interthreads/doc/html/standalone_HTML.manifest | 23
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices.html | 1931 ++++++++++++++++++++++++++
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/acknowledgements.html | 21
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/changes.html | 109
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/implementation.html | 181 +-
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/rationale.html | 1442 +++++++++----------
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/tests.html | 23
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/tickets.html | 277 +-
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/todo.html | 185 +-
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/examples.html | 324 ++++
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/examples/thread_safe_deferred_traces.html | 64
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/overview.html | 476 ++++-
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/overview/motivation.html | 75
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference.html | 2857 +++++++++++++++++++++++++++++++++++++++
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/concepts.html | 20
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/keep_alive_file_hpp.html | 272 +--
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/set_once_hpp.html | 53
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_decoration_hpp.html | 165 +-
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_decorator_hpp.html | 474 +++---
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_group_once_hpp.html | 482 +++---
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_specific_shared_ptr_hpp.html | 634 ++++----
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_tuple_hpp.html | 541 +++----
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_tuple_once_hpp.html | 514 +++---
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide.html | 1753 ++++++++++++++++++++++++
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/bibliography.html | 26
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/getting_started.html | 180 +-
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/glosary.html | 62
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/tutorial.html | 372 ++---
   sandbox/interthreads/libs/interthreads/doc/interthreads.qbk | 9
   sandbox/interthreads/libs/interthreads/doc/overview.qbk | 72
   sandbox/interthreads/libs/interthreads/doc/rationale.qbk | 16
   sandbox/interthreads/libs/interthreads/doc/users_guide.qbk | 5
   34 files changed, 10044 insertions(+), 3713 deletions(-)

Modified: sandbox/interthreads/libs/interthreads/doc/Jamfile.v2
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/Jamfile.v2 (original)
+++ sandbox/interthreads/libs/interthreads/doc/Jamfile.v2 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -17,7 +17,7 @@
 # Use graphics not text for navigation:
 <xsl:param>navig.graphics=1
 # How far down we chunk nested sections, basically all of them:
- <xsl:param>chunk.section.depth=2
+ <xsl:param>chunk.section.depth=1
 # Don't put the first section on the same page as the TOC:
 <xsl:param>chunk.first.sections=1
 # How far down sections get TOC's
@@ -31,15 +31,15 @@
 # Path for libraries index:
 <xsl:param>boost.libraries=../../../../libs/libraries.htm
 # Use the main Boost stylesheet:
- <xsl:param>html.stylesheet=../../../../doc/html/boostbook.css
+ <xsl:param>html.stylesheet=../../../../doc/src/boostbook.css

 # PDF Options:
 # TOC Generation: this is needed for FOP-0.9 and later:
- #<xsl:param>fop1.extensions=1
+ <format>pdf:<xsl:param>fop1.extensions=0
 # Or enable this if you're using XEP:
- <xsl:param>xep.extensions=1
+ <format>pdf:<xsl:param>xep.extensions=1
 # TOC generation: this is needed for FOP 0.2, but must not be set to zero for FOP-0.9!
- <xsl:param>fop.extensions=0
+ <format>pdf:<xsl:param>fop.extensions=0
 # No indent on body text:
 <xsl:param>body.start.indent=0pt
 # Margin size:
@@ -52,6 +52,9 @@
 # default pnd graphics are awful in PDF form,
 # better use SVG's instead:
 <format>pdf:<xsl:param>admon.graphics.extension=".svg"
- <format>pdf:<xsl:param>admon.graphics.path=$(boost-images)/
- ;
+ <format>pdf:<xsl:param>admon.graphics.path=$(boost-images)
+ <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/interthreads/doc/html
+ ;
+
+install pdf-install : standalone : <location>. <install-type>PDF ;

Modified: sandbox/interthreads/libs/interthreads/doc/html/index.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/index.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/index.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,12 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>Toward Boost.InterThreads</title>
-<link rel="stylesheet" href="../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Toward Boost.InterThreads">
-<link rel="next" href="toward_boost_interthreads/overview.html" title=" Overview">
+<title>Toward Boost.InterThreads 0.1.3</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="Toward Boost.InterThreads 0.1.3">
+<link rel="next" href="toward_boost_interthreads/overview.html" title="Overview">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -19,17 +18,17 @@
</tr></table>
<hr>
<div class="spirit-nav"><a accesskey="n" href="toward_boost_interthreads/overview.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
-<div class="article" lang="en">
+<div class="article">
<div class="titlepage">
<div>
<div><h2 class="title">
-<a name="toward_boost_interthreads"></a>Toward Boost.InterThreads</h2></div>
+<a name="toward_boost_interthreads"></a>Toward Boost.InterThreads 0.1.3</h2></div>
<div><div class="authorgroup"><div class="author"><h3 class="author">
Vicente J. Botet Escriba
</h3></div></div></div>
-<div>Copyright © 2008 -2009 Vicente J. Botet Escriba</div>
+<div>Copyright © 2008 -2009,2011 Vicente J. Botet Escriba</div>
<div><div class="legalnotice">
-<a name="id4946174"></a>
+<a name="id3012888"></a>
 Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 
@@ -40,56 +39,56 @@
<div class="toc">
Table of Contents
<dl>
-<dt> Overview</dt>
-<dd><dl><dt> Motivation</dt></dl></dd>
-<dt> Users'Guide</dt>
+<dt>Overview</dt>
<dd><dl>
-<dt><a href="toward_boost_interthreads/users_guide/getting_started.html">
- Getting Started</a></dt>
-<dt> Tutorial</dt>
-<dt><a href="toward_boost_interthreads/users_guide/bibliography.html">
- References</a></dt>
-<dt> Glossary</dt>
+<dt>Motivation</dt>
+<dt>Description</dt>
</dl></dd>
-<dt> Reference</dt>
+<dt>Users'Guide</dt>
<dd><dl>
-<dt>Concepts</dt>
-<dt><a href="toward_boost_interthreads/reference/thread_decoration_hpp.html">
- Header <code class="computeroutput"><boost/interthreads/thread_decoration.hpp></code></a></dt>
-<dt><a href="toward_boost_interthreads/reference/thread_decorator_hpp.html">
- Header <code class="computeroutput"><boost/interthreads/thread_decorator.hpp></code></a></dt>
-<dt><a href="toward_boost_interthreads/reference/thread_specific_shared_ptr_hpp.html">
- Header <code class="computeroutput"><boost/interthreads/thread_specific_shared_ptr.hpp></code></a></dt>
-<dt><a href="toward_boost_interthreads/reference/keep_alive_file_hpp.html">
- Header <code class="computeroutput"><boost/interthreads/thread_keep_alive.hpp></code></a></dt>
-<dt><a href="toward_boost_interthreads/reference/set_once_hpp.html"> Header
+<dt><a href="toward_boost_interthreads/users_guide.html#toward_boost_interthreads.users_guide.getting_started">Getting
+ Started</a></dt>
+<dt>Tutorial</dt>
+<dt>Examples</dt>
+<dt>References</dt>
+<dt>Glossary</dt>
+</dl></dd>
+<dt>Reference</dt>
+<dd><dl>
+<dt>Concepts</dt>
+<dt><a href="toward_boost_interthreads/reference.html#toward_boost_interthreads.reference.thread_decoration_hpp">Header
+ <code class="computeroutput"><boost/interthreads/thread_decoration.hpp></code></a></dt>
+<dt><a href="toward_boost_interthreads/reference.html#toward_boost_interthreads.reference.thread_decorator_hpp">Header
+ <code class="computeroutput"><boost/interthreads/thread_decorator.hpp></code></a></dt>
+<dt><a href="toward_boost_interthreads/reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp">Header
+ <code class="computeroutput"><boost/interthreads/thread_specific_shared_ptr.hpp></code></a></dt>
+<dt><a href="toward_boost_interthreads/reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp">Header
+ <code class="computeroutput"><boost/interthreads/thread_keep_alive.hpp></code></a></dt>
+<dt><a href="toward_boost_interthreads/reference.html#toward_boost_interthreads.reference.set_once_hpp">Header
 <code class="computeroutput"><boost/interthreads/set_once.hpp></code></a></dt>
-<dt><a href="toward_boost_interthreads/reference/thread_tuple_hpp.html">
- Header <code class="computeroutput"><boost/interthreads/thread_tuple.hpp></code></a></dt>
-<dt><a href="toward_boost_interthreads/reference/thread_tuple_once_hpp.html">
- Header <code class="computeroutput"><boost/interthreads/thread_tuple_once.hpp></code></a></dt>
-<dt><a href="toward_boost_interthreads/reference/thread_group_once_hpp.html">
- Header <code class="computeroutput"><boost/interthreads/thread_group_once.hpp></code></a></dt>
+<dt><a href="toward_boost_interthreads/reference.html#toward_boost_interthreads.reference.thread_tuple_hpp">Header
+ <code class="computeroutput"><boost/interthreads/thread_tuple.hpp></code></a></dt>
+<dt><a href="toward_boost_interthreads/reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp">Header
+ <code class="computeroutput"><boost/interthreads/thread_tuple_once.hpp></code></a></dt>
+<dt><a href="toward_boost_interthreads/reference.html#toward_boost_interthreads.reference.thread_group_once_hpp">Header
+ <code class="computeroutput"><boost/interthreads/thread_group_once.hpp></code></a></dt>
</dl></dd>
-<dt>Examples</dt>
-<dd><dl><dt><a href="toward_boost_interthreads/examples/thread_safe_deferred_traces.html">Thread
- safe deferred traces</a></dt></dl></dd>
<dt>Appendices</dt>
<dd><dl>
-<dt><a href="toward_boost_interthreads/appendices/changes.html"> Appendix
+<dt><a href="toward_boost_interthreads/appendices.html#toward_boost_interthreads.appendices.changes">Appendix
 A: History</a></dt>
-<dt><a href="toward_boost_interthreads/appendices/rationale.html"> Appendix
+<dt><a href="toward_boost_interthreads/appendices.html#toward_boost_interthreads.appendices.rationale">Appendix
 B: Rationale</a></dt>
-<dt><a href="toward_boost_interthreads/appendices/implementation.html">
- Appendix C: Implementation Notes</a></dt>
-<dt><a href="toward_boost_interthreads/appendices/acknowledgements.html">
- Appendix D: Acknowledgments</a></dt>
-<dt><a href="toward_boost_interthreads/appendices/tests.html"> Appendix
+<dt><a href="toward_boost_interthreads/appendices.html#toward_boost_interthreads.appendices.implementation">Appendix
+ C: Implementation Notes</a></dt>
+<dt><a href="toward_boost_interthreads/appendices.html#toward_boost_interthreads.appendices.acknowledgements">Appendix
+ D: Acknowledgments</a></dt>
+<dt><a href="toward_boost_interthreads/appendices.html#toward_boost_interthreads.appendices.tests">Appendix
 E: Tests</a></dt>
-<dt><a href="toward_boost_interthreads/appendices/tickets.html"> Appendix
+<dt><a href="toward_boost_interthreads/appendices.html#toward_boost_interthreads.appendices.tickets">Appendix
 F: Tickets</a></dt>
-<dt><a href="toward_boost_interthreads/appendices/todo.html"> Appendix
- G: Future plans</a></dt>
+<dt><a href="toward_boost_interthreads/appendices.html#toward_boost_interthreads.appendices.todo">Appendix G:
+ Future plans</a></dt>
</dl></dd>
</dl>
</div>
@@ -102,12 +101,9 @@
 Toward Boost.InterThreads is not a part of the Boost libraries.
 </td></tr>
</table></div>
-
- [/
- 
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: January 16, 2011 at 09:25:40 GMT</td>
+<td align="left">Last revised: February 16, 2011 at 00:18:47 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Modified: sandbox/interthreads/libs/interthreads/doc/html/standalone_HTML.manifest
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/standalone_HTML.manifest (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/standalone_HTML.manifest 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,28 +1,5 @@
index.html
toward_boost_interthreads/overview.html
-toward_boost_interthreads/overview/motivation.html
toward_boost_interthreads/users_guide.html
-toward_boost_interthreads/users_guide/getting_started.html
-toward_boost_interthreads/users_guide/tutorial.html
-toward_boost_interthreads/users_guide/bibliography.html
-toward_boost_interthreads/users_guide/glosary.html
toward_boost_interthreads/reference.html
-toward_boost_interthreads/reference/concepts.html
-toward_boost_interthreads/reference/thread_decoration_hpp.html
-toward_boost_interthreads/reference/thread_decorator_hpp.html
-toward_boost_interthreads/reference/thread_specific_shared_ptr_hpp.html
-toward_boost_interthreads/reference/keep_alive_file_hpp.html
-toward_boost_interthreads/reference/set_once_hpp.html
-toward_boost_interthreads/reference/thread_tuple_hpp.html
-toward_boost_interthreads/reference/thread_tuple_once_hpp.html
-toward_boost_interthreads/reference/thread_group_once_hpp.html
-toward_boost_interthreads/examples.html
-toward_boost_interthreads/examples/thread_safe_deferred_traces.html
toward_boost_interthreads/appendices.html
-toward_boost_interthreads/appendices/changes.html
-toward_boost_interthreads/appendices/rationale.html
-toward_boost_interthreads/appendices/implementation.html
-toward_boost_interthreads/appendices/acknowledgements.html
-toward_boost_interthreads/appendices/tests.html
-toward_boost_interthreads/appendices/tickets.html
-toward_boost_interthreads/appendices/todo.html

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,16 +1,12 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Appendices</title>
-<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../index.html" title="Toward Boost.InterThreads">
-<link rel="prev" href="examples/thread_safe_deferred_traces.html" title="Thread
- safe deferred traces">
-<link rel="next" href="appendices/changes.html" title=" Appendix
- A: History">
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Toward Boost.InterThreads 0.1.3">
+<link rel="up" href="../index.html" title="Toward Boost.InterThreads 0.1.3">
+<link rel="prev" href="reference.html" title="Reference">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -23,69 +19,1924 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="examples/thread_safe_deferred_traces.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="appendices/changes.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="reference.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="toward_boost_interthreads.appendices"></a>Appendices
+<a name="toward_boost_interthreads.appendices"></a><a class="link" href="appendices.html" title="Appendices">Appendices</a>
</h2></div></div></div>
<div class="toc"><dl>
-<dt><a href="appendices/changes.html"> Appendix
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.changes">Appendix
 A: History</a></dt>
<dd><dl>
-<dt><a href="appendices/changes.html#toward_boost_interthreads.appendices.changes.__version_0_1_3__mars_29__2009__extraction_of_the_asynchonous_executor_framework">Version 0.1.3, Mars 29, 2009 Extraction of the Asynchonous
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.changes.__version_0_1_3__mars_29__2009__extraction_of_the_asynchonous_executor_framework">Version 0.1.3, Mars 29, 2009 Extraction of the Asynchonous
 Executor framework</a></dt>
-<dt>Version 0.1.2, February 8, 2009 Bug fixes</dt>
-<dt><a href="appendices/changes.html#toward_boost_interthreads.appendices.changes.__version_0_1_1__january_14__2009__bug_fixes_and_test_on_more_toolsets">Version 0.1.1, January 14, 2009 Bug fixes and test
+<dt>Version 0.1.2, February 8, 2009 Bug fixes</dt>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.changes.__version_0_1_1__january_14__2009__bug_fixes_and_test_on_more_toolsets">Version 0.1.1, January 14, 2009 Bug fixes and test
 on more toolsets</a></dt>
-<dt><a href="appendices/changes.html#toward_boost_interthreads.appendices.changes.__version_0_1_0__november_30__2008____announcement_of_interthreads_">Version 0.1.0, November 30, 2008 Announcement
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.changes.__version_0_1_0__november_30__2008____announcement_of_interthreads_">Version 0.1.0, November 30, 2008 Announcement
 of Interthreads</a></dt>
-<dt>Bugs</dt>
+<dt>Bugs</dt>
</dl></dd>
-<dt><a href="appendices/rationale.html"> Appendix
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.rationale">Appendix
 B: Rationale</a></dt>
<dd><dl>
-<dt><a href="appendices/rationale.html#toward_boost_interthreads.appendices.rationale.thread_decorator">Thread
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.rationale.decorator">Thread
 Decorator</a></dt>
-<dt><a href="appendices/rationale.html#toward_boost_interthreads.appendices.rationale.thread_specific_storage">Thread
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.rationale.tss">Thread
 Specific Storage</a></dt>
-<dt><a href="appendices/rationale.html#toward_boost_interthreads.appendices.rationale.keep_alive">Keep
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.rationale.ka">Keep
 Alive</a></dt>
-<dt><a href="appendices/rationale.html#toward_boost_interthreads.appendices.rationale.thread_tuple">Thread
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.rationale.tuple">Thread
 Tuple</a></dt>
</dl></dd>
-<dt><a href="appendices/implementation.html">
- Appendix C: Implementation Notes</a></dt>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.implementation">Appendix
+ C: Implementation Notes</a></dt>
<dd><dl>
-<dt><a href="appendices/implementation.html#toward_boost_interthreads.appendices.implementation.thread_decorator">Thread
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.implementation.thread_decorator">Thread
 Decorator</a></dt>
-<dt><a href="appendices/implementation.html#toward_boost_interthreads.appendices.implementation.thread_specific_storage">Thread
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.implementation.thread_specific_storage">Thread
 Specific Storage</a></dt>
-<dt><a href="appendices/implementation.html#toward_boost_interthreads.appendices.implementation.keep_alive">Keep
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.implementation.keep_alive">Keep
 Alive</a></dt>
-<dt><a href="appendices/implementation.html#toward_boost_interthreads.appendices.implementation.thread_tuple">Thread
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.implementation.thread_tuple">Thread
 Tuple</a></dt>
</dl></dd>
-<dt><a href="appendices/acknowledgements.html">
- Appendix D: Acknowledgments</a></dt>
-<dt><a href="appendices/tests.html"> Appendix
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.acknowledgements">Appendix
+ D: Acknowledgments</a></dt>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.tests">Appendix
 E: Tests</a></dt>
-<dd><dl><dt>thread_specific_shared_pointer</dt></dl></dd>
-<dt><a href="appendices/tickets.html"> Appendix
+<dd><dl><dt>thread_specific_shared_pointer</dt></dl></dd>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.tickets">Appendix
 F: Tickets</a></dt>
-<dt><a href="appendices/todo.html"> Appendix
- G: Future plans</a></dt>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.todo">Appendix G:
+ Future plans</a></dt>
<dd><dl>
-<dt><a href="appendices/todo.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review">Tasks
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review">Tasks
 to do before review</a></dt>
-<dt><a href="appendices/todo.html#toward_boost_interthreads.appendices.todo.for_later_releases">For
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.todo.for_later_releases">For
 later releases</a></dt>
</dl></dd>
</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.appendices.changes"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.changes" title="Appendix A: History">Appendix
+ A: History</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.changes.__version_0_1_3__mars_29__2009__extraction_of_the_asynchonous_executor_framework">Version 0.1.3, Mars 29, 2009 Extraction of the Asynchonous
+ Executor framework</a></dt>
+<dt>Version 0.1.2, February 8, 2009 Bug fixes</dt>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.changes.__version_0_1_1__january_14__2009__bug_fixes_and_test_on_more_toolsets">Version 0.1.1, January 14, 2009 Bug fixes and test
+ on more toolsets</a></dt>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.changes.__version_0_1_0__november_30__2008____announcement_of_interthreads_">Version 0.1.0, November 30, 2008 Announcement
+ of Interthreads</a></dt>
+<dt>Bugs</dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.changes.__version_0_1_3__mars_29__2009__extraction_of_the_asynchonous_executor_framework"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.changes.__version_0_1_3__mars_29__2009__extraction_of_the_asynchonous_executor_framework" title="Version 0.1.3, Mars 29, 2009 Extraction of the Asynchonous Executor framework">Version 0.1.3, Mars 29, 2009 Extraction of the Asynchonous
+ Executor framework</a>
+</h4></div></div></div>
+
+ New Features:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ Extraction of the Asynchonous Executor framework
+ </li></ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.changes.__version_0_1_2__february_8__2009__bug_fixes"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.changes.__version_0_1_2__february_8__2009__bug_fixes" title="Version 0.1.2, February 8, 2009 Bug fixes">Version 0.1.2, February 8, 2009 Bug fixes</a>
+</h4></div></div></div>
+
+ Fixed Bugs:
+ 
+
+ v0.3.1#1: keep alive mechanism crash when setting
+ <code class="computeroutput">set_on_dead_thread()</code>
+ before enabling the mechanism. This was due to the fact that
+ there were no default data for the backup.
+ 
+
+ v0.3.1#2: keep alive mechanism do not detect dead
+ threads. We need to reset the counters only when the period
+ is 0.
+ 
+
+ v0.3.1#3: The <code class="computeroutput">set_on_dead_thread()</code> setting is not recovered by embeeding
+ kep_alive enablers/disablers. The problem is that the <code class="computeroutput">on_dead()</code>
+ the function and the thread pointer were stored on the backup. It is enough
+ to store them on the <code class="computeroutput">thread_keep_alive_ctx</code>
+ and make the functions thread_safe.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.changes.__version_0_1_1__january_14__2009__bug_fixes_and_test_on_more_toolsets"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.changes.__version_0_1_1__january_14__2009__bug_fixes_and_test_on_more_toolsets" title="Version 0.1.1, January 14, 2009 Bug fixes and test on more toolsets">Version 0.1.1, January 14, 2009 Bug fixes and test
+ on more toolsets</a>
+</h4></div></div></div>
+
+ Toolsets:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Tested on Linux gcc 3.4.6.
+ </li>
+<li class="listitem">
+ Tested on Linux gcc 4.1.2.
+ </li>
+<li class="listitem">
+ Modification helping Windows (not tested)
+ </li>
+</ul></div>
+
+ Fixed Bugs:
+ 
+
+ v0.1#1: basic_keep_alive example do not link.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.changes.__version_0_1_0__november_30__2008____announcement_of_interthreads_"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.changes.__version_0_1_0__november_30__2008____announcement_of_interthreads_" title="Version 0.1.0, November 30, 2008 Announcement of Interthreads">Version 0.1.0, November 30, 2008 Announcement
+ of Interthreads</a>
+</h4></div></div></div>
+
+ Features:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <code class="computeroutput">thread_decorator</code> setup/cleanup
+ thread decorator,
+ </li>
+<li class="listitem">
+ thread specific shared pointer,
+ </li>
+<li class="listitem">
+ thread keep alive mechanism,
+ </li>
+<li class="listitem">
+ thread tuples, set_once synchonizer, thread_tuple_once and thread_group_once.
+ </li>
+</ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.changes.__bugs_"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.changes.__bugs_" title="Bugs">Bugs</a>
+</h4></div></div></div>
+<a name="toward_boost_interthreads.appendices.changes.__bugs_._emphasis_role__bold__open_bugs___emphasis_"></a><h6>
+<a name="id3061844"></a>
+ <a class="link" href="appendices.html#toward_boost_interthreads.appendices.changes.__bugs_._emphasis_role__bold__open_bugs___emphasis_">Open Bugs:</a>
+ </h6>
+<a name="toward_boost_interthreads.appendices.changes.__bugs_._emphasis_role__bold__fixed_bugs___emphasis_"></a><h6>
+<a name="id3061872"></a>
+ <a class="link" href="appendices.html#toward_boost_interthreads.appendices.changes.__bugs_._emphasis_role__bold__fixed_bugs___emphasis_">Fixed Bugs:</a>
+ </h6>
+
+ v0.1.1#1: keep alive mechanism crash when setting
+ set_on_dead_thread before enabling the mechanism. This was due
+ to the fact that there were no default data for the backup.
+ 
+
+ v0.1.1#2: keep alive mechanism do not detect dead
+ threads. We need to reste the counters only when the period
+ is 0.
+ 
+
+ v0.1.1#3: The set_on_dead_thread setting is not recovered
+ by embeeding enablers/disablers. The problem is that the on_dead
+ and th thread pointer were stored on the backup. It is enough to store
+ them on the
+ 
+
+ v0.1#1: basic_keep_alive example do not link.
+ 
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.appendices.rationale"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.rationale" title="Appendix B: Rationale">Appendix
+ B: Rationale</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.rationale.decorator">Thread
+ Decorator</a></dt>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.rationale.tss">Thread
+ Specific Storage</a></dt>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.rationale.ka">Keep
+ Alive</a></dt>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.rationale.tuple">Thread
+ Tuple</a></dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.rationale.decorator"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.rationale.decorator" title="Thread Decorator">Thread
+ Decorator</a>
+</h4></div></div></div>
+<div class="variablelist">
+
+<dl>
+<dt>Function wrapper versus thread refinement</dt>
+<dd>
+ The threadalert on which this library was initialy based redefined
+ the boost:thread class which called implicitly the wrapper. As the
+ single varying features between both threads was this wrapping of
+ the thread function it has been isolated in the interthreads library.
+ </dd>
+<dt>Static decoration variables</dt>
+<dd>
+ Thread decorations construction is not thread safe and must be done
+ before other threads have been created and the <code class="computeroutput">decorate()</code> function is called.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.rationale.tss"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.rationale.tss" title="Thread Specific Storage">Thread
+ Specific Storage</a>
+</h4></div></div></div>
+<div class="variablelist">
+
+<dl>
+<dt>Non copiable/Non movable</dt>
+<dd>
+ Specific pointers are singletons.
+ </dd>
+<dt>External locking</dt>
+<dd>
+ In order to ensure thread safety while providing as much functionality
+ as possible the class allows to get the map of thread specific contexts
+ as soon as the application provides a <code class="computeroutput">unique_lock</code>.
+ </dd>
+<dt>Mimic thread_specific_ptr</dt>
+<dd>
+
+ From the point of view of the current thread thread_specific_shared_ptr
+ behaves as a thread_specific_ptr. From it we takes:
+ 
+
+
+
+<pre class="programlisting">thread_specific_shared_ptr();
+explicit thread_specific_shared_ptr(void (*cleanup_)(shared_ptr_type));
+T* get() const;
+T* operator->() const;
+T& operator*() const;
+void reset();
+template<class Y> void reset(Y * p);
+</pre>
+
+ 
+</dd>
+<dt>Mimic shared_ptr</dt>
+<dd>
+
+ From the point of view of the other threads thread_specific_shared_ptr
+ behaves as a shared_ptr lockup. From the point of view of the current
+ thread the stored pointer is located in a shared_pointer, so we can
+ use the shared_ptr deleter feature From shared_ptr takes:
+ 
+
+
+
+<pre class="programlisting">T* get() const;
+T* operator->() const;
+T& operator*() const;
+void reset();
+template<class Y> void reset(Y * p);
+template<class Y, class D> void reset(Y * p, D d);
+template<class Y, class D, class A> void reset(Y * p, D d, A a);
+</pre>
+
+ 
+</dd>
+<dt>Why doesn't thread_specific_shared_ptr provide a release() function?</dt>
+<dd>
+ As it store a shared_ptr, it cannot give away ownership unless it's
+ unique() because the other copy will still destroy the object.
+ </dd>
+</dl>
+</div>
+<a name="toward_boost_interthreads.appendices.rationale.tss._hcmp_tss_comparaing_tsss_and_tss"></a><h6>
+<a name="id3062782"></a>
+ <a class="link" href="appendices.html#toward_boost_interthreads.appendices.rationale.tss._hcmp_tss_comparaing_tsss_and_tss">:hcmp_tss
+ Comparaing TSSS and TSS</a>
+ </h6>
+<div class="table">
+<a name="toward_boost_interthreads.appendices.rationale.tss.tcmp_tss"></a>Table 1. Comparaing TSSS and TSS
+<div class="table-contents"><table class="table" summary="Comparaing TSSS and TSS">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Feature
+ 
+ </th>
+<th>
+ 
+ thread_specific_shared_ptr
+ 
+ </th>
+<th>
+ 
+ thread_specific_ptr
+ 
+ </th>
+<th>
+ 
+ Compatible
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ ownership
+ 
+ </td>
+<td>
+ 
+ shared
+ 
+ </td>
+<td>
+ 
+ exclusive
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ default constructor
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ cleanup constructor
+ 
+ </td>
+<td>
+ 
+ yes: can not delete the pointer
+ 
+ </td>
+<td>
+ 
+ yes:must delete the pointer
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">get()</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator->()</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator*()</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">reset()</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">reset(T*)</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">reset(Y*)</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">reset(Y*,D)</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">reset(Y*,D,A)</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">release()</code>
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">get_mutex()</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">get_map()</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator[]()</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">wait_and_get()</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.rationale.ka"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.rationale.ka" title="Keep Alive">Keep
+ Alive</a>
+</h4></div></div></div>
+<div class="variablelist">
+
+<dl>
+<dt>Can a thread that has just do a check point be considered as dead
+ less than one second after?</dt>
+<dd>
+ Whell this depends on the enabling parameters. If the checking parameter
+ is greater than one it could be possible that the thread do a check_point
+ just before the keep alive manager do the check, seen that there
+ are not enough check_points and declaring the thread dead. If you
+ want to avoid this situation let the checkin to 1.
+ </dd>
+<dt>Nesting enablers and disablers</dt>
+<dd>
+ Enablers/disablers use RAII, so they can be nested and the context
+ be restored on the destructor.
+ </dd>
+<dt>Configurable on dead action</dt>
+<dd>
+ The default action is to abort the process because I don't see any
+ generic and cleaner way to manage this event. The library provides
+ this hook for user wanting to try something specific.
+ </dd>
+<dt>Who control the controler?</dt>
+<dd>
+ There is no way to control this thread other than adding an external
+ process.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.rationale.tuple"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.rationale.tuple" title="Thread Tuple">Thread
+ Tuple</a>
+</h4></div></div></div>
+<div class="variablelist">
+
+<dl>
+<dt>Why must be not copiable?</dt>
+<dd>
+ Thread tuples can not be copiable since boost::thread is not copiable.
+ </dd>
+<dt>Why should be movable?</dt>
+<dd>
+ If we want functions to return Thread tuples it is necessary to make
+ them movable.
+ </dd>
+<dt>Mimic boost::thread_group</dt>
+<dd>
+
+ thread_tuple has in common some function found in thread_group. From
+ it we take
+ 
+
+
+
+<pre class="programlisting">void join_all();
+void interrupt_all();
+std::size_t size();
+</pre>
+
+ 
+</dd>
+<dt>Mimic boost::thread</dt>
+<dd>
+
+ We can consider a thread tuple as a compound thread, and so we can
+ mimic the thread intyerface. From it we takes
+ 
+
+
+
+<pre class="programlisting">void join();
+void interrupt();
+void detach/detach_all();
+bool interruption_requested() const;
+void timed_join/timed_join_all();
+bool joinable/all_joinable() const;
+</pre>
+
+ 
+</dd>
+<dt>Why the user can not modify directly the embeeded threads?</dt>
+<dd>
+
+ The library provides a safe function to get a constant thread reference
+ 
+
+
+
+<pre class="programlisting">const thread& operator[](std::size_t i) const;</pre>
+
+ 
+
+ The problem if we provide the non constant variant is that the user
+ can detach them.
+ 
+</dd>
+<dt>Joining the first finishing thread of a thread tuple</dt>
+<dd>
+ This functionallity has a price. We need to synchronize all the threads
+ transparently, so we need to wrap the user thread functions.
+ </dd>
+</dl>
+</div>
+<a name="toward_boost_interthreads.appendices.rationale.tuple._hcmp_thread_comparaing_thread__thread_group_and_thread_tuple"></a><h6>
+<a name="id3064259"></a>
+ <a class="link" href="appendices.html#toward_boost_interthreads.appendices.rationale.tuple._hcmp_thread_comparaing_thread__thread_group_and_thread_tuple">:hcmp_thread
+ Comparaing thread, thread_group and thread_tuple</a>
+ </h6>
+<div class="table">
+<a name="toward_boost_interthreads.appendices.rationale.tuple.tcmp_thread"></a>Table 2. Comparaing thread, thread_group and thread_tuple
+<div class="table-contents"><table class="table" summary="Comparaing thread, thread_group and thread_tuple">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Feature
+ 
+ </th>
+<th>
+ 
+ thread
+ 
+ </th>
+<th>
+ 
+ thread_group
+ 
+ </th>
+<th>
+ 
+ thread_tuple
+ 
+ </th>
+<th>
+ 
+ Compatible
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ default constructor
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ copiable
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ movable
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">joinable()</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no*
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">join()</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no*
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">timed_join()</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no*
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">interruption_requested()</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no*
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">join_all()</code>
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">timed_join_all()</code>
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">interrupt_all()</code>
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">size()</code>
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no* *
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">join_first_then_interrupt()</code>
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no* * *
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">timed_join_first_then_interrupt()</code>
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no* * *
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator[]()</code>
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">swap()</code>
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no
+ 
+ </td>
+<td>
+ 
+ yes
+ 
+ </td>
+<td>
+ 
+ no*
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+ <div class="variablelist">
+
+<dl>
+<dt>*</dt>
+<dd>
+ thread_group could add these synonym functions
+ </dd>
+<dt>* *</dt>
+<dd>
+ thread could add the size function returning 1
+ </dd>
+<dt>* * *</dt>
+<dd>
+ thread & thread_group could add these functions
+ </dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.appendices.implementation"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.implementation" title="Appendix C: Implementation Notes">Appendix
+ C: Implementation Notes</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.implementation.thread_decorator">Thread
+ Decorator</a></dt>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.implementation.thread_specific_storage">Thread
+ Specific Storage</a></dt>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.implementation.keep_alive">Keep
+ Alive</a></dt>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.implementation.thread_tuple">Thread
+ Tuple</a></dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.implementation.thread_decorator"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.implementation.thread_decorator" title="Thread Decorator">Thread
+ Decorator</a>
+</h4></div></div></div>
+<div class="variablelist">
+
+<dl>
+<dt>Thread safe</dt>
+<dd>
+ The library is thread safe as far as the thread decorations are declared
+ staticaly, because these variables will be initialized sequentially.
+ </dd>
+<dt>Chained thread decorations</dt>
+<dd>
+ All the thread decorations are chained between them.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.implementation.thread_specific_storage"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.implementation.thread_specific_storage" title="Thread Specific Storage">Thread
+ Specific Storage</a>
+</h4></div></div></div>
+
+ The Thread-Specific Storage pattern can be implemented in various ways
+ 
+<div class="variablelist">
+
+<dl>
+<dt>External versus internal thread storage</dt>
+<dd>
+ The thread specific data collections can be stored either externally
+ to all threads or internally to each thread. The thread_specific_shared_ptr
+ use both ensuring efficiency when the context is requested by the
+ current thread and allowing threads to access thread specific pointer
+ of other threads
+ </dd>
+<dt>Fixed- vs. variable-sized thread specific key mapping</dt>
+<dd>
+ This library is based on the the Boost.Thread thread_specific_ptr
+ implementation which use a variable-size map indexed by the address
+ of the object. Future releases will provide fixed and mixed keys.
+ </dd>
+<dt>Fixed- vs. variable-sized mapping of thread IDs to thread specific
+ pointers</dt>
+<dd>
+ It may be impractical to have a fixed-size array with an entry for
+ every possible thread ID value. Instead, it is more space efficient
+ to have threads use a dynamic data structure to map thread IDs to
+ thread specific pointers.
+ </dd>
+<dt>One mapping of thread IDs to thread specific pointers or to thread
+ specific key mapping</dt>
+<dd>
+ This library maps thread IDs to thread specific pointers to avoid
+ contention on a single map.
+ </dd>
+<dt>Default versus explicit specific context setting</dt>
+<dd>
+ This library provides explicit setting. In future release will provide
+ explicit/eager and implicit/lazy specific context setting. Note that
+ implicit setting will need a factory or a default constructible type.
+ </dd>
+<dt>Ordered or unordered map</dt>
+<dd>
+ While the thread::id type is ordered, there is no need to use it.
+ The current implementation use an ordered map. Future version will
+ allow the user to configure this.
+ </dd>
+<dt>Intrusive or not maps</dt>
+<dd>
+ As the thread specific pointer is stored on only one map the implementation
+ could use an intrusive container. This will be provided in future
+ releases
+ </dd>
+<dt>Shared versus exclusive locking</dt>
+<dd>
+ Locating the right TS pointer requires the use of mutex to prevent
+ race conditions. The library use a a shared_mutex because most of
+ the access to the map will be readings by other threads. The problem
+ is that the native conditions can not be used directly with shared
+ mutex. Some benchmarks will be needed before decidinf which implementation
+ is the best.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.implementation.keep_alive"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.implementation.keep_alive" title="Keep Alive">Keep
+ Alive</a>
+</h4></div></div></div>
+<div class="variablelist">
+
+<dl>
+<dt>Ensuring keep alive manager singleton is initialized and the thread
+ specific shared storage is set before use</dt>
+<dd>
+ The use of the thread decoration ensures that the decoration are
+ called before the user thread function is called. The keep_alive
+ decoration use the call_once to ensure that the keep_alive manager
+ is correctly initialized.
+ </dd>
+<dt>backup/restore context</dt>
+<dd>
+ The real thread specific data is stored directly on the stack of
+ enablers/disablers avoiding heap memory. On enablers/disablers construction
+ they store a backup pointer to the nesting context. This allows a
+ quick restore. The keep alive pointer contains just a pointer to
+ this data.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.implementation.thread_tuple"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.implementation.thread_tuple" title="Thread Tuple">Thread
+ Tuple</a>
+</h4></div></div></div>
+<div class="variablelist">
+
+<dl>
+<dt>Joining the first finishing thread</dt>
+<dd>
+ In order to synchronize the end of all the threads the libarry use
+ a internal class which stores the index of the first thread notifying
+ that it is finished. As the user function has no idea of this index
+ we need to wrap the user thread functions.
+ </dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.appendices.acknowledgements"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.acknowledgements" title="Appendix D: Acknowledgments">Appendix
+ D: Acknowledgments</a>
+</h3></div></div></div>
+
+ Part of this library (thread_decorator and thread_specific_shared_ptr) are
+ based on the original implementation of threadalert written by Roland Schwarz (thread::init
+ and thread_member_ptr). Many Thanks to Roland that allowed me to adapt his
+ implementation.
+ 
+
+ Thanks also must go to Jochen Heckl for the ideas given respect to the thread_tuple::wait_first
+ implementation.
+ 
+
+ You can help me to make this library better! Any feedback is very welcome.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.appendices.tests"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.tests" title="Appendix E: Tests">Appendix
+ E: Tests</a>
+</h3></div></div></div>
+<div class="toc"><dl><dt>thread_specific_shared_pointer</dt></dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.tests.thread_specific_shared_pointer"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.tests.thread_specific_shared_pointer" title="thread_specific_shared_pointer">thread_specific_shared_pointer</a>
+</h4></div></div></div>
+<div class="informaltable"><table class="table">
+<colgroup></colgroup>
+<tbody></tbody>
+</table></div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.appendices.tickets"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.tickets" title="Appendix F: Tickets">Appendix
+ F: Tickets</a>
+</h3></div></div></div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Kind
+ 
+ </th>
+<th>
+ 
+ Identifier
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Resolution
+ 
+ </th>
+<th>
+ 
+ State
+ 
+ </th>
+<th>
+ 
+ Tests
+ 
+ </th>
+<th>
+ 
+ Version
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ bug
+ 
+ </td>
+<td>
+ 
+ v0.1#1
+ 
+ </td>
+<td>
+ 
+ basic_keep_alive example do not link
+ 
+ </td>
+<td>
+ 
+ Add to the link
+ 
+ </td>
+<td>
+ 
+ Closed
+ 
+ </td>
+<td>
+ 
+ See basic_keep_alive.cpp example
+ 
+ </td>
+<td>
+ 
+ v0.2
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ bug
+ 
+ </td>
+<td>
+ 
+ v0.1.1#1
+ 
+ </td>
+<td>
+ 
+ keep alive mechanism crash when setting set_on_dead_thread before
+ enabling the mechanism
+ 
+ </td>
+<td>
+ 
+ This was due to the fact that there were no default data for the
+ backup.
+ 
+ </td>
+<td>
+ 
+ Closed
+ 
+ </td>
+<td>
+ 
+ See basic_keep_alive.cpp example
+ 
+ </td>
+<td>
+ 
+ v0.4
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ bug
+ 
+ </td>
+<td>
+ 
+ v0.1.1#2
+ 
+ </td>
+<td>
+ 
+ keep alive mechanism do not detect dead threads
+ 
+ </td>
+<td>
+ 
+ We need to reset the counters only when the period is 0.
+ 
+ </td>
+<td>
+ 
+ Closed
+ 
+ </td>
+<td>
+ 
+ See basic_keep_alive.cpp example
+ 
+ </td>
+<td>
+ 
+ v0.4
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ bug
+ 
+ </td>
+<td>
+ 
+ v0.1.1#3
+ 
+ </td>
+<td>
+ 
+ The set_on_dead_thread setting is not recovered by embeeding enablers/disablers
+ 
+ </td>
+<td>
+ 
+ The problem is that the on_dead and th thread pointer were stored
+ on the backup. It is enough to store them on the
+ 
+ </td>
+<td>
+ 
+ Closed
+ 
+ </td>
+<td>
+ 
+ See basic_keep_alive.cpp example
+ 
+ </td>
+<td>
+ 
+ v0.4
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ bug
+ 
+ </td>
+<td>
+ 
+ v0.2.0#1
+ 
+ </td>
+<td>
+ 
+ xxx
+ 
+ </td>
+<td>
+ 
+ xx
+ 
+ </td>
+<td>
+ 
+ Open
+ 
+ </td>
+<td>
+ 
+ xxx
+ 
+ </td>
+<td>
+ 
+ v0.4.1
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.appendices.todo"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.todo" title="Appendix G: Future plans">Appendix G:
+ Future plans</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review">Tasks
+ to do before review</a></dt>
+<dt><a href="appendices.html#toward_boost_interthreads.appendices.todo.for_later_releases">For
+ later releases</a></dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.todo.tasks_to_do_before_review"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review" title="Tasks to do before review">Tasks
+ to do before review</a>
+</h4></div></div></div>
+<a name="toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.complete_the_tests"></a><h6>
+<a name="id3066297"></a>
+ <a class="link" href="appendices.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.complete_the_tests">Complete
+ the tests</a>
+ </h6>
+
+ Even if the current release include some test there is yet a long way before
+ been able to review the library.]]
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ change the test so they take less time using locks; conditions and
+ variables.
+ </li>
+<li class="listitem">
+ Add test with functions throwing
+ </li>
+<li class="listitem">
+ Formalize the tests for thread_decoratoor
+ </li>
+<li class="listitem">
+ Formalize the tests for thread_specific_shared_ptr
+ </li>
+<li class="listitem">
+ Add tests for keep alive mechanism
+ </li>
+</ul></div>
+<a name="toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.add_more_examples"></a><h6>
+<a name="id3066370"></a>
+ <a class="link" href="appendices.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.add_more_examples">Add
+ more examples</a>
+ </h6>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Complete the STM example.
+ </li>
+<li class="listitem">
+ Change the implementation of the file on the async_ostream.
+ </li>
+</ul></div>
+<a name="toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.change_the_rational_and_implementation_sections"></a><h6>
+<a name="id3066414"></a>
+ <a class="link" href="appendices.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.change_the_rational_and_implementation_sections">Change
+ the rational and implementation sections</a>
+ </h6>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.appendices.todo.for_later_releases"></a><a class="link" href="appendices.html#toward_boost_interthreads.appendices.todo.for_later_releases" title="For later releases">For
+ later releases</a>
+</h4></div></div></div>
+<a name="toward_boost_interthreads.appendices.todo.for_later_releases.add_c__0x_move_semantics_on_compilers_supporting_it_and_use_the_boost_move_emulation_otherwise"></a><h6>
+<a name="id3066456"></a>
+ <a class="link" href="appendices.html#toward_boost_interthreads.appendices.todo.for_later_releases.add_c__0x_move_semantics_on_compilers_supporting_it_and_use_the_boost_move_emulation_otherwise">Add
+ C++0x move semantics on compilers supporting it and use the Boost.Move
+ emulation otherwise</a>
+ </h6>
+<a name="toward_boost_interthreads.appendices.todo.for_later_releases.use_c__0x_variadic_templates_on_compilers_supporting_it_and_use_the_preprocesor_otherwise"></a><h6>
+<a name="id3066486"></a>
+ <a class="link" href="appendices.html#toward_boost_interthreads.appendices.todo.for_later_releases.use_c__0x_variadic_templates_on_compilers_supporting_it_and_use_the_preprocesor_otherwise">Use
+ C++0x variadic templates on compilers supporting it and use the preprocesor
+ otherwise</a>
+ </h6>
+<a name="toward_boost_interthreads.appendices.todo.for_later_releases.use_c__0x_concepts_on_compilers_supporting_them_and_use_the_boost_conceptcheck_or_boost_concepttraits_otherwise"></a><h6>
+<a name="id3066516"></a>
+ <a class="link" href="appendices.html#toward_boost_interthreads.appendices.todo.for_later_releases.use_c__0x_concepts_on_compilers_supporting_them_and_use_the_boost_conceptcheck_or_boost_concepttraits_otherwise">Use
+ C++0x Concepts on compilers supporting them and use the Boost.ConceptCheck
+ or Boost.ConceptTraits otherwise</a>
+ </h6>
+<a name="toward_boost_interthreads.appendices.todo.for_later_releases.add_a_daemon_controlling_all_the_keep_alive_controller_threads"></a><h6>
+<a name="id3066547"></a>
+ <a class="link" href="appendices.html#toward_boost_interthreads.appendices.todo.for_later_releases.add_a_daemon_controlling_all_the_keep_alive_controller_threads">Add
+ a daemon controlling all the keep alive controller threads</a>
+ </h6>
+
+ This daemon will send regular keep_alive messages and kill the process
+ when dead.
+ 
+<a name="toward_boost_interthreads.appendices.todo.for_later_releases.optimize_the_tsss_maps_using_intrusive_containers"></a><h6>
+<a name="id3066584"></a>
+ <a class="link" href="appendices.html#toward_boost_interthreads.appendices.todo.for_later_releases.optimize_the_tsss_maps_using_intrusive_containers">Optimize
+ the TSSS maps using intrusive containers</a>
+ </h6>
+<a name="toward_boost_interthreads.appendices.todo.for_later_releases.generalize_both_specific_pointers_in_a_template_class_basic_thread_specific_ptr"></a><h6>
+<a name="id3066606"></a>
+ <a class="link" href="appendices.html#toward_boost_interthreads.appendices.todo.for_later_releases.generalize_both_specific_pointers_in_a_template_class_basic_thread_specific_ptr">Generalize
+ both specific pointers in a template class basic_thread_specific_ptr</a>
+ </h6>
+
+ Domain Features
+ 
+<div class="variablelist">
+
+<dl>
+<dt>ownership: exclusive/shared</dt>
+<dd>
+ Specifies if the pointer is exclusive to the thread or shared with
+ other threads.
+ </dd>
+<dt>key range: fixed/variable/mixed </dt>
+<dd>
+ Specifies how the key range is defined. fixed has an integer range
+ 0..n, variable takes as key the address of the specific_ptr and mixed
+ use a variant of fixed or variable key.
+ </dd>
+<dt>key creation: eager/lazy</dt>
+<dd>
+ Specifies how the key is created, eager at construction time, lazy
+ when needed.
+ </dd>
+<dt>context setting: eager/lazy</dt>
+<dd>
+ Specifies how the pointer is set, eager at thread initialization
+ time, lazy when needed.
+ </dd>
+</dl>
+</div>
+
+ The current <code class="computeroutput">thread_specific_ptr</code>
+ is exclusive, has a variable key range and so the key is initialized at
+ construction time and explicit context setting by user on the current thread.
+ 
+<pre class="programlisting">typedef basic_thread_specific_ptr<exclusive, variable_key_range<>, eager_context_setting> thread_specific_ptr;
+</pre>
+
+ The current <code class="computeroutput">thread_specific_shared_ptr</code>
+ is shared, has a variable key range and so the key is initialized at construction
+ time and explicit context setting by user on the current thread.
+ 
+<pre class="programlisting">typedef basic_thread_specific_ptr<exclusive, variable_key_range<>, eager_context_setting> thread_specific_ptr;
+</pre>
+
+ Design rationale
+ 
+
+ <code class="computeroutput">boost::thread_specific_ptr</code> uses as key the address
+ of the variable. This has as consequence that the mapping from keys to
+ the thread specific context pointer is much less efficient that the direct
+ access provided by some implementations. In this concern this library would
+ try to improve the performance to this mapping providing direct access
+ keys. As the number of direct access keys must be know at compile time
+ this has a limit on the number of thread specific pointers. A mixed approach
+ would be also provided in which the key could be a fixed one or a variable
+ one. It is up to the user to give an hint of the key sort. When using fixed
+ or mixed keys, there is decision to take related to when the key is created,
+ i.e. eager before the threads starts or lazy when we need it.
+ 
+
+ Non-portable: The interfaces of POSIX Pthreads, Solaris threads, and Win32
+ threads are very similar. However, the semantics of Win32 threads are subtly
+ different since they do not provide a reliable means of cleaning up objects
+ allocated in thread-specific storage when a thread exits. Moreover, there
+ is no API to delete a key in Solaris threads. This makes it hard to write
+ portable code among UNIX and Win32 platforms.
+ 
+
+ So we need to implement it on top of the underlying OS. The idea is to
+ take a native thread specific pointer which will manage with the fixed,
+ variable and mixed keys. This exactly the approach of <code class="computeroutput">boost::thread_specific_ptr</code>
+ but only for variable keys.
+ 
+
+ Just to finish, we need to decide when the context is set, two possibilities:
+ the user sets explicitlly the context when it considers pertinent or the
+ context is created lazily the first time we try to get it. The first approach
+ has the liability that the user needs to ensure that the context is set
+ before get them, but when the context must be set before the function thread
+ starts this is a no issue. The second is safe but has as consequence that
+ every access include a check. In addition the type must be default constructible.
+ 
+<pre class="programlisting">bith::thread_specific_shared_ptr<myclass, lazy_setting> ptr;
+</pre>
+
+ The pointer will be initilaized when needed as if we had do
+ 
+<pre class="programlisting">if (ptr.get()==0) {
+ ptr.reset( new myclass() );
+}
+</pre>
+
+ Between the features:
+ 
+
+ Thread_specific key mapping optimization: Replace the Boost.Thread thread_specific_ptr
+ thread specific key mapping implementation by a mix of fixed/variable mapping
+ which will provide efficient access to the fixed keys and scalability with
+ the others keys.
+ 
+
+ Configuration the fixed/variable/mixed key range, ordered/unordered map,
+ intrusive/extrusive map, shared/exclusive locking.
+ 
+</div>
+</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 © 2008 -2009 Vicente J. Botet Escriba
+<td align="right"><div class="copyright-footer">Copyright © 2008 -2009,2011 Vicente J. Botet Escriba
 Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 
@@ -93,7 +1944,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="examples/thread_safe_deferred_traces.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="appendices/changes.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="reference.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a>
</div>
</body>
</html>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/acknowledgements.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/acknowledgements.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/acknowledgements.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,17 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>
- Appendix D: Acknowledgments</title>
+<title>Appendix D: Acknowledgments</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
<link rel="up" href="../appendices.html" title="Appendices">
-<link rel="prev" href="implementation.html" title="
- Appendix C: Implementation Notes">
-<link rel="next" href="tests.html" title=" Appendix
- E: Tests">
+<link rel="prev" href="implementation.html" title="Appendix C: Implementation Notes">
+<link rel="next" href="tests.html" title="Appendix E: Tests">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -26,11 +22,10 @@
<div class="spirit-nav">
<a accesskey="p" href="implementation.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tests.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.appendices.acknowledgements"></a><a href="acknowledgements.html" title="
- Appendix D: Acknowledgments">
- Appendix D: Acknowledgments</a>
+<a name="toward_boost_interthreads.appendices.acknowledgements"></a><a class="link" href="acknowledgements.html" title="Appendix D: Acknowledgments">Appendix
+ D: Acknowledgments</a>
</h3></div></div></div>

Part of this library (thread_decorator and thread_specific_shared_ptr) are

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/changes.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/changes.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/changes.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,16 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title> Appendix
- A: History</title>
+<title>Appendix A: History</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
<link rel="up" href="../appendices.html" title="Appendices">
<link rel="prev" href="../appendices.html" title="Appendices">
-<link rel="next" href="rationale.html" title=" Appendix
- B: Rationale">
+<link rel="next" href="rationale.html" title="Appendix B: Rationale">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -25,10 +22,9 @@
<div class="spirit-nav">
<a accesskey="p" href="../appendices.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="rationale.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.appendices.changes"></a><a href="changes.html" title=" Appendix
- A: History"> Appendix
+<a name="toward_boost_interthreads.appendices.changes"></a><a class="link" href="changes.html" title="Appendix A: History">Appendix
 A: History</a>
</h3></div></div></div>
<div class="toc"><dl>
@@ -41,22 +37,21 @@
 of Interthreads</a></dt>
<dt>Bugs</dt>
</dl></div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.changes.__version_0_1_3__mars_29__2009__extraction_of_the_asynchonous_executor_framework"></a><a href="changes.html#toward_boost_interthreads.appendices.changes.__version_0_1_3__mars_29__2009__extraction_of_the_asynchonous_executor_framework" title="Version 0.1.3, Mars 29, 2009 Extraction of the Asynchonous
- Executor framework">Version 0.1.3, Mars 29, 2009 Extraction of the Asynchonous
+<a name="toward_boost_interthreads.appendices.changes.__version_0_1_3__mars_29__2009__extraction_of_the_asynchonous_executor_framework"></a><a class="link" href="changes.html#toward_boost_interthreads.appendices.changes.__version_0_1_3__mars_29__2009__extraction_of_the_asynchonous_executor_framework" title="Version 0.1.3, Mars 29, 2009 Extraction of the Asynchonous Executor framework">Version 0.1.3, Mars 29, 2009 Extraction of the Asynchonous
 Executor framework</a>
</h4></div></div></div>

 New Features:
 
-<div class="itemizedlist"><ul type="disc"><li>
- Extraction of the Asynchonous Executor framework
- </li></ul></div>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ Extraction of the Asynchonous Executor framework
+ </li></ul></div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.changes.__version_0_1_2__february_8__2009__bug_fixes"></a>Version 0.1.2, February 8, 2009 Bug fixes
+<a name="toward_boost_interthreads.appendices.changes.__version_0_1_2__february_8__2009__bug_fixes"></a><a class="link" href="changes.html#toward_boost_interthreads.appendices.changes.__version_0_1_2__february_8__2009__bug_fixes" title="Version 0.1.2, February 8, 2009 Bug fixes">Version 0.1.2, February 8, 2009 Bug fixes</a>
</h4></div></div></div>

 Fixed Bugs:
@@ -80,25 +75,24 @@
 and make the functions thread_safe.
 
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.changes.__version_0_1_1__january_14__2009__bug_fixes_and_test_on_more_toolsets"></a><a href="changes.html#toward_boost_interthreads.appendices.changes.__version_0_1_1__january_14__2009__bug_fixes_and_test_on_more_toolsets" title="Version 0.1.1, January 14, 2009 Bug fixes and test
- on more toolsets">Version 0.1.1, January 14, 2009 Bug fixes and test
+<a name="toward_boost_interthreads.appendices.changes.__version_0_1_1__january_14__2009__bug_fixes_and_test_on_more_toolsets"></a><a class="link" href="changes.html#toward_boost_interthreads.appendices.changes.__version_0_1_1__january_14__2009__bug_fixes_and_test_on_more_toolsets" title="Version 0.1.1, January 14, 2009 Bug fixes and test on more toolsets">Version 0.1.1, January 14, 2009 Bug fixes and test
 on more toolsets</a>
</h4></div></div></div>

 Toolsets:
 
-<div class="itemizedlist"><ul type="disc">
-<li>
- Tested on Linux gcc 3.4.6.
- </li>
-<li>
- Tested on Linux gcc 4.1.2.
- </li>
-<li>
- Modification helping Windows (not tested)
- </li>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Tested on Linux gcc 3.4.6.
+ </li>
+<li class="listitem">
+ Tested on Linux gcc 4.1.2.
+ </li>
+<li class="listitem">
+ Modification helping Windows (not tested)
+ </li>
</ul></div>

 Fixed Bugs:
@@ -107,43 +101,42 @@
 v0.1#1: basic_keep_alive example do not link.
 
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.changes.__version_0_1_0__november_30__2008____announcement_of_interthreads_"></a><a href="changes.html#toward_boost_interthreads.appendices.changes.__version_0_1_0__november_30__2008____announcement_of_interthreads_" title="Version 0.1.0, November 30, 2008 Announcement
- of Interthreads">Version 0.1.0, November 30, 2008 Announcement
+<a name="toward_boost_interthreads.appendices.changes.__version_0_1_0__november_30__2008____announcement_of_interthreads_"></a><a class="link" href="changes.html#toward_boost_interthreads.appendices.changes.__version_0_1_0__november_30__2008____announcement_of_interthreads_" title="Version 0.1.0, November 30, 2008 Announcement of Interthreads">Version 0.1.0, November 30, 2008 Announcement
 of Interthreads</a>
</h4></div></div></div>

 Features:
 
-<div class="itemizedlist"><ul type="disc">
-<li>
-<code class="computeroutput">thread_decorator</code> setup/cleanup
- thread decorator,
- </li>
-<li>
- thread specific shared pointer,
- </li>
-<li>
- thread keep alive mechanism,
- </li>
-<li>
- thread tuples, set_once synchonizer, thread_tuple_once and thread_group_once.
- </li>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <code class="computeroutput">thread_decorator</code> setup/cleanup
+ thread decorator,
+ </li>
+<li class="listitem">
+ thread specific shared pointer,
+ </li>
+<li class="listitem">
+ thread keep alive mechanism,
+ </li>
+<li class="listitem">
+ thread tuples, set_once synchonizer, thread_tuple_once and thread_group_once.
+ </li>
</ul></div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.changes.__bugs_"></a>Bugs
+<a name="toward_boost_interthreads.appendices.changes.__bugs_"></a><a class="link" href="changes.html#toward_boost_interthreads.appendices.changes.__bugs_" title="Bugs">Bugs</a>
</h4></div></div></div>
-<a name="toward_boost_interthreads.appendices.changes.__bugs_._emphasis_role__bold__open_bugs___emphasis_"></a><h5>
-<a name="id5034280"></a>
- Open Bugs:
- </h5>
-<a name="toward_boost_interthreads.appendices.changes.__bugs_._emphasis_role__bold__fixed_bugs___emphasis_"></a><h5>
-<a name="id5034308"></a>
- Fixed Bugs:
- </h5>
+<a name="toward_boost_interthreads.appendices.changes.__bugs_._emphasis_role__bold__open_bugs___emphasis_"></a><h6>
+<a name="id3232394"></a>
+ <a class="link" href="changes.html#toward_boost_interthreads.appendices.changes.__bugs_._emphasis_role__bold__open_bugs___emphasis_">Open Bugs:</a>
+ </h6>
+<a name="toward_boost_interthreads.appendices.changes.__bugs_._emphasis_role__bold__fixed_bugs___emphasis_"></a><h6>
+<a name="id3232422"></a>
+ <a class="link" href="changes.html#toward_boost_interthreads.appendices.changes.__bugs_._emphasis_role__bold__fixed_bugs___emphasis_">Fixed Bugs:</a>
+ </h6>

 v0.1.1#1: keep alive mechanism crash when setting
 set_on_dead_thread before enabling the mechanism. This was due

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/implementation.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/implementation.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/implementation.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,17 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>
- Appendix C: Implementation Notes</title>
+<title>Appendix C: Implementation Notes</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
<link rel="up" href="../appendices.html" title="Appendices">
-<link rel="prev" href="rationale.html" title=" Appendix
- B: Rationale">
-<link rel="next" href="acknowledgements.html" title="
- Appendix D: Acknowledgments">
+<link rel="prev" href="rationale.html" title="Appendix B: Rationale">
+<link rel="next" href="acknowledgements.html" title="Appendix D: Acknowledgments">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -26,11 +22,10 @@
<div class="spirit-nav">
<a accesskey="p" href="rationale.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="acknowledgements.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.appendices.implementation"></a><a href="implementation.html" title="
- Appendix C: Implementation Notes">
- Appendix C: Implementation Notes</a>
+<a name="toward_boost_interthreads.appendices.implementation"></a><a class="link" href="implementation.html" title="Appendix C: Implementation Notes">Appendix
+ C: Implementation Notes</a>
</h3></div></div></div>
<div class="toc"><dl>
<dt><a href="implementation.html#toward_boost_interthreads.appendices.implementation.thread_decorator">Thread
@@ -42,10 +37,9 @@
<dt><a href="implementation.html#toward_boost_interthreads.appendices.implementation.thread_tuple">Thread
 Tuple</a></dt>
</dl></div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.implementation.thread_decorator"></a><a href="implementation.html#toward_boost_interthreads.appendices.implementation.thread_decorator" title="Thread
- Decorator">Thread
+<a name="toward_boost_interthreads.appendices.implementation.thread_decorator"></a><a class="link" href="implementation.html#toward_boost_interthreads.appendices.implementation.thread_decorator" title="Thread Decorator">Thread
 Decorator</a>
</h4></div></div></div>
<div class="variablelist">
@@ -53,20 +47,19 @@
<dl>
<dt>Thread safe</dt>
<dd>
- The library is thread safe as far as the thread decorations are declared
- staticaly, because these variables will be initialized sequentially.
- </dd>
+ The library is thread safe as far as the thread decorations are declared
+ staticaly, because these variables will be initialized sequentially.
+ </dd>
<dt>Chained thread decorations</dt>
<dd>
- All the thread decorations are chained between them.
- </dd>
+ All the thread decorations are chained between them.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.implementation.thread_specific_storage"></a><a href="implementation.html#toward_boost_interthreads.appendices.implementation.thread_specific_storage" title="Thread
- Specific Storage">Thread
+<a name="toward_boost_interthreads.appendices.implementation.thread_specific_storage"></a><a class="link" href="implementation.html#toward_boost_interthreads.appendices.implementation.thread_specific_storage" title="Thread Specific Storage">Thread
 Specific Storage</a>
</h4></div></div></div>

@@ -77,94 +70,92 @@
<dl>
<dt>External versus internal thread storage</dt>
<dd>
- The thread specific data collections can be stored either externally
- to all threads or internally to each thread. The thread_specific_shared_ptr
- use both ensuring efficiency when the context is requested by the current
- thread and allowing threads to access thread specific pointer of other
- threads
- </dd>
-<dt>Fixed- vs. variable-sized thread specific
- key mapping</dt>
-<dd>
- This library is based on the the Boost.Thread thread_specific_ptr implementation
- which use a variable-size map indexed by the address of the object.
- Future releases will provide fixed and mixed keys.
- </dd>
-<dt>Fixed- vs. variable-sized mapping of
- thread IDs to thread specific pointers</dt>
-<dd>
- It may be impractical to have a fixed-size array with an entry for
- every possible thread ID value. Instead, it is more space efficient
- to have threads use a dynamic data structure to map thread IDs to thread
- specific pointers.
- </dd>
-<dt>One mapping of thread IDs to thread
- specific pointers or to thread specific key mapping</dt>
-<dd>
- This library maps thread IDs to thread specific pointers to avoid contention
- on a single map.
- </dd>
-<dt>Default versus explicit specific context
- setting</dt>
-<dd>
- This library provides explicit setting. In future release will provide
- explicit/eager and implicit/lazy specific context setting. Note that
- implicit setting will need a factory or a default constructible type.
- </dd>
+ The thread specific data collections can be stored either externally
+ to all threads or internally to each thread. The thread_specific_shared_ptr
+ use both ensuring efficiency when the context is requested by the
+ current thread and allowing threads to access thread specific pointer
+ of other threads
+ </dd>
+<dt>Fixed- vs. variable-sized thread specific key mapping</dt>
+<dd>
+ This library is based on the the Boost.Thread thread_specific_ptr
+ implementation which use a variable-size map indexed by the address
+ of the object. Future releases will provide fixed and mixed keys.
+ </dd>
+<dt>Fixed- vs. variable-sized mapping of thread IDs to thread specific
+ pointers</dt>
+<dd>
+ It may be impractical to have a fixed-size array with an entry for
+ every possible thread ID value. Instead, it is more space efficient
+ to have threads use a dynamic data structure to map thread IDs to
+ thread specific pointers.
+ </dd>
+<dt>One mapping of thread IDs to thread specific pointers or to thread
+ specific key mapping</dt>
+<dd>
+ This library maps thread IDs to thread specific pointers to avoid
+ contention on a single map.
+ </dd>
+<dt>Default versus explicit specific context setting</dt>
+<dd>
+ This library provides explicit setting. In future release will provide
+ explicit/eager and implicit/lazy specific context setting. Note that
+ implicit setting will need a factory or a default constructible type.
+ </dd>
<dt>Ordered or unordered map</dt>
<dd>
- While the thread::id type is ordered, there is no need to use it. The
- current implementation use an ordered map. Future version will allow
- the user to configure this.
- </dd>
+ While the thread::id type is ordered, there is no need to use it.
+ The current implementation use an ordered map. Future version will
+ allow the user to configure this.
+ </dd>
<dt>Intrusive or not maps</dt>
<dd>
- As the thread specific pointer is stored on only one map the implementation
- could use an intrusive container. This will be provided in future releases
- </dd>
+ As the thread specific pointer is stored on only one map the implementation
+ could use an intrusive container. This will be provided in future
+ releases
+ </dd>
<dt>Shared versus exclusive locking</dt>
<dd>
- Locating the right TS pointer requires the use of mutex to prevent
- race conditions. The library use a a shared_mutex because most of the
- access to the map will be readings by other threads. The problem is
- that the native conditions can not be used directly with shared mutex.
- Some benchmarks will be needed before decidinf which implementation
- is the best.
- </dd>
+ Locating the right TS pointer requires the use of mutex to prevent
+ race conditions. The library use a a shared_mutex because most of
+ the access to the map will be readings by other threads. The problem
+ is that the native conditions can not be used directly with shared
+ mutex. Some benchmarks will be needed before decidinf which implementation
+ is the best.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.implementation.keep_alive"></a><a href="implementation.html#toward_boost_interthreads.appendices.implementation.keep_alive" title="Keep
- Alive">Keep
+<a name="toward_boost_interthreads.appendices.implementation.keep_alive"></a><a class="link" href="implementation.html#toward_boost_interthreads.appendices.implementation.keep_alive" title="Keep Alive">Keep
 Alive</a>
</h4></div></div></div>
<div class="variablelist">

<dl>
-<dt>Ensuring keep alive manager singleton
- is initialized and the thread specific shared storage is set before use</dt>
+<dt>Ensuring keep alive manager singleton is initialized and the thread
+ specific shared storage is set before use</dt>
<dd>
- The use of the thread decoration ensures that the decoration are called
- before the user thread function is called. The keep_alive decoration
- use the call_once to ensure that the keep_alive manager is correctly
- initialized.
- </dd>
+ The use of the thread decoration ensures that the decoration are
+ called before the user thread function is called. The keep_alive
+ decoration use the call_once to ensure that the keep_alive manager
+ is correctly initialized.
+ </dd>
<dt>backup/restore context</dt>
<dd>
- The real thread specific data is stored directly on the stack of enablers/disablers
- avoiding heap memory. On enablers/disablers construction they store
- a backup pointer to the nesting context. This allows a quick restore.
- The keep alive pointer contains just a pointer to this data.
- </dd>
+ The real thread specific data is stored directly on the stack of
+ enablers/disablers avoiding heap memory. On enablers/disablers construction
+ they store a backup pointer to the nesting context. This allows a
+ quick restore. The keep alive pointer contains just a pointer to
+ this data.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.implementation.thread_tuple"></a><a href="implementation.html#toward_boost_interthreads.appendices.implementation.thread_tuple" title="Thread
- Tuple">Thread
+<a name="toward_boost_interthreads.appendices.implementation.thread_tuple"></a><a class="link" href="implementation.html#toward_boost_interthreads.appendices.implementation.thread_tuple" title="Thread Tuple">Thread
 Tuple</a>
</h4></div></div></div>
<div class="variablelist">
@@ -172,11 +163,11 @@
<dl>
<dt>Joining the first finishing thread</dt>
<dd>
- In order to synchronize the end of all the threads the libarry use
- a internal class which stores the index of the first thread notifying
- that it is finished. As the user function has no idea of this index
- we need to wrap the user thread functions.
- </dd>
+ In order to synchronize the end of all the threads the libarry use
+ a internal class which stores the index of the first thread notifying
+ that it is finished. As the user function has no idea of this index
+ we need to wrap the user thread functions.
+ </dd>
</dl>
</div>
</div>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/rationale.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/rationale.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/rationale.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,17 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title> Appendix
- B: Rationale</title>
+<title>Appendix B: Rationale</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
<link rel="up" href="../appendices.html" title="Appendices">
-<link rel="prev" href="changes.html" title=" Appendix
- A: History">
-<link rel="next" href="implementation.html" title="
- Appendix C: Implementation Notes">
+<link rel="prev" href="changes.html" title="Appendix A: History">
+<link rel="next" href="implementation.html" title="Appendix C: Implementation Notes">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -26,10 +22,9 @@
<div class="spirit-nav">
<a accesskey="p" href="changes.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.appendices.rationale"></a><a href="rationale.html" title=" Appendix
- B: Rationale"> Appendix
+<a name="toward_boost_interthreads.appendices.rationale"></a><a class="link" href="rationale.html" title="Appendix B: Rationale">Appendix
 B: Rationale</a>
</h3></div></div></div>
<div class="toc"><dl>
@@ -42,10 +37,9 @@
<dt><a href="rationale.html#toward_boost_interthreads.appendices.rationale.thread_tuple">Thread
 Tuple</a></dt>
</dl></div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.rationale.thread_decorator"></a><a href="rationale.html#toward_boost_interthreads.appendices.rationale.thread_decorator" title="Thread
- Decorator">Thread
+<a name="toward_boost_interthreads.appendices.rationale.thread_decorator"></a><a class="link" href="rationale.html#toward_boost_interthreads.appendices.rationale.thread_decorator" title="Thread Decorator">Thread
 Decorator</a>
</h4></div></div></div>
<div class="variablelist">
@@ -53,23 +47,22 @@
<dl>
<dt>Function wrapper versus thread refinement</dt>
<dd>
- The threadalert on which this library was initialy based redefined
- the boost:thread class which called implicitly the wrapper. As the
- single varying features between both threads was this wrapping of the
- thread function it has been isolated in the interthreads library.
- </dd>
+ The threadalert on which this library was initialy based redefined
+ the boost:thread class which called implicitly the wrapper. As the
+ single varying features between both threads was this wrapping of
+ the thread function it has been isolated in the interthreads library.
+ </dd>
<dt>Static decoration variables</dt>
<dd>
- Thread decorations construction is not thread safe and must be done
- before other threads have been created and the <code class="computeroutput">decorate()</code> function is called.
- </dd>
+ Thread decorations construction is not thread safe and must be done
+ before other threads have been created and the <code class="computeroutput">decorate()</code> function is called.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.rationale.thread_specific_storage"></a><a href="rationale.html#toward_boost_interthreads.appendices.rationale.thread_specific_storage" title="Thread
- Specific Storage">Thread
+<a name="toward_boost_interthreads.appendices.rationale.thread_specific_storage"></a><a class="link" href="rationale.html#toward_boost_interthreads.appendices.rationale.thread_specific_storage" title="Thread Specific Storage">Thread
 Specific Storage</a>
</h4></div></div></div>
<div class="variablelist">
@@ -77,25 +70,24 @@
<dl>
<dt>Non copiable/Non movable</dt>
<dd>
- Specific pointers are singletons.
- </dd>
+ Specific pointers are singletons.
+ </dd>
<dt>External locking</dt>
<dd>
- In order to ensure thread safety while providing as much functionality
- as possible the class allows to get the map of thread specific contexts
- as soon as the application provides a <code class="computeroutput">unique_lock</code>.
- </dd>
+ In order to ensure thread safety while providing as much functionality
+ as possible the class allows to get the map of thread specific contexts
+ as soon as the application provides a <code class="computeroutput">unique_lock</code>.
+ </dd>
<dt>Mimic thread_specific_ptr</dt>
<dd>

- From the point of view of the current thread thread_specific_shared_ptr
- behaves as a thread_specific_ptr. From it we takes:
- 
+ From the point of view of the current thread thread_specific_shared_ptr
+ behaves as a thread_specific_ptr. From it we takes:
+ 

-
+

-<pre class="programlisting">
-thread_specific_shared_ptr();
+<pre class="programlisting">thread_specific_shared_ptr();
explicit thread_specific_shared_ptr(void (*cleanup_)(shared_ptr_type));
T* get() const;
T* operator->() const;
@@ -104,21 +96,20 @@
template<class Y> void reset(Y * p);
</pre>

- 
+ 
</dd>
<dt>Mimic shared_ptr</dt>
<dd>

- From the point of view of the other threads thread_specific_shared_ptr
- behaves as a shared_ptr lockup. From the point of view of the current
- thread the stored pointer is located in a shared_pointer, so we can
- use the shared_ptr deleter feature From shared_ptr takes:
- 
+ From the point of view of the other threads thread_specific_shared_ptr
+ behaves as a shared_ptr lockup. From the point of view of the current
+ thread the stored pointer is located in a shared_pointer, so we can
+ use the shared_ptr deleter feature From shared_ptr takes:
+ 

-
+

-<pre class="programlisting">
-T* get() const;
+<pre class="programlisting">T* get() const;
T* operator->() const;
T& operator*() const;
void reset();
@@ -127,24 +118,23 @@
template<class Y, class D, class A> void reset(Y * p, D d, A a);
</pre>

- 
+ 
</dd>
-<dt>Why doesn't thread_specific_shared_ptr
- provide a release() function?</dt>
+<dt>Why doesn't thread_specific_shared_ptr provide a release() function?</dt>
<dd>
- As it store a shared_ptr, it cannot give away ownership unless it's
- unique() because the other copy will still destroy the object.
- </dd>
+ As it store a shared_ptr, it cannot give away ownership unless it's
+ unique() because the other copy will still destroy the object.
+ </dd>
</dl>
</div>
-<a name="toward_boost_interthreads.appendices.rationale.thread_specific_storage.comparaing_tsss_and_tss"></a><h5>
-<a name="id5035216"></a>
- <a href="rationale.html#toward_boost_interthreads.appendices.rationale.thread_specific_storage.comparaing_tsss_and_tss">Comparaing
+<a name="toward_boost_interthreads.appendices.rationale.thread_specific_storage.comparaing_tsss_and_tss"></a><h6>
+<a name="id3233334"></a>
+ <a class="link" href="rationale.html#toward_boost_interthreads.appendices.rationale.thread_specific_storage.comparaing_tsss_and_tss">Comparaing
 TSSS and TSS</a>
- </h5>
+ </h6>
<div class="table">
-<a name="id5035232"></a>Table 1. Comparaing TSSS and TSS
-<table class="table" summary="Comparaing TSSS and TSS">
+<a name="toward_boost_interthreads.appendices.rationale.thread_specific_storage.comparaing_tsss_and_tss"></a>Table 1. Comparaing TSSS and TSS
+<div class="table-contents"><table class="table" summary="Comparaing TSSS and TSS">
<colgroup>
<col>
<col>
@@ -153,424 +143,423 @@
</colgroup>
<thead><tr>
<th>
- 
- Feature
- 
- </th>
+ 
+ Feature
+ 
+ </th>
<th>
- 
- thread_specific_shared_ptr
- 
- </th>
+ 
+ thread_specific_shared_ptr
+ 
+ </th>
<th>
- 
- thread_specific_ptr
- 
- </th>
+ 
+ thread_specific_ptr
+ 
+ </th>
<th>
- 
- Compatible
- 
- </th>
+ 
+ Compatible
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
<td>
- 
- ownership
- 
- </td>
+ 
+ ownership
+ 
+ </td>
<td>
- 
- shared
- 
- </td>
+ 
+ shared
+ 
+ </td>
<td>
- 
- exclusive
- 
- </td>
+ 
+ exclusive
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
<tr>
<td>
- 
- default constructor
- 
- </td>
+ 
+ default constructor
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
</tr>
<tr>
<td>
- 
- cleanup constructor
- 
- </td>
+ 
+ cleanup constructor
+ 
+ </td>
<td>
- 
- yes: can not delete the pointer
- 
- </td>
+ 
+ yes: can not delete the pointer
+ 
+ </td>
<td>
- 
- yes:must delete the pointer
- 
- </td>
+ 
+ yes:must delete the pointer
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">get()</code>
- 
- </td>
+ 
+ <code class="computeroutput">get()</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">operator->()</code>
- 
- </td>
+ 
+ <code class="computeroutput">operator->()</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">operator*()</code>
- 
- </td>
+ 
+ <code class="computeroutput">operator*()</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">reset()</code>
- 
- </td>
+ 
+ <code class="computeroutput">reset()</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">reset(T*)</code>
- 
- </td>
+ 
+ <code class="computeroutput">reset(T*)</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">reset(Y*)</code>
- 
- </td>
+ 
+ <code class="computeroutput">reset(Y*)</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">reset(Y*,D)</code>
- 
- </td>
+ 
+ <code class="computeroutput">reset(Y*,D)</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">reset(Y*,D,A)</code>
- 
- </td>
+ 
+ <code class="computeroutput">reset(Y*,D,A)</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">release()</code>
- 
- </td>
+ 
+ <code class="computeroutput">release()</code>
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">get_mutex()</code>
- 
- </td>
+ 
+ <code class="computeroutput">get_mutex()</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">get_map()</code>
- 
- </td>
+ 
+ <code class="computeroutput">get_map()</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">operator[]()</code>
- 
- </td>
+ 
+ <code class="computeroutput">operator[]()</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">wait_and_get()</code>
- 
- </td>
+ 
+ <code class="computeroutput">wait_and_get()</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
</tbody>
-</table>
+</table></div>
</div>
+ 
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.rationale.keep_alive"></a><a href="rationale.html#toward_boost_interthreads.appendices.rationale.keep_alive" title="Keep
- Alive">Keep
+<a name="toward_boost_interthreads.appendices.rationale.keep_alive"></a><a class="link" href="rationale.html#toward_boost_interthreads.appendices.rationale.keep_alive" title="Keep Alive">Keep
 Alive</a>
</h4></div></div></div>
<div class="variablelist">

<dl>
-<dt>Can a thread that has just do a check
- point be considered as dead less than one second after?</dt>
+<dt>Can a thread that has just do a check point be considered as dead
+ less than one second after?</dt>
<dd>
- Whell this depends on the enabling parameters. If the checking parameter
- is greater than one it could be possible that the thread do a check_point
- just before the keep alive manager do the check, seen that there are
- not enough check_points and declaring the thread dead. If you want
- to avoid this situation let the checkin to 1.
- </dd>
+ Whell this depends on the enabling parameters. If the checking parameter
+ is greater than one it could be possible that the thread do a check_point
+ just before the keep alive manager do the check, seen that there
+ are not enough check_points and declaring the thread dead. If you
+ want to avoid this situation let the checkin to 1.
+ </dd>
<dt>Nesting enablers and disablers</dt>
<dd>
- Enablers/disablers use RAII, so they can be nested and the context
- be restored on the destructor.
- </dd>
+ Enablers/disablers use RAII, so they can be nested and the context
+ be restored on the destructor.
+ </dd>
<dt>Configurable on dead action</dt>
<dd>
- The default action is to abort the process because I don't see any
- generic and cleaner way to manage this event. The library provides
- this hook for user wanting to try something specific.
- </dd>
+ The default action is to abort the process because I don't see any
+ generic and cleaner way to manage this event. The library provides
+ this hook for user wanting to try something specific.
+ </dd>
<dt>Who control the controler?</dt>
<dd>
- There is no way to control this thread other than adding an external
- process.
- </dd>
+ There is no way to control this thread other than adding an external
+ process.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.rationale.thread_tuple"></a><a href="rationale.html#toward_boost_interthreads.appendices.rationale.thread_tuple" title="Thread
- Tuple">Thread
+<a name="toward_boost_interthreads.appendices.rationale.thread_tuple"></a><a class="link" href="rationale.html#toward_boost_interthreads.appendices.rationale.thread_tuple" title="Thread Tuple">Thread
 Tuple</a>
</h4></div></div></div>
<div class="variablelist">
@@ -578,43 +567,39 @@
<dl>
<dt>Why must be not copiable?</dt>
<dd>
- Thread tuples can not be copiable since boost::thread is not copiable.
- </dd>
+ Thread tuples can not be copiable since boost::thread is not copiable.
+ </dd>
<dt>Why should be movable?</dt>
<dd>
- If we want functions to return Thread tuples it is necessary to make
- them movable.
- </dd>
+ If we want functions to return Thread tuples it is necessary to make
+ them movable.
+ </dd>
<dt>Mimic boost::thread_group</dt>
<dd>

- thread_tuple has in common some function found in thread_group. From
- it we take
- 
+ thread_tuple has in common some function found in thread_group. From
+ it we take
+ 

-
+

-<pre class="programlisting">
-void join_all();
+<pre class="programlisting">void join_all();
void interrupt_all();
std::size_t size();
</pre>

- 
-
- 
+ 
</dd>
<dt>Mimic boost::thread</dt>
<dd>

- We can consider a thread tuple as a compound thread, and so we can
- mimic the thread intyerface. From it we takes
- 
+ We can consider a thread tuple as a compound thread, and so we can
+ mimic the thread intyerface. From it we takes
+ 

-
+

-<pre class="programlisting">
-void join();
+<pre class="programlisting">void join();
void interrupt();
void detach/detach_all();
bool interruption_requested() const;
@@ -622,48 +607,39 @@
bool joinable/all_joinable() const;
</pre>

- 
-
- 
+ 
</dd>
-<dt>Why the user can not modify directly
- the embeeded threads?</dt>
+<dt>Why the user can not modify directly the embeeded threads?</dt>
<dd>

- 
-
- The library provides a safe function to get a constant thread reference
- 
+ The library provides a safe function to get a constant thread reference
+ 

-
+

-<pre class="programlisting">
-const thread& operator[](std::size_t i) const;</pre>
+<pre class="programlisting">const thread& operator[](std::size_t i) const;</pre>

- 
-
- The problem if we provide the non constant variant is that the user
- can detach them.
- 
+ 

- 
+ The problem if we provide the non constant variant is that the user
+ can detach them.
+ 
</dd>
-<dt>Joining the first finishing thread
- of a thread tuple</dt>
+<dt>Joining the first finishing thread of a thread tuple</dt>
<dd>
- This functionallity has a price. We need to synchronize all the threads
- transparently, so we need to wrap the user thread functions.
- </dd>
+ This functionallity has a price. We need to synchronize all the threads
+ transparently, so we need to wrap the user thread functions.
+ </dd>
</dl>
</div>
-<a name="toward_boost_interthreads.appendices.rationale.thread_tuple.comparaing_thread__thread_group_and_thread_tuple"></a><h5>
-<a name="id5036636"></a>
- <a href="rationale.html#toward_boost_interthreads.appendices.rationale.thread_tuple.comparaing_thread__thread_group_and_thread_tuple">Comparaing
+<a name="toward_boost_interthreads.appendices.rationale.thread_tuple.comparaing_thread__thread_group_and_thread_tuple"></a><h6>
+<a name="id3234827"></a>
+ <a class="link" href="rationale.html#toward_boost_interthreads.appendices.rationale.thread_tuple.comparaing_thread__thread_group_and_thread_tuple">Comparaing
 thread, thread_group and thread_tuple</a>
- </h5>
+ </h6>
<div class="table">
-<a name="id5036652"></a>Table 2. Comparaing thread, thread_group and thread_tuple
-<table class="table" summary="Comparaing thread, thread_group and thread_tuple">
+<a name="toward_boost_interthreads.appendices.rationale.thread_tuple.comparaing_thread__thread_group_and_thread_tuple"></a>Table 2. Comparaing thread, thread_group and thread_tuple
+<div class="table-contents"><table class="table" summary="Comparaing thread, thread_group and thread_tuple">
<colgroup>
<col>
<col>
@@ -673,455 +649,455 @@
</colgroup>
<thead><tr>
<th>
- 
- Feature
- 
- </th>
+ 
+ Feature
+ 
+ </th>
<th>
- 
- thread
- 
- </th>
+ 
+ thread
+ 
+ </th>
<th>
- 
- thread_group
- 
- </th>
+ 
+ thread_group
+ 
+ </th>
<th>
- 
- thread_tuple
- 
- </th>
+ 
+ thread_tuple
+ 
+ </th>
<th>
- 
- Compatible
- 
- </th>
+ 
+ Compatible
+ 
+ </th>
</tr></thead>
<tbody>
<tr>
<td>
- 
- default constructor
- 
- </td>
+ 
+ default constructor
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
</tr>
<tr>
<td>
- 
- copiable
- 
- </td>
+ 
+ copiable
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
</tr>
<tr>
<td>
- 
- movable
- 
- </td>
+ 
+ movable
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">joinable()</code>
- 
- </td>
+ 
+ <code class="computeroutput">joinable()</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no*
- 
- </td>
+ 
+ no*
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">join()</code>
- 
- </td>
+ 
+ <code class="computeroutput">join()</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no*
- 
- </td>
+ 
+ no*
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">timed_join()</code>
- 
- </td>
+ 
+ <code class="computeroutput">timed_join()</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no*
- 
- </td>
+ 
+ no*
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">interruption_requested()</code>
- 
- </td>
+ 
+ <code class="computeroutput">interruption_requested()</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no*
- 
- </td>
+ 
+ no*
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">join_all()</code>
- 
- </td>
+ 
+ <code class="computeroutput">join_all()</code>
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">timed_join_all()</code>
- 
- </td>
+ 
+ <code class="computeroutput">timed_join_all()</code>
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">interrupt_all()</code>
- 
- </td>
+ 
+ <code class="computeroutput">interrupt_all()</code>
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">size()</code>
- 
- </td>
+ 
+ <code class="computeroutput">size()</code>
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no* *
- 
- </td>
+ 
+ no* *
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">join_first_then_interrupt()</code>
- 
- </td>
+ 
+ <code class="computeroutput">join_first_then_interrupt()</code>
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no* * *
- 
- </td>
+ 
+ no* * *
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">timed_join_first_then_interrupt()</code>
- 
- </td>
+ 
+ <code class="computeroutput">timed_join_first_then_interrupt()</code>
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no* * *
- 
- </td>
+ 
+ no* * *
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">operator[]()</code>
- 
- </td>
+ 
+ <code class="computeroutput">operator[]()</code>
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
</tr>
<tr>
<td>
- 
- <code class="computeroutput">swap()</code>
- 
- </td>
+ 
+ <code class="computeroutput">swap()</code>
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no
- 
- </td>
+ 
+ no
+ 
+ </td>
<td>
- 
- yes
- 
- </td>
+ 
+ yes
+ 
+ </td>
<td>
- 
- no*
- 
- </td>
+ 
+ no*
+ 
+ </td>
</tr>
</tbody>
-</table>
+</table></div>
</div>
-<div class="variablelist">
+ <div class="variablelist">

<dl>
<dt>*</dt>
<dd>
- thread_group could add these synonym functions
- </dd>
+ thread_group could add these synonym functions
+ </dd>
<dt>* *</dt>
<dd>
- thread could add the size function returning 1
- </dd>
+ thread could add the size function returning 1
+ </dd>
<dt>* * *</dt>
<dd>
- thread & thread_group could add these functions
- </dd>
+ thread & thread_group could add these functions
+ </dd>
</dl>
</div>
</div>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/tests.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/tests.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/tests.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,17 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title> Appendix
- E: Tests</title>
+<title>Appendix E: Tests</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
<link rel="up" href="../appendices.html" title="Appendices">
-<link rel="prev" href="acknowledgements.html" title="
- Appendix D: Acknowledgments">
-<link rel="next" href="tickets.html" title=" Appendix
- F: Tickets">
+<link rel="prev" href="acknowledgements.html" title="Appendix D: Acknowledgments">
+<link rel="next" href="tickets.html" title="Appendix F: Tickets">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -26,16 +22,15 @@
<div class="spirit-nav">
<a accesskey="p" href="acknowledgements.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tickets.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.appendices.tests"></a><a href="tests.html" title=" Appendix
- E: Tests"> Appendix
+<a name="toward_boost_interthreads.appendices.tests"></a><a class="link" href="tests.html" title="Appendix E: Tests">Appendix
E: Tests</a>
</h3></div></div></div>
<div class="toc"><dl><dt>thread_specific_shared_pointer</dt></dl></div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.tests.thread_specific_shared_pointer"></a>thread_specific_shared_pointer
+<a name="toward_boost_interthreads.appendices.tests.thread_specific_shared_pointer"></a><a class="link" href="tests.html#toward_boost_interthreads.appendices.tests.thread_specific_shared_pointer" title="thread_specific_shared_pointer">thread_specific_shared_pointer</a>
</h4></div></div></div>
<div class="informaltable"><table class="table">
<colgroup></colgroup>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/tickets.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/tickets.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/tickets.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,17 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title> Appendix
- F: Tickets</title>
+<title>Appendix F: Tickets</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
<link rel="up" href="../appendices.html" title="Appendices">
-<link rel="prev" href="tests.html" title=" Appendix
- E: Tests">
-<link rel="next" href="todo.html" title=" Appendix
- G: Future plans">
+<link rel="prev" href="tests.html" title="Appendix E: Tests">
+<link rel="next" href="todo.html" title="Appendix G: Future plans">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -26,10 +22,9 @@
<div class="spirit-nav">
<a accesskey="p" href="tests.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="todo.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.appendices.tickets"></a><a href="tickets.html" title=" Appendix
- F: Tickets"> Appendix
+<a name="toward_boost_interthreads.appendices.tickets"></a><a class="link" href="tickets.html" title="Appendix F: Tickets">Appendix
 F: Tickets</a>
</h3></div></div></div>
<div class="informaltable"><table class="table">
@@ -44,228 +39,228 @@
</colgroup>
<thead><tr>
<th>
- 
- Kind
- 
+ 
+ Kind
+ 
 </th>
<th>
- 
- Identifier
- 
+ 
+ Identifier
+ 
 </th>
<th>
- 
- Description
- 
+ 
+ Description
+ 
 </th>
<th>
- 
- Resolution
- 
+ 
+ Resolution
+ 
 </th>
<th>
- 
- State
- 
+ 
+ State
+ 
 </th>
<th>
- 
- Tests
- 
+ 
+ Tests
+ 
 </th>
<th>
- 
- Version
- 
+ 
+ Version
+ 
 </th>
</tr></thead>
<tbody>
<tr>
<td>
- 
- bug
- 
+ 
+ bug
+ 
 </td>
<td>
- 
- v0.1#1
- 
+ 
+ v0.1#1
+ 
 </td>
<td>
- 
- basic_keep_alive example do not link
- 
+ 
+ basic_keep_alive example do not link
+ 
 </td>
<td>
- 
- Add to the link
- 
+ 
+ Add to the link
+ 
 </td>
<td>
- 
- Closed
- 
+ 
+ Closed
+ 
 </td>
<td>
- 
- See basic_keep_alive.cpp example
- 
+ 
+ See basic_keep_alive.cpp example
+ 
 </td>
<td>
- 
- v0.2
- 
+ 
+ v0.2
+ 
 </td>
</tr>
<tr>
<td>
- 
- bug
- 
+ 
+ bug
+ 
 </td>
<td>
- 
- v0.1.1#1
- 
+ 
+ v0.1.1#1
+ 
 </td>
<td>
- 
- keep alive mechanism crash when setting set_on_dead_thread before
- enabling the mechanism
- 
+ 
+ keep alive mechanism crash when setting set_on_dead_thread before
+ enabling the mechanism
+ 
 </td>
<td>
- 
- This was due to the fact that there were no default data for the
- backup.
- 
+ 
+ This was due to the fact that there were no default data for the
+ backup.
+ 
 </td>
<td>
- 
- Closed
- 
+ 
+ Closed
+ 
 </td>
<td>
- 
- See basic_keep_alive.cpp example
- 
+ 
+ See basic_keep_alive.cpp example
+ 
 </td>
<td>
- 
- v0.4
- 
+ 
+ v0.4
+ 
 </td>
</tr>
<tr>
<td>
- 
- bug
- 
+ 
+ bug
+ 
 </td>
<td>
- 
- v0.1.1#2
- 
+ 
+ v0.1.1#2
+ 
 </td>
<td>
- 
- keep alive mechanism do not detect dead threads
- 
+ 
+ keep alive mechanism do not detect dead threads
+ 
 </td>
<td>
- 
- We need to reset the counters only when the period is 0.
- 
+ 
+ We need to reset the counters only when the period is 0.
+ 
 </td>
<td>
- 
- Closed
- 
+ 
+ Closed
+ 
 </td>
<td>
- 
- See basic_keep_alive.cpp example
- 
+ 
+ See basic_keep_alive.cpp example
+ 
 </td>
<td>
- 
- v0.4
- 
+ 
+ v0.4
+ 
 </td>
</tr>
<tr>
<td>
- 
- bug
- 
+ 
+ bug
+ 
 </td>
<td>
- 
- v0.1.1#3
- 
+ 
+ v0.1.1#3
+ 
 </td>
<td>
- 
- The set_on_dead_thread setting is not recovered by embeeding enablers/disablers
- 
+ 
+ The set_on_dead_thread setting is not recovered by embeeding enablers/disablers
+ 
 </td>
<td>
- 
- The problem is that the on_dead and th thread pointer were stored
- on the backup. It is enough to store them on the
- 
+ 
+ The problem is that the on_dead and th thread pointer were stored
+ on the backup. It is enough to store them on the
+ 
 </td>
<td>
- 
- Closed
- 
+ 
+ Closed
+ 
 </td>
<td>
- 
- See basic_keep_alive.cpp example
- 
+ 
+ See basic_keep_alive.cpp example
+ 
 </td>
<td>
- 
- v0.4
- 
+ 
+ v0.4
+ 
 </td>
</tr>
<tr>
<td>
- 
- bug
- 
+ 
+ bug
+ 
 </td>
<td>
- 
- v0.2.0#1
- 
+ 
+ v0.2.0#1
+ 
 </td>
<td>
- 
- xxx
- 
+ 
+ xxx
+ 
 </td>
<td>
- 
- xx
- 
+ 
+ xx
+ 
 </td>
<td>
- 
- Open
- 
+ 
+ Open
+ 
 </td>
<td>
- 
- xxx
- 
+ 
+ xxx
+ 
 </td>
<td>
- 
- v0.4.1
- 
+ 
+ v0.4.1
+ 
 </td>
</tr>
</tbody>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/todo.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/todo.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/todo.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,15 +1,12 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title> Appendix
- G: Future plans</title>
+<title>Appendix G: Future plans</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
<link rel="up" href="../appendices.html" title="Appendices">
-<link rel="prev" href="tickets.html" title=" Appendix
- F: Tickets">
+<link rel="prev" href="tickets.html" title="Appendix F: Tickets">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -24,11 +21,10 @@
<div class="spirit-nav">
<a accesskey="p" href="tickets.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.appendices.todo"></a><a href="todo.html" title=" Appendix
- G: Future plans"> Appendix
- G: Future plans</a>
+<a name="toward_boost_interthreads.appendices.todo"></a><a class="link" href="todo.html" title="Appendix G: Future plans">Appendix G:
+ Future plans</a>
</h3></div></div></div>
<div class="toc"><dl>
<dt><a href="todo.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review">Tasks
@@ -36,100 +32,99 @@
<dt><a href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases">For
 later releases</a></dt>
</dl></div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.todo.tasks_to_do_before_review"></a><a href="todo.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review" title="Tasks
- to do before review">Tasks
+<a name="toward_boost_interthreads.appendices.todo.tasks_to_do_before_review"></a><a class="link" href="todo.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review" title="Tasks to do before review">Tasks
 to do before review</a>
</h4></div></div></div>
-<a name="toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.complete_the_tests"></a><h5>
-<a name="id5038397"></a>
- <a href="todo.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.complete_the_tests">Complete
+<a name="toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.complete_the_tests"></a><h6>
+<a name="id3236864"></a>
+ <a class="link" href="todo.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.complete_the_tests">Complete
 the tests</a>
- </h5>
+ </h6>

 Even if the current release include some test there is yet a long way before
 been able to review the library.]]
 
-<div class="itemizedlist"><ul type="disc">
-<li>
- change the test so they take less time using locks; conditions and variables.
- </li>
-<li>
- Add test with functions throwing
- </li>
-<li>
- Formalize the tests for thread_decoratoor
- </li>
-<li>
- Formalize the tests for thread_specific_shared_ptr
- </li>
-<li>
- Add tests for keep alive mechanism
- </li>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ change the test so they take less time using locks; conditions and
+ variables.
+ </li>
+<li class="listitem">
+ Add test with functions throwing
+ </li>
+<li class="listitem">
+ Formalize the tests for thread_decoratoor
+ </li>
+<li class="listitem">
+ Formalize the tests for thread_specific_shared_ptr
+ </li>
+<li class="listitem">
+ Add tests for keep alive mechanism
+ </li>
</ul></div>
-<a name="toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.add_more_examples"></a><h5>
-<a name="id5038453"></a>
- <a href="todo.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.add_more_examples">Add
+<a name="toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.add_more_examples"></a><h6>
+<a name="id3236937"></a>
+ <a class="link" href="todo.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.add_more_examples">Add
 more examples</a>
- </h5>
-<div class="itemizedlist"><ul type="disc">
-<li>
- Complete the STM example.
- </li>
-<li>
- Change the implementation of the file on the async_ostream.
- </li>
+ </h6>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Complete the STM example.
+ </li>
+<li class="listitem">
+ Change the implementation of the file on the async_ostream.
+ </li>
</ul></div>
-<a name="toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.change_the_rational_and_implementation_sections"></a><h5>
-<a name="id5038490"></a>
- <a href="todo.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.change_the_rational_and_implementation_sections">Change
+<a name="toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.change_the_rational_and_implementation_sections"></a><h6>
+<a name="id3236980"></a>
+ <a class="link" href="todo.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.change_the_rational_and_implementation_sections">Change
 the rational and implementation sections</a>
- </h5>
+ </h6>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.appendices.todo.for_later_releases"></a><a href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases" title="For
- later releases">For
+<a name="toward_boost_interthreads.appendices.todo.for_later_releases"></a><a class="link" href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases" title="For later releases">For
 later releases</a>
</h4></div></div></div>
-<a name="toward_boost_interthreads.appendices.todo.for_later_releases.add_c__0x_move_semantics_on_compilers_supporting_it_and_use_the_boost_move_emulation_otherwise"></a><h5>
-<a name="id5038532"></a>
- <a href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases.add_c__0x_move_semantics_on_compilers_supporting_it_and_use_the_boost_move_emulation_otherwise">Add
+<a name="toward_boost_interthreads.appendices.todo.for_later_releases.add_c__0x_move_semantics_on_compilers_supporting_it_and_use_the_boost_move_emulation_otherwise"></a><h6>
+<a name="id3237022"></a>
+ <a class="link" href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases.add_c__0x_move_semantics_on_compilers_supporting_it_and_use_the_boost_move_emulation_otherwise">Add
 C++0x move semantics on compilers supporting it and use the Boost.Move
 emulation otherwise</a>
- </h5>
-<a name="toward_boost_interthreads.appendices.todo.for_later_releases.use_c__0x_variadic_templates_on_compilers_supporting_it_and_use_the_preprocesor_otherwise"></a><h5>
-<a name="id5038563"></a>
- <a href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases.use_c__0x_variadic_templates_on_compilers_supporting_it_and_use_the_preprocesor_otherwise">Use
+ </h6>
+<a name="toward_boost_interthreads.appendices.todo.for_later_releases.use_c__0x_variadic_templates_on_compilers_supporting_it_and_use_the_preprocesor_otherwise"></a><h6>
+<a name="id3237052"></a>
+ <a class="link" href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases.use_c__0x_variadic_templates_on_compilers_supporting_it_and_use_the_preprocesor_otherwise">Use
 C++0x variadic templates on compilers supporting it and use the preprocesor
 otherwise</a>
- </h5>
-<a name="toward_boost_interthreads.appendices.todo.for_later_releases.use_c__0x_concepts_on_compilers_supporting_them_and_use_the_boost_conceptcheck_or_boost_concepttraits_otherwise"></a><h5>
-<a name="id5038593"></a>
- <a href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases.use_c__0x_concepts_on_compilers_supporting_them_and_use_the_boost_conceptcheck_or_boost_concepttraits_otherwise">Use
+ </h6>
+<a name="toward_boost_interthreads.appendices.todo.for_later_releases.use_c__0x_concepts_on_compilers_supporting_them_and_use_the_boost_conceptcheck_or_boost_concepttraits_otherwise"></a><h6>
+<a name="id3237082"></a>
+ <a class="link" href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases.use_c__0x_concepts_on_compilers_supporting_them_and_use_the_boost_conceptcheck_or_boost_concepttraits_otherwise">Use
 C++0x Concepts on compilers supporting them and use the Boost.ConceptCheck
 or Boost.ConceptTraits otherwise</a>
- </h5>
-<a name="toward_boost_interthreads.appendices.todo.for_later_releases.add_a_daemon_controlling_all_the_keep_alive_controller_threads"></a><h5>
-<a name="id5038624"></a>
- <a href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases.add_a_daemon_controlling_all_the_keep_alive_controller_threads">Add
+ </h6>
+<a name="toward_boost_interthreads.appendices.todo.for_later_releases.add_a_daemon_controlling_all_the_keep_alive_controller_threads"></a><h6>
+<a name="id3237113"></a>
+ <a class="link" href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases.add_a_daemon_controlling_all_the_keep_alive_controller_threads">Add
 a daemon controlling all the keep alive controller threads</a>
- </h5>
+ </h6>

 This daemon will send regular keep_alive messages and kill the process
 when dead.
 
-<a name="toward_boost_interthreads.appendices.todo.for_later_releases.optimize_the_tsss_maps_using_intrusive_containers"></a><h5>
-<a name="id5038660"></a>
- <a href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases.optimize_the_tsss_maps_using_intrusive_containers">Optimize
+<a name="toward_boost_interthreads.appendices.todo.for_later_releases.optimize_the_tsss_maps_using_intrusive_containers"></a><h6>
+<a name="id3237150"></a>
+ <a class="link" href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases.optimize_the_tsss_maps_using_intrusive_containers">Optimize
 the TSSS maps using intrusive containers</a>
- </h5>
-<a name="toward_boost_interthreads.appendices.todo.for_later_releases.generalize_both_specific_pointers_in_a_template_class_basic_thread_specific_ptr"></a><h5>
-<a name="id5038683"></a>
- <a href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases.generalize_both_specific_pointers_in_a_template_class_basic_thread_specific_ptr">Generalize
+ </h6>
+<a name="toward_boost_interthreads.appendices.todo.for_later_releases.generalize_both_specific_pointers_in_a_template_class_basic_thread_specific_ptr"></a><h6>
+<a name="id3237172"></a>
+ <a class="link" href="todo.html#toward_boost_interthreads.appendices.todo.for_later_releases.generalize_both_specific_pointers_in_a_template_class_basic_thread_specific_ptr">Generalize
 both specific pointers in a template class basic_thread_specific_ptr</a>
- </h5>
+ </h6>

 Domain Features
 
@@ -138,25 +133,25 @@
<dl>
<dt>ownership: exclusive/shared</dt>
<dd>
- Specifies if the pointer is exclusive to the thread or shared with
- other threads.
- </dd>
+ Specifies if the pointer is exclusive to the thread or shared with
+ other threads.
+ </dd>
<dt>key range: fixed/variable/mixed </dt>
<dd>
- Specifies how the key range is defined. fixed has an integer range
- 0..n, variable takes as key the address of the specific_ptr and mixed
- use a variant of fixed or variable key.
- </dd>
+ Specifies how the key range is defined. fixed has an integer range
+ 0..n, variable takes as key the address of the specific_ptr and mixed
+ use a variant of fixed or variable key.
+ </dd>
<dt>key creation: eager/lazy</dt>
<dd>
- Specifies how the key is created, eager at construction time, lazy
- when needed.
- </dd>
+ Specifies how the key is created, eager at construction time, lazy
+ when needed.
+ </dd>
<dt>context setting: eager/lazy</dt>
<dd>
- Specifies how the pointer is set, eager at thread initialization time,
- lazy when needed.
- </dd>
+ Specifies how the pointer is set, eager at thread initialization
+ time, lazy when needed.
+ </dd>
</dl>
</div>

@@ -164,16 +159,14 @@
 is exclusive, has a variable key range and so the key is initialized at
 construction time and explicit context setting by user on the current thread.
 
-<pre class="programlisting">
-typedef basic_thread_specific_ptr<exclusive, variable_key_range<>, eager_context_setting> thread_specific_ptr;
+<pre class="programlisting">typedef basic_thread_specific_ptr<exclusive, variable_key_range<>, eager_context_setting> thread_specific_ptr;
</pre>

 The current <code class="computeroutput">thread_specific_shared_ptr</code>
 is shared, has a variable key range and so the key is initialized at construction
 time and explicit context setting by user on the current thread.
 
-<pre class="programlisting">
-typedef basic_thread_specific_ptr<exclusive, variable_key_range<>, eager_context_setting> thread_specific_ptr;
+<pre class="programlisting">typedef basic_thread_specific_ptr<exclusive, variable_key_range<>, eager_context_setting> thread_specific_ptr;
</pre>

 Design rationale
@@ -214,14 +207,12 @@
 starts this is a no issue. The second is safe but has as consequence that
 every access include a check. In addition the type must be default constructible.
 
-<pre class="programlisting">
-bith::thread_specific_shared_ptr<myclass, lazy_setting> ptr;
+<pre class="programlisting">bith::thread_specific_shared_ptr<myclass, lazy_setting> ptr;
</pre>

 The pointer will be initilaized when needed as if we had do
 
-<pre class="programlisting">
-if (ptr.get()==0) {
+<pre class="programlisting">if (ptr.get()==0) {
 ptr.reset( new myclass() );
}
</pre>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/examples.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/examples.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/examples.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,16 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Examples</title>
-<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../index.html" title="Toward Boost.InterThreads">
-<link rel="prev" href="reference/thread_group_once_hpp.html" title="
- Header <boost/interthreads/thread_group_once.hpp>">
-<link rel="next" href="examples/thread_safe_deferred_traces.html" title="Thread
- safe deferred traces">
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Toward Boost.InterThreads 0.1.3">
+<link rel="up" href="../index.html" title="Toward Boost.InterThreads 0.1.3">
+<link rel="prev" href="reference.html" title="Reference">
+<link rel="next" href="appendices.html" title="Appendices">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -23,24 +20,321 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="reference/thread_group_once_hpp.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="examples/thread_safe_deferred_traces.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="reference.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="appendices.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="toward_boost_interthreads.examples"></a>Examples
+<a name="toward_boost_interthreads.examples"></a><a class="link" href="examples.html" title="Examples">Examples</a>
</h2></div></div></div>
-<div class="toc"><dl><dt><a href="examples/thread_safe_deferred_traces.html">Thread
+<div class="toc"><dl><dt><a href="examples.html#toward_boost_interthreads.examples.thread_safe_deferred_traces">Thread
 safe deferred traces</a></dt></dl></div>

 This section do includes complete examples using the library.
 
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.examples.thread_safe_deferred_traces"></a><a class="link" href="examples.html#toward_boost_interthreads.examples.thread_safe_deferred_traces" title="Thread safe deferred traces">Thread
+ safe deferred traces</a>
+</h3></div></div></div>
+
+ When executing on a multi thread environment, the output lines on std::cout
+ could interleave. We can synchronize these outputs with a global mutex
+ 
+<pre class="programlisting">{
+ boost::lock_guard<boost::mutex> lock(global_cout_mutex);
+ std::cout << ... << std::endl ;
+}
+</pre>
+
+ This mutex could be the bottleneck of the system. Only one mutex resource
+ for all the user threads.
+ 
+<pre class="programlisting">U U
+ /
+ /
+ U ----- R ----- U
+ |
+ |
+ U
+</pre>
+
+ Another approach could be using a queue of output stream buffers for each
+ thread. Each buffer is timestamped with the creation date and there is a
+ concentrator that takes one by one the elements ordered by their timestamp.
+ Only the current thread can push on this queue because it is specific to
+ the thread. There is a single thread, the concentrator, that pops from these
+ queue. In this context we can ensure thread safety without locking as far
+ as the queue has at least two messages.
+ 
+<pre class="programlisting">U ----- R ------+
+ \
+ U ----- R ------\
+ \
+ U ----- R -------- C
+ / /
+ U ----- R ------/ /
+ /
+ U ----- R ------+
+</pre>
+
+ This can be encapsulated in an async_ostream class
+ 
+<pre class="programlisting">class async_ostream : public iostreams::stream<detail::async_ostream_sink> {
+public:
+ typedef char char_type;
+ typedef iostreams::sink_tag category;
+
+ async_ostream(std::ostream& os);
+ void flush();
+};
+
+extern async_ostream cout_;
+</pre>
+
+ With this interface the user can use cout_ as it used std::cout.
+ 
+<pre class="programlisting">cout_ << "Hello World!" << std::endl ;
+</pre>
+
+ All the magic is in the <code class="computeroutput">template class boost::iostreams::stream<></code>. The parameter must be a model of
+ a sink (See Boost.Iostreams). Here it is.
+ 
+<pre class="programlisting">namespace detail {
+ struct async_ostream_sink {
+ typedef char char_type;
+ typedef boost::iostreams::sink_tag category;
+ async_ostream_sink(std::ostream& os);
+ std::streamsize write(const char* s, std::streamsize n);
+ void flush();
+ private:
+ friend class async_ostream_concentrator;
+ friend class async_ostream;
+ struct impl;
+ boost::shared_ptr<impl> impl_;
+ };
+}
+</pre>
+
+ This class declares the just minimum in order to model a sink. In addition,
+ in order to mask the implementation, the Pimpl idiom is used. The implementation
+ of these functions is straigtforward:
+ 
+<pre class="programlisting">async_ostream::async_ostream(std::ostream& os)
+ : base_type(os) {}
+
+void async_ostream::flush() {
+ this->base_type::flush();
+ async_ostream& d = *this;
+ d->flush();
+}
+
+async_ostream_sink::async_ostream_sink(std::ostream& os)
+ : impl_(new async_ostream_sink::impl(os)) {}
+
+std::streamsize detail::async_ostream_sink::write(const char* s, std::streamsize n) {
+ return impl_->write(s,n);
+}
+
+void async_ostream_sink::flush() {
+ return impl_->flush();
+}
+</pre>
+
+ Let me continue with the handle of the Pimpl pattern:
+ 
+<pre class="programlisting">struct detail::async_ostream_sink::impl {
+ impl(std::ostream& os);
+ std::ostream& os_;
+ tsss_type tsss_;
+ priority_queue_type queue_;
+ boost::thread thread_;
+
+ std::streamsize write(const char* s, std::streamsize n);
+
+ static void terminate(shared_ptr<async_ostream_thread_ctx> that);
+ static void loop(impl* that);
+};
+</pre>
+
+ Of course we need to store a reference to the final ostream.
+ 
+
+ The <code class="computeroutput">thread_specific_shared_ptr
+ tsss_</code> is used to encapsulate the
+ logic specific to each thread.
+ 
+<pre class="programlisting">typedef thread_specific_shared_ptr<async_ostream_thread_ctx> tsss_type;
+</pre>
+
+ A priority queue <code class="computeroutput">queue_</code> will
+ be used by the concentrator thread to order the stringstreams by date.
+ 
+<pre class="programlisting">template <typename T>
+struct detail::timestamped {
+ system_time date_;
+ unsigned seq_;
+ T value_;
+ void reset_date(unsigned seq) {
+ date_ = system_time();
+ seq_ = seq;
+ }
+ struct ptr_comparator_gt {
+ typedef timestamped* value_type;
+ bool operator()(const value_type&lhs, const value_type&rhs) {
+ return (lhs->date_ > rhs->date_) ? true :
+ (lhs->date_ == rhs->date_) && (lhs->seq_ > rhs->seq_)? true:false;
+ }
+ };
+};
+
+typedef timestamped<std::stringstream> element_type;
+typedef std::priority_queue<queue_type*, std::deque<element_type*>, element_type::ptr_comparator_gt> priority_queue_type;
+</pre>
+
+ In addition to the timestamp <code class="computeroutput">date_</code>
+ we need a sequence number to order the stringstreams pushed without enough
+ time granularity, e.g. on the same microsecond.
+ 
+
+ To finish the field declaration there is the concentrator thread implemented
+ by the loop function.
+ 
+<pre class="programlisting">, thread_(boost::bind(loop, this))
+</pre>
+
+ Comming back to the sink implementation,
+ 
+<pre class="programlisting">async_ostream_sink::impl::impl(std::ostream& os)
+: os_(os)
+, tsss_(terminate)
+, thread_(boost::bind(loop, this))
+{}
+</pre>
+
+ The terminate cleanup function is used to ensure that the queue is empty
+ before the thread finishes. To avoid optimizations a non const call inc is
+ done while waiting the queue empties.
+ 
+<pre class="programlisting">void async_ostream_sink::impl::terminate(shared_ptr<async_ostream_thread_ctx> that) {
+ while (!that->empty()) {
+ that->inc();
+ }
+}
+</pre>
+
+ The central sink function is write. Here instead to lock a mutex the function
+ forwards to the thread specific shared pointer. We will see below how <code class="computeroutput">async_ostream_thread_ctx</code> handles this call.
+ 
+<pre class="programlisting">std::streamsize write(const char* s, std::streamsize n) {
+ return tsss_->write(s, n);
+}
+</pre>
+
+ It is time to analyze the thread specific context before seeing how the concentrator
+ is implemented.
+ 
+<pre class="programlisting">struct async_ostream_thread_ctx {
+ async_ostream_thread_ctx();
+ std::streamsize write(const char* s, std::streamsize n);
+ void flush();
+ element_type* get();
+ bool empty() const {return queue_.empty();}
+ void inc() {++inc_;}
+private:
+ unsigned seq_;
+ element_type *current_;
+ queue_type queue_;
+ boost::mutex mutex_;
+ std::stringstream& buffer() {return current_->value_;}
+};
+</pre>
+
+ Each thread has a pointer to the current timestamped stringstream wich is
+ used for the current output flow, i.e. by the write function.
+ 
+<pre class="programlisting">std::streamsize write(const char* s, std::streamsize n) {
+ buffer().write(s, n);
+ return n;
+}
+</pre>
+
+ Once the user does a flush, the current element is pushed on the queue. The
+ <code class="computeroutput">sec_</code> integer is used as monotonic
+ sequence in conjuntion with the timestamp.
+ 
+<pre class="programlisting">void flush() {
+ current_->reset_date(seq_);
+ ++seq_;
+ if (queue_.size()>2) {
+ queue_.push(current_);
+ } else {
+ boost::lock_guard<boost::mutex> lock(mutex_);
+ queue_.push(current_);
+ }
+ current_ = new element_type();
+}
+</pre>
+
+ As stated in the introduction, we don't need to lock the mutex if the number
+ of elements in the queue is enough.
+ 
+
+ These queue elements will be read by the concentrator using the get function.
+ 
+<pre class="programlisting">element_type* get() {
+ if (queue_.size()>1) {
+ return get_i();
+ } else {
+ boost::lock_guard<boost::mutex> lock(mutex_);
+ return get_i();
+ }
+}
+
+element_type* get_i() {
+ if (queue_.empty()) return 0;
+ element_type* e= queue_.front();
+ queue_.pop();
+ return e;
+}
+</pre>
+
+ The concentrator loop looks like:
+ 
+<pre class="programlisting">void async_ostream_sink_impl::loop(async_ostream_sink::impl* that) {
+ std::ostream& os_ = that->os_;
+ for(;;) {
+ // sleeps a little bit
+ this_thread::sleep(boost::posix_time::milliseconds(1));
+ { // scope needed don't remove
+ // lock the map access
+ tsss_type::lock_type lock(that->tsss_.get_mutex());
+ const tsss_type::map_type& tmap(that->tsss_.get_map(lock));
+ for (tsss_type::map_type::const_iterator it = tmap.begin(); it != tmap.end(); ++it) {
+ // takes the first element of each thread queue (if it exists) and push it on the ordered queue.
+ element_type* e= it->second->get();
+ if (e != 0) that->queue_.push(e);
+ }
+ }
+ if (that->queue_.empty()) { //when the queue is empty sleeps a little more
+ this_thread::sleep(boost::posix_time::milliseconds(10));
+ } else {
+ // takes the fist element of the ordered queue, write them on the output stream and delete it.
+ element_type* e = that->queue_.top();
+ that->queue_.pop();
+ os_ << "["<< e->date_ <<"-" << e->seq_ << "] " << e->value_.str();
+ delete e;
+ }
+ }
+}
+</pre>
+</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 © 2008 -2009 Vicente J. Botet Escriba
+<td align="right"><div class="copyright-footer">Copyright © 2008 -2009,2011 Vicente J. Botet Escriba
 Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 
@@ -48,7 +342,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="reference/thread_group_once_hpp.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="examples/thread_safe_deferred_traces.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="reference.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="appendices.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/examples/thread_safe_deferred_traces.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/examples/thread_safe_deferred_traces.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/examples/thread_safe_deferred_traces.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,12 +1,10 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>Thread
- safe deferred traces</title>
+<title>Thread safe deferred traces</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
<link rel="up" href="../examples.html" title="Examples">
<link rel="prev" href="../examples.html" title="Examples">
<link rel="next" href="../appendices.html" title="Appendices">
@@ -24,18 +22,16 @@
<div class="spirit-nav">
<a accesskey="p" href="../examples.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../examples.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../appendices.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.examples.thread_safe_deferred_traces"></a><a href="thread_safe_deferred_traces.html" title="Thread
- safe deferred traces">Thread
+<a name="toward_boost_interthreads.examples.thread_safe_deferred_traces"></a><a class="link" href="thread_safe_deferred_traces.html" title="Thread safe deferred traces">Thread
 safe deferred traces</a>
</h3></div></div></div>

 When executing on a multi thread environment, the output lines on std::cout
 could interleave. We can synchronize these outputs with a global mutex
 
-<pre class="programlisting">
-{
+<pre class="programlisting">{
 boost::lock_guard<boost::mutex> lock(global_cout_mutex);
 std::cout << ... << std::endl ;
}
@@ -74,8 +70,7 @@

 This can be encapsulated in an async_ostream class
 
-<pre class="programlisting">
-class async_ostream : public iostreams::stream<detail::async_ostream_sink> {
+<pre class="programlisting">class async_ostream : public iostreams::stream<detail::async_ostream_sink> {
public:
 typedef char char_type;
 typedef iostreams::sink_tag category;
@@ -89,15 +84,13 @@

 With this interface the user can use cout_ as it used std::cout.
 
-<pre class="programlisting">
-cout_ << "Hello World!" << std::endl ;
+<pre class="programlisting">cout_ << "Hello World!" << std::endl ;
</pre>

 All the magic is in the <code class="computeroutput">template class boost::iostreams::stream<></code>. The parameter must be a model of
 a sink (See Boost.Iostreams). Here it is.
 
-<pre class="programlisting">
-namespace detail {
+<pre class="programlisting">namespace detail {
 struct async_ostream_sink {
 typedef char char_type;
 typedef boost::iostreams::sink_tag category;
@@ -117,8 +110,7 @@
 in order to mask the implementation, the Pimpl idiom is used. The implementation
 of these functions is straigtforward:
 
-<pre class="programlisting">
-async_ostream::async_ostream(std::ostream& os)
+<pre class="programlisting">async_ostream::async_ostream(std::ostream& os)
 : base_type(os) {}

void async_ostream::flush() {
@@ -141,8 +133,7 @@

 Let me continue with the handle of the Pimpl pattern:
 
-<pre class="programlisting">
-struct detail::async_ostream_sink::impl {
+<pre class="programlisting">struct detail::async_ostream_sink::impl {
 impl(std::ostream& os);
 std::ostream& os_;
 tsss_type tsss_;
@@ -163,15 +154,13 @@
 tsss_</code> is used to encapsulate the
 logic specific to each thread.
 
-<pre class="programlisting">
-typedef thread_specific_shared_ptr<async_ostream_thread_ctx> tsss_type;
+<pre class="programlisting">typedef thread_specific_shared_ptr<async_ostream_thread_ctx> tsss_type;
</pre>

 A priority queue <code class="computeroutput">queue_</code> will
 be used by the concentrator thread to order the stringstreams by date.
 
-<pre class="programlisting">
-template <typename T>
+<pre class="programlisting">template <typename T>
struct detail::timestamped {
 system_time date_;
 unsigned seq_;
@@ -201,14 +190,12 @@
 To finish the field declaration there is the concentrator thread implemented
 by the loop function.
 
-<pre class="programlisting">
-, thread_(boost::bind(loop, this))
+<pre class="programlisting">, thread_(boost::bind(loop, this))
</pre>

 Comming back to the sink implementation,
 
-<pre class="programlisting">
-async_ostream_sink::impl::impl(std::ostream& os)
+<pre class="programlisting">async_ostream_sink::impl::impl(std::ostream& os)
: os_(os)
, tsss_(terminate)
, thread_(boost::bind(loop, this))
@@ -219,8 +206,7 @@
 before the thread finishes. To avoid optimizations a non const call inc is
 done while waiting the queue empties.
 
-<pre class="programlisting">
-void async_ostream_sink::impl::terminate(shared_ptr<async_ostream_thread_ctx> that) {
+<pre class="programlisting">void async_ostream_sink::impl::terminate(shared_ptr<async_ostream_thread_ctx> that) {
 while (!that->empty()) {
 that->inc();
 }
@@ -230,8 +216,7 @@
 The central sink function is write. Here instead to lock a mutex the function
 forwards to the thread specific shared pointer. We will see below how <code class="computeroutput">async_ostream_thread_ctx</code> handles this call.
 
-<pre class="programlisting">
-std::streamsize write(const char* s, std::streamsize n) {
+<pre class="programlisting">std::streamsize write(const char* s, std::streamsize n) {
 return tsss_->write(s, n);
}
</pre>
@@ -239,8 +224,7 @@
 It is time to analyze the thread specific context before seeing how the concentrator
 is implemented.
 
-<pre class="programlisting">
-struct async_ostream_thread_ctx {
+<pre class="programlisting">struct async_ostream_thread_ctx {
 async_ostream_thread_ctx();
 std::streamsize write(const char* s, std::streamsize n);
 void flush();
@@ -259,8 +243,7 @@
 Each thread has a pointer to the current timestamped stringstream wich is
 used for the current output flow, i.e. by the write function.
 
-<pre class="programlisting">
-std::streamsize write(const char* s, std::streamsize n) {
+<pre class="programlisting">std::streamsize write(const char* s, std::streamsize n) {
 buffer().write(s, n);
 return n;
}
@@ -270,8 +253,7 @@
 <code class="computeroutput">sec_</code> integer is used as monotonic
 sequence in conjuntion with the timestamp.
 
-<pre class="programlisting">
-void flush() {
+<pre class="programlisting">void flush() {
 current_->reset_date(seq_);
 ++seq_;
 if (queue_.size()>2) {
@@ -290,8 +272,7 @@

 These queue elements will be read by the concentrator using the get function.
 
-<pre class="programlisting">
-element_type* get() {
+<pre class="programlisting">element_type* get() {
 if (queue_.size()>1) {
 return get_i();
 } else {
@@ -310,8 +291,7 @@

 The concentrator loop looks like:
 
-<pre class="programlisting">
-void async_ostream_sink_impl::loop(async_ostream_sink::impl* that) {
+<pre class="programlisting">void async_ostream_sink_impl::loop(async_ostream_sink::impl* that) {
 std::ostream& os_ = that->os_;
 for(;;) {
 // sleeps a little bit

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/overview.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/overview.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/overview.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,14 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title> Overview</title>
-<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../index.html" title="Toward Boost.InterThreads">
-<link rel="prev" href="../index.html" title="Toward Boost.InterThreads">
-<link rel="next" href="overview/motivation.html" title=" Motivation">
+<title>Overview</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Toward Boost.InterThreads 0.1.3">
+<link rel="up" href="../index.html" title="Toward Boost.InterThreads 0.1.3">
+<link rel="prev" href="../index.html" title="Toward Boost.InterThreads 0.1.3">
+<link rel="next" href="users_guide.html" title="Users'Guide">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -21,129 +20,61 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overview/motivation.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="users_guide.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="toward_boost_interthreads.overview"></a> Overview
+<a name="toward_boost_interthreads.overview"></a><a class="link" href="overview.html" title="Overview">Overview</a>
</h2></div></div></div>
<div class="toc"><dl>
-<dt> Motivation</dt>
+<dt>Motivation</dt>
<dd><dl>
-<dt>Decorators</dt>
-<dt><a href="overview/motivation.html#toward_boost_interthreads.overview.motivation.sharing_thread_local_storage">Sharing
+<dt>Decorators</dt>
+<dt><a href="overview.html#toward_boost_interthreads.overview.motivation.sharing_thread_local_storage">Sharing
 Thread Local Storage</a></dt>
-<dt><a href="overview/motivation.html#toward_boost_interthreads.overview.motivation.keep_alive_motivation">
- Keep Alive</a></dt>
-<dt><a href="overview/motivation.html#toward_boost_interthreads.overview.motivation.thread_tuple">Thread
+<dt><a href="overview.html#toward_boost_interthreads.overview.motivation.keep_alive_motivation">Keep
+ Alive</a></dt>
+<dt><a href="overview.html#toward_boost_interthreads.overview.motivation.thread_tuple">Thread
 Tuple</a></dt>
</dl></dd>
+<dt>Description</dt>
</dl></div>
-<a name="toward_boost_interthreads.overview.description"></a><h3>
-<a name="id4946103"></a>
- Description
- </h3>
-
- Boost.InterThreads extends Boost.Threads adding some features:
- 
-<div class="itemizedlist"><ul type="disc">
-<li>
- A thread_decoration class allowing to define setup/cleanup functions which
- will be called only once by thread (if the thread function is decorated with
- thread_decorator): setup before the thread function and cleanup at thread
- exit. It is used together with asynchronous_executor_decorator
- </li>
-<li>
- A thread_decorator/thread_decorate class/function which decorate a thread
- function in order to call the setup and the cleanup of all the thread_decorations.
- </li>
-<li>
- A thread specific shared pointer which is an extension of the thread_specific_ptr
- providing access to this thread specific context from other threads. As it
- is shared the stored pointer is a shared_ptr instead of a raw one.
- </li>
-<li>
- A thread keep alive mechanism: this mechanism allows to detect threads that
- do not prove that they are alive by calling to the keep_alive_point regularly.
- When a thread is declared dead a user provided function is called, which
- by default will abort the program.
- </li>
-<li>
- A thread static array
- <div class="itemizedlist"><ul type="circle"><li>
- thread tuple: defines a thread groupe where the number of threads is
- know statically and the threads are created at construction time in oposition
- to a thread_group.
- </li></ul></div>
-</li>
-<li>
- A thread static array and a thread group with wait for any feature
- <div class="itemizedlist"><ul type="circle">
-<li>
- set_once: a synchonizer that allows to set a variable only once, notifying
- to the variable value to whatever is waiting for that.
- </li>
-<li>
- thread_tuple_once: an extension of the boost::thread_tuple which allows
- to join the completion of any thread using for that the set_once synchronizer.
- </li>
-<li>
- thread_group_once: an extension of the boost::thread_group which allows
- to join the completion of any thread in the group using for that the
- set_once synchronizer.
- </li>
-</ul></div>
-</li>
-</ul></div>
-<div class="note"><table border="0" summary="Note">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
-<th align="left">Note</th>
-</tr>
-<tr><td align="left" valign="top">
- thread_decorator and thread_specific_shared_ptr are based on the original
- implementation of threadalert written by Roland Schwarz.
- </td></tr>
-</table></div>
-<a name="toward_boost_interthreads.overview.how_to_use_this_documentation"></a><h3>
-<a name="id4948728"></a>
- <a href="overview.html#toward_boost_interthreads.overview.how_to_use_this_documentation">How
+<a name="toward_boost_interthreads.overview.how_to_use_this_documentation"></a><h4>
+<a name="id3012937"></a>
+ <a class="link" href="overview.html#toward_boost_interthreads.overview.how_to_use_this_documentation">How
 to Use This Documentation</a>
- </h3>
+ </h4>

 This documentation makes use of the following naming and formatting conventions.
 
-<div class="itemizedlist"><ul type="disc">
-<li>
- Code is in <code class="computeroutput">fixed width
- font</code> and is syntax-highlighted.
- </li>
-<li>
- Replaceable text that you will need to supply is in
- <code>
- italics
- </code>
- .
- </li>
-<li>
- If a name refers to a free function, it is specified like this: <code class="computeroutput">free_function()</code>;
- that is, it is in code font and its name is followed by <code class="computeroutput">()</code>
- to indicate that it is a free function.
- </li>
-<li>
- If a name refers to a class template, it is specified like this: <code class="computeroutput">class_template<></code>;
- that is, it is in code font and its name is followed by <code class="computeroutput"><></code>
- to indicate that it is a class template.
- </li>
-<li>
- If a name refers to a function-like macro, it is specified like this: <code class="computeroutput">MACRO()</code>;
- that is, it is uppercase in code font and its name is followed by <code class="computeroutput">()</code> to indicate that it is a function-like
- macro. Object-like macros appear without the trailing <code class="computeroutput">()</code>.
- </li>
-<li>
- Names that refer to concepts in the generic programming
- sense are specified in CamelCase.
- </li>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Code is in <code class="computeroutput">fixed width
+ font</code> and is syntax-highlighted.
+ </li>
+<li class="listitem">
+ Replaceable text that you will need to supply is in <code>italics</code>.
+ </li>
+<li class="listitem">
+ If a name refers to a free function, it is specified like this: <code class="computeroutput">free_function()</code>;
+ that is, it is in code font and its name is followed by <code class="computeroutput">()</code>
+ to indicate that it is a free function.
+ </li>
+<li class="listitem">
+ If a name refers to a class template, it is specified like this: <code class="computeroutput">class_template<></code>;
+ that is, it is in code font and its name is followed by <code class="computeroutput"><></code>
+ to indicate that it is a class template.
+ </li>
+<li class="listitem">
+ If a name refers to a function-like macro, it is specified like this:
+ <code class="computeroutput">MACRO()</code>;
+ that is, it is uppercase in code font and its name is followed by <code class="computeroutput">()</code> to indicate that it is a function-like
+ macro. Object-like macros appear without the trailing <code class="computeroutput">()</code>.
+ </li>
+<li class="listitem">
+ Names that refer to concepts in the generic programming
+ sense are specified in CamelCase.
+ </li>
</ul></div>
<div class="note"><table border="0" summary="Note">
<tr>
@@ -158,17 +89,318 @@

 Finally, you can mentally add the following to any code fragments in this document:
 
-<pre class="programlisting">
-// Include all of InterThreads
+<pre class="programlisting">// Include all of InterThreads
#include <boost/interthreads/interthreads.hpp>

// Create a namespace aliases
namespace bith = boost::interthreads;
</pre>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.overview.motivation"></a><a class="link" href="overview.html#toward_boost_interthreads.overview.motivation" title="Motivation">Motivation</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt>Decorators</dt>
+<dt><a href="overview.html#toward_boost_interthreads.overview.motivation.sharing_thread_local_storage">Sharing
+ Thread Local Storage</a></dt>
+<dt><a href="overview.html#toward_boost_interthreads.overview.motivation.keep_alive_motivation">Keep
+ Alive</a></dt>
+<dt><a href="overview.html#toward_boost_interthreads.overview.motivation.thread_tuple">Thread
+ Tuple</a></dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.overview.motivation.decorators"></a><a class="link" href="overview.html#toward_boost_interthreads.overview.motivation.decorators" title="Decorators">Decorators</a>
+</h4></div></div></div>
+
+ <code class="computeroutput">boost::call_once</code> provides a mechanism for ensuring
+ that an initialization routine is run exactly once on a programm without
+ data races or deadlocks. <code class="computeroutput">boost::this_thread::at_thread_exit</code>
+ allows to execute a cleanup function at thread exit.
+ 
+
+ If we want a setup function to be executed once at the begining on the
+ threads and a cleanup at thread exit we need to do
+ 
+<pre class="programlisting">void thread_main() {
+ setup();
+ boost::this_thread::at_thread_exit(cleanup);
+ // do whatever
+ // ...
+}
+// ...
+{
+ launch(thread_main);
+ //...
+}
+</pre>
+
+ Of course we can define an init function that calls setup and do the registration.
+ 
+<pre class="programlisting">void init() {
+ setup();
+ boost::this_thread::at_thread_exit(cleanup);
+}
+</pre>
+
+ Different services could require these setup/cleanup functions to be called,
+ and so each thread function should do
+ 
+<pre class="programlisting">void thread_main() {
+ serv1::init();
+ // ...
+ servN::init();
+ // do whatever using serv1, ..., servN.
+ // ...
+}
+</pre>
+
+ This approach is valid for services that the user can configure for specifics
+ threads, but not for services that must be installed on every thread.
+ 
+
+ <code class="computeroutput">thread_decoration</code> ensures
+ that a setup function is called only once by thread before the thread function
+ provided the thread is created with a decorator wrapper. This setup function
+ is usualy used to set thread specific pointers and call functions once.
+ 
+
+ The conterpart of the setup is the cleanup. The <code class="computeroutput">thread_decoration</code>
+ takes an optional cleanup function which will be executed at thread exit.
+ 
+<pre class="programlisting">// define in only the implementation file of each service
+
+boost::interthreads::decoration serv1:decoration(serv1:setup, serv1:cleanup);
+// ...
+boost::interthreads::decoration servN:decoration(servN:setup, servN:cleanup);
+
+
+void thread_main() {
+ // do whatever using serv1, ..., servN.
+ // ...
+}
+
+// ...
+{
+ boost::thread th(boost::interthreads::make_decorator(thread_main));
+ //...
+}
+</pre>
+
+ We can use a basic_threader_decorator as asynchronous executor to fork
+ thread_main.
+ 
+<pre class="programlisting">// ...
+{
+ boost::thread th=fork(basic_threader_decorator(), thread_main);
+ //...
+}
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.overview.motivation.sharing_thread_local_storage"></a><a class="link" href="overview.html#toward_boost_interthreads.overview.motivation.sharing_thread_local_storage" title="Sharing Thread Local Storage">Sharing
+ Thread Local Storage</a>
+</h4></div></div></div>
+
+ Thread local storage allows multi-threaded applications to have a separate
+ instance of a given data item for each thread. But does not provide any
+ mechanism to access this data from other threads. Although this seems to
+ defeat the whole point of thread-specific storage, it is useful when these
+ contexts need some kind of communication between them, or some central
+ global object needs to control them.
+ 
+
+ The intent of the <code class="computeroutput">boost::thread_specific_shared_ptr</code>
+ class is to allow two threads to establish a shared memory space, without
+ requiring the user code to pass any information. <code class="computeroutput">boost::thread_specific_shared_ptr</code>
+ provides a portable mechanism for shared thread-local storage that works
+ on all compilers supported by <code class="computeroutput">boost::thread</code>
+ and <code class="computeroutput">boost::shared_ptr</code>. Each instance of <code class="computeroutput">boost::thread_specific_shared_ptr</code> represents
+ a pointer to a shared object where each thread must have a distinct value.
+ 
+
+ Only the current thread can modify the thread specific shared pointer using
+ the non const functions reset/release functions. Each time these functions
+ are used, a synchronization must be ensured to update the mapping. The
+ other threads have only read access to the shared_ptr<T>. It is worth
+ saying that the shared object T must be thread safe.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.overview.motivation.keep_alive_motivation"></a><a class="link" href="overview.html#toward_boost_interthreads.overview.motivation.keep_alive_motivation" title="Keep Alive">Keep
+ Alive</a>
+</h4></div></div></div>
+
+ On fault tolerant systems we need to be able to detect threads that could
+ stay on a loop, or simply blocked.
+ 
+
+ One way to detect this situations is to require the thread to signal it
+ is alive by calling a check point function. Of course it should be up to
+ the user to state when this mechanism is enabled or disabled. At the begining
+ of a thread the keep alive mechanism is disabled.
+ 
+
+ A thread will be considered dead if during a given period the number of
+ checkins is inferior to a given threshold. These two parameters can be
+ given when the keep alive mechanislm is enabled.
+ 
+
+ The controler checks at predefined intervals if the thread is dead, and
+ in this case it will call a user specific function which by default aborts
+ the program.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.overview.motivation.thread_tuple"></a><a class="link" href="overview.html#toward_boost_interthreads.overview.motivation.thread_tuple" title="Thread Tuple">Thread
+ Tuple</a>
+</h4></div></div></div>
+
+ The <code class="computeroutput">boots::thread_group</code> class allows to group dynamically
+ threads. This means that the container must be dynamic.
+ 
+<pre class="programlisting">{
+ boost::thread_group tg;
+ tg.create_thread(thread1);
+ tg.create_thread(thread2);
+ tg.join_all(thread1);
+}
+</pre>
+
+ The <code class="computeroutput">thread_tuple<></code>
+ class is responsible for launching and managing a static collection of
+ threads that are related in some way. No new threads can be added to the
+ tuple once constructed. So we can write
+ 
+<pre class="programlisting">{
+ bith::thread_tuple<2> tt(thread1, thread2);
+ tt.join_all(thread1);
+}
+</pre>
+
+ As this
+ 
+<pre class="programlisting">bith::conc_join_all(thread1, thread2);
+</pre>
+
+ In addition the user can join the first finishing thread.
+ 
+<pre class="programlisting">unsigned i = bith::conc_join_any(thread1, thread2);
+</pre>
+
+ Evidently, thread_tuple can not be used when we need dynamic creation or
+ deletion. The <code class="computeroutput">boots::thread_group</code> class allows to group dynamically
+ threads.
+ 
+<pre class="programlisting">{
+ boost::thread_group tg;
+ tg.create_thread(thread1);
+
+ // later on
+ tg.create_thread(thread2);
+ boost::thread th3(thread3)
+ tg.add_thread(th3);
+
+ // later on
+ tg.remove_thread(th3);
+
+ tg.join_all(thread1);
+}
+</pre>
+
+ Objects of type <code class="computeroutput">thread_tuple<></code> are movable, so they can be stored
+ in move-aware containers, and returned from functions. This allows the
+ details of thread tuple creation to be wrapped in a function.
+ 
+<pre class="programlisting">boost::interthreads::thread_tuple<2> make_thread_tuple(...);
+
+void f()
+{
+ bith::thread_tuple<2> some_thread_tuple=bith::make_thread_tuple(f1, g2);
+ some_thread_tuple.join();
+}
+</pre>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.overview.description"></a><a class="link" href="overview.html#toward_boost_interthreads.overview.description" title="Description">Description</a>
+</h3></div></div></div>
+
+ Boost.InterThreads extends Boost.Threads adding some features:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ A thread_decoration class allowing to define setup/cleanup functions
+ which will be called only once by thread (if the thread function is decorated
+ with thread_decorator): setup before the thread function and cleanup
+ at thread exit. It is used together with asynchronous_executor_decorator
+ </li>
+<li class="listitem">
+ A thread_decorator/thread_decorate class/function which decorate a thread
+ function in order to call the setup and the cleanup of all the thread_decorations.
+ </li>
+<li class="listitem">
+ A thread specific shared pointer which is an extension of the thread_specific_ptr
+ providing access to this thread specific context from other threads.
+ As it is shared the stored pointer is a shared_ptr instead of a raw one.
+ </li>
+<li class="listitem">
+ A thread keep alive mechanism: this mechanism allows to detect threads
+ that do not prove that they are alive by calling to the keep_alive_point
+ regularly. When a thread is declared dead a user provided function is
+ called, which by default will abort the program.
+ </li>
+<li class="listitem">
+
+ A thread static array
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
+ thread tuple: defines a thread groupe where the number of threads
+ is know statically and the threads are created at construction time
+ in oposition to a thread_group.
+ </li></ul></div>
+</li>
+<li class="listitem">
+
+ A thread static array and a thread group with wait for any feature
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="circle">
+<li class="listitem">
+ set_once: a synchonizer that allows to set a variable only once,
+ notifying to the variable value to whatever is waiting for that.
+ </li>
+<li class="listitem">
+ thread_tuple_once: an extension of the boost::thread_tuple which
+ allows to join the completion of any thread using for that the set_once
+ synchronizer.
+ </li>
+<li class="listitem">
+ thread_group_once: an extension of the boost::thread_group which
+ allows to join the completion of any thread in the group using for
+ that the set_once synchronizer.
+ </li>
+</ul></div>
+</li>
+</ul></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ thread_decorator and thread_specific_shared_ptr are based on the original
+ implementation of threadalert written by Roland Schwarz.
+ </td></tr>
+</table></div>
+</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 © 2008 -2009 Vicente J. Botet Escriba
+<td align="right"><div class="copyright-footer">Copyright © 2008 -2009,2011 Vicente J. Botet Escriba
 Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 
@@ -176,7 +408,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overview/motivation.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="users_guide.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/overview/motivation.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/overview/motivation.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/overview/motivation.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,14 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title> Motivation</title>
+<title>Motivation</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../overview.html" title=" Overview">
-<link rel="prev" href="../overview.html" title=" Overview">
-<link rel="next" href="../users_guide.html" title=" Users'Guide">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
+<link rel="up" href="../overview.html" title="Overview">
+<link rel="prev" href="../overview.html" title="Overview">
+<link rel="next" href="../users_guide.html" title="Users'Guide">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -23,22 +22,22 @@
<div class="spirit-nav">
<a accesskey="p" href="../overview.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../users_guide.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.overview.motivation"></a> Motivation
+<a name="toward_boost_interthreads.overview.motivation"></a><a class="link" href="motivation.html" title="Motivation">Motivation</a>
</h3></div></div></div>
<div class="toc"><dl>
<dt>Decorators</dt>
<dt><a href="motivation.html#toward_boost_interthreads.overview.motivation.sharing_thread_local_storage">Sharing
 Thread Local Storage</a></dt>
-<dt><a href="motivation.html#toward_boost_interthreads.overview.motivation.keep_alive_motivation">
- Keep Alive</a></dt>
+<dt><a href="motivation.html#toward_boost_interthreads.overview.motivation.keep_alive_motivation">Keep
+ Alive</a></dt>
<dt><a href="motivation.html#toward_boost_interthreads.overview.motivation.thread_tuple">Thread
 Tuple</a></dt>
</dl></div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.overview.motivation.decorators"></a>Decorators
+<a name="toward_boost_interthreads.overview.motivation.decorators"></a><a class="link" href="motivation.html#toward_boost_interthreads.overview.motivation.decorators" title="Decorators">Decorators</a>
</h4></div></div></div>

 <code class="computeroutput">boost::call_once</code> provides a mechanism for ensuring
@@ -50,8 +49,7 @@
 If we want a setup function to be executed once at the begining on the
 threads and a cleanup at thread exit we need to do
 
-<pre class="programlisting">
-void thread_main() {
+<pre class="programlisting">void thread_main() {
 setup();
 boost::this_thread::at_thread_exit(cleanup);
 // do whatever
@@ -66,8 +64,7 @@

 Of course we can define an init function that calls setup and do the registration.
 
-<pre class="programlisting">
-void init() {
+<pre class="programlisting">void init() {
 setup();
 boost::this_thread::at_thread_exit(cleanup);
}
@@ -76,8 +73,7 @@
 Different services could require these setup/cleanup functions to be called,
 and so each thread function should do
 
-<pre class="programlisting">
-void thread_main() {
+<pre class="programlisting">void thread_main() {
 serv1::init();
 // ...
 servN::init();
@@ -99,8 +95,7 @@
 The conterpart of the setup is the cleanup. The <code class="computeroutput">thread_decoration</code>
 takes an optional cleanup function which will be executed at thread exit.
 
-<pre class="programlisting">
-// define in only the implementation file of each service
+<pre class="programlisting">// define in only the implementation file of each service

boost::interthreads::decoration serv1:decoration(serv1:setup, serv1:cleanup);
// ...
@@ -122,18 +117,16 @@
 We can use a basic_threader_decorator as asynchronous executor to fork
 thread_main.
 
-<pre class="programlisting">
-// ...
+<pre class="programlisting">// ...
{
 boost::thread th=fork(basic_threader_decorator(), thread_main);
 //...
}
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.overview.motivation.sharing_thread_local_storage"></a><a href="motivation.html#toward_boost_interthreads.overview.motivation.sharing_thread_local_storage" title="Sharing
- Thread Local Storage">Sharing
+<a name="toward_boost_interthreads.overview.motivation.sharing_thread_local_storage"></a><a class="link" href="motivation.html#toward_boost_interthreads.overview.motivation.sharing_thread_local_storage" title="Sharing Thread Local Storage">Sharing
 Thread Local Storage</a>
</h4></div></div></div>

@@ -161,11 +154,10 @@
 saying that the shared object T must be thread safe.
 
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.overview.motivation.keep_alive_motivation"></a><a href="motivation.html#toward_boost_interthreads.overview.motivation.keep_alive_motivation" title="
- Keep Alive">
- Keep Alive</a>
+<a name="toward_boost_interthreads.overview.motivation.keep_alive_motivation"></a><a class="link" href="motivation.html#toward_boost_interthreads.overview.motivation.keep_alive_motivation" title="Keep Alive">Keep
+ Alive</a>
</h4></div></div></div>

 On fault tolerant systems we need to be able to detect threads that could
@@ -188,18 +180,16 @@
 the program.
 
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.overview.motivation.thread_tuple"></a><a href="motivation.html#toward_boost_interthreads.overview.motivation.thread_tuple" title="Thread
- Tuple">Thread
+<a name="toward_boost_interthreads.overview.motivation.thread_tuple"></a><a class="link" href="motivation.html#toward_boost_interthreads.overview.motivation.thread_tuple" title="Thread Tuple">Thread
 Tuple</a>
</h4></div></div></div>

 The <code class="computeroutput">boots::thread_group</code> class allows to group dynamically
 threads. This means that the container must be dynamic.
 
-<pre class="programlisting">
-{
+<pre class="programlisting">{
 boost::thread_group tg;
 tg.create_thread(thread1);
 tg.create_thread(thread2);
@@ -212,8 +202,7 @@
 threads that are related in some way. No new threads can be added to the
 tuple once constructed. So we can write
 
-<pre class="programlisting">
-{
+<pre class="programlisting">{
 bith::thread_tuple<2> tt(thread1, thread2);
 tt.join_all(thread1);
}
@@ -221,22 +210,19 @@

 As this
 
-<pre class="programlisting">
-bith::conc_join_all(thread1, thread2);
+<pre class="programlisting">bith::conc_join_all(thread1, thread2);
</pre>

 In addition the user can join the first finishing thread.
 
-<pre class="programlisting">
-unsigned i = bith::conc_join_any(thread1, thread2);
+<pre class="programlisting">unsigned i = bith::conc_join_any(thread1, thread2);
</pre>

 Evidently, thread_tuple can not be used when we need dynamic creation or
 deletion. The <code class="computeroutput">boots::thread_group</code> class allows to group dynamically
 threads.
 
-<pre class="programlisting">
-{
+<pre class="programlisting">{
 boost::thread_group tg;
 tg.create_thread(thread1);

@@ -256,8 +242,7 @@
 in move-aware containers, and returned from functions. This allows the
 details of thread tuple creation to be wrapped in a function.
 
-<pre class="programlisting">
-boost::interthreads::thread_tuple<2> make_thread_tuple(...);
+<pre class="programlisting">boost::interthreads::thread_tuple<2> make_thread_tuple(...);

void f()
{

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,14 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title> Reference</title>
-<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../index.html" title="Toward Boost.InterThreads">
-<link rel="prev" href="users_guide/glosary.html" title=" Glossary">
-<link rel="next" href="reference/concepts.html" title="Concepts">
+<title>Reference</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Toward Boost.InterThreads 0.1.3">
+<link rel="up" href="../index.html" title="Toward Boost.InterThreads 0.1.3">
+<link rel="prev" href="users_guide.html" title="Users'Guide">
+<link rel="next" href="appendices.html" title="Appendices">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -21,78 +20,2796 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="users_guide/glosary.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reference/concepts.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="users_guide.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="appendices.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="toward_boost_interthreads.reference"></a> Reference
+<a name="toward_boost_interthreads.reference"></a><a class="link" href="reference.html" title="Reference">Reference</a>
</h2></div></div></div>
<div class="toc"><dl>
-<dt>Concepts</dt>
-<dd><dl><dt>Decorator</dt></dl></dd>
-<dt><a href="reference/thread_decoration_hpp.html">
- Header <code class="computeroutput"><boost/interthreads/thread_decoration.hpp></code></a></dt>
-<dd><dl><dt><a href="reference/thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration">
- Class <code class="computeroutput">thread_decoration</code></a></dt></dl></dd>
-<dt><a href="reference/thread_decorator_hpp.html">
- Header <code class="computeroutput"><boost/interthreads/thread_decorator.hpp></code></a></dt>
-<dd><dl>
-<dt><a href="reference/thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator">
- Class <code class="computeroutput">thread_decorator</code></a></dt>
-<dt><a href="reference/thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.decorate">
- Non Member Function <code class="computeroutput">decorate()</code></a></dt>
-</dl></dd>
-<dt><a href="reference/thread_specific_shared_ptr_hpp.html">
- Header <code class="computeroutput"><boost/interthreads/thread_specific_shared_ptr.hpp></code></a></dt>
-<dd><dl><dt><a href="reference/thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr">
- Template Class <code class="computeroutput">thread_specific_shared_ptr<></code></a></dt></dl></dd>
-<dt><a href="reference/keep_alive_file_hpp.html">
- Header <code class="computeroutput"><boost/interthreads/thread_keep_alive.hpp></code></a></dt>
-<dd><dl>
-<dt><a href="reference/keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive">
- class <code class="computeroutput">enable_keep_alive</code></a></dt>
-<dt><a href="reference/keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive">
- class <code class="computeroutput">disable_keep_alive</code></a></dt>
-<dt><a href="reference/keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_check_point">
- Non Member Function <code class="computeroutput">keep_alive_check_point()</code></a></dt>
-<dt><a href="reference/keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_enabled">
- Non Member Function <code class="computeroutput">keep_alive_enabled()</code></a></dt>
-<dt><a href="reference/keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_set_on_dead_thread">
- Non Member Function <code class="computeroutput">set_on_dead_thread()</code></a></dt>
+<dt>Concepts</dt>
+<dd><dl><dt>Decorator</dt></dl></dd>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decoration_hpp">Header
+ <code class="computeroutput"><boost/interthreads/thread_decoration.hpp></code></a></dt>
+<dd><dl><dt><a href="reference.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration">Class
+ <code class="computeroutput">thread_decoration</code></a></dt></dl></dd>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp">Header
+ <code class="computeroutput"><boost/interthreads/thread_decorator.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator">Class
+ <code class="computeroutput">thread_decorator</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.decorate">Non
+ Member Function <code class="computeroutput">decorate()</code></a></dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp">Header
+ <code class="computeroutput"><boost/interthreads/thread_specific_shared_ptr.hpp></code></a></dt>
+<dd><dl><dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr">Template
+ Class <code class="computeroutput">thread_specific_shared_ptr<></code></a></dt></dl></dd>
+<dt><a href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp">Header
+ <code class="computeroutput"><boost/interthreads/thread_keep_alive.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive">class
+ <code class="computeroutput">enable_keep_alive</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive">class
+ <code class="computeroutput">disable_keep_alive</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_check_point">Non
+ Member Function <code class="computeroutput">keep_alive_check_point()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_enabled">Non
+ Member Function <code class="computeroutput">keep_alive_enabled()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_set_on_dead_thread">Non
+ Member Function <code class="computeroutput">set_on_dead_thread()</code></a></dt>
</dl></dd>
-<dt><a href="reference/set_once_hpp.html"> Header
+<dt><a href="reference.html#toward_boost_interthreads.reference.set_once_hpp">Header
 <code class="computeroutput"><boost/interthreads/set_once.hpp></code></a></dt>
-<dd><dl><dt><a href="reference/set_once_hpp.html#toward_boost_interthreads.reference.set_once_hpp.set_onceclass">
- Template Class <code class="computeroutput">set_once<></code></a></dt></dl></dd>
-<dt><a href="reference/thread_tuple_hpp.html">
- Header <code class="computeroutput"><boost/interthreads/thread_tuple.hpp></code></a></dt>
-<dd><dl>
-<dt><a href="reference/thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class">
- Template Class <code class="computeroutput">thread_tuple<></code></a></dt>
-<dt><a href="reference/thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_make_thread_tuple">
- Non Member Function <code class="computeroutput">make_thread_tuple()</code></a></dt>
-</dl></dd>
-<dt><a href="reference/thread_tuple_once_hpp.html">
- Header <code class="computeroutput"><boost/interthreads/thread_tuple_once.hpp></code></a></dt>
-<dd><dl>
-<dt><a href="reference/thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class">
- Template Class <code class="computeroutput">thread_tuple_once<></code></a></dt>
-<dt><a href="reference/thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_make_thread_tuple_once">
- Non Member Function <code class="computeroutput">make_thread_tuple_once()</code></a></dt>
-</dl></dd>
-<dt><a href="reference/thread_group_once_hpp.html">
- Header <code class="computeroutput"><boost/interthreads/thread_group_once.hpp></code></a></dt>
-<dd><dl>
-<dt><a href="reference/thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class">
- Template Class <code class="computeroutput">thread_group_once<></code></a></dt>
-<dt><a href="reference/thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_make_thread_group_once">
- Non Member Function <code class="computeroutput">make_thread_group_once()</code></a></dt>
+<dd><dl><dt><a href="reference.html#toward_boost_interthreads.reference.set_once_hpp.set_onceclass">Template
+ Class <code class="computeroutput">set_once<></code></a></dt></dl></dd>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp">Header
+ <code class="computeroutput"><boost/interthreads/thread_tuple.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class">Template
+ Class <code class="computeroutput">thread_tuple<></code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_make_thread_tuple">Non
+ Member Function <code class="computeroutput">make_thread_tuple()</code></a></dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp">Header
+ <code class="computeroutput"><boost/interthreads/thread_tuple_once.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class">Template
+ Class <code class="computeroutput">thread_tuple_once<></code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_make_thread_tuple_once">Non
+ Member Function <code class="computeroutput">make_thread_tuple_once()</code></a></dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp">Header
+ <code class="computeroutput"><boost/interthreads/thread_group_once.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class">Template
+ Class <code class="computeroutput">thread_group_once<></code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_make_thread_group_once">Non
+ Member Function <code class="computeroutput">make_thread_group_once()</code></a></dt>
+</dl></dd>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.reference.concepts"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.concepts" title="Concepts">Concepts</a>
+</h3></div></div></div>
+<div class="toc"><dl><dt>Decorator</dt></dl></div>
+<div class="section"><div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.concepts.decorator"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.concepts.decorator" title="Decorator">Decorator</a>
+</h4></div></div></div></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.reference.thread_decoration_hpp"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decoration_hpp" title="Header <boost/interthreads/thread_decoration.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/thread_decoration.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration">Class
+ <code class="computeroutput">thread_decoration</code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.thread_decoration_class_constructor_setup">Constructor
+ with setup</a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.constructor_with_setup___cleanup">Constructor
+ with setup & cleanup</a></dt>
+</dl></dd>
+</dl></div>
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+ class thread_decoration;
+}
+}
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration" title="Class thread_decoration">Class
+ <code class="computeroutput">thread_decoration</code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.thread_decoration_class_constructor_setup">Constructor
+ with setup</a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.constructor_with_setup___cleanup">Constructor
+ with setup & cleanup</a></dt>
+</dl></div>
+
+ <code class="computeroutput">thread_decoration</code> defines
+ a couple of setup/cleanup functions chained to the last constructed decoration,
+ i.e. decorations are chained between them.
+ 
+<pre class="programlisting">class thread_decoration {
+public:
+ template<typename Callable1>
+ thread_decoration(Callable1 setup);
+
+ template<typename Callable1,typename Callable2>
+ thread_decoration(Callable1 setup, Callable2 cleanup);
+
+ ~thread_decoration() {
+};
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.thread_decoration_class_constructor_setup"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.thread_decoration_class_constructor_setup" title="Constructor with setup">Constructor
+ with setup</a>
+</h5></div></div></div>
+<pre class="programlisting">template<typename Callable>
+thread_decoration(Callable func);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Requires:</dt>
+<dd>
+ <code class="computeroutput">Callable</code> is <code class="computeroutput">CopyConstructible</code>. Copying <code class="computeroutput">setup</code> shall have no side effects,
+ and the effect of calling the copy shall be equivalent to calling
+ the original.
+ </dd>
+<dt>Effects:</dt>
+<dd>
+ <code class="computeroutput">setup</code> is copied
+ into storage managed internally by the library, and that copy is
+ invoked by the <code class="computeroutput">decorate()</code> function.
+ </dd>
+<dt>Postconditions:</dt>
+<dd>
+ <code class="computeroutput">*this</code>
+ refers to a decoration.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ unsafe
+ </dd>
+</dl>
+</div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ The library do not ensures any order of decorations.
+ </td></tr>
+</table></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.constructor_with_setup___cleanup"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.constructor_with_setup___cleanup" title="Constructor with setup & cleanup">Constructor
+ with setup & cleanup</a>
+</h5></div></div></div>
+<pre class="programlisting">template<typename Callable1,typename Callable2>
+thread_decoration(Callable1 setup, Callable2 cleanup);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Requires:</dt>
+<dd>
+ <code class="computeroutput">Callable1</code> &
+ <code class="computeroutput">Callable1</code> are
+ <code class="computeroutput">CopyConstructible</code>.
+ Copying <code class="computeroutput">setup</code> or
+ <code class="computeroutput">cleanup</code> shall have
+ no side effects, and the effect of calling the copy shall be equivalent
+ to calling the original.
+ </dd>
+<dt>Effects:</dt>
+<dd>
+ <code class="computeroutput">setup</code> and <code class="computeroutput">cleanup</code> are copied into storage
+ managed internally by the library, and the <code class="computeroutput">setup</code>
+ copy is invoked by the <code class="computeroutput">decorate()</code> function. If successful the cleanup
+ function is registered to the to the thread exit handler.
+ </dd>
+<dt>Postconditions:</dt>
+<dd>
+ <code class="computeroutput">*this</code>
+ refers to a decoration.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ unsafe
+ </dd>
+</dl>
+</div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ The library do not ensures any order of setup decorations neither of
+ cleanup decorations.
+ </td></tr>
+</table></div>
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp" title="Header <boost/interthreads/thread_decorator.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/thread_decorator.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator">Class
+ <code class="computeroutput">thread_decorator</code></a></dt>
+<dd><dl>
+<dt>Constructor</dt>
+<dt>Constructor</dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_move_constructor">Copy
+ Move Constructor</a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_constructor">Assign
+ Move Constructor</a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_conversion">Member
+ Function <code class="computeroutput">operator detail::thread_move_t<thread_decorator>()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_move">Member
+ Function <code class="computeroutput">move()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_swap">Member
+ Function <code class="computeroutput">swap()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_operator_f">Member
+ Function <code class="computeroutput">operator()()</code></a></dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.decorate">Non
+ Member Function <code class="computeroutput">decorate()</code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+ class thread_decorator;
+ void decorate();
+}
+}
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator" title="Class thread_decorator">Class
+ <code class="computeroutput">thread_decorator</code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt>Constructor</dt>
+<dt>Constructor</dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_move_constructor">Copy
+ Move Constructor</a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_constructor">Assign
+ Move Constructor</a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_conversion">Member
+ Function <code class="computeroutput">operator detail::thread_move_t<thread_decorator>()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_move">Member
+ Function <code class="computeroutput">move()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_swap">Member
+ Function <code class="computeroutput">swap()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_operator_f">Member
+ Function <code class="computeroutput">operator()()</code></a></dt>
+</dl></div>
+
+ <code class="computeroutput">thread_decorator</code> is a functor
+ wrapping a function with the setup and the cleanup of chained decorations
+ which will be called only once by thread: decoration's setup are called
+ before the thread function and decoration's cleanup at thread exit.
+ 
+<pre class="programlisting">class thread_decorator {
+public:
+
+ template <class Callable>
+ explicit thread_decorator(Callable&& f);
+ template <class Callable>
+ explicit thread_decorator(detail::thread_move_t<Callable> f):
+ template<typename Callable>
+ thread_decorator(Callable f,
+ typename disable_if<boost::is_convertible<F&,detail::thread_move_t<F> >
+ , detail::dummy* >::type=0);
+
+ template <typename Callable, typename A1, typename A2, ...>
+ thread_decorator(Callable f, A1 a1, A2 a2, ...)
+
+ thread_decorator(thread_decorator&& other);
+
+ thread_decorator& operator=(thread_decorator&& other);
+
+ thread_decorator&& move();
+
+ void swap(thread_decorator& x);
+
+ void operator ()();
+
+};
+</pre>
+
+ Functor wrapping the user function thread to ensure that all the decorations
+ are called.
+ 
+
+ Objects of type <code class="computeroutput">thread_decorator</code>
+ are movable, so they can be stored in move-aware containers, and returned
+ from functions. This allows the details of thread decoration to be wrapped
+ in a function.
+ 
+<pre class="programlisting">thread_decorator make_decorator();
+
+void f()
+{
+ boot::thread some_thread(make_decorator());
+ some_thread.join();
+}
+</pre>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+
+ On compilers that support rvalue references, <code class="computeroutput">thread_decorator</code>
+ will provides a proper move constructor and move-assignment operator,
+ and therefore meets the C++0x <code class="computeroutput">MoveConstructible</code>
+ and <code class="computeroutput">MoveAssignable</code> concepts.
+ With such compilers, <code class="computeroutput">thread_decorator</code>
+ can therefore be used with containers that support those concepts.
+ 
+
+ For other compilers, move support is provided with a move emulation layer,
+ so containers must explicitly detect that move emulation layer. See
+ <code class="computeroutput"><boost/thread/detail/move.hpp></code> for details.
+ 
+</td></tr>
+</table></div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructor" title="Constructor">Constructor</a>
+</h5></div></div></div>
+<pre class="programlisting">template <class Callable>
+thread_decorator(Callable&& func);
+template<typename Callable>
+thread_decorator(Callable func);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Template parameters:</dt>
+<dd>
+ <code class="computeroutput">Callable</code> must by
+ <code class="computeroutput">CopyConstructible</code>.
+ </dd>
+<dt>Effects:</dt>
+<dd>
+ <code class="computeroutput">func</code> is copied
+ into storage managed internally by the library, and that copy will
+ be invoked after the operator() function when the decorate is used
+ as Callable of a newly-created thread of execution.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ safe
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructorn"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructorn" title="Constructor">Constructor</a>
+</h5></div></div></div>
+<pre class="programlisting">template <typename Callable, typename A1, typename A2, ...>
+thread_decorator(Callable func, A1 a1, A2 a2, ...)
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Template parameters:</dt>
+<dd>
+ <code class="computeroutput">Callable</code> must by
+ <code class="computeroutput">CopyConstructible</code>.
+ </dd>
+<dt>Effects:</dt>
+<dd>
+ <code class="computeroutput">func</code> is copied
+ into storage managed internally by the library, and that copy will
+ be invoked after the operator() function when the decorate is used
+ as Callable of a newly-created thread of execution.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ safe
+ </dd>
+<dt>Limitations:</dt>
+<dd>
+ The current implementation defines overloads up to four parameters.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_move_constructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_move_constructor" title="Copy Move Constructor">Copy
+ Move Constructor</a>
+</h5></div></div></div>
+<pre class="programlisting">thread_decorator(thread_decorator&& other);
+thread_decorator(detail::thread_move_t<thread_decorator> other) {
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Template parameters:</dt>
+<dd>
+ <code class="computeroutput">Callable</code> must by
+ <code class="computeroutput">CopyConstructible</code>.
+ </dd>
+<dt>Effects:</dt>
+<dd>
+ <code class="computeroutput">func</code> is copied
+ into storage managed internally by the library, and that copy will
+ be invoked after the operator() function when the decorate is used
+ as Callable of a newly-created thread of execution.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ safe
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_constructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_constructor" title="Assign Move Constructor">Assign
+ Move Constructor</a>
+</h5></div></div></div>
+<pre class="programlisting">thread_decorator& operator=(thread_decorator&& other);
+thread_decorator& operator=(detail::thread_move_t<thread_decorator> x) {
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Requires:</dt>
+<dd>
+ <code class="computeroutput">Callable</code> must by
+ <code class="computeroutput">CopyConstructible</code>.
+ </dd>
+<dt>Effects:</dt>
+<dd>
+ <code class="computeroutput">func</code> is copied
+ into storage managed internally by the library, and that copy will
+ be invoked after the operator() function when the decorate is used
+ as Callable of a newly-created thread of execution.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ a reference to <code class="computeroutput">*this</code>.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ neutral
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_conversion"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_conversion" title="Member Function operator detail::thread_move_t<thread_decorator>()">Member
+ Function <code class="computeroutput">operator detail::thread_move_t<thread_decorator>()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">operator detail::thread_move_t<thread_decorator>();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ helper for move semantics emulation.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ the move form <code class="computeroutput">*this</code>.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ neutral
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_move"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_move" title="Member Function move()">Member
+ Function <code class="computeroutput">move()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">detail::thread_move_t<thread_decorator> move() {
+thread_decorator&& move();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Move *this to the caller.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ the move form <code class="computeroutput">*this</code>.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ neutral
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_swap"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_swap" title="Member Function swap()">Member
+ Function <code class="computeroutput">swap()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void swap(thread_decorator& x);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd></dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ neutral
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_operator_f"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_operator_f" title="Member Function operator()()">Member
+ Function <code class="computeroutput">operator()()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void operator()();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Functor operator
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Any exception thrown by the decorations or the user function.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ unsafe - depends on the decorations construction/destruction.
+ </dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.decorate"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_decorator_hpp.decorate" title="Non Member Function decorate()">Non
+ Member Function <code class="computeroutput">decorate()</code></a>
+</h4></div></div></div>
+<pre class="programlisting">void decorate();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Requires:</dt>
+<dd>
+ <code class="computeroutput">Callable</code> is <code class="computeroutput">CopyConstructible</code>. Copying <code class="computeroutput">f</code> shall have no side effects, and
+ the effect of calling the copy shall be equivalent to calling the
+ original.
+ </dd>
+<dt>Effects:</dt>
+<dd>
+ Calls every declared decoration using the thread_decoration class.
+ </dd>
+<dt>Postconditions:</dt>
+<dd>
+ All the decorations have been called.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Any exception thrown by the decorations.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ unsafe - depends on the decorations construction/destruction.
+ </dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp" title="Header <boost/interthreads/thread_specific_shared_ptr.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/thread_specific_shared_ptr.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr">Template
+ Class <code class="computeroutput">thread_specific_shared_ptr<></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_parameters">Template
+ parameters</a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_types">Public
+ types</a></dt>
+<dt>Constructor</dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_constructor_with_custom_cleanup">Cleanup
+ Constructor</a></dt>
+<dt>Destructor</dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_get">Member
+ Function <code class="computeroutput">get()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_arrow">Member
+ Function <code class="computeroutput">operator->()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_star">Member
+ Function <code class="computeroutput">operator*()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reset">Member
+ Function <code class="computeroutput">reset()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_wait_and_get">Member
+ Function <code class="computeroutput">wait_and_get()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operatora">Member
+ Function <code class="computeroutput">operator[]()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_mutex">Member
+ Function <code class="computeroutput">get_mutex()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_map">Member
+ Function <code class="computeroutput">get_map()</code></a></dt>
+</dl></dd>
+</dl></div>
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+
+ template <typename T>
+ class thread_specific_shared_ptr;
+
+}
+}
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr" title="Template Class thread_specific_shared_ptr<>">Template
+ Class <code class="computeroutput">thread_specific_shared_ptr<></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_parameters">Template
+ parameters</a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_types">Public
+ types</a></dt>
+<dt>Constructor</dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_constructor_with_custom_cleanup">Cleanup
+ Constructor</a></dt>
+<dt>Destructor</dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_get">Member
+ Function <code class="computeroutput">get()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_arrow">Member
+ Function <code class="computeroutput">operator->()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_star">Member
+ Function <code class="computeroutput">operator*()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reset">Member
+ Function <code class="computeroutput">reset()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_wait_and_get">Member
+ Function <code class="computeroutput">wait_and_get()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operatora">Member
+ Function <code class="computeroutput">operator[]()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_mutex">Member
+ Function <code class="computeroutput">get_mutex()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_map">Member
+ Function <code class="computeroutput">get_map()</code></a></dt>
+</dl></div>
+
+ <code class="computeroutput">bith::thread_specific_shared_ptr<></code>
+ is an extension of the thread_specific_ptr providing access to the thread
+ specific context from other threads.
+ 
+<pre class="programlisting">template <typename T>
+class thread_specific_shared_ptr : private noncopyable
+{
+public:
+ typedef shared_ptr<T> shared_ptr_type;
+ typedef 'implementation defined' map_type;
+ typedef 'implementation defined' mutex_type;
+ typedef 'implementation defined' lock_type;
+
+ thread_specific_shared_ptr();
+ explicit thread_specific_shared_ptr(void (*cleanup_)(shared_ptr_type));
+ ~thread_specific_shared_ptr();
+
+ T* get() const;
+ T* operator->() const;
+ T& operator*() const;
+ void reset();
+ template<class Y>
+ void reset(Y * p);
+ template<class Y, class D>
+ void reset(Y * p, D d);
+ template<class Y, class D, class A>
+ void reset(Y * p, D d, A a);
+
+ mutex_type& get_mutex();
+ const map_type& get_map(lock_type&) const;
+ shared_ptr_type operator[](thread::id id) const;
+ shared_ptr_type wait_and_get(thread::id id) const;
+private:
+ shared_ptr_type get_shared_ptr() const;
+};
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_parameters"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_parameters" title="Template parameters">Template
+ parameters</a>
+</h5></div></div></div>
+
+ <code class="computeroutput">thread_specific_shared_ptr<></code> is instantiated with the following
+ types:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ T The type of the pointeed object
+ </li></ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_types"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_types" title="Public types">Public
+ types</a>
+</h5></div></div></div>
+
+ <code class="computeroutput">thread_specific_shared_ptr<></code> defines the following types:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <code class="computeroutput">shared_ptr_type</code>
+ The shared pointed type.
+ </li>
+<li class="listitem">
+ <code class="computeroutput">map_type</code>
+ The mapping type from <code class="computeroutput">thread::id</code>
+ to <code class="computeroutput">shared_ptr_type</code>
+ </li>
+<li class="listitem">
+ <code class="computeroutput">mutex_type</code>
+ The protecting mutext type follwing the Lockable Concept
+ </li>
+<li class="listitem">
+ <code class="computeroutput">lock_type</code>
+ The lock used to get the map follwing the unique_lock subjacent Concept
+ </li>
+</ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_default_constructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_default_constructor" title="Constructor">Constructor</a>
+</h5></div></div></div>
+<pre class="programlisting">thread_specific_shared_ptr();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Construct a <code class="computeroutput">thread_specific_shared_ptr<></code> object for storing a pointer
+ to an object of type <code class="computeroutput">T</code>
+ specific to each thread.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ safe.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_constructor_with_custom_cleanup"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_constructor_with_custom_cleanup" title="Cleanup Constructor">Cleanup
+ Constructor</a>
+</h5></div></div></div>
+<pre class="programlisting">explicit thread_specific_shared_ptr(void (*cleanup_)(shared_ptr_type));
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Requires:</dt>
+<dd>
+ <code class="computeroutput">cleanup_function(this->get())</code> does not throw any exceptions.
+ </dd>
+<dt>Effects:</dt>
+<dd>
+ Construct a <code class="computeroutput">thread_specific_shared_ptr<></code> object for storing a pointer
+ to an object of type <code class="computeroutput">T</code>
+ specific to each thread. The supplied <code class="computeroutput">cleanup_function</code>
+ will be called at thread exit.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ safe.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_destructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_destructor" title="Destructor">Destructor</a>
+</h5></div></div></div>
+<pre class="programlisting">~thread_specific_shared_ptr();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Remove from the static map the current thread::id and destroys
+ <code class="computeroutput">*this</code>.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ safe.
+ </dd>
+</dl>
+</div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ Care needs to be taken to ensure that any threads still running after
+ an instance of <code class="computeroutput">boost::thread_specific_shared_ptr<></code> has been destroyed do not call
+ any member functions on that instance. Is for this raison that usualy
+ instance of this class are static.
+ </td></tr>
+</table></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_get"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_get" title="Member Function get()">Member
+ Function <code class="computeroutput">get()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">shared_ptr_type get() const;
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Returns:</dt>
+<dd>
+ The pointer associated with the current thread.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ safe.
+ </dd>
+</dl>
+</div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ The initial value associated with an instance of <code class="computeroutput">boost::thread_specific_shared_ptr<></code> is <code class="computeroutput">0</code>
+ for each thread.
+ </td></tr>
+</table></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_arrow"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_arrow" title="Member Function operator->()">Member
+ Function <code class="computeroutput">operator->()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">T* operator->() const;
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Requires:</dt>
+<dd>
+ <code class="computeroutput">this->get()</code>
+ is not <code class="computeroutput">0</code>.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ <code class="computeroutput">this->get()</code>
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ safe.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_star"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_star" title="Member Function operator*()">Member
+ Function <code class="computeroutput">operator*()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">T& operator*() const;
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Requires:</dt>
+<dd>
+ <code class="computeroutput">this->get()</code>
+ is not <code class="computeroutput">0</code>.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ <code class="computeroutput">*(this->get())</code>
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ safe.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reset"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reset" title="Member Function reset()">Member
+ Function <code class="computeroutput">reset()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void reset();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Equivalent to <code class="computeroutput">shared_ptr().swap(this->get_shared_ptr())</code>. Update the mapping.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ <code class="computeroutput">this->get()==0</code>
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ safe.
+ </dd>
+</dl>
+</div>
+<pre class="programlisting">template<class Y> void reset(Y * new_value);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Equivalent to <code class="computeroutput">shared_ptr(new_value).swap(this->get_shared_ptr())</code>. Update the mapping.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ <code class="computeroutput">this->get()==new_value</code>
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ safe.
+ </dd>
+</dl>
+</div>
+<pre class="programlisting">template<class Y, class D> void reset(Y * new_value, D deleter);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Equivalent to <code class="computeroutput">shared_ptr(new_value, deleter).swap(this->get_shared_ptr())</code>. Update the mapping.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ <code class="computeroutput">this->get()==new_value</code>
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ safe.
+ </dd>
+</dl>
+</div>
+<pre class="programlisting">template<class Y, class D, class A> void reset(Y * new_value, D deleter, A a);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Equivalent to <code class="computeroutput">shared_ptr(new_value, deleter, a).swap(this->get_shared_ptr())</code>. Update the mapping.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ <code class="computeroutput">this->get()==new_value</code>
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
+<dt>Thread safety:</dt>
+<dd>
+ safe.
+ </dd>
+</dl>
+</div>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ If <code class="computeroutput">this->get()!=new_value</code> and <code class="computeroutput">this->get()</code> is non-<code class="computeroutput">NULL</code>,
+ invoke <code class="computeroutput">delete this->get()</code> or <code class="computeroutput">deleter(this->get())</code> as appropriate. Store <code class="computeroutput">new_value</code> as the pointer associated
+ with the current thread.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_wait_and_get"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_wait_and_get" title="Member Function wait_and_get()">Member
+ Function <code class="computeroutput">wait_and_get()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">shared_ptr_type wait_and_get(thread::id id) const;
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Waits until the specific shared pointer has been set and returns
+ a shared pointer to this context.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ <code class="computeroutput">boost::thread_interrupted</code> if the current
+ thread of execution is interrupted.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operatora"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operatora" title="Member Function operator[]()">Member
+ Function <code class="computeroutput">operator[]()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">shared_ptr_type operator[](thread::id id) const;
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Returns a copy of the specific shared_ptr of the thread of execution
+ identified by the <code class="computeroutput">thread::id</code>.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_mutex"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_mutex" title="Member Function get_mutex()">Member
+ Function <code class="computeroutput">get_mutex()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">mutex_type& get_mutex();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Returns a reference to the protection mutex.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_map"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_map" title="Member Function get_map()">Member
+ Function <code class="computeroutput">get_map()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">const map_type& get_map(lock_type&) const;
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Returns a reference to the mapping from <code class="computeroutput">thread::id</code>
+ to the specific pointers provided the user gives a lock on the
+ motext get using <code class="computeroutput">get_mutex()</code>.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing.
+ </dd>
+</dl>
+</div>
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp" title="Header <boost/interthreads/thread_keep_alive.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/thread_keep_alive.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive">class
+ <code class="computeroutput">enable_keep_alive</code></a></dt>
+<dd><dl>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive">class
+ <code class="computeroutput">disable_keep_alive</code></a></dt>
+<dd><dl>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
</dl></dd>
+<dt><a href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_check_point">Non
+ Member Function <code class="computeroutput">keep_alive_check_point()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_enabled">Non
+ Member Function <code class="computeroutput">keep_alive_enabled()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_set_on_dead_thread">Non
+ Member Function <code class="computeroutput">set_on_dead_thread()</code></a></dt>
+</dl></div>
+
+ Includes the keep alive enabling/disabling classes and non member functions.
+ 
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+ namespace this_thread {
+ class enable_keep_alive;
+ class disable_keep_alive;
+
+ void keep_alive_check_point();
+ bool keep_alive_enabled();
+ typedef void (*on_dead_thread_type)(thread::id);
+ void set_on_dead_thread(on_dead_thread_type fct);
+ }
+}
+}
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive" title="class enable_keep_alive">class
+ <code class="computeroutput">enable_keep_alive</code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
</dl></div>
+
+ Keep alive enabler.
+ 
+<pre class="programlisting">class enable_keep_alive : private noncopyable{
+public:
+ enable_keep_alive(std::size_t threshold=2, std::size_t tap=1);
+ ~enable_keep_alive();
+};
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Constructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Constructor" title="Constructor">Constructor</a>
+</h5></div></div></div>
+<pre class="programlisting">enable_keep_alive(std::size_t threshold=2, std::size_t tap=1);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Enable the keep alive mechanism on this thread of execution.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Destructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Destructor" title="Destructor">Destructor</a>
+</h5></div></div></div>
+<pre class="programlisting">~enable_keep_alive();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Restore the keep alive mechanism as it was before the constructor.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive" title="class disable_keep_alive">class
+ <code class="computeroutput">disable_keep_alive</code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
+</dl></div>
+
+ Keep alive disabler.
+ 
+<pre class="programlisting">class disable_keep_alive private noncopyable {
+public:
+ disable_keep_alive();
+ ~disable_keep_alive();
+};
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Constructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Constructor" title="Constructor">Constructor</a>
+</h5></div></div></div>
+<pre class="programlisting">disable_keep_alive();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Disable the keep alive mechanism on this thread of execution.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Destructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Destructor" title="Destructor">Destructor</a>
+</h5></div></div></div>
+<pre class="programlisting">~disable_keep_alive();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Restore the keep alive mechanism as it was before the constructor.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_check_point"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_check_point" title="Non Member Function keep_alive_check_point()">Non
+ Member Function <code class="computeroutput">keep_alive_check_point()</code></a>
+</h4></div></div></div>
+
+ Keep alive check point.
+ 
+<pre class="programlisting">void keep_alive_check_point();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ States that the current thread is alive.
+ </dd>
+<dt>Postconditions:</dt>
+<dd>
+ The thread is alive.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_enabled"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_enabled" title="Non Member Function keep_alive_enabled()">Non
+ Member Function <code class="computeroutput">keep_alive_enabled()</code></a>
+</h4></div></div></div>
+
+ Keep alive query.
+ 
+<pre class="programlisting">bool keep_alive_enabled();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ States if the keep alive mechanism is enabled on this thread.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_set_on_dead_thread"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_set_on_dead_thread" title="Non Member Function set_on_dead_thread()">Non
+ Member Function <code class="computeroutput">set_on_dead_thread()</code></a>
+</h4></div></div></div>
+
+ Keep alive on dead thread action setting.
+ 
+<pre class="programlisting">void set_on_dead_thread(on_dead_thread_type fct);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Modifies the action to be done when a this thread is declared dead.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.reference.set_once_hpp"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.set_once_hpp" title="Header <boost/interthreads/set_once.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/set_once.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl><dt><a href="reference.html#toward_boost_interthreads.reference.set_once_hpp.set_onceclass">Template
+ Class <code class="computeroutput">set_once<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+ template <typename T>
+ class set_once;
+}
+}
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.set_once_hpp.set_onceclass"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.set_once_hpp.set_onceclass" title="Template Class set_once<>">Template
+ Class <code class="computeroutput">set_once<></code></a>
+</h4></div></div></div>
+
+ <code class="computeroutput">set_once<></code>
+ is a synchonizer that allows to set a variable only once, notifying to
+ the variable value to whatever is waiting for that.
+ 
+<pre class="programlisting">template <typename T>
+class set_once {
+public:
+ typedef T value_type;
+
+ set_once();
+ void wait();
+ bool wait_until(const system_time& abs_time);
+ template<typename TimeDuration>
+ bool wait_for(const TimeDuration& rel_time);
+
+ value_type get();
+ std::pair<bool,value_type> get_until(const system_time& abs_time);
+ template<typename TimeDuration>
+ std::pair<bool,value_type> get_for(const TimeDuration& rel_time);
+
+ bool set_if_unassigned(value_type id);
+
+ template<typename F>
+ static void decorator(this_type& once, T value, F fct);
+ template<typename F>
+ static boost::detail::thread_move_t<thread> make_thread(this_type& once, T value, F fct);
+};
+</pre>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp" title="Header <boost/interthreads/thread_tuple.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/thread_tuple.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class">Template
+ Class <code class="computeroutput">thread_tuple<></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.template_parameters">Template
+ parameters</a></dt>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_joinable">Member
+ function <code class="computeroutput">joinable()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_join">Member
+ function <code class="computeroutput">join_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_until___">Member
+ function <code class="computeroutput">join_all_until()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_for___">Member
+ function <code class="computeroutput">join_all_for()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.join_first_then_interrupt">Member
+ function <code class="computeroutput">join_any()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_any_until___">Member
+ function <code class="computeroutput">join_any_until()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.detach_all">Member
+ function <code class="computeroutput">detach_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_interrupt_all">Member
+ function <code class="computeroutput">interrupt_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_size">Member
+ function <code class="computeroutput">size()</code></a></dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_make_thread_tuple">Non
+ Member Function <code class="computeroutput">make_thread_tuple()</code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+
+ template <std::size_t N>
+ class thread_tuple;
+
+ template<typename F0, ..., typename Fn-1>
+ thread_tuple<n> make_thread_tuple(F0 f0, ..., Fn fn-1);
+
+}
+}
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class" title="Template Class thread_tuple<>">Template
+ Class <code class="computeroutput">thread_tuple<></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.template_parameters">Template
+ parameters</a></dt>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_joinable">Member
+ function <code class="computeroutput">joinable()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_join">Member
+ function <code class="computeroutput">join_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_until___">Member
+ function <code class="computeroutput">join_all_until()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_for___">Member
+ function <code class="computeroutput">join_all_for()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.join_first_then_interrupt">Member
+ function <code class="computeroutput">join_any()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_any_until___">Member
+ function <code class="computeroutput">join_any_until()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.detach_all">Member
+ function <code class="computeroutput">detach_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_interrupt_all">Member
+ function <code class="computeroutput">interrupt_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_size">Member
+ function <code class="computeroutput">size()</code></a></dt>
+</dl></div>
+
+ <code class="computeroutput">thread_tuple<></code>
+ defines a thread groupe where the number of threads is know statically
+ and the threads are created at construction time.
+ 
+<pre class="programlisting">template <std::size_t n>
+class thread_tuple {
+public:
+ template<typename F0, ..., typename Fn-1>
+ thread_tuple(F0 f0, ..., Fn-1 fn-1);
+
+ template <class F>
+ thread_tuple(boost::move_t<F> f);
+ ~thread_tuple();
+
+ // move support
+ thread_tuple(boost::move_t<thread_tuple<n>> x);
+ thread_tuple& operator=(boost::move_t<thread_tuple<n>> x);
+ operator boost::move_t<thread_tuple<n>>();
+ boost::move_t<thread_tuple<n>> move();
+
+ void swap(thread_tuple<n>& x);
+
+ bool joinable() const;
+ void join_all();
+ bool join_all_until(const system_time& wait_until);
+ template<typename TimeDuration>
+ bool join_all_for(TimeDuration const& rel_time);
+
+ void detach();
+ void detach_all();
+
+ void interrupt();
+ void interrupt_all();
+ bool interruption_requested() const;
+
+ size_t size();
+
+ const thread& operator[](std::size_t i);
+};
+}
+}
+</pre>
+
+ The <code class="computeroutput">thread_tuple<></code>
+ class is responsible for launching and managing a static collection of
+ threads that are related in some fashion. No new threads can be added to
+ the tuple once constructed.
+ 
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.template_parameters"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.template_parameters" title="Template parameters">Template
+ parameters</a>
+</h5></div></div></div>
+
+ <code class="computeroutput">thread_tuple<></code>
+ is instantiated with the following value:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ n is the size of the tuple.
+ </li></ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_callable_constructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_callable_constructor" title="Constructor">Constructor</a>
+</h5></div></div></div>
+<pre class="programlisting">template<typename F0, ..., typename Fn-1>
+thread_tuple(F0 func_0, ..., Fn-1 func_n-1);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Preconditions:</dt>
+<dd>
+ <code class="computeroutput">Fk</code> must by copyable.
+ </dd>
+<dt>Effects:</dt>
+<dd>
+ <code class="computeroutput">func_k</code> is copied
+ into storage managed internally by the library, and that copy is
+ invoked on a newly-created thread of execution. If this invocation
+ results in an exception being propagated into the internals of
+ the library that is not of type <code class="computeroutput">boost::thread_interrupted</code>,
+ then <code class="computeroutput">std::terminate()</code>
+ will be called.
+ </dd>
+<dt>Postconditions:</dt>
+<dd>
+ <code class="computeroutput">*this</code>
+ refers to the newly created tuple of threads of execution.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ <code class="computeroutput">boost::thread_resource_error</code> if an error
+ occurs.
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Currently up to ten arguments <code class="computeroutput">func_0</code>
+ to <code class="computeroutput">funct_9</code> can
+ be specified.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_destructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_destructor" title="Destructor">Destructor</a>
+</h5></div></div></div>
+<pre class="programlisting">~thread_tuple();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ If *this have associateds thread of execution, calls detach() on
+ them. Destroys *this.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_joinable"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_joinable" title="Member function joinable()">Member
+ function <code class="computeroutput">joinable()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">bool joinable() const;
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Returns:</dt>
+<dd>
+ <code class="computeroutput">true</code> if <code class="computeroutput">*this</code>
+ refers to threads of execution, <code class="computeroutput">false</code>
+ otherwise.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_join"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_join" title="Member function join_all()">Member
+ function <code class="computeroutput">join_all()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void join();
+void join_all();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">join()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the tuple.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ Every thread in the tuple has terminated.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Since <code class="computeroutput">boost::thread::join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_tuple<>::join_all()</code> is also an interruption point.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_until___"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_until___" title="Member function join_all_until()">Member
+ function <code class="computeroutput">join_all_until()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">bool join_all_until(const system_time& wait_until);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">timed_join()</code> on each <code class="computeroutput">boost::thread</code>
+ object in the tuple.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ Every thread in the tuple has terminated.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ true if joined.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_tuple<>::join_all_until()</code> is also an interruption point.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_for___"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_for___" title="Member function join_all_for()">Member
+ function <code class="computeroutput">join_all_for()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">template<typename TimeDuration>
+bool join_for(TimeDuration const& rel_time);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ As <code class="computeroutput">join_all_until(now()+rel_time)</code>.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ Every thread in the tuple has terminated.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ true if joined.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_tuple<>::join_all_for()</code> is also an interruption point.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.join_first_then_interrupt"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.join_first_then_interrupt" title="Member function join_any()">Member
+ function <code class="computeroutput">join_any()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">std::size_t conc_join_any();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">join_any()</code>
+ on a temporary thread_tuple and the <code class="computeroutput">interrup_all()</code>.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ Every thread in the tuple has terminated.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Since <code class="computeroutput">join_any()</code> is one of the predefined interruption
+ points, <code class="computeroutput">conc_join_any()</code> is also an interruption point.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_any_until___"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_any_until___" title="Member function join_any_until()">Member
+ function <code class="computeroutput">join_any_until()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">std::pair<bool,std::size_t> conc_join_any_until(
+ const system_time& wait_until);
+template<typename TimeDuration>
+std::pair<bool,std::size_t> join_any_for(
+ TimeDuration const& rel_time);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">join_any_until()</code> on a temporary thread_tuple and
+ the <code class="computeroutput">interrup_all()</code>.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ Every thread in the tuple has terminated.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ true if joined.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Since <code class="computeroutput">join_any_until()</code> is one of the predefined interruption
+ points, <code class="computeroutput">conc_join_any_until()</code> is also an interruption point.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.detach_all"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.detach_all" title="Member function detach_all()">Member
+ function <code class="computeroutput">detach_all()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void detach_all();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">detach()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the tuple.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_interrupt_all"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_interrupt_all" title="Member function interrupt_all()">Member
+ function <code class="computeroutput">interrupt_all()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void interrupt_all();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">thread::interrupt()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the tuple.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_size"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_size" title="Member function size()">Member
+ function <code class="computeroutput">size()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">int size();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Returns:</dt>
+<dd>
+ The number of threads in the tuple.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing.
+ </dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_make_thread_tuple"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_make_thread_tuple" title="Non Member Function make_thread_tuple()">Non
+ Member Function <code class="computeroutput">make_thread_tuple()</code></a>
+</h4></div></div></div>
+<pre class="programlisting">template<typename F0, ..., typename Fn-1>
+thread_tuple make_thread_tuple(F0 f0, ..., Fn fn-1);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ makes a new thread_tuple<>.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ the created thread tuple.
+ </dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp" title="Header <boost/interthreads/thread_tuple_once.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/thread_tuple_once.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class">Template
+ Class <code class="computeroutput">thread_tuple_once<></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.template_parameters">Template
+ parameters</a></dt>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_joinable">Member
+ function <code class="computeroutput">joinables()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_join">Member
+ function <code class="computeroutput">join_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_all_until___">Member
+ function <code class="computeroutput">join_all_until()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_any___">Member
+ function <code class="computeroutput">join_any()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.timed_join_first_then_interrupt">Member
+ function <code class="computeroutput">timed_join_first_then_interrupt()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.detach_all">Member
+ function <code class="computeroutput">detach_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_interrupt_all">Member
+ function <code class="computeroutput">interrupt_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_size">Member
+ function <code class="computeroutput">size()</code></a></dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_make_thread_tuple_once">Non
+ Member Function <code class="computeroutput">make_thread_tuple_once()</code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+
+ template <std::size_t N>
+ class thread_tuple_once;
+
+ template<typename F0, ..., typename Fn-1>
+ thread_tuple make_thread_tuple_once(F0 f0, ..., Fn fn-1);
+
+}
+}
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class" title="Template Class thread_tuple_once<>">Template
+ Class <code class="computeroutput">thread_tuple_once<></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.template_parameters">Template
+ parameters</a></dt>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_joinable">Member
+ function <code class="computeroutput">joinables()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_join">Member
+ function <code class="computeroutput">join_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_all_until___">Member
+ function <code class="computeroutput">join_all_until()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_any___">Member
+ function <code class="computeroutput">join_any()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.timed_join_first_then_interrupt">Member
+ function <code class="computeroutput">timed_join_first_then_interrupt()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.detach_all">Member
+ function <code class="computeroutput">detach_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_interrupt_all">Member
+ function <code class="computeroutput">interrupt_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_size">Member
+ function <code class="computeroutput">size()</code></a></dt>
+</dl></div>
+
+ <code class="computeroutput">biththread_tuple_once</code> is
+ an extension of the <code class="computeroutput">bith::thread_tuple</code>
+ which allows to join the thread finishing the first, using for that the
+ <code class="computeroutput">bith::set_once</code> synchronizer.
+ 
+<pre class="programlisting">template <std::size_t n>
+class thread_tuple_once {
+public:
+ template<typename F0, ..., typename Fn-1>
+ thread_tuple_once(F0 f0, ..., Fn-1 fn-1);
+
+ template <class F>
+ thread_tuple_once(boost::move_t<F> f);
+ ~thread_tuple_once();
+
+ // move support
+ thread_tuple_once(boost::move_t<thread_tuple_once<n>> x);
+ thread_tuple_once& operator=(boost::move_t<thread_tuple_once<n>> x);
+ operator boost::move_t<thread_tuple_once<n>>();
+ boost::move_t<thread_tuple_once<n>> move();
+
+ void swap(thread_tuple_once<n>& x);
+
+ bool joinables() const;
+ void join_all();
+ bool join_all_until(const system_time& wait_until);
+ template<typename TimeDuration>
+ bool join_all_for(TimeDuration const& rel_time);
+
+ std::size_t join_any();
+ std::pair<bool,std::size_t> join_any_until(
+ const system_time& wait_until);
+ template<typename TimeDuration>
+ std::pair<bool,std::size_t> join_any_for(
+ TimeDuration const& rel_time);
+
+ void detach_all();
+
+ void interrupt_all();
+ bool interruption_requested() const;
+
+ size_t size();
+
+ const thread& operator[](std::size_t i);
+};
+}
+}
+</pre>
+
+ The __thread_tupleonce_ class is
+ responsible for launching and managing a static collection of threads that
+ are related in some fashion. No new threads can be added to the tuple once
+ constructed.
+ 
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.template_parameters"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.template_parameters" title="Template parameters">Template
+ parameters</a>
+</h5></div></div></div>
+
+ <code class="computeroutput">thread_tuple_once<></code>
+ is instantiated with the following value:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ n is the size of the tuple.
+ </li></ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_callable_constructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_callable_constructor" title="Constructor">Constructor</a>
+</h5></div></div></div>
+<pre class="programlisting">template<typename F0, ..., typename Fn-1>
+thread_tuple_once(F0 func_0, ..., Fn-1 func_n-1);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Preconditions:</dt>
+<dd>
+ <code class="computeroutput">Fk</code> must by copyable.
+ </dd>
+<dt>Effects:</dt>
+<dd>
+ <code class="computeroutput">func_k</code> is copied
+ into storage managed internally by the library, and that copy is
+ invoked on a newly-created thread of execution. If this invocation
+ results in an exception being propagated into the internals of
+ the library that is not of type <code class="computeroutput">boost::thread_interrupted</code>,
+ then <code class="computeroutput">std::terminate()</code>
+ will be called.
+ </dd>
+<dt>Postconditions:</dt>
+<dd>
+ <code class="computeroutput">*this</code>
+ refers to the newly created tuple of threads of execution.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ <code class="computeroutput">boost::thread_resource_error</code> if an error
+ occurs.
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Currently up to ten arguments <code class="computeroutput">func_0</code>
+ to <code class="computeroutput">funct_9</code> can
+ be specified.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_destructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_destructor" title="Destructor">Destructor</a>
+</h5></div></div></div>
+<pre class="programlisting">~thread_tuple_once();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ If *this have associateds thread of execution, calls detach() on
+ them. Destroys *this.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_joinable"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_joinable" title="Member function joinables()">Member
+ function <code class="computeroutput">joinables()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">bool joinables() const;
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Returns:</dt>
+<dd>
+ <code class="computeroutput">true</code> if <code class="computeroutput">*this</code>
+ refers to threads of execution, <code class="computeroutput">false</code>
+ otherwise.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_join"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_join" title="Member function join_all()">Member
+ function <code class="computeroutput">join_all()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void join_all();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">join()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the tuple.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ Every thread in the tuple has terminated.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Since <code class="computeroutput">boost::thread::join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_tuple_once<>::join_all()</code> is also an interruption point.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_all_until___"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_all_until___" title="Member function join_all_until()">Member
+ function <code class="computeroutput">join_all_until()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">bool join_all_until(const system_time& wait_until);
+template<typename TimeDuration>
+bool join_all_for(TimeDuration const& rel_time);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">timed_join()</code> on each <code class="computeroutput">boost::thread</code>
+ object in the tuple.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ Every thread in the tuple has terminated.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ true if joined.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_tuple_once<>::timed_join_all()</code> is also an interruption point.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_any___"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_any___" title="Member function join_any()">Member
+ function <code class="computeroutput">join_any()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">std::size_t join_any();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">join_first()</code> and the <code class="computeroutput">interrup_all()</code>.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ Every thread in the tuple has terminated.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Since <code class="computeroutput">boost::thread::join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_tuple_once<>::join_all()</code> is also an interruption point.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.timed_join_first_then_interrupt"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.timed_join_first_then_interrupt" title="Member function timed_join_first_then_interrupt()">Member
+ function <code class="computeroutput">timed_join_first_then_interrupt()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">std::pair<bool,std::size_t> timed_join_first_then_interrupt(
+ const system_time& wait_until);
+template<typename TimeDuration>
+std::pair<bool,std::size_t> timed_join_first_then_interrupt(
+ TimeDuration const& rel_time);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">timed_join_first()</code> and the <code class="computeroutput">interrup_all()</code>.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ Every thread in the tuple has terminated.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ true if joined.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_tuple_once<>::timed_join_all()</code> is also an interruption point.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.detach_all"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.detach_all" title="Member function detach_all()">Member
+ function <code class="computeroutput">detach_all()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void detach_all();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">detach()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the tuple.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_interrupt_all"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_interrupt_all" title="Member function interrupt_all()">Member
+ function <code class="computeroutput">interrupt_all()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void interrupt_all();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">thread::interrupt()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the tuple.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_size"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_size" title="Member function size()">Member
+ function <code class="computeroutput">size()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">int size();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Returns:</dt>
+<dd>
+ The number of threads in the tuple.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing.
+ </dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_make_thread_tuple_once"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_make_thread_tuple_once" title="Non Member Function make_thread_tuple_once()">Non
+ Member Function <code class="computeroutput">make_thread_tuple_once()</code></a>
+</h4></div></div></div>
+<pre class="programlisting">template<typename F0, ..., typename Fn-1>
+thread_tuple_once make_thread_tuple_once(F0 f0, ..., Fn fn-1);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ makes a new thread_tuple_once<>.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ the created thread tuple.
+ </dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp" title="Header <boost/interthreads/thread_group_once.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/thread_group_once.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class">Template
+ Class <code class="computeroutput">thread_group_once<></code></a></dt>
+<dd><dl>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_joinable">Member
+ function <code class="computeroutput">joinables()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_join">Member
+ function <code class="computeroutput">join_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_timed_join">Member
+ function <code class="computeroutput">join_all_until()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.join_first_then_interrupt">Member
+ function <code class="computeroutput">join_any()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.timed_join_first_then_interrupt">Member
+ function <code class="computeroutput">join_any_until()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.detach_all">Member
+ function <code class="computeroutput">detach_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.member_function__interrupt_all___">Member
+ function <code class="computeroutput">interrupt_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_size">Member
+ function <code class="computeroutput">size()</code></a></dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_make_thread_group_once">Non
+ Member Function <code class="computeroutput">make_thread_group_once()</code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+
+ template <std::size_t N>
+ class thread_group;
+
+}
+}
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class" title="Template Class thread_group_once<>">Template
+ Class <code class="computeroutput">thread_group_once<></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_joinable">Member
+ function <code class="computeroutput">joinables()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_join">Member
+ function <code class="computeroutput">join_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_timed_join">Member
+ function <code class="computeroutput">join_all_until()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.join_first_then_interrupt">Member
+ function <code class="computeroutput">join_any()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.timed_join_first_then_interrupt">Member
+ function <code class="computeroutput">join_any_until()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.detach_all">Member
+ function <code class="computeroutput">detach_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.member_function__interrupt_all___">Member
+ function <code class="computeroutput">interrupt_all()</code></a></dt>
+<dt><a href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_size">Member
+ function <code class="computeroutput">size()</code></a></dt>
+</dl></div>
+
+ <code class="computeroutput">thread_group_once<></code>
+ is an extension of the boost::thread_group which allows to join the thread
+ finishing the first, using for that the set_once synchronizer.
+ 
+<pre class="programlisting">template <std::size_t n>
+class thread_group_once {
+public:
+ thread_group_once();
+ ~thread_group_once();
+
+ template<typename F>
+ thread* create_thread(F threadfunc);
+ void remove_thread(thread* thrd);
+
+ // move support
+ thread_group_once(boost::move_t<thread_group_once<n>> x);
+ thread_group_once& operator=(boost::move_t<thread_group_once<n>> x);
+ operator boost::move_t<thread_group_once<n>>();
+ boost::move_t<thread_group_once<n>> move();
+
+ void swap(thread_group_once<n>& x);
+
+ bool joinables() const;
+
+ void join_all();
+ bool join_all_until(const system_time& wait_until);
+ template<typename TimeDuration>
+ bool join_all_for(TimeDuration const& rel_time);
+
+ std::size_t join_any();
+ std::pair<bool,std::size_t> join_any_until(
+ const system_time& wait_until);
+ template<typename TimeDuration>
+ std::pair<bool,std::size_t> join_any_for(
+ TimeDuration const& rel_time);
+
+ void detach_all();
+
+ void interrupt_all();
+ bool interruption_requested() const;
+
+ size_t size();
+
+ const thread& operator[](std::size_t i);
+};
+}
+}
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_callable_constructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_callable_constructor" title="Constructor">Constructor</a>
+</h5></div></div></div>
+<pre class="programlisting">thread_group_once();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ creates a thread group.
+ </dd>
+<dt>Postconditions:</dt>
+<dd>
+ <code class="computeroutput">*this</code>
+ refers to the newly created group of threads of execution.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ <code class="computeroutput">boost::thread_resource_error</code> if an error
+ occurs.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_destructor"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_destructor" title="Destructor">Destructor</a>
+</h5></div></div></div>
+<pre class="programlisting">~thread_group_once();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ If *this have associateds thread of execution, calls detach() on
+ them. Destroys *this.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_joinable"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_joinable" title="Member function joinables()">Member
+ function <code class="computeroutput">joinables()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">bool joinables() const;
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Returns:</dt>
+<dd>
+ <code class="computeroutput">true</code> if <code class="computeroutput">*this</code>
+ refers to threads of execution, <code class="computeroutput">false</code>
+ otherwise.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_join"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_join" title="Member function join_all()">Member
+ function <code class="computeroutput">join_all()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void join_all();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">join()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the group.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ Every thread in the group has terminated.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Since <code class="computeroutput">boost::thread::join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_group_once<>::join_all()</code> is also an interruption point.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_timed_join"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_timed_join" title="Member function join_all_until()">Member
+ function <code class="computeroutput">join_all_until()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">bool join_all_until(const system_time& wait_until);
+template<typename TimeDuration>
+bool join_all_for(TimeDuration const& rel_time);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">timed_join()</code> on each <code class="computeroutput">boost::thread</code>
+ object in the group.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ Every thread in the group has terminated.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ true if joined.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_group_once<>::timed_join_all()</code> is also an interruption point.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.join_first_then_interrupt"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.join_first_then_interrupt" title="Member function join_any()">Member
+ function <code class="computeroutput">join_any()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">std::size_t join_any();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">join_any()</code>
+ and the <code class="computeroutput">interrup_all()</code>.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ Every thread in the group has terminated.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Since <code class="computeroutput">join_any</code>
+ is one of the predefined interruption points, <code class="computeroutput">thread_group_once<>::join_any()</code> is also an interruption point.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.timed_join_first_then_interrupt"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.timed_join_first_then_interrupt" title="Member function join_any_until()">Member
+ function <code class="computeroutput">join_any_until()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">std::pair<bool,std::size_t> join_any_until(
+ const system_time& wait_until);
+template<typename TimeDuration>
+std::pair<bool,std::size_t> join_any_for(
+ TimeDuration const& rel_time);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">get_until()</code> and the <code class="computeroutput">interrup_all()</code>.
+ </dd>
+<dt>Postcondition:</dt>
+<dd>
+ Every thread in the group has terminated.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ true if joined.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing
+ </dd>
+<dt>Note:</dt>
+<dd>
+ Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_group_once<>::timed_join_all()</code> is also an interruption point.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.detach_all"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.detach_all" title="Member function detach_all()">Member
+ function <code class="computeroutput">detach_all()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void detach_all();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">detach()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the group.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.member_function__interrupt_all___"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.member_function__interrupt_all___" title="Member function interrupt_all()">Member
+ function <code class="computeroutput">interrupt_all()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void interrupt_all();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ Call <code class="computeroutput">thread::interrupt()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the group.
+ </dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_size"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_size" title="Member function size()">Member
+ function <code class="computeroutput">size()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">int size();
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Returns:</dt>
+<dd>
+ The number of threads in the group.
+ </dd>
+<dt>Throws:</dt>
+<dd>
+ Nothing.
+ </dd>
+</dl>
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_make_thread_group_once"></a><a class="link" href="reference.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_make_thread_group_once" title="Non Member Function make_thread_group_once()">Non
+ Member Function <code class="computeroutput">make_thread_group_once()</code></a>
+</h4></div></div></div>
+<pre class="programlisting">template<typename F0, ..., typename Fn-1>
+thread_group_once make_thread_group_once(F0 f0, ..., Fn fn-1);
+</pre>
+<div class="variablelist">
+
+<dl>
+<dt>Effects:</dt>
+<dd>
+ makes a new thread_group_once<>.
+ </dd>
+<dt>Returns:</dt>
+<dd>
+ the created thread group.
+ </dd>
+</dl>
+</div>
+</div>
+</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 © 2008 -2009 Vicente J. Botet Escriba
+<td align="right"><div class="copyright-footer">Copyright © 2008 -2009,2011 Vicente J. Botet Escriba
 Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 
@@ -100,7 +2817,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="users_guide/glosary.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reference/concepts.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="users_guide.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="appendices.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/concepts.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/concepts.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/concepts.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,15 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Concepts</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../reference.html" title=" Reference">
-<link rel="prev" href="../reference.html" title=" Reference">
-<link rel="next" href="thread_decoration_hpp.html" title="
- Header <boost/interthreads/thread_decoration.hpp>">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="../reference.html" title="Reference">
+<link rel="next" href="thread_decoration_hpp.html" title="Header <boost/interthreads/thread_decoration.hpp>">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -24,13 +22,13 @@
<div class="spirit-nav">
<a accesskey="p" href="../reference.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="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="thread_decoration_hpp.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.reference.concepts"></a>Concepts
+<a name="toward_boost_interthreads.reference.concepts"></a><a class="link" href="concepts.html" title="Concepts">Concepts</a>
</h3></div></div></div>
<div class="toc"><dl><dt>Decorator</dt></dl></div>
-<div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.concepts.decorator"></a>Decorator
+<div class="section"><div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.reference.concepts.decorator"></a><a class="link" href="concepts.html#toward_boost_interthreads.reference.concepts.decorator" title="Decorator">Decorator</a>
</h4></div></div></div></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/keep_alive_file_hpp.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/keep_alive_file_hpp.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/keep_alive_file_hpp.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,17 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>
- Header <boost/interthreads/thread_keep_alive.hpp></title>
+<title>Header <boost/interthreads/thread_keep_alive.hpp></title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../reference.html" title=" Reference">
-<link rel="prev" href="thread_specific_shared_ptr_hpp.html" title="
- Header <boost/interthreads/thread_specific_shared_ptr.hpp>">
-<link rel="next" href="set_once_hpp.html" title=" Header
- <boost/interthreads/set_once.hpp>">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="thread_specific_shared_ptr_hpp.html" title="Header <boost/interthreads/thread_specific_shared_ptr.hpp>">
+<link rel="next" href="set_once_hpp.html" title="Header <boost/interthreads/set_once.hpp>">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -26,273 +22,239 @@
<div class="spirit-nav">
<a accesskey="p" href="thread_specific_shared_ptr_hpp.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="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="set_once_hpp.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.reference.keep_alive_file_hpp"></a><a href="keep_alive_file_hpp.html" title="
- Header <boost/interthreads/thread_keep_alive.hpp>">
- Header <code class="computeroutput"><boost/interthreads/thread_keep_alive.hpp></code></a>
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp"></a><a class="link" href="keep_alive_file_hpp.html" title="Header <boost/interthreads/thread_keep_alive.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/thread_keep_alive.hpp></code></a>
</h3></div></div></div>
<div class="toc"><dl>
-<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive">
- class <code class="computeroutput">enable_keep_alive</code></a></dt>
+<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive">class
+ <code class="computeroutput">enable_keep_alive</code></a></dt>
<dd><dl>
-<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Constructor">
- Constructor</a></dt>
-<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Destructor">
- Destructor</a></dt>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
</dl></dd>
-<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive">
- class <code class="computeroutput">disable_keep_alive</code></a></dt>
+<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive">class
+ <code class="computeroutput">disable_keep_alive</code></a></dt>
<dd><dl>
-<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Constructor">
- Constructor</a></dt>
-<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Destructor">
- Destructor</a></dt>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
</dl></dd>
-<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_check_point">
- Non Member Function <code class="computeroutput">keep_alive_check_point()</code></a></dt>
-<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_enabled">
- Non Member Function <code class="computeroutput">keep_alive_enabled()</code></a></dt>
-<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_set_on_dead_thread">
- Non Member Function <code class="computeroutput">set_on_dead_thread()</code></a></dt>
+<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_check_point">Non
+ Member Function <code class="computeroutput">keep_alive_check_point()</code></a></dt>
+<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_enabled">Non
+ Member Function <code class="computeroutput">keep_alive_enabled()</code></a></dt>
+<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_set_on_dead_thread">Non
+ Member Function <code class="computeroutput">set_on_dead_thread()</code></a></dt>
</dl></div>

 Includes the keep alive enabling/disabling classes and non member functions.
 
-<pre class="programlisting">
- namespace boost {
- namespace interthreads {
- namespace this_thread {
- class enable_keep_alive;
- class disable_keep_alive;
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+ namespace this_thread {
+ class enable_keep_alive;
+ class disable_keep_alive;

- void keep_alive_check_point();
- bool keep_alive_enabled();
- typedef void (*on_dead_thread_type)(thread::id);
- void set_on_dead_thread(on_dead_thread_type fct);
- }
+ void keep_alive_check_point();
+ bool keep_alive_enabled();
+ typedef void (*on_dead_thread_type)(thread::id);
+ void set_on_dead_thread(on_dead_thread_type fct);
 }
- }
-=======]
-
-I</pre>
-<div class="section" lang="en">
+}
+}
+</pre>
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive"></a><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive" title="
- class enable_keep_alive">
- class <code class="computeroutput">enable_keep_alive</code></a>
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive"></a><a class="link" href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive" title="class enable_keep_alive">class
+ <code class="computeroutput">enable_keep_alive</code></a>
</h4></div></div></div>
<div class="toc"><dl>
-<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Constructor">
- Constructor</a></dt>
-<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Destructor">
- Destructor</a></dt>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
</dl></div>

 Keep alive enabler.
 
-<pre class="programlisting">
- class enable_keep_alive : private noncopyable{
- public:
- enable_keep_alive(std::size_t threshold=2, std::size_t tap=1);
- ~enable_keep_alive();
- };
-alive</pre>
-<div class="section" lang="en">
+<pre class="programlisting">class enable_keep_alive : private noncopyable{
+public:
+ enable_keep_alive(std::size_t threshold=2, std::size_t tap=1);
+ ~enable_keep_alive();
+};
+</pre>
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Constructor"></a><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Constructor" title="
- Constructor">
- Constructor</a>
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Constructor"></a><a class="link" href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Constructor" title="Constructor">Constructor</a>
</h5></div></div></div>
-<pre class="programlisting">
-enable_keep_alive(std::size_t threshold=2, std::size_t tap=1);
+<pre class="programlisting">enable_keep_alive(std::size_t threshold=2, std::size_t tap=1);
</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Enable the keep alive mechanism on this thread of execution.
- </dd>
+ Enable the keep alive mechanism on this thread of execution.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Destructor"></a><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Destructor" title="
- Destructor">
- Destructor</a>
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Destructor"></a><a class="link" href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.enable_keep_alive.keep_alive_enable_keep_alive_Destructor" title="Destructor">Destructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- ~enable_keep_alive();
-t</pre>
+<pre class="programlisting">~enable_keep_alive();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Restore the keep alive mechanism as it was before the constructor.
- </dd>
+ Restore the keep alive mechanism as it was before the constructor.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
</dl>
</div>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive"></a><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive" title="
- class disable_keep_alive">
- class <code class="computeroutput">disable_keep_alive</code></a>
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive"></a><a class="link" href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive" title="class disable_keep_alive">class
+ <code class="computeroutput">disable_keep_alive</code></a>
</h4></div></div></div>
<div class="toc"><dl>
-<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Constructor">
- Constructor</a></dt>
-<dt><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Destructor">
- Destructor</a></dt>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
</dl></div>

 Keep alive disabler.
 
-<pre class="programlisting">
- class disable_keep_alive private noncopyable {
- public:
- disable_keep_alive();
- ~disable_keep_alive();
- };
-e><ph</pre>
-<div class="section" lang="en">
+<pre class="programlisting">class disable_keep_alive private noncopyable {
+public:
+ disable_keep_alive();
+ ~disable_keep_alive();
+};
+</pre>
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Constructor"></a><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Constructor" title="
- Constructor">
- Constructor</a>
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Constructor"></a><a class="link" href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Constructor" title="Constructor">Constructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- disable_keep_alive();
-i</pre>
+<pre class="programlisting">disable_keep_alive();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Disable the keep alive mechanism on this thread of execution.
- </dd>
+ Disable the keep alive mechanism on this thread of execution.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Destructor"></a><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Destructor" title="
- Destructor">
- Destructor</a>
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Destructor"></a><a class="link" href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_disable_keep_alive.keep_alive_disable_keep_alive_Destructor" title="Destructor">Destructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- ~disable_keep_alive();
-:</pre>
+<pre class="programlisting">~disable_keep_alive();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Restore the keep alive mechanism as it was before the constructor.
- </dd>
+ Restore the keep alive mechanism as it was before the constructor.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
</dl>
</div>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_check_point"></a><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_check_point" title="
- Non Member Function keep_alive_check_point()">
- Non Member Function <code class="computeroutput">keep_alive_check_point()</code></a>
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_check_point"></a><a class="link" href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_check_point" title="Non Member Function keep_alive_check_point()">Non
+ Member Function <code class="computeroutput">keep_alive_check_point()</code></a>
</h4></div></div></div>

 Keep alive check point.
 
-<pre class="programlisting">
- void keep_alive_check_point();
-#</pre>
+<pre class="programlisting">void keep_alive_check_point();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- States that the current thread is alive.
- </dd>
+ States that the current thread is alive.
+ </dd>
<dt>Postconditions:</dt>
<dd>
- The thread is alive.
- </dd>
+ The thread is alive.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_enabled"></a><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_enabled" title="
- Non Member Function keep_alive_enabled()">
- Non Member Function <code class="computeroutput">keep_alive_enabled()</code></a>
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_enabled"></a><a class="link" href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_enabled" title="Non Member Function keep_alive_enabled()">Non
+ Member Function <code class="computeroutput">keep_alive_enabled()</code></a>
</h4></div></div></div>

 Keep alive query.
 
-<pre class="programlisting">
- bool keep_alive_enabled();
-a</pre>
+<pre class="programlisting">bool keep_alive_enabled();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- States if the keep alive mechanism is enabled on this thread.
- </dd>
+ States if the keep alive mechanism is enabled on this thread.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_set_on_dead_thread"></a><a href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_set_on_dead_thread" title="
- Non Member Function set_on_dead_thread()">
- Non Member Function <code class="computeroutput">set_on_dead_thread()</code></a>
+<a name="toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_set_on_dead_thread"></a><a class="link" href="keep_alive_file_hpp.html#toward_boost_interthreads.reference.keep_alive_file_hpp.keep_alive_keep_alive_set_on_dead_thread" title="Non Member Function set_on_dead_thread()">Non
+ Member Function <code class="computeroutput">set_on_dead_thread()</code></a>
</h4></div></div></div>

 Keep alive on dead thread action setting.
 
-<pre class="programlisting">
- void set_on_dead_thread(on_dead_thread_type fct);
-o</pre>
+<pre class="programlisting">void set_on_dead_thread(on_dead_thread_type fct);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Modifies the action to be done when a this thread is declared dead.
- </dd>
+ Modifies the action to be done when a this thread is declared dead.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
</dl>
</div>
</div>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/set_once_hpp.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/set_once_hpp.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/set_once_hpp.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,17 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title> Header
- <boost/interthreads/set_once.hpp></title>
+<title>Header <boost/interthreads/set_once.hpp></title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../reference.html" title=" Reference">
-<link rel="prev" href="keep_alive_file_hpp.html" title="
- Header <boost/interthreads/thread_keep_alive.hpp>">
-<link rel="next" href="thread_tuple_hpp.html" title="
- Header <boost/interthreads/thread_tuple.hpp>">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="keep_alive_file_hpp.html" title="Header <boost/interthreads/thread_keep_alive.hpp>">
+<link rel="next" href="thread_tuple_hpp.html" title="Header <boost/interthreads/thread_tuple.hpp>">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -26,35 +22,31 @@
<div class="spirit-nav">
<a accesskey="p" href="keep_alive_file_hpp.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="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="thread_tuple_hpp.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.reference.set_once_hpp"></a><a href="set_once_hpp.html" title=" Header
- <boost/interthreads/set_once.hpp>"> Header
+<a name="toward_boost_interthreads.reference.set_once_hpp"></a><a class="link" href="set_once_hpp.html" title="Header <boost/interthreads/set_once.hpp>">Header
 <code class="computeroutput"><boost/interthreads/set_once.hpp></code></a>
</h3></div></div></div>
-<div class="toc"><dl><dt><a href="set_once_hpp.html#toward_boost_interthreads.reference.set_once_hpp.set_onceclass">
- Template Class <code class="computeroutput">set_once<></code></a></dt></dl></div>
-<pre class="programlisting">
- namespace boost {
- namespace interthreads {
- template <typename T>
- class set_once;
- }
- }
-ase ro</pre>
-<div class="section" lang="en">
+<div class="toc"><dl><dt><a href="set_once_hpp.html#toward_boost_interthreads.reference.set_once_hpp.set_onceclass">Template
+ Class <code class="computeroutput">set_once<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+ template <typename T>
+ class set_once;
+}
+}
+</pre>
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.set_once_hpp.set_onceclass"></a><a href="set_once_hpp.html#toward_boost_interthreads.reference.set_once_hpp.set_onceclass" title="
- Template Class set_once<>">
- Template Class <code class="computeroutput">set_once<></code></a>
+<a name="toward_boost_interthreads.reference.set_once_hpp.set_onceclass"></a><a class="link" href="set_once_hpp.html#toward_boost_interthreads.reference.set_once_hpp.set_onceclass" title="Template Class set_once<>">Template
+ Class <code class="computeroutput">set_once<></code></a>
</h4></div></div></div>

 <code class="computeroutput">set_once<></code>
 is a synchonizer that allows to set a variable only once, notifying to
 the variable value to whatever is waiting for that.
 
-<pre class="programlisting">
-template <typename T>
+<pre class="programlisting">template <typename T>
class set_once {
public:
 typedef T value_type;
@@ -77,8 +69,7 @@
 template<typename F>
 static boost::detail::thread_move_t<thread> make_thread(this_type& once, T value, F fct);
};
-
-template <type</pre>
+</pre>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_decoration_hpp.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_decoration_hpp.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_decoration_hpp.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,16 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>
- Header <boost/interthreads/thread_decoration.hpp></title>
+<title>Header <boost/interthreads/thread_decoration.hpp></title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../reference.html" title=" Reference">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
+<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="concepts.html" title="Concepts">
-<link rel="next" href="thread_decorator_hpp.html" title="
- Header <boost/interthreads/thread_decorator.hpp>">
+<link rel="next" href="thread_decorator_hpp.html" title="Header <boost/interthreads/thread_decorator.hpp>">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -25,38 +22,35 @@
<div class="spirit-nav">
<a accesskey="p" href="concepts.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="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="thread_decorator_hpp.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.reference.thread_decoration_hpp"></a><a href="thread_decoration_hpp.html" title="
- Header <boost/interthreads/thread_decoration.hpp>">
- Header <code class="computeroutput"><boost/interthreads/thread_decoration.hpp></code></a>
+<a name="toward_boost_interthreads.reference.thread_decoration_hpp"></a><a class="link" href="thread_decoration_hpp.html" title="Header <boost/interthreads/thread_decoration.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/thread_decoration.hpp></code></a>
</h3></div></div></div>
<div class="toc"><dl>
-<dt><a href="thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration">
- Class <code class="computeroutput">thread_decoration</code></a></dt>
+<dt><a href="thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration">Class
+ <code class="computeroutput">thread_decoration</code></a></dt>
<dd><dl>
-<dt><a href="thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.thread_decoration_class_constructor_setup">
- Constructor with setup</a></dt>
+<dt><a href="thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.thread_decoration_class_constructor_setup">Constructor
+ with setup</a></dt>
<dt><a href="thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.constructor_with_setup___cleanup">Constructor
 with setup & cleanup</a></dt>
</dl></dd>
</dl></div>
-<pre class="programlisting">
- namespace boost {
- namespace interthreads {
- class thread_decoration;
- }
- }
-###a#</pre>
-<div class="section" lang="en">
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+ class thread_decoration;
+}
+}
+</pre>
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration"></a><a href="thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration" title="
- Class thread_decoration">
- Class <code class="computeroutput">thread_decoration</code></a>
+<a name="toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration"></a><a class="link" href="thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration" title="Class thread_decoration">Class
+ <code class="computeroutput">thread_decoration</code></a>
</h4></div></div></div>
<div class="toc"><dl>
-<dt><a href="thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.thread_decoration_class_constructor_setup">
- Constructor with setup</a></dt>
+<dt><a href="thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.thread_decoration_class_constructor_setup">Constructor
+ with setup</a></dt>
<dt><a href="thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.constructor_with_setup___cleanup">Constructor
 with setup & cleanup</a></dt>
</dl></div>
@@ -65,26 +59,23 @@
 a couple of setup/cleanup functions chained to the last constructed decoration,
 i.e. decorations are chained between them.
 
-<pre class="programlisting">
- class thread_decoration {
- public:
- template<typename Callable1>
- thread_decoration(Callable1 setup);
-
- template<typename Callable1,typename Callable2>
- thread_decoration(Callable1 setup, Callable2 cleanup);
-
- ~thread_decoration() {
- };
-p function</pre>
-<div class="section" lang="en">
+<pre class="programlisting">class thread_decoration {
+public:
+ template<typename Callable1>
+ thread_decoration(Callable1 setup);
+
+ template<typename Callable1,typename Callable2>
+ thread_decoration(Callable1 setup, Callable2 cleanup);
+
+ ~thread_decoration() {
+};
+</pre>
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.thread_decoration_class_constructor_setup"></a><a href="thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.thread_decoration_class_constructor_setup" title="
- Constructor with setup">
- Constructor with setup</a>
+<a name="toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.thread_decoration_class_constructor_setup"></a><a class="link" href="thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.thread_decoration_class_constructor_setup" title="Constructor with setup">Constructor
+ with setup</a>
</h5></div></div></div>
-<pre class="programlisting">
-template<typename Callable>
+<pre class="programlisting">template<typename Callable>
thread_decoration(Callable func);
</pre>
<div class="variablelist">
@@ -92,30 +83,29 @@
<dl>
<dt>Requires:</dt>
<dd>
- <code class="computeroutput">Callable</code> is <code class="computeroutput">CopyConstructible</code>. Copying <code class="computeroutput">setup</code> shall have no side effects,
- and the effect of calling the copy shall be equivalent to calling
- the original.
- </dd>
+ <code class="computeroutput">Callable</code> is <code class="computeroutput">CopyConstructible</code>. Copying <code class="computeroutput">setup</code> shall have no side effects,
+ and the effect of calling the copy shall be equivalent to calling
+ the original.
+ </dd>
<dt>Effects:</dt>
<dd>
- <code class="computeroutput">setup</code> is copied into
- storage managed internally by the library, and that copy is invoked
- by the <code class="computeroutput">decorate()</code>
- function.
- </dd>
+ <code class="computeroutput">setup</code> is copied
+ into storage managed internally by the library, and that copy is
+ invoked by the <code class="computeroutput">decorate()</code> function.
+ </dd>
<dt>Postconditions:</dt>
<dd>
- <code class="computeroutput">*this</code>
- refers to a decoration.
- </dd>
+ <code class="computeroutput">*this</code>
+ refers to a decoration.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Thread safety:</dt>
<dd>
- unsafe
- </dd>
+ unsafe
+ </dd>
</dl>
</div>
<div class="note"><table border="0" summary="Note">
@@ -128,46 +118,47 @@
 </td></tr>
</table></div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.constructor_with_setup___cleanup"></a><a href="thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.constructor_with_setup___cleanup" title="Constructor
- with setup & cleanup">Constructor
+<a name="toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.constructor_with_setup___cleanup"></a><a class="link" href="thread_decoration_hpp.html#toward_boost_interthreads.reference.thread_decoration_hpp.thread_decoration.constructor_with_setup___cleanup" title="Constructor with setup & cleanup">Constructor
 with setup & cleanup</a>
</h5></div></div></div>
-<pre class="programlisting">
- template<typename Callable1,typename Callable2>
- thread_decoration(Callable1 setup, Callable2 cleanup);
-de</pre>
+<pre class="programlisting">template<typename Callable1,typename Callable2>
+thread_decoration(Callable1 setup, Callable2 cleanup);
+</pre>
<div class="variablelist">

<dl>
<dt>Requires:</dt>
<dd>
- <code class="computeroutput">Callable1</code> &
- <code class="computeroutput">Callable1</code> are <code class="computeroutput">CopyConstructible</code>. Copying <code class="computeroutput">setup</code> or <code class="computeroutput">cleanup</code>
- shall have no side effects, and the effect of calling the copy shall
- be equivalent to calling the original.
- </dd>
+ <code class="computeroutput">Callable1</code> &
+ <code class="computeroutput">Callable1</code> are
+ <code class="computeroutput">CopyConstructible</code>.
+ Copying <code class="computeroutput">setup</code> or
+ <code class="computeroutput">cleanup</code> shall have
+ no side effects, and the effect of calling the copy shall be equivalent
+ to calling the original.
+ </dd>
<dt>Effects:</dt>
<dd>
- <code class="computeroutput">setup</code> and <code class="computeroutput">cleanup</code> are copied into storage
- managed internally by the library, and the <code class="computeroutput">setup</code>
- copy is invoked by the <code class="computeroutput">decorate()</code> function. If successful the cleanup
- function is registered to the to the thread exit handler.
- </dd>
+ <code class="computeroutput">setup</code> and <code class="computeroutput">cleanup</code> are copied into storage
+ managed internally by the library, and the <code class="computeroutput">setup</code>
+ copy is invoked by the <code class="computeroutput">decorate()</code> function. If successful the cleanup
+ function is registered to the to the thread exit handler.
+ </dd>
<dt>Postconditions:</dt>
<dd>
- <code class="computeroutput">*this</code>
- refers to a decoration.
- </dd>
+ <code class="computeroutput">*this</code>
+ refers to a decoration.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Thread safety:</dt>
<dd>
- unsafe
- </dd>
+ unsafe
+ </dd>
</dl>
</div>
<div class="note"><table border="0" summary="Note">

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_decorator_hpp.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_decorator_hpp.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_decorator_hpp.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,17 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>
- Header <boost/interthreads/thread_decorator.hpp></title>
+<title>Header <boost/interthreads/thread_decorator.hpp></title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../reference.html" title=" Reference">
-<link rel="prev" href="thread_decoration_hpp.html" title="
- Header <boost/interthreads/thread_decoration.hpp>">
-<link rel="next" href="thread_specific_shared_ptr_hpp.html" title="
- Header <boost/interthreads/thread_specific_shared_ptr.hpp>">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="thread_decoration_hpp.html" title="Header <boost/interthreads/thread_decoration.hpp>">
+<link rel="next" href="thread_specific_shared_ptr_hpp.html" title="Header <boost/interthreads/thread_specific_shared_ptr.hpp>">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -26,67 +22,60 @@
<div class="spirit-nav">
<a accesskey="p" href="thread_decoration_hpp.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="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="thread_specific_shared_ptr_hpp.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.reference.thread_decorator_hpp"></a><a href="thread_decorator_hpp.html" title="
- Header <boost/interthreads/thread_decorator.hpp>">
- Header <code class="computeroutput"><boost/interthreads/thread_decorator.hpp></code></a>
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp"></a><a class="link" href="thread_decorator_hpp.html" title="Header <boost/interthreads/thread_decorator.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/thread_decorator.hpp></code></a>
</h3></div></div></div>
<div class="toc"><dl>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator">
- Class <code class="computeroutput">thread_decorator</code></a></dt>
+<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator">Class
+ <code class="computeroutput">thread_decorator</code></a></dt>
<dd><dl>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructor">
- Constructor</a></dt>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructorn">
- Constructor</a></dt>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_move_constructor">
- Copy Move Constructor</a></dt>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_constructor">
- Assign Move Constructor</a></dt>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_conversion">
- Member Function <code class="computeroutput">operator detail::thread_move_t<thread_decorator>()</code></a></dt>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_move">
- Member Function <code class="computeroutput">move()</code></a></dt>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_swap">
- Member Function <code class="computeroutput">swap()</code></a></dt>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_operator_f">
- Member Function <code class="computeroutput">operator()()</code></a></dt>
+<dt>Constructor</dt>
+<dt>Constructor</dt>
+<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_move_constructor">Copy
+ Move Constructor</a></dt>
+<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_constructor">Assign
+ Move Constructor</a></dt>
+<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_conversion">Member
+ Function <code class="computeroutput">operator detail::thread_move_t<thread_decorator>()</code></a></dt>
+<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_move">Member
+ Function <code class="computeroutput">move()</code></a></dt>
+<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_swap">Member
+ Function <code class="computeroutput">swap()</code></a></dt>
+<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_operator_f">Member
+ Function <code class="computeroutput">operator()()</code></a></dt>
</dl></dd>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.decorate">
- Non Member Function <code class="computeroutput">decorate()</code></a></dt>
+<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.decorate">Non
+ Member Function <code class="computeroutput">decorate()</code></a></dt>
</dl></div>
-<pre class="programlisting">
- namespace boost {
- namespace interthreads {
- class thread_decorator;
- void decorate();
- }
- }
-l#>/</</pre>
-<div class="section" lang="en">
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+ class thread_decorator;
+ void decorate();
+}
+}
+</pre>
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator"></a><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator" title="
- Class thread_decorator">
- Class <code class="computeroutput">thread_decorator</code></a>
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator"></a><a class="link" href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator" title="Class thread_decorator">Class
+ <code class="computeroutput">thread_decorator</code></a>
</h4></div></div></div>
<div class="toc"><dl>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructor">
- Constructor</a></dt>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructorn">
- Constructor</a></dt>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_move_constructor">
- Copy Move Constructor</a></dt>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_constructor">
- Assign Move Constructor</a></dt>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_conversion">
- Member Function <code class="computeroutput">operator detail::thread_move_t<thread_decorator>()</code></a></dt>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_move">
- Member Function <code class="computeroutput">move()</code></a></dt>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_swap">
- Member Function <code class="computeroutput">swap()</code></a></dt>
-<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_operator_f">
- Member Function <code class="computeroutput">operator()()</code></a></dt>
+<dt>Constructor</dt>
+<dt>Constructor</dt>
+<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_move_constructor">Copy
+ Move Constructor</a></dt>
+<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_constructor">Assign
+ Move Constructor</a></dt>
+<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_conversion">Member
+ Function <code class="computeroutput">operator detail::thread_move_t<thread_decorator>()</code></a></dt>
+<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_move">Member
+ Function <code class="computeroutput">move()</code></a></dt>
+<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_swap">Member
+ Function <code class="computeroutput">swap()</code></a></dt>
+<dt><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_operator_f">Member
+ Function <code class="computeroutput">operator()()</code></a></dt>
</dl></div>

 <code class="computeroutput">thread_decorator</code> is a functor
@@ -94,35 +83,33 @@
 which will be called only once by thread: decoration's setup are called
 before the thread function and decoration's cleanup at thread exit.
 
-<pre class="programlisting">
- class thread_decorator {
- public:
+<pre class="programlisting">class thread_decorator {
+public:

- template <class Callable>
- explicit thread_decorator(Callable&& f);
- template <class Callable>
- explicit thread_decorator(detail::thread_move_t<Callable> f):
- template<typename Callable>
- thread_decorator(Callable f,
- typename disable_if<boost::is_convertible<F&,detail::thread_move_t<F> >
- , detail::dummy* >::type=0);
+ template <class Callable>
+ explicit thread_decorator(Callable&& f);
+ template <class Callable>
+ explicit thread_decorator(detail::thread_move_t<Callable> f):
+ template<typename Callable>
+ thread_decorator(Callable f,
+ typename disable_if<boost::is_convertible<F&,detail::thread_move_t<F> >
+ , detail::dummy* >::type=0);

- template <typename Callable, typename A1, typename A2, ...>
- thread_decorator(Callable f, A1 a1, A2 a2, ...)
+ template <typename Callable, typename A1, typename A2, ...>
+ thread_decorator(Callable f, A1 a1, A2 a2, ...)

- thread_decorator(thread_decorator&& other);
-
- thread_decorator& operator=(thread_decorator&& other);
+ thread_decorator(thread_decorator&& other);
+
+ thread_decorator& operator=(thread_decorator&& other);

- thread_decorator&& move();
-
- void swap(thread_decorator& x);
+ thread_decorator&& move();
+
+ void swap(thread_decorator& x);

- void operator ()();
+ void operator ()();

- };
-########a#####Su#A
-##8iv#8</pre>
+};
+</pre>

 Functor wrapping the user function thread to ensure that all the decorations
 are called.
@@ -133,15 +120,14 @@
 from functions. This allows the details of thread decoration to be wrapped
 in a function.
 
-<pre class="programlisting">
- thread_decorator make_decorator();
+<pre class="programlisting">thread_decorator make_decorator();

- void f()
- {
- boot::thread some_thread(make_decorator());
- some_thread.join();
- }
-e=#iden</pre>
+void f()
+{
+ boot::thread some_thread(make_decorator());
+ some_thread.join();
+}
+</pre>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
@@ -163,310 +149,290 @@
 
</td></tr>
</table></div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructor"></a><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructor" title="
- Constructor">
- Constructor</a>
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructor"></a><a class="link" href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructor" title="Constructor">Constructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- template <class Callable>
- thread_decorator(Callable&& func);
- template<typename Callable>
- thread_decorator(Callable func);
-ignm</pre>
+<pre class="programlisting">template <class Callable>
+thread_decorator(Callable&& func);
+template<typename Callable>
+thread_decorator(Callable func);
+</pre>
<div class="variablelist">

<dl>
<dt>Template parameters:</dt>
<dd>
- <code class="computeroutput">Callable</code> must by
- <code class="computeroutput">CopyConstructible</code>.
- </dd>
+ <code class="computeroutput">Callable</code> must by
+ <code class="computeroutput">CopyConstructible</code>.
+ </dd>
<dt>Effects:</dt>
<dd>
- <code class="computeroutput">func</code> is copied into
- storage managed internally by the library, and that copy will be
- invoked after the operator() function when the decorate is used as
- Callable of a newly-created thread of execution.
- </dd>
+ <code class="computeroutput">func</code> is copied
+ into storage managed internally by the library, and that copy will
+ be invoked after the operator() function when the decorate is used
+ as Callable of a newly-created thread of execution.
+ </dd>
<dt>Throws:</dt>
<dd>
- <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
- </dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- safe
- </dd>
+ safe
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructorn"></a><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructorn" title="
- Constructor">
- Constructor</a>
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructorn"></a><a class="link" href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_constructorn" title="Constructor">Constructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- template <typename Callable, typename A1, typename A2, ...>
- thread_decorator(Callable func, A1 a1, A2 a2, ...)
-e></pre>
+<pre class="programlisting">template <typename Callable, typename A1, typename A2, ...>
+thread_decorator(Callable func, A1 a1, A2 a2, ...)
+</pre>
<div class="variablelist">

<dl>
<dt>Template parameters:</dt>
<dd>
- <code class="computeroutput">Callable</code> must by
- <code class="computeroutput">CopyConstructible</code>.
- </dd>
+ <code class="computeroutput">Callable</code> must by
+ <code class="computeroutput">CopyConstructible</code>.
+ </dd>
<dt>Effects:</dt>
<dd>
- <code class="computeroutput">func</code> is copied into
- storage managed internally by the library, and that copy will be
- invoked after the operator() function when the decorate is used as
- Callable of a newly-created thread of execution.
- </dd>
+ <code class="computeroutput">func</code> is copied
+ into storage managed internally by the library, and that copy will
+ be invoked after the operator() function when the decorate is used
+ as Callable of a newly-created thread of execution.
+ </dd>
<dt>Throws:</dt>
<dd>
- <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
- </dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- safe
- </dd>
+ safe
+ </dd>
<dt>Limitations:</dt>
<dd>
- The current implementation defines overloads up to four parameters.
- </dd>
+ The current implementation defines overloads up to four parameters.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_move_constructor"></a><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_move_constructor" title="
- Copy Move Constructor">
- Copy Move Constructor</a>
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_move_constructor"></a><a class="link" href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_move_constructor" title="Copy Move Constructor">Copy
+ Move Constructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- thread_decorator(thread_decorator&& other);
- thread_decorator(detail::thread_move_t<thread_decorator> other) {
-se</pre>
+<pre class="programlisting">thread_decorator(thread_decorator&& other);
+thread_decorator(detail::thread_move_t<thread_decorator> other) {
+</pre>
<div class="variablelist">

<dl>
<dt>Template parameters:</dt>
<dd>
- <code class="computeroutput">Callable</code> must by
- <code class="computeroutput">CopyConstructible</code>.
- </dd>
+ <code class="computeroutput">Callable</code> must by
+ <code class="computeroutput">CopyConstructible</code>.
+ </dd>
<dt>Effects:</dt>
<dd>
- <code class="computeroutput">func</code> is copied into
- storage managed internally by the library, and that copy will be
- invoked after the operator() function when the decorate is used as
- Callable of a newly-created thread of execution.
- </dd>
+ <code class="computeroutput">func</code> is copied
+ into storage managed internally by the library, and that copy will
+ be invoked after the operator() function when the decorate is used
+ as Callable of a newly-created thread of execution.
+ </dd>
<dt>Throws:</dt>
<dd>
- <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
- </dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- safe
- </dd>
+ safe
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_constructor"></a><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_constructor" title="
- Assign Move Constructor">
- Assign Move Constructor</a>
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_constructor"></a><a class="link" href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_decorate_copy_constructor" title="Assign Move Constructor">Assign
+ Move Constructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- thread_decorator& operator=(thread_decorator&& other);
- thread_decorator& operator=(detail::thread_move_t<thread_decorator> x) {
-so</pre>
+<pre class="programlisting">thread_decorator& operator=(thread_decorator&& other);
+thread_decorator& operator=(detail::thread_move_t<thread_decorator> x) {
+</pre>
<div class="variablelist">

<dl>
<dt>Requires:</dt>
<dd>
- <code class="computeroutput">Callable</code> must by
- <code class="computeroutput">CopyConstructible</code>.
- </dd>
+ <code class="computeroutput">Callable</code> must by
+ <code class="computeroutput">CopyConstructible</code>.
+ </dd>
<dt>Effects:</dt>
<dd>
- <code class="computeroutput">func</code> is copied into
- storage managed internally by the library, and that copy will be
- invoked after the operator() function when the decorate is used as
- Callable of a newly-created thread of execution.
- </dd>
+ <code class="computeroutput">func</code> is copied
+ into storage managed internally by the library, and that copy will
+ be invoked after the operator() function when the decorate is used
+ as Callable of a newly-created thread of execution.
+ </dd>
<dt>Returns:</dt>
<dd>
- a reference to <code class="computeroutput">*this</code>.
- </dd>
+ a reference to <code class="computeroutput">*this</code>.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing.
- </dd>
+ Nothing.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- neutral
- </dd>
+ neutral
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_conversion"></a><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_conversion" title="
- Member Function operator detail::thread_move_t<thread_decorator>()">
- Member Function <code class="computeroutput">operator detail::thread_move_t<thread_decorator>()</code></a>
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_conversion"></a><a class="link" href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_conversion" title="Member Function operator detail::thread_move_t<thread_decorator>()">Member
+ Function <code class="computeroutput">operator detail::thread_move_t<thread_decorator>()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- operator detail::thread_move_t<thread_decorator>();
-a</pre>
+<pre class="programlisting">operator detail::thread_move_t<thread_decorator>();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- helper for move semantics emulation.
- </dd>
+ helper for move semantics emulation.
+ </dd>
<dt>Returns:</dt>
<dd>
- the move form <code class="computeroutput">*this</code>.
- </dd>
+ the move form <code class="computeroutput">*this</code>.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing.
- </dd>
+ Nothing.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- neutral
- </dd>
+ neutral
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_move"></a><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_move" title="
- Member Function move()">
- Member Function <code class="computeroutput">move()</code></a>
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_move"></a><a class="link" href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_move" title="Member Function move()">Member
+ Function <code class="computeroutput">move()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- detail::thread_move_t<thread_decorator> move() {
- thread_decorator&& move();
-ra</pre>
+<pre class="programlisting">detail::thread_move_t<thread_decorator> move() {
+thread_decorator&& move();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Move *this to the caller.
- </dd>
+ Move *this to the caller.
+ </dd>
<dt>Returns:</dt>
<dd>
- the move form <code class="computeroutput">*this</code>.
- </dd>
+ the move form <code class="computeroutput">*this</code>.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing.
- </dd>
+ Nothing.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- neutral
- </dd>
+ neutral
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_swap"></a><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_swap" title="
- Member Function swap()">
- Member Function <code class="computeroutput">swap()</code></a>
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_swap"></a><a class="link" href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_swap" title="Member Function swap()">Member
+ Function <code class="computeroutput">swap()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- void swap(thread_decorator& x);
-#</pre>
+<pre class="programlisting">void swap(thread_decorator& x);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
-<dd>
- </dd>
+<dd></dd>
<dt>Throws:</dt>
<dd>
- Nothing.
- </dd>
+ Nothing.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- neutral
- </dd>
+ neutral
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_operator_f"></a><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_operator_f" title="
- Member Function operator()()">
- Member Function <code class="computeroutput">operator()()</code></a>
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_operator_f"></a><a class="link" href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.thread_decorator.decorator_thread_decoration_operator_f" title="Member Function operator()()">Member
+ Function <code class="computeroutput">operator()()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- void operator()();
-t</pre>
+<pre class="programlisting">void operator()();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Functor operator
- </dd>
+ Functor operator
+ </dd>
<dt>Throws:</dt>
<dd>
- Any exception thrown by the decorations or the user function.
- </dd>
+ Any exception thrown by the decorations or the user function.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- unsafe - depends on the decorations construction/destruction.
- </dd>
+ unsafe - depends on the decorations construction/destruction.
+ </dd>
</dl>
</div>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.thread_decorator_hpp.decorate"></a><a href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.decorate" title="
- Non Member Function decorate()">
- Non Member Function <code class="computeroutput">decorate()</code></a>
+<a name="toward_boost_interthreads.reference.thread_decorator_hpp.decorate"></a><a class="link" href="thread_decorator_hpp.html#toward_boost_interthreads.reference.thread_decorator_hpp.decorate" title="Non Member Function decorate()">Non
+ Member Function <code class="computeroutput">decorate()</code></a>
</h4></div></div></div>
-<pre class="programlisting">
- void decorate();
-#</pre>
+<pre class="programlisting">void decorate();
+</pre>
<div class="variablelist">

<dl>
<dt>Requires:</dt>
<dd>
- <code class="computeroutput">Callable</code> is <code class="computeroutput">CopyConstructible</code>. Copying <code class="computeroutput">f</code> shall have no side effects, and
- the effect of calling the copy shall be equivalent to calling the original.
- </dd>
+ <code class="computeroutput">Callable</code> is <code class="computeroutput">CopyConstructible</code>. Copying <code class="computeroutput">f</code> shall have no side effects, and
+ the effect of calling the copy shall be equivalent to calling the
+ original.
+ </dd>
<dt>Effects:</dt>
<dd>
- Calls every declared decoration using the thread_decoration class.
- </dd>
+ Calls every declared decoration using the thread_decoration class.
+ </dd>
<dt>Postconditions:</dt>
<dd>
- All the decorations have been called.
- </dd>
+ All the decorations have been called.
+ </dd>
<dt>Throws:</dt>
<dd>
- Any exception thrown by the decorations.
- </dd>
+ Any exception thrown by the decorations.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- unsafe - depends on the decorations construction/destruction.
- </dd>
+ unsafe - depends on the decorations construction/destruction.
+ </dd>
</dl>
</div>
</div>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_group_once_hpp.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_group_once_hpp.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_group_once_hpp.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,15 +1,12 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>
- Header <boost/interthreads/thread_group_once.hpp></title>
+<title>Header <boost/interthreads/thread_group_once.hpp></title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../reference.html" title=" Reference">
-<link rel="prev" href="thread_tuple_once_hpp.html" title="
- Header <boost/interthreads/thread_tuple_once.hpp>">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="thread_tuple_once_hpp.html" title="Header <boost/interthreads/thread_tuple_once.hpp>">
<link rel="next" href="../examples.html" title="Examples">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -25,433 +22,400 @@
<div class="spirit-nav">
<a accesskey="p" href="thread_tuple_once_hpp.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="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../examples.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.reference.thread_group_once_hpp"></a><a href="thread_group_once_hpp.html" title="
- Header <boost/interthreads/thread_group_once.hpp>">
- Header <code class="computeroutput"><boost/interthreads/thread_group_once.hpp></code></a>
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp"></a><a class="link" href="thread_group_once_hpp.html" title="Header <boost/interthreads/thread_group_once.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/thread_group_once.hpp></code></a>
</h3></div></div></div>
<div class="toc"><dl>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class">
- Template Class <code class="computeroutput">thread_group_once<></code></a></dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class">Template
+ Class <code class="computeroutput">thread_group_once<></code></a></dt>
<dd><dl>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_callable_constructor">
- Constructor</a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_destructor">
- Destructor</a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_joinable">
- Member function <code class="computeroutput">joinables()</code></a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_join">
- Member function <code class="computeroutput">join_all()</code></a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_timed_join">
- Member function <code class="computeroutput">join_all_until()</code></a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.join_first_then_interrupt">
- Member function <code class="computeroutput">join_any()</code></a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.timed_join_first_then_interrupt">
- Member function <code class="computeroutput">join_any_until()</code></a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.detach_all">
- Member function <code class="computeroutput">detach_all()</code></a></dt>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_joinable">Member
+ function <code class="computeroutput">joinables()</code></a></dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_join">Member
+ function <code class="computeroutput">join_all()</code></a></dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_timed_join">Member
+ function <code class="computeroutput">join_all_until()</code></a></dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.join_first_then_interrupt">Member
+ function <code class="computeroutput">join_any()</code></a></dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.timed_join_first_then_interrupt">Member
+ function <code class="computeroutput">join_any_until()</code></a></dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.detach_all">Member
+ function <code class="computeroutput">detach_all()</code></a></dt>
<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.member_function__interrupt_all___">Member
 function <code class="computeroutput">interrupt_all()</code></a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_size">
- Member function <code class="computeroutput">size()</code></a></dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_size">Member
+ function <code class="computeroutput">size()</code></a></dt>
</dl></dd>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_make_thread_group_once">
- Non Member Function <code class="computeroutput">make_thread_group_once()</code></a></dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_make_thread_group_once">Non
+ Member Function <code class="computeroutput">make_thread_group_once()</code></a></dt>
</dl></div>
-<pre class="programlisting">
- namespace boost {
- namespace interthreads {
+<pre class="programlisting">namespace boost {
+namespace interthreads {

- template <std::size_t N>
- class thread_group;
+ template <std::size_t N>
+ class thread_group;

- }
- }
-hrase><p</pre>
-<div class="section" lang="en">
+}
+}
+</pre>
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class"></a><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class" title="
- Template Class thread_group_once<>">
- Template Class <code class="computeroutput">thread_group_once<></code></a>
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class"></a><a class="link" href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class" title="Template Class thread_group_once<>">Template
+ Class <code class="computeroutput">thread_group_once<></code></a>
</h4></div></div></div>
<div class="toc"><dl>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_callable_constructor">
- Constructor</a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_destructor">
- Destructor</a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_joinable">
- Member function <code class="computeroutput">joinables()</code></a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_join">
- Member function <code class="computeroutput">join_all()</code></a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_timed_join">
- Member function <code class="computeroutput">join_all_until()</code></a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.join_first_then_interrupt">
- Member function <code class="computeroutput">join_any()</code></a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.timed_join_first_then_interrupt">
- Member function <code class="computeroutput">join_any_until()</code></a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.detach_all">
- Member function <code class="computeroutput">detach_all()</code></a></dt>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_joinable">Member
+ function <code class="computeroutput">joinables()</code></a></dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_join">Member
+ function <code class="computeroutput">join_all()</code></a></dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_timed_join">Member
+ function <code class="computeroutput">join_all_until()</code></a></dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.join_first_then_interrupt">Member
+ function <code class="computeroutput">join_any()</code></a></dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.timed_join_first_then_interrupt">Member
+ function <code class="computeroutput">join_any_until()</code></a></dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.detach_all">Member
+ function <code class="computeroutput">detach_all()</code></a></dt>
<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.member_function__interrupt_all___">Member
 function <code class="computeroutput">interrupt_all()</code></a></dt>
-<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_size">
- Member function <code class="computeroutput">size()</code></a></dt>
+<dt><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_size">Member
+ function <code class="computeroutput">size()</code></a></dt>
</dl></div>

 <code class="computeroutput">thread_group_once<></code>
 is an extension of the boost::thread_group which allows to join the thread
 finishing the first, using for that the set_once synchronizer.
 
-<pre class="programlisting">
- template <std::size_t n>
- class thread_group_once {
- public:
- thread_group_once();
- ~thread_group_once();
-
- template<typename F>
- thread* create_thread(F threadfunc);
- void remove_thread(thread* thrd);
+<pre class="programlisting">template <std::size_t n>
+class thread_group_once {
+public:
+ thread_group_once();
+ ~thread_group_once();
+
+ template<typename F>
+ thread* create_thread(F threadfunc);
+ void remove_thread(thread* thrd);

- // move support
- thread_group_once(boost::move_t<thread_group_once<n>> x);
- thread_group_once& operator=(boost::move_t<thread_group_once<n>> x);
- operator boost::move_t<thread_group_once<n>>();
- boost::move_t<thread_group_once<n>> move();
+ // move support
+ thread_group_once(boost::move_t<thread_group_once<n>> x);
+ thread_group_once& operator=(boost::move_t<thread_group_once<n>> x);
+ operator boost::move_t<thread_group_once<n>>();
+ boost::move_t<thread_group_once<n>> move();

- void swap(thread_group_once<n>& x);
+ void swap(thread_group_once<n>& x);

- bool joinables() const;
-
- void join_all();
- bool join_all_until(const system_time& wait_until);
- template<typename TimeDuration>
- bool join_all_for(TimeDuration const& rel_time);
+ bool joinables() const;
+
+ void join_all();
+ bool join_all_until(const system_time& wait_until);
+ template<typename TimeDuration>
+ bool join_all_for(TimeDuration const& rel_time);

- std::size_t join_any();
- std::pair<bool,std::size_t> join_any_until(
- const system_time& wait_until);
- template<typename TimeDuration>
- std::pair<bool,std::size_t> join_any_for(
- TimeDuration const& rel_time);
+ std::size_t join_any();
+ std::pair<bool,std::size_t> join_any_until(
+ const system_time& wait_until);
+ template<typename TimeDuration>
+ std::pair<bool,std::size_t> join_any_for(
+ TimeDuration const& rel_time);

- void detach_all();
+ void detach_all();

- void interrupt_all();
- bool interruption_requested() const;
+ void interrupt_all();
+ bool interruption_requested() const;

- size_t size();
-
- const thread& operator[](std::size_t i);
- };
- }
- }
-#######a####X8v#X8v############a####p8v#p8v</pre>
-<div class="section" lang="en">
+ size_t size();
+
+ const thread& operator[](std::size_t i);
+};
+}
+}
+</pre>
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_callable_constructor"></a><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_callable_constructor" title="
- Constructor">
- Constructor</a>
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_callable_constructor"></a><a class="link" href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_callable_constructor" title="Constructor">Constructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- thread_group_once();
-h</pre>
+<pre class="programlisting">thread_group_once();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- creates a thread group.
- </dd>
+ creates a thread group.
+ </dd>
<dt>Postconditions:</dt>
<dd>
- <code class="computeroutput">*this</code>
- refers to the newly created group of threads of execution.
- </dd>
+ <code class="computeroutput">*this</code>
+ refers to the newly created group of threads of execution.
+ </dd>
<dt>Throws:</dt>
<dd>
- <code class="computeroutput">boost::thread_resource_error</code> if an error
- occurs.
- </dd>
+ <code class="computeroutput">boost::thread_resource_error</code> if an error
+ occurs.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_destructor"></a><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_destructor" title="
- Destructor">
- Destructor</a>
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_destructor"></a><a class="link" href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_destructor" title="Destructor">Destructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- ~thread_group_once();
-#</pre>
+<pre class="programlisting">~thread_group_once();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- If *this have associateds thread of execution, calls detach() on
- them. Destroys *this.
- </dd>
+ If *this have associateds thread of execution, calls detach() on
+ them. Destroys *this.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_joinable"></a><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_joinable" title="
- Member function joinables()">
- Member function <code class="computeroutput">joinables()</code></a>
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_joinable"></a><a class="link" href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_joinable" title="Member function joinables()">Member
+ function <code class="computeroutput">joinables()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- bool joinables() const;
-s</pre>
+<pre class="programlisting">bool joinables() const;
+</pre>
<div class="variablelist">

<dl>
<dt>Returns:</dt>
<dd>
- <code class="computeroutput">true</code> if <code class="computeroutput">*this</code>
- refers to threads of execution, <code class="computeroutput">false</code>
- otherwise.
- </dd>
+ <code class="computeroutput">true</code> if <code class="computeroutput">*this</code>
+ refers to threads of execution, <code class="computeroutput">false</code>
+ otherwise.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_join"></a><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_join" title="
- Member function join_all()">
- Member function <code class="computeroutput">join_all()</code></a>
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_join"></a><a class="link" href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_join" title="Member function join_all()">Member
+ function <code class="computeroutput">join_all()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- void join_all();
-e</pre>
+<pre class="programlisting">void join_all();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">join()</code>
- on each <code class="computeroutput">boost::thread</code> object in the group.
- </dd>
+ Call <code class="computeroutput">join()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the group.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- Every thread in the group has terminated.
- </dd>
+ Every thread in the group has terminated.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Note:</dt>
<dd>
- Since <code class="computeroutput">boost::thread::join</code> is one of the predefined interruption
- points, <code class="computeroutput">thread_group_once<>::join_all()</code> is also an interruption point.
- </dd>
+ Since <code class="computeroutput">boost::thread::join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_group_once<>::join_all()</code> is also an interruption point.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_timed_join"></a><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_timed_join" title="
- Member function join_all_until()">
- Member function <code class="computeroutput">join_all_until()</code></a>
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_timed_join"></a><a class="link" href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_timed_join" title="Member function join_all_until()">Member
+ function <code class="computeroutput">join_all_until()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- bool join_all_until(const system_time& wait_until);
- template<typename TimeDuration>
- bool join_all_for(TimeDuration const& rel_time);
-rol</pre>
+<pre class="programlisting">bool join_all_until(const system_time& wait_until);
+template<typename TimeDuration>
+bool join_all_for(TimeDuration const& rel_time);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">timed_join()</code>
- on each <code class="computeroutput">boost::thread</code> object in the group.
- </dd>
+ Call <code class="computeroutput">timed_join()</code> on each <code class="computeroutput">boost::thread</code>
+ object in the group.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- Every thread in the group has terminated.
- </dd>
+ Every thread in the group has terminated.
+ </dd>
<dt>Returns:</dt>
<dd>
- true if joined.
- </dd>
+ true if joined.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Note:</dt>
<dd>
- Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
- interruption points, <code class="computeroutput">thread_group_once<>::timed_join_all()</code> is also an interruption point.
- </dd>
+ Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_group_once<>::timed_join_all()</code> is also an interruption point.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.join_first_then_interrupt"></a><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.join_first_then_interrupt" title="
- Member function join_any()">
- Member function <code class="computeroutput">join_any()</code></a>
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.join_first_then_interrupt"></a><a class="link" href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.join_first_then_interrupt" title="Member function join_any()">Member
+ function <code class="computeroutput">join_any()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- std::size_t join_any();
-0</pre>
+<pre class="programlisting">std::size_t join_any();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">join_any()</code>
- and the <code class="computeroutput">interrup_all()</code>.
- </dd>
+ Call <code class="computeroutput">join_any()</code>
+ and the <code class="computeroutput">interrup_all()</code>.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- Every thread in the group has terminated.
- </dd>
+ Every thread in the group has terminated.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Note:</dt>
<dd>
- Since <code class="computeroutput">join_any</code> is
- one of the predefined interruption points, <code class="computeroutput">thread_group_once<>::join_any()</code> is also an interruption point.
- </dd>
+ Since <code class="computeroutput">join_any</code>
+ is one of the predefined interruption points, <code class="computeroutput">thread_group_once<>::join_any()</code> is also an interruption point.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.timed_join_first_then_interrupt"></a><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.timed_join_first_then_interrupt" title="
- Member function join_any_until()">
- Member function <code class="computeroutput">join_any_until()</code></a>
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.timed_join_first_then_interrupt"></a><a class="link" href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.timed_join_first_then_interrupt" title="Member function join_any_until()">Member
+ function <code class="computeroutput">join_any_until()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- std::pair<bool,std::size_t> join_any_until(
- const system_time& wait_until);
- template<typename TimeDuration>
- std::pair<bool,std::size_t> join_any_for(
- TimeDuration const& rel_time);
-de>#1</pre>
+<pre class="programlisting">std::pair<bool,std::size_t> join_any_until(
+ const system_time& wait_until);
+template<typename TimeDuration>
+std::pair<bool,std::size_t> join_any_for(
+ TimeDuration const& rel_time);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">get_until()</code>
- and the <code class="computeroutput">interrup_all()</code>.
- </dd>
+ Call <code class="computeroutput">get_until()</code> and the <code class="computeroutput">interrup_all()</code>.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- Every thread in the group has terminated.
- </dd>
+ Every thread in the group has terminated.
+ </dd>
<dt>Returns:</dt>
<dd>
- true if joined.
- </dd>
+ true if joined.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Note:</dt>
<dd>
- Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
- interruption points, <code class="computeroutput">thread_group_once<>::timed_join_all()</code> is also an interruption point.
- </dd>
+ Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_group_once<>::timed_join_all()</code> is also an interruption point.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.detach_all"></a><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.detach_all" title="
- Member function detach_all()">
- Member function <code class="computeroutput">detach_all()</code></a>
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.detach_all"></a><a class="link" href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.detach_all" title="Member function detach_all()">Member
+ function <code class="computeroutput">detach_all()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- void detach_all();
-<</pre>
+<pre class="programlisting">void detach_all();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">detach()</code>
- on each <code class="computeroutput">boost::thread</code> object in the group.
- </dd>
+ Call <code class="computeroutput">detach()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the group.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.member_function__interrupt_all___"></a><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.member_function__interrupt_all___" title="Member
- function interrupt_all()">Member
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.member_function__interrupt_all___"></a><a class="link" href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.member_function__interrupt_all___" title="Member function interrupt_all()">Member
 function <code class="computeroutput">interrupt_all()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- void interrupt_all();
-a</pre>
+<pre class="programlisting">void interrupt_all();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">thread::interrupt()</code>
- on each <code class="computeroutput">boost::thread</code> object in the group.
- </dd>
+ Call <code class="computeroutput">thread::interrupt()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the group.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_size"></a><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_size" title="
- Member function size()">
- Member function <code class="computeroutput">size()</code></a>
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_size"></a><a class="link" href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_class.thread_group_once_size" title="Member function size()">Member
+ function <code class="computeroutput">size()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
-int size();
+<pre class="programlisting">int size();
</pre>
<div class="variablelist">

<dl>
<dt>Returns:</dt>
<dd>
- The number of threads in the group.
- </dd>
+ The number of threads in the group.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing.
- </dd>
+ Nothing.
+ </dd>
</dl>
</div>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_make_thread_group_once"></a><a href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_make_thread_group_once" title="
- Non Member Function make_thread_group_once()">
- Non Member Function <code class="computeroutput">make_thread_group_once()</code></a>
+<a name="toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_make_thread_group_once"></a><a class="link" href="thread_group_once_hpp.html#toward_boost_interthreads.reference.thread_group_once_hpp.thread_group_once_make_thread_group_once" title="Non Member Function make_thread_group_once()">Non
+ Member Function <code class="computeroutput">make_thread_group_once()</code></a>
</h4></div></div></div>
-<pre class="programlisting">
- template<typename F0, ..., typename Fn-1>
- thread_group_once make_thread_group_once(F0 f0, ..., Fn fn-1);
-e></pre>
+<pre class="programlisting">template<typename F0, ..., typename Fn-1>
+thread_group_once make_thread_group_once(F0 f0, ..., Fn fn-1);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- makes a new thread_group_once<>.
- </dd>
+ makes a new thread_group_once<>.
+ </dd>
<dt>Returns:</dt>
<dd>
- the created thread group.
- </dd>
+ the created thread group.
+ </dd>
</dl>
</div>
</div>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_specific_shared_ptr_hpp.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_specific_shared_ptr_hpp.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_specific_shared_ptr_hpp.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,17 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>
- Header <boost/interthreads/thread_specific_shared_ptr.hpp></title>
+<title>Header <boost/interthreads/thread_specific_shared_ptr.hpp></title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../reference.html" title=" Reference">
-<link rel="prev" href="thread_decorator_hpp.html" title="
- Header <boost/interthreads/thread_decorator.hpp>">
-<link rel="next" href="keep_alive_file_hpp.html" title="
- Header <boost/interthreads/thread_keep_alive.hpp>">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="thread_decorator_hpp.html" title="Header <boost/interthreads/thread_decorator.hpp>">
+<link rel="next" href="keep_alive_file_hpp.html" title="Header <boost/interthreads/thread_keep_alive.hpp>">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -26,256 +22,239 @@
<div class="spirit-nav">
<a accesskey="p" href="thread_decorator_hpp.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="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="keep_alive_file_hpp.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp"></a><a href="thread_specific_shared_ptr_hpp.html" title="
- Header <boost/interthreads/thread_specific_shared_ptr.hpp>">
- Header <code class="computeroutput"><boost/interthreads/thread_specific_shared_ptr.hpp></code></a>
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp"></a><a class="link" href="thread_specific_shared_ptr_hpp.html" title="Header <boost/interthreads/thread_specific_shared_ptr.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/thread_specific_shared_ptr.hpp></code></a>
</h3></div></div></div>
<div class="toc"><dl>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr">
- Template Class <code class="computeroutput">thread_specific_shared_ptr<></code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr">Template
+ Class <code class="computeroutput">thread_specific_shared_ptr<></code></a></dt>
<dd><dl>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_parameters">
- Template parameters</a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_types">
- Public types</a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_default_constructor">
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_parameters">Template
+ parameters</a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_types">Public
+ types</a></dt>
+<dt>Constructor</dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_constructor_with_custom_cleanup">Cleanup
 Constructor</a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_constructor_with_custom_cleanup">
- Cleanup Constructor</a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_destructor">
- Destructor</a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_get">
- Member Function <code class="computeroutput">get()</code></a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_arrow">
- Member Function <code class="computeroutput">operator->()</code></a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_star">
- Member Function <code class="computeroutput">operator*()</code></a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reset">
- Member Function <code class="computeroutput">reset()</code></a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_wait_and_get">
- Member Function <code class="computeroutput">wait_and_get()</code></a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operatora">
- Member Function <code class="computeroutput">operator[]()</code></a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_mutex">
- Member Function <code class="computeroutput">get_mutex()</code></a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_map">
- Member Function <code class="computeroutput">get_map()</code></a></dt>
+<dt>Destructor</dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_get">Member
+ Function <code class="computeroutput">get()</code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_arrow">Member
+ Function <code class="computeroutput">operator->()</code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_star">Member
+ Function <code class="computeroutput">operator*()</code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reset">Member
+ Function <code class="computeroutput">reset()</code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_wait_and_get">Member
+ Function <code class="computeroutput">wait_and_get()</code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operatora">Member
+ Function <code class="computeroutput">operator[]()</code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_mutex">Member
+ Function <code class="computeroutput">get_mutex()</code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_map">Member
+ Function <code class="computeroutput">get_map()</code></a></dt>
</dl></dd>
</dl></div>
-<pre class="programlisting">
- namespace boost {
- namespace interthreads {
-
- template <typename T>
- class thread_specific_shared_ptr;
-
- }
- }
-="bold"></pre>
-<div class="section" lang="en">
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+
+ template <typename T>
+ class thread_specific_shared_ptr;
+
+}
+}
+</pre>
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr"></a><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr" title="
- Template Class thread_specific_shared_ptr<>">
- Template Class <code class="computeroutput">thread_specific_shared_ptr<></code></a>
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr"></a><a class="link" href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr" title="Template Class thread_specific_shared_ptr<>">Template
+ Class <code class="computeroutput">thread_specific_shared_ptr<></code></a>
</h4></div></div></div>
<div class="toc"><dl>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_parameters">
- Template parameters</a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_types">
- Public types</a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_default_constructor">
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_parameters">Template
+ parameters</a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_types">Public
+ types</a></dt>
+<dt>Constructor</dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_constructor_with_custom_cleanup">Cleanup
 Constructor</a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_constructor_with_custom_cleanup">
- Cleanup Constructor</a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_destructor">
- Destructor</a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_get">
- Member Function <code class="computeroutput">get()</code></a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_arrow">
- Member Function <code class="computeroutput">operator->()</code></a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_star">
- Member Function <code class="computeroutput">operator*()</code></a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reset">
- Member Function <code class="computeroutput">reset()</code></a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_wait_and_get">
- Member Function <code class="computeroutput">wait_and_get()</code></a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operatora">
- Member Function <code class="computeroutput">operator[]()</code></a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_mutex">
- Member Function <code class="computeroutput">get_mutex()</code></a></dt>
-<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_map">
- Member Function <code class="computeroutput">get_map()</code></a></dt>
+<dt>Destructor</dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_get">Member
+ Function <code class="computeroutput">get()</code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_arrow">Member
+ Function <code class="computeroutput">operator->()</code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_star">Member
+ Function <code class="computeroutput">operator*()</code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reset">Member
+ Function <code class="computeroutput">reset()</code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_wait_and_get">Member
+ Function <code class="computeroutput">wait_and_get()</code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operatora">Member
+ Function <code class="computeroutput">operator[]()</code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_mutex">Member
+ Function <code class="computeroutput">get_mutex()</code></a></dt>
+<dt><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_map">Member
+ Function <code class="computeroutput">get_map()</code></a></dt>
</dl></div>

 <code class="computeroutput">bith::thread_specific_shared_ptr<></code>
 is an extension of the thread_specific_ptr providing access to the thread
 specific context from other threads.
 
-<pre class="programlisting">
- template <typename T>
- class thread_specific_shared_ptr : private noncopyable
- {
- public:
- typedef shared_ptr<T> shared_ptr_type;
- typedef 'implementation defined' map_type;
- typedef 'implementation defined' mutex_type;
- typedef 'implementation defined' lock_type;
+<pre class="programlisting">template <typename T>
+class thread_specific_shared_ptr : private noncopyable
+{
+public:
+ typedef shared_ptr<T> shared_ptr_type;
+ typedef 'implementation defined' map_type;
+ typedef 'implementation defined' mutex_type;
+ typedef 'implementation defined' lock_type;

- thread_specific_shared_ptr();
- explicit thread_specific_shared_ptr(void (*cleanup_)(shared_ptr_type));
- ~thread_specific_shared_ptr();
+ thread_specific_shared_ptr();
+ explicit thread_specific_shared_ptr(void (*cleanup_)(shared_ptr_type));
+ ~thread_specific_shared_ptr();

- T* get() const;
- T* operator->() const;
- T& operator*() const;
- void reset();
- template<class Y>
- void reset(Y * p);
- template<class Y, class D>
- void reset(Y * p, D d);
- template<class Y, class D, class A>
- void reset(Y * p, D d, A a);
-
- mutex_type& get_mutex();
- const map_type& get_map(lock_type&) const;
- shared_ptr_type operator[](thread::id id) const;
- shared_ptr_type wait_and_get(thread::id id) const;
- private:
- shared_ptr_type get_shared_ptr() const;
- };
-ad_specific_shared_ptr_hpp Head</pre>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_parameters"></a><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_parameters" title="
- Template parameters">
- Template parameters</a>
+ T* get() const;
+ T* operator->() const;
+ T& operator*() const;
+ void reset();
+ template<class Y>
+ void reset(Y * p);
+ template<class Y, class D>
+ void reset(Y * p, D d);
+ template<class Y, class D, class A>
+ void reset(Y * p, D d, A a);
+
+ mutex_type& get_mutex();
+ const map_type& get_map(lock_type&) const;
+ shared_ptr_type operator[](thread::id id) const;
+ shared_ptr_type wait_and_get(thread::id id) const;
+private:
+ shared_ptr_type get_shared_ptr() const;
+};
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_parameters"></a><a class="link" href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_parameters" title="Template parameters">Template
+ parameters</a>
</h5></div></div></div>

 <code class="computeroutput">thread_specific_shared_ptr<></code> is instantiated with the following
 types:
 
-<div class="itemizedlist"><ul type="disc"><li>
- T The type of the pointeed object
- </li></ul></div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_types"></a><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_types" title="
- Public types">
- Public types</a>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ T The type of the pointeed object
+ </li></ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_types"></a><a class="link" href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reference_types" title="Public types">Public
+ types</a>
</h5></div></div></div>

 <code class="computeroutput">thread_specific_shared_ptr<></code> defines the following types:
 
-<div class="itemizedlist"><ul type="disc">
-<li>
-<code class="computeroutput">shared_ptr_type</code>
- The shared pointed type.
- </li>
-<li>
-<code class="computeroutput">map_type</code>
- The mapping type from <code class="computeroutput">thread::id</code>
- to <code class="computeroutput">shared_ptr_type</code>
-</li>
-<li>
-<code class="computeroutput">mutex_type</code>
- The protecting mutext type follwing the Lockable Concept
- </li>
-<li>
-<code class="computeroutput">lock_type</code>
- The lock used to get the map follwing the unique_lock subjacent Concept
- </li>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <code class="computeroutput">shared_ptr_type</code>
+ The shared pointed type.
+ </li>
+<li class="listitem">
+ <code class="computeroutput">map_type</code>
+ The mapping type from <code class="computeroutput">thread::id</code>
+ to <code class="computeroutput">shared_ptr_type</code>
+ </li>
+<li class="listitem">
+ <code class="computeroutput">mutex_type</code>
+ The protecting mutext type follwing the Lockable Concept
+ </li>
+<li class="listitem">
+ <code class="computeroutput">lock_type</code>
+ The lock used to get the map follwing the unique_lock subjacent Concept
+ </li>
</ul></div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_default_constructor"></a><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_default_constructor" title="
- Constructor">
- Constructor</a>
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_default_constructor"></a><a class="link" href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_default_constructor" title="Constructor">Constructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- thread_specific_shared_ptr();
-o</pre>
+<pre class="programlisting">thread_specific_shared_ptr();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Construct a <code class="computeroutput">thread_specific_shared_ptr<></code> object for storing a pointer
- to an object of type <code class="computeroutput">T</code>
- specific to each thread.
- </dd>
+ Construct a <code class="computeroutput">thread_specific_shared_ptr<></code> object for storing a pointer
+ to an object of type <code class="computeroutput">T</code>
+ specific to each thread.
+ </dd>
<dt>Throws:</dt>
<dd>
- <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
- </dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- safe.
- </dd>
+ safe.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_constructor_with_custom_cleanup"></a><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_constructor_with_custom_cleanup" title="
- Cleanup Constructor">
- Cleanup Constructor</a>
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_constructor_with_custom_cleanup"></a><a class="link" href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_constructor_with_custom_cleanup" title="Cleanup Constructor">Cleanup
+ Constructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- explicit thread_specific_shared_ptr(void (*cleanup_)(shared_ptr_type));
-#</pre>
+<pre class="programlisting">explicit thread_specific_shared_ptr(void (*cleanup_)(shared_ptr_type));
+</pre>
<div class="variablelist">

<dl>
<dt>Requires:</dt>
<dd>
- <code class="computeroutput">cleanup_function(this->get())</code> does not throw any exceptions.
- </dd>
+ <code class="computeroutput">cleanup_function(this->get())</code> does not throw any exceptions.
+ </dd>
<dt>Effects:</dt>
<dd>
- Construct a <code class="computeroutput">thread_specific_shared_ptr<></code> object for storing a pointer
- to an object of type <code class="computeroutput">T</code>
- specific to each thread. The supplied <code class="computeroutput">cleanup_function</code>
- will be called at thread exit.
- </dd>
+ Construct a <code class="computeroutput">thread_specific_shared_ptr<></code> object for storing a pointer
+ to an object of type <code class="computeroutput">T</code>
+ specific to each thread. The supplied <code class="computeroutput">cleanup_function</code>
+ will be called at thread exit.
+ </dd>
<dt>Throws:</dt>
<dd>
- <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
- </dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- safe.
- </dd>
+ safe.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_destructor"></a><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_destructor" title="
- Destructor">
- Destructor</a>
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_destructor"></a><a class="link" href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_destructor" title="Destructor">Destructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- ~thread_specific_shared_ptr();
-#</pre>
+<pre class="programlisting">~thread_specific_shared_ptr();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Remove from the static map the current thread::id and destroys <code class="computeroutput">*this</code>.
- </dd>
+ Remove from the static map the current thread::id and destroys
+ <code class="computeroutput">*this</code>.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing.
- </dd>
+ Nothing.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- safe.
- </dd>
+ safe.
+ </dd>
</dl>
</div>
<div class="note"><table border="0" summary="Note">
@@ -291,30 +270,28 @@
 </td></tr>
</table></div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_get"></a><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_get" title="
- Member Function get()">
- Member Function <code class="computeroutput">get()</code></a>
-</h5></div></div></div>
-<pre class="programlisting">
- shared_ptr_type get() const;
-u</pre>
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_get"></a><a class="link" href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_get" title="Member Function get()">Member
+ Function <code class="computeroutput">get()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">shared_ptr_type get() const;
+</pre>
<div class="variablelist">

<dl>
<dt>Returns:</dt>
<dd>
- The pointer associated with the current thread.
- </dd>
+ The pointer associated with the current thread.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing.
- </dd>
+ Nothing.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- safe.
- </dd>
+ safe.
+ </dd>
</dl>
</div>
<div class="note"><table border="0" summary="Note">
@@ -328,170 +305,161 @@
 </td></tr>
</table></div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_arrow"></a><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_arrow" title="
- Member Function operator->()">
- Member Function <code class="computeroutput">operator->()</code></a>
-</h5></div></div></div>
-<pre class="programlisting">
- T* operator->() const;
-e</pre>
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_arrow"></a><a class="link" href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_arrow" title="Member Function operator->()">Member
+ Function <code class="computeroutput">operator->()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">T* operator->() const;
+</pre>
<div class="variablelist">

<dl>
<dt>Requires:</dt>
<dd>
- <code class="computeroutput">this->get()</code>
- is not <code class="computeroutput">0</code>.
- </dd>
+ <code class="computeroutput">this->get()</code>
+ is not <code class="computeroutput">0</code>.
+ </dd>
<dt>Returns:</dt>
<dd>
- <code class="computeroutput">this->get()</code>
- </dd>
+ <code class="computeroutput">this->get()</code>
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing.
- </dd>
+ Nothing.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- safe.
- </dd>
+ safe.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_star"></a><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_star" title="
- Member Function operator*()">
- Member Function <code class="computeroutput">operator*()</code></a>
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_star"></a><a class="link" href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operator_star" title="Member Function operator*()">Member
+ Function <code class="computeroutput">operator*()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- T& operator*() const;
-_</pre>
+<pre class="programlisting">T& operator*() const;
+</pre>
<div class="variablelist">

<dl>
<dt>Requires:</dt>
<dd>
- <code class="computeroutput">this->get()</code>
- is not <code class="computeroutput">0</code>.
- </dd>
+ <code class="computeroutput">this->get()</code>
+ is not <code class="computeroutput">0</code>.
+ </dd>
<dt>Returns:</dt>
<dd>
- <code class="computeroutput">*(this->get())</code>
- </dd>
+ <code class="computeroutput">*(this->get())</code>
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing.
- </dd>
+ Nothing.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- safe.
- </dd>
+ safe.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reset"></a><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reset" title="
- Member Function reset()">
- Member Function <code class="computeroutput">reset()</code></a>
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reset"></a><a class="link" href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_reset" title="Member Function reset()">Member
+ Function <code class="computeroutput">reset()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- void reset();
-></pre>
+<pre class="programlisting">void reset();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Equivalent to <code class="computeroutput">shared_ptr().swap(this->get_shared_ptr())</code>. Update the mapping.
- </dd>
+ Equivalent to <code class="computeroutput">shared_ptr().swap(this->get_shared_ptr())</code>. Update the mapping.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- <code class="computeroutput">this->get()==0</code>
- </dd>
+ <code class="computeroutput">this->get()==0</code>
+ </dd>
<dt>Throws:</dt>
<dd>
- <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
- </dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- safe.
- </dd>
+ safe.
+ </dd>
</dl>
</div>
-<pre class="programlisting">
- template<class Y> void reset(Y * new_value);
-#</pre>
+<pre class="programlisting">template<class Y> void reset(Y * new_value);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Equivalent to <code class="computeroutput">shared_ptr(new_value).swap(this->get_shared_ptr())</code>. Update the mapping.
- </dd>
+ Equivalent to <code class="computeroutput">shared_ptr(new_value).swap(this->get_shared_ptr())</code>. Update the mapping.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- <code class="computeroutput">this->get()==new_value</code>
- </dd>
+ <code class="computeroutput">this->get()==new_value</code>
+ </dd>
<dt>Throws:</dt>
<dd>
- <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
- </dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- safe.
- </dd>
+ safe.
+ </dd>
</dl>
</div>
-<pre class="programlisting">
- template<class Y, class D> void reset(Y * new_value, D deleter);
-#</pre>
+<pre class="programlisting">template<class Y, class D> void reset(Y * new_value, D deleter);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Equivalent to <code class="computeroutput">shared_ptr(new_value, deleter).swap(this->get_shared_ptr())</code>. Update the mapping.
- </dd>
+ Equivalent to <code class="computeroutput">shared_ptr(new_value, deleter).swap(this->get_shared_ptr())</code>. Update the mapping.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- <code class="computeroutput">this->get()==new_value</code>
- </dd>
+ <code class="computeroutput">this->get()==new_value</code>
+ </dd>
<dt>Throws:</dt>
<dd>
- <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
- </dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- safe.
- </dd>
+ safe.
+ </dd>
</dl>
</div>
-<pre class="programlisting">
- template<class Y, class D, class A> void reset(Y * new_value, D deleter, A a);
-#</pre>
+<pre class="programlisting">template<class Y, class D, class A> void reset(Y * new_value, D deleter, A a);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Equivalent to <code class="computeroutput">shared_ptr(new_value, deleter, a).swap(this->get_shared_ptr())</code>. Update the mapping.
- </dd>
+ Equivalent to <code class="computeroutput">shared_ptr(new_value, deleter, a).swap(this->get_shared_ptr())</code>. Update the mapping.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- <code class="computeroutput">this->get()==new_value</code>
- </dd>
+ <code class="computeroutput">this->get()==new_value</code>
+ </dd>
<dt>Throws:</dt>
<dd>
- <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
- </dd>
+ <code class="computeroutput">std::bad_alloc</code> when resources unavailable.
+ </dd>
<dt>Thread safety:</dt>
<dd>
- safe.
- </dd>
+ safe.
+ </dd>
</dl>
</div>
<div class="variablelist">
@@ -499,107 +467,99 @@
<dl>
<dt>Effects:</dt>
<dd>
- If <code class="computeroutput">this->get()!=new_value</code> and <code class="computeroutput">this->get()</code> is non-<code class="computeroutput">NULL</code>,
- invoke <code class="computeroutput">delete this->get()</code> or <code class="computeroutput">deleter(this->get())</code> as appropriate. Store <code class="computeroutput">new_value</code> as the pointer associated
- with the current thread.
- </dd>
+ If <code class="computeroutput">this->get()!=new_value</code> and <code class="computeroutput">this->get()</code> is non-<code class="computeroutput">NULL</code>,
+ invoke <code class="computeroutput">delete this->get()</code> or <code class="computeroutput">deleter(this->get())</code> as appropriate. Store <code class="computeroutput">new_value</code> as the pointer associated
+ with the current thread.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_wait_and_get"></a><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_wait_and_get" title="
- Member Function wait_and_get()">
- Member Function <code class="computeroutput">wait_and_get()</code></a>
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_wait_and_get"></a><a class="link" href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_wait_and_get" title="Member Function wait_and_get()">Member
+ Function <code class="computeroutput">wait_and_get()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- shared_ptr_type wait_and_get(thread::id id) const;
-a</pre>
+<pre class="programlisting">shared_ptr_type wait_and_get(thread::id id) const;
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Waits until the specific shared pointer has been set and returns
- a shared pointer to this context.
- </dd>
+ Waits until the specific shared pointer has been set and returns
+ a shared pointer to this context.
+ </dd>
<dt>Throws:</dt>
<dd>
- <code class="computeroutput">boost::thread_interrupted</code> if the current
- thread of execution is interrupted.
- </dd>
+ <code class="computeroutput">boost::thread_interrupted</code> if the current
+ thread of execution is interrupted.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operatora"></a><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operatora" title="
- Member Function operator[]()">
- Member Function <code class="computeroutput">operator[]()</code></a>
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operatora"></a><a class="link" href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.thread_specific_shared_ptr_operatora" title="Member Function operator[]()">Member
+ Function <code class="computeroutput">operator[]()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- shared_ptr_type operator[](thread::id id) const;
-o</pre>
+<pre class="programlisting">shared_ptr_type operator[](thread::id id) const;
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Returns a copy of the specific shared_ptr of the thread of execution
- identified by the <code class="computeroutput">thread::id</code>.
- </dd>
+ Returns a copy of the specific shared_ptr of the thread of execution
+ identified by the <code class="computeroutput">thread::id</code>.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing.
- </dd>
+ Nothing.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_mutex"></a><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_mutex" title="
- Member Function get_mutex()">
- Member Function <code class="computeroutput">get_mutex()</code></a>
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_mutex"></a><a class="link" href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_mutex" title="Member Function get_mutex()">Member
+ Function <code class="computeroutput">get_mutex()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- mutex_type& get_mutex();
-n</pre>
+<pre class="programlisting">mutex_type& get_mutex();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Returns a reference to the protection mutex.
- </dd>
+ Returns a reference to the protection mutex.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing.
- </dd>
+ Nothing.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_map"></a><a href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_map" title="
- Member Function get_map()">
- Member Function <code class="computeroutput">get_map()</code></a>
+<a name="toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_map"></a><a class="link" href="thread_specific_shared_ptr_hpp.html#toward_boost_interthreads.reference.thread_specific_shared_ptr_hpp.thread_specific_shared_ptr_reference_thread_specific_shared_ptr.get_map" title="Member Function get_map()">Member
+ Function <code class="computeroutput">get_map()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- const map_type& get_map(lock_type&) const;
-a</pre>
+<pre class="programlisting">const map_type& get_map(lock_type&) const;
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Returns a reference to the mapping from <code class="computeroutput">thread::id</code>
- to the specific pointers provided the user gives a lock on the motext
- get using <code class="computeroutput">get_mutex()</code>.
- </dd>
+ Returns a reference to the mapping from <code class="computeroutput">thread::id</code>
+ to the specific pointers provided the user gives a lock on the
+ motext get using <code class="computeroutput">get_mutex()</code>.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing.
- </dd>
+ Nothing.
+ </dd>
</dl>
</div>
</div>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_tuple_hpp.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_tuple_hpp.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_tuple_hpp.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,17 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>
- Header <boost/interthreads/thread_tuple.hpp></title>
+<title>Header <boost/interthreads/thread_tuple.hpp></title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../reference.html" title=" Reference">
-<link rel="prev" href="set_once_hpp.html" title=" Header
- <boost/interthreads/set_once.hpp>">
-<link rel="next" href="thread_tuple_once_hpp.html" title="
- Header <boost/interthreads/thread_tuple_once.hpp>">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="set_once_hpp.html" title="Header <boost/interthreads/set_once.hpp>">
+<link rel="next" href="thread_tuple_once_hpp.html" title="Header <boost/interthreads/thread_tuple_once.hpp>">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -26,511 +22,476 @@
<div class="spirit-nav">
<a accesskey="p" href="set_once_hpp.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="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="thread_tuple_once_hpp.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp"></a><a href="thread_tuple_hpp.html" title="
- Header <boost/interthreads/thread_tuple.hpp>">
- Header <code class="computeroutput"><boost/interthreads/thread_tuple.hpp></code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp"></a><a class="link" href="thread_tuple_hpp.html" title="Header <boost/interthreads/thread_tuple.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/thread_tuple.hpp></code></a>
</h3></div></div></div>
<div class="toc"><dl>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class">
- Template Class <code class="computeroutput">thread_tuple<></code></a></dt>
+<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class">Template
+ Class <code class="computeroutput">thread_tuple<></code></a></dt>
<dd><dl>
<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.template_parameters">Template
 parameters</a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_callable_constructor">
- Constructor</a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_destructor">
- Destructor</a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_joinable">
- Member function <code class="computeroutput">joinable()</code></a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_join">
- Member function <code class="computeroutput">join_all()</code></a></dt>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
+<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_joinable">Member
+ function <code class="computeroutput">joinable()</code></a></dt>
+<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_join">Member
+ function <code class="computeroutput">join_all()</code></a></dt>
<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_until___">Member
 function <code class="computeroutput">join_all_until()</code></a></dt>
<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_for___">Member
 function <code class="computeroutput">join_all_for()</code></a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.join_first_then_interrupt">
- Member function <code class="computeroutput">join_any()</code></a></dt>
+<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.join_first_then_interrupt">Member
+ function <code class="computeroutput">join_any()</code></a></dt>
<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_any_until___">Member
 function <code class="computeroutput">join_any_until()</code></a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.detach_all">
- Member function <code class="computeroutput">detach_all()</code></a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_interrupt_all">
- Member function <code class="computeroutput">interrupt_all()</code></a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_size">
- Member function <code class="computeroutput">size()</code></a></dt>
+<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.detach_all">Member
+ function <code class="computeroutput">detach_all()</code></a></dt>
+<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_interrupt_all">Member
+ function <code class="computeroutput">interrupt_all()</code></a></dt>
+<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_size">Member
+ function <code class="computeroutput">size()</code></a></dt>
</dl></dd>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_make_thread_tuple">
- Non Member Function <code class="computeroutput">make_thread_tuple()</code></a></dt>
+<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_make_thread_tuple">Non
+ Member Function <code class="computeroutput">make_thread_tuple()</code></a></dt>
</dl></div>
-<pre class="programlisting">
- namespace boost {
- namespace interthreads {
+<pre class="programlisting">namespace boost {
+namespace interthreads {

- template <std::size_t N>
- class thread_tuple;
+ template <std::size_t N>
+ class thread_tuple;

- template<typename F0, ..., typename Fn-1>
- thread_tuple<n> make_thread_tuple(F0 f0, ..., Fn fn-1);
+ template<typename F0, ..., typename Fn-1>
+ thread_tuple<n> make_thread_tuple(F0 f0, ..., Fn fn-1);

- }
- }
-ead_tuple</</pre>
-<div class="section" lang="en">
+}
+}
+</pre>
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class"></a><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class" title="
- Template Class thread_tuple<>">
- Template Class <code class="computeroutput">thread_tuple<></code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class"></a><a class="link" href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class" title="Template Class thread_tuple<>">Template
+ Class <code class="computeroutput">thread_tuple<></code></a>
</h4></div></div></div>
<div class="toc"><dl>
<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.template_parameters">Template
 parameters</a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_callable_constructor">
- Constructor</a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_destructor">
- Destructor</a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_joinable">
- Member function <code class="computeroutput">joinable()</code></a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_join">
- Member function <code class="computeroutput">join_all()</code></a></dt>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
+<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_joinable">Member
+ function <code class="computeroutput">joinable()</code></a></dt>
+<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_join">Member
+ function <code class="computeroutput">join_all()</code></a></dt>
<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_until___">Member
 function <code class="computeroutput">join_all_until()</code></a></dt>
<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_for___">Member
 function <code class="computeroutput">join_all_for()</code></a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.join_first_then_interrupt">
- Member function <code class="computeroutput">join_any()</code></a></dt>
+<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.join_first_then_interrupt">Member
+ function <code class="computeroutput">join_any()</code></a></dt>
<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_any_until___">Member
 function <code class="computeroutput">join_any_until()</code></a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.detach_all">
- Member function <code class="computeroutput">detach_all()</code></a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_interrupt_all">
- Member function <code class="computeroutput">interrupt_all()</code></a></dt>
-<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_size">
- Member function <code class="computeroutput">size()</code></a></dt>
+<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.detach_all">Member
+ function <code class="computeroutput">detach_all()</code></a></dt>
+<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_interrupt_all">Member
+ function <code class="computeroutput">interrupt_all()</code></a></dt>
+<dt><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_size">Member
+ function <code class="computeroutput">size()</code></a></dt>
</dl></div>

 <code class="computeroutput">thread_tuple<></code>
 defines a thread groupe where the number of threads is know statically
 and the threads are created at construction time.
 
-<pre class="programlisting">
- template <std::size_t n>
- class thread_tuple {
- public:
- template<typename F0, ..., typename Fn-1>
- thread_tuple(F0 f0, ..., Fn-1 fn-1);
-
- template <class F>
- thread_tuple(boost::move_t<F> f);
- ~thread_tuple();
+<pre class="programlisting">template <std::size_t n>
+class thread_tuple {
+public:
+ template<typename F0, ..., typename Fn-1>
+ thread_tuple(F0 f0, ..., Fn-1 fn-1);
+
+ template <class F>
+ thread_tuple(boost::move_t<F> f);
+ ~thread_tuple();

- // move support
- thread_tuple(boost::move_t<thread_tuple<n>> x);
- thread_tuple& operator=(boost::move_t<thread_tuple<n>> x);
- operator boost::move_t<thread_tuple<n>>();
- boost::move_t<thread_tuple<n>> move();
+ // move support
+ thread_tuple(boost::move_t<thread_tuple<n>> x);
+ thread_tuple& operator=(boost::move_t<thread_tuple<n>> x);
+ operator boost::move_t<thread_tuple<n>>();
+ boost::move_t<thread_tuple<n>> move();

- void swap(thread_tuple<n>& x);
+ void swap(thread_tuple<n>& x);

- bool joinable() const;
- void join_all();
- bool join_all_until(const system_time& wait_until);
- template<typename TimeDuration>
- bool join_all_for(TimeDuration const& rel_time);
+ bool joinable() const;
+ void join_all();
+ bool join_all_until(const system_time& wait_until);
+ template<typename TimeDuration>
+ bool join_all_for(TimeDuration const& rel_time);

- void detach();
- void detach_all();
+ void detach();
+ void detach_all();

- void interrupt();
- void interrupt_all();
- bool interruption_requested() const;
+ void interrupt();
+ void interrupt_all();
+ bool interruption_requested() const;

- size_t size();
-
- const thread& operator[](std::size_t i);
- };
- }
- }
-ze_t</phrase> <phrase role=#identifie</pre>
+ size_t size();
+
+ const thread& operator[](std::size_t i);
+};
+}
+}
+</pre>

 The <code class="computeroutput">thread_tuple<></code>
 class is responsible for launching and managing a static collection of
 threads that are related in some fashion. No new threads can be added to
 the tuple once constructed.
 
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.template_parameters"></a><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.template_parameters" title="Template
- parameters">Template
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.template_parameters"></a><a class="link" href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.template_parameters" title="Template parameters">Template
 parameters</a>
</h5></div></div></div>

 <code class="computeroutput">thread_tuple<></code>
 is instantiated with the following value:
 
-<div class="itemizedlist"><ul type="disc"><li>
- n is the size of the tuple.
- </li></ul></div>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ n is the size of the tuple.
+ </li></ul></div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_callable_constructor"></a><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_callable_constructor" title="
- Constructor">
- Constructor</a>
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_callable_constructor"></a><a class="link" href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_callable_constructor" title="Constructor">Constructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- template<typename F0, ..., typename Fn-1>
- thread_tuple(F0 func_0, ..., Fn-1 func_n-1);
-e></pre>
+<pre class="programlisting">template<typename F0, ..., typename Fn-1>
+thread_tuple(F0 func_0, ..., Fn-1 func_n-1);
+</pre>
<div class="variablelist">

<dl>
<dt>Preconditions:</dt>
<dd>
- <code class="computeroutput">Fk</code> must by copyable.
- </dd>
+ <code class="computeroutput">Fk</code> must by copyable.
+ </dd>
<dt>Effects:</dt>
<dd>
- <code class="computeroutput">func_k</code> is copied
- into storage managed internally by the library, and that copy is
- invoked on a newly-created thread of execution. If this invocation
- results in an exception being propagated into the internals of the
- library that is not of type <code class="computeroutput">boost::thread_interrupted</code>,
- then <code class="computeroutput">std::terminate()</code>
- will be called.
- </dd>
+ <code class="computeroutput">func_k</code> is copied
+ into storage managed internally by the library, and that copy is
+ invoked on a newly-created thread of execution. If this invocation
+ results in an exception being propagated into the internals of
+ the library that is not of type <code class="computeroutput">boost::thread_interrupted</code>,
+ then <code class="computeroutput">std::terminate()</code>
+ will be called.
+ </dd>
<dt>Postconditions:</dt>
<dd>
- <code class="computeroutput">*this</code>
- refers to the newly created tuple of threads of execution.
- </dd>
+ <code class="computeroutput">*this</code>
+ refers to the newly created tuple of threads of execution.
+ </dd>
<dt>Throws:</dt>
<dd>
- <code class="computeroutput">boost::thread_resource_error</code> if an error
- occurs.
- </dd>
+ <code class="computeroutput">boost::thread_resource_error</code> if an error
+ occurs.
+ </dd>
<dt>Note:</dt>
<dd>
- Currently up to ten arguments <code class="computeroutput">func_0</code>
- to <code class="computeroutput">funct_9</code> can be
- specified.
- </dd>
+ Currently up to ten arguments <code class="computeroutput">func_0</code>
+ to <code class="computeroutput">funct_9</code> can
+ be specified.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_destructor"></a><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_destructor" title="
- Destructor">
- Destructor</a>
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_destructor"></a><a class="link" href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_destructor" title="Destructor">Destructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- ~thread_tuple();
-#</pre>
+<pre class="programlisting">~thread_tuple();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- If *this have associateds thread of execution, calls detach() on
- them. Destroys *this.
- </dd>
+ If *this have associateds thread of execution, calls detach() on
+ them. Destroys *this.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_joinable"></a><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_joinable" title="
- Member function joinable()">
- Member function <code class="computeroutput">joinable()</code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_joinable"></a><a class="link" href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_joinable" title="Member function joinable()">Member
+ function <code class="computeroutput">joinable()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- bool joinable() const;
-a</pre>
+<pre class="programlisting">bool joinable() const;
+</pre>
<div class="variablelist">

<dl>
<dt>Returns:</dt>
<dd>
- <code class="computeroutput">true</code> if <code class="computeroutput">*this</code>
- refers to threads of execution, <code class="computeroutput">false</code>
- otherwise.
- </dd>
+ <code class="computeroutput">true</code> if <code class="computeroutput">*this</code>
+ refers to threads of execution, <code class="computeroutput">false</code>
+ otherwise.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_join"></a><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_join" title="
- Member function join_all()">
- Member function <code class="computeroutput">join_all()</code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_join"></a><a class="link" href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_join" title="Member function join_all()">Member
+ function <code class="computeroutput">join_all()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- void join();
- void join_all();
-de</pre>
+<pre class="programlisting">void join();
+void join_all();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">join()</code>
- on each <code class="computeroutput">boost::thread</code> object in the tuple.
- </dd>
+ Call <code class="computeroutput">join()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the tuple.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- Every thread in the tuple has terminated.
- </dd>
+ Every thread in the tuple has terminated.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Note:</dt>
<dd>
- Since <code class="computeroutput">boost::thread::join</code> is one of the predefined interruption
- points, <code class="computeroutput">thread_tuple<>::join_all()</code> is also an interruption point.
- </dd>
+ Since <code class="computeroutput">boost::thread::join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_tuple<>::join_all()</code> is also an interruption point.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_until___"></a><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_until___" title="Member
- function join_all_until()">Member
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_until___"></a><a class="link" href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_until___" title="Member function join_all_until()">Member
 function <code class="computeroutput">join_all_until()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- bool join_all_until(const system_time& wait_until);
-_</pre>
+<pre class="programlisting">bool join_all_until(const system_time& wait_until);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">timed_join()</code>
- on each <code class="computeroutput">boost::thread</code> object in the tuple.
- </dd>
+ Call <code class="computeroutput">timed_join()</code> on each <code class="computeroutput">boost::thread</code>
+ object in the tuple.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- Every thread in the tuple has terminated.
- </dd>
+ Every thread in the tuple has terminated.
+ </dd>
<dt>Returns:</dt>
<dd>
- true if joined.
- </dd>
+ true if joined.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Note:</dt>
<dd>
- Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
- interruption points, <code class="computeroutput">thread_tuple<>::join_all_until()</code> is also an interruption point.
- </dd>
+ Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_tuple<>::join_all_until()</code> is also an interruption point.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_for___"></a><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_for___" title="Member
- function join_all_for()">Member
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_for___"></a><a class="link" href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_all_for___" title="Member function join_all_for()">Member
 function <code class="computeroutput">join_all_for()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- template<typename TimeDuration>
- bool join_for(TimeDuration const& rel_time);
-ec</pre>
+<pre class="programlisting">template<typename TimeDuration>
+bool join_for(TimeDuration const& rel_time);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- As <code class="computeroutput">join_all_until(now()+rel_time)</code>.
- </dd>
+ As <code class="computeroutput">join_all_until(now()+rel_time)</code>.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- Every thread in the tuple has terminated.
- </dd>
+ Every thread in the tuple has terminated.
+ </dd>
<dt>Returns:</dt>
<dd>
- true if joined.
- </dd>
+ true if joined.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Note:</dt>
<dd>
- Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
- interruption points, <code class="computeroutput">thread_tuple<>::join_all_for()</code> is also an interruption point.
- </dd>
+ Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_tuple<>::join_all_for()</code> is also an interruption point.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.join_first_then_interrupt"></a><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.join_first_then_interrupt" title="
- Member function join_any()">
- Member function <code class="computeroutput">join_any()</code></a>
-</h5></div></div></div>
-<pre class="programlisting">
- std::size_t conc_join_any();
-l</pre>
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.join_first_then_interrupt"></a><a class="link" href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.join_first_then_interrupt" title="Member function join_any()">Member
+ function <code class="computeroutput">join_any()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">std::size_t conc_join_any();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">join_any()</code>
- on a temporary thread_tuple and the <code class="computeroutput">interrup_all()</code>.
- </dd>
+ Call <code class="computeroutput">join_any()</code>
+ on a temporary thread_tuple and the <code class="computeroutput">interrup_all()</code>.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- Every thread in the tuple has terminated.
- </dd>
+ Every thread in the tuple has terminated.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Note:</dt>
<dd>
- Since <code class="computeroutput">join_any()</code>
- is one of the predefined interruption points, <code class="computeroutput">conc_join_any()</code> is also an interruption point.
- </dd>
+ Since <code class="computeroutput">join_any()</code> is one of the predefined interruption
+ points, <code class="computeroutput">conc_join_any()</code> is also an interruption point.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_any_until___"></a><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_any_until___" title="Member
- function join_any_until()">Member
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_any_until___"></a><a class="link" href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.member_function__join_any_until___" title="Member function join_any_until()">Member
 function <code class="computeroutput">join_any_until()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- std::pair<bool,std::size_t> conc_join_any_until(
- const system_time& wait_until);
- template<typename TimeDuration>
- std::pair<bool,std::size_t> join_any_for(
- TimeDuration const& rel_time);
-</phr</pre>
+<pre class="programlisting">std::pair<bool,std::size_t> conc_join_any_until(
+ const system_time& wait_until);
+template<typename TimeDuration>
+std::pair<bool,std::size_t> join_any_for(
+ TimeDuration const& rel_time);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">join_any_until()</code> on a temporary thread_tuple and
- the <code class="computeroutput">interrup_all()</code>.
- </dd>
+ Call <code class="computeroutput">join_any_until()</code> on a temporary thread_tuple and
+ the <code class="computeroutput">interrup_all()</code>.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- Every thread in the tuple has terminated.
- </dd>
+ Every thread in the tuple has terminated.
+ </dd>
<dt>Returns:</dt>
<dd>
- true if joined.
- </dd>
+ true if joined.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Note:</dt>
<dd>
- Since <code class="computeroutput">join_any_until()</code> is one of the predefined interruption
- points, <code class="computeroutput">conc_join_any_until()</code> is also an interruption point.
- </dd>
+ Since <code class="computeroutput">join_any_until()</code> is one of the predefined interruption
+ points, <code class="computeroutput">conc_join_any_until()</code> is also an interruption point.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.detach_all"></a><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.detach_all" title="
- Member function detach_all()">
- Member function <code class="computeroutput">detach_all()</code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.detach_all"></a><a class="link" href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.detach_all" title="Member function detach_all()">Member
+ function <code class="computeroutput">detach_all()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- void detach_all();
-<</pre>
+<pre class="programlisting">void detach_all();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">detach()</code>
- on each <code class="computeroutput">boost::thread</code> object in the tuple.
- </dd>
+ Call <code class="computeroutput">detach()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the tuple.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_interrupt_all"></a><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_interrupt_all" title="
- Member function interrupt_all()">
- Member function <code class="computeroutput">interrupt_all()</code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_interrupt_all"></a><a class="link" href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_interrupt_all" title="Member function interrupt_all()">Member
+ function <code class="computeroutput">interrupt_all()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- void interrupt_all();
-r</pre>
+<pre class="programlisting">void interrupt_all();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">thread::interrupt()</code>
- on each <code class="computeroutput">boost::thread</code> object in the tuple.
- </dd>
+ Call <code class="computeroutput">thread::interrupt()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the tuple.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_size"></a><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_size" title="
- Member function size()">
- Member function <code class="computeroutput">size()</code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_size"></a><a class="link" href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_class.thread_tuple_size" title="Member function size()">Member
+ function <code class="computeroutput">size()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
-int size();
+<pre class="programlisting">int size();
</pre>
<div class="variablelist">

<dl>
<dt>Returns:</dt>
<dd>
- The number of threads in the tuple.
- </dd>
+ The number of threads in the tuple.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing.
- </dd>
+ Nothing.
+ </dd>
</dl>
</div>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_make_thread_tuple"></a><a href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_make_thread_tuple" title="
- Non Member Function make_thread_tuple()">
- Non Member Function <code class="computeroutput">make_thread_tuple()</code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_make_thread_tuple"></a><a class="link" href="thread_tuple_hpp.html#toward_boost_interthreads.reference.thread_tuple_hpp.thread_tuple_make_thread_tuple" title="Non Member Function make_thread_tuple()">Non
+ Member Function <code class="computeroutput">make_thread_tuple()</code></a>
</h4></div></div></div>
-<pre class="programlisting">
- template<typename F0, ..., typename Fn-1>
- thread_tuple make_thread_tuple(F0 f0, ..., Fn fn-1);
-em</pre>
+<pre class="programlisting">template<typename F0, ..., typename Fn-1>
+thread_tuple make_thread_tuple(F0 f0, ..., Fn fn-1);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- makes a new thread_tuple<>.
- </dd>
+ makes a new thread_tuple<>.
+ </dd>
<dt>Returns:</dt>
<dd>
- the created thread tuple.
- </dd>
+ the created thread tuple.
+ </dd>
</dl>
</div>
</div>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_tuple_once_hpp.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_tuple_once_hpp.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_tuple_once_hpp.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,17 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>
- Header <boost/interthreads/thread_tuple_once.hpp></title>
+<title>Header <boost/interthreads/thread_tuple_once.hpp></title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../reference.html" title=" Reference">
-<link rel="prev" href="thread_tuple_hpp.html" title="
- Header <boost/interthreads/thread_tuple.hpp>">
-<link rel="next" href="thread_group_once_hpp.html" title="
- Header <boost/interthreads/thread_group_once.hpp>">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="thread_tuple_hpp.html" title="Header <boost/interthreads/thread_tuple.hpp>">
+<link rel="next" href="thread_group_once_hpp.html" title="Header <boost/interthreads/thread_group_once.hpp>">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -26,84 +22,77 @@
<div class="spirit-nav">
<a accesskey="p" href="thread_tuple_hpp.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="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="thread_group_once_hpp.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp"></a><a href="thread_tuple_once_hpp.html" title="
- Header <boost/interthreads/thread_tuple_once.hpp>">
- Header <code class="computeroutput"><boost/interthreads/thread_tuple_once.hpp></code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp"></a><a class="link" href="thread_tuple_once_hpp.html" title="Header <boost/interthreads/thread_tuple_once.hpp>">Header
+ <code class="computeroutput"><boost/interthreads/thread_tuple_once.hpp></code></a>
</h3></div></div></div>
<div class="toc"><dl>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class">
- Template Class <code class="computeroutput">thread_tuple_once<></code></a></dt>
+<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class">Template
+ Class <code class="computeroutput">thread_tuple_once<></code></a></dt>
<dd><dl>
<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.template_parameters">Template
 parameters</a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_callable_constructor">
- Constructor</a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_destructor">
- Destructor</a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_joinable">
- Member function <code class="computeroutput">joinables()</code></a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_join">
- Member function <code class="computeroutput">join_all()</code></a></dt>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
+<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_joinable">Member
+ function <code class="computeroutput">joinables()</code></a></dt>
+<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_join">Member
+ function <code class="computeroutput">join_all()</code></a></dt>
<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_all_until___">Member
 function <code class="computeroutput">join_all_until()</code></a></dt>
<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_any___">Member
 function <code class="computeroutput">join_any()</code></a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.timed_join_first_then_interrupt">
- Member function <code class="computeroutput">timed_join_first_then_interrupt()</code></a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.detach_all">
- Member function <code class="computeroutput">detach_all()</code></a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_interrupt_all">
- Member function <code class="computeroutput">interrupt_all()</code></a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_size">
- Member function <code class="computeroutput">size()</code></a></dt>
+<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.timed_join_first_then_interrupt">Member
+ function <code class="computeroutput">timed_join_first_then_interrupt()</code></a></dt>
+<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.detach_all">Member
+ function <code class="computeroutput">detach_all()</code></a></dt>
+<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_interrupt_all">Member
+ function <code class="computeroutput">interrupt_all()</code></a></dt>
+<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_size">Member
+ function <code class="computeroutput">size()</code></a></dt>
</dl></dd>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_make_thread_tuple_once">
- Non Member Function <code class="computeroutput">make_thread_tuple_once()</code></a></dt>
+<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_make_thread_tuple_once">Non
+ Member Function <code class="computeroutput">make_thread_tuple_once()</code></a></dt>
</dl></div>
-<pre class="programlisting">
- namespace boost {
- namespace interthreads {
+<pre class="programlisting">namespace boost {
+namespace interthreads {

- template <std::size_t N>
- class thread_tuple_once;
+ template <std::size_t N>
+ class thread_tuple_once;

- template<typename F0, ..., typename Fn-1>
- thread_tuple make_thread_tuple_once(F0 f0, ..., Fn fn-1);
+ template<typename F0, ..., typename Fn-1>
+ thread_tuple make_thread_tuple_once(F0 f0, ..., Fn fn-1);

- }
- }
-le_once</ph</pre>
-<div class="section" lang="en">
+}
+}
+</pre>
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class"></a><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class" title="
- Template Class thread_tuple_once<>">
- Template Class <code class="computeroutput">thread_tuple_once<></code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class"></a><a class="link" href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class" title="Template Class thread_tuple_once<>">Template
+ Class <code class="computeroutput">thread_tuple_once<></code></a>
</h4></div></div></div>
<div class="toc"><dl>
<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.template_parameters">Template
 parameters</a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_callable_constructor">
- Constructor</a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_destructor">
- Destructor</a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_joinable">
- Member function <code class="computeroutput">joinables()</code></a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_join">
- Member function <code class="computeroutput">join_all()</code></a></dt>
+<dt>Constructor</dt>
+<dt>Destructor</dt>
+<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_joinable">Member
+ function <code class="computeroutput">joinables()</code></a></dt>
+<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_join">Member
+ function <code class="computeroutput">join_all()</code></a></dt>
<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_all_until___">Member
 function <code class="computeroutput">join_all_until()</code></a></dt>
<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_any___">Member
 function <code class="computeroutput">join_any()</code></a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.timed_join_first_then_interrupt">
- Member function <code class="computeroutput">timed_join_first_then_interrupt()</code></a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.detach_all">
- Member function <code class="computeroutput">detach_all()</code></a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_interrupt_all">
- Member function <code class="computeroutput">interrupt_all()</code></a></dt>
-<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_size">
- Member function <code class="computeroutput">size()</code></a></dt>
+<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.timed_join_first_then_interrupt">Member
+ function <code class="computeroutput">timed_join_first_then_interrupt()</code></a></dt>
+<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.detach_all">Member
+ function <code class="computeroutput">detach_all()</code></a></dt>
+<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_interrupt_all">Member
+ function <code class="computeroutput">interrupt_all()</code></a></dt>
+<dt><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_size">Member
+ function <code class="computeroutput">size()</code></a></dt>
</dl></div>

 <code class="computeroutput">biththread_tuple_once</code> is
@@ -111,391 +100,364 @@
 which allows to join the thread finishing the first, using for that the
 <code class="computeroutput">bith::set_once</code> synchronizer.
 
-<pre class="programlisting">
- template <std::size_t n>
- class thread_tuple_once {
- public:
- template<typename F0, ..., typename Fn-1>
- thread_tuple_once(F0 f0, ..., Fn-1 fn-1);
-
- template <class F>
- thread_tuple_once(boost::move_t<F> f);
- ~thread_tuple_once();
+<pre class="programlisting">template <std::size_t n>
+class thread_tuple_once {
+public:
+ template<typename F0, ..., typename Fn-1>
+ thread_tuple_once(F0 f0, ..., Fn-1 fn-1);
+
+ template <class F>
+ thread_tuple_once(boost::move_t<F> f);
+ ~thread_tuple_once();

- // move support
- thread_tuple_once(boost::move_t<thread_tuple_once<n>> x);
- thread_tuple_once& operator=(boost::move_t<thread_tuple_once<n>> x);
- operator boost::move_t<thread_tuple_once<n>>();
- boost::move_t<thread_tuple_once<n>> move();
+ // move support
+ thread_tuple_once(boost::move_t<thread_tuple_once<n>> x);
+ thread_tuple_once& operator=(boost::move_t<thread_tuple_once<n>> x);
+ operator boost::move_t<thread_tuple_once<n>>();
+ boost::move_t<thread_tuple_once<n>> move();

- void swap(thread_tuple_once<n>& x);
+ void swap(thread_tuple_once<n>& x);

- bool joinables() const;
- void join_all();
- bool join_all_until(const system_time& wait_until);
- template<typename TimeDuration>
- bool join_all_for(TimeDuration const& rel_time);
+ bool joinables() const;
+ void join_all();
+ bool join_all_until(const system_time& wait_until);
+ template<typename TimeDuration>
+ bool join_all_for(TimeDuration const& rel_time);

- std::size_t join_any();
- std::pair<bool,std::size_t> join_any_until(
- const system_time& wait_until);
- template<typename TimeDuration>
- std::pair<bool,std::size_t> join_any_for(
- TimeDuration const& rel_time);
+ std::size_t join_any();
+ std::pair<bool,std::size_t> join_any_until(
+ const system_time& wait_until);
+ template<typename TimeDuration>
+ std::pair<bool,std::size_t> join_any_for(
+ TimeDuration const& rel_time);

- void detach_all();
+ void detach_all();

- void interrupt_all();
- bool interruption_requested() const;
+ void interrupt_all();
+ bool interruption_requested() const;

- size_t size();
-
- const thread& operator[](std::size_t i);
- };
- }
- }
-ial">,</phrase> <phrase role="special#>...</pre>
+ size_t size();
+
+ const thread& operator[](std::size_t i);
+};
+}
+}
+</pre>

 The __thread_tupleonce_ class is
 responsible for launching and managing a static collection of threads that
 are related in some fashion. No new threads can be added to the tuple once
 constructed.
 
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.template_parameters"></a><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.template_parameters" title="Template
- parameters">Template
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.template_parameters"></a><a class="link" href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.template_parameters" title="Template parameters">Template
 parameters</a>
</h5></div></div></div>

 <code class="computeroutput">thread_tuple_once<></code>
 is instantiated with the following value:
 
-<div class="itemizedlist"><ul type="disc"><li>
- n is the size of the tuple.
- </li></ul></div>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ n is the size of the tuple.
+ </li></ul></div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_callable_constructor"></a><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_callable_constructor" title="
- Constructor">
- Constructor</a>
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_callable_constructor"></a><a class="link" href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_callable_constructor" title="Constructor">Constructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- template<typename F0, ..., typename Fn-1>
- thread_tuple_once(F0 func_0, ..., Fn-1 func_n-1);
-le</pre>
+<pre class="programlisting">template<typename F0, ..., typename Fn-1>
+thread_tuple_once(F0 func_0, ..., Fn-1 func_n-1);
+</pre>
<div class="variablelist">

<dl>
<dt>Preconditions:</dt>
<dd>
- <code class="computeroutput">Fk</code> must by copyable.
- </dd>
+ <code class="computeroutput">Fk</code> must by copyable.
+ </dd>
<dt>Effects:</dt>
<dd>
- <code class="computeroutput">func_k</code> is copied
- into storage managed internally by the library, and that copy is
- invoked on a newly-created thread of execution. If this invocation
- results in an exception being propagated into the internals of the
- library that is not of type <code class="computeroutput">boost::thread_interrupted</code>,
- then <code class="computeroutput">std::terminate()</code>
- will be called.
- </dd>
+ <code class="computeroutput">func_k</code> is copied
+ into storage managed internally by the library, and that copy is
+ invoked on a newly-created thread of execution. If this invocation
+ results in an exception being propagated into the internals of
+ the library that is not of type <code class="computeroutput">boost::thread_interrupted</code>,
+ then <code class="computeroutput">std::terminate()</code>
+ will be called.
+ </dd>
<dt>Postconditions:</dt>
<dd>
- <code class="computeroutput">*this</code>
- refers to the newly created tuple of threads of execution.
- </dd>
+ <code class="computeroutput">*this</code>
+ refers to the newly created tuple of threads of execution.
+ </dd>
<dt>Throws:</dt>
<dd>
- <code class="computeroutput">boost::thread_resource_error</code> if an error
- occurs.
- </dd>
+ <code class="computeroutput">boost::thread_resource_error</code> if an error
+ occurs.
+ </dd>
<dt>Note:</dt>
<dd>
- Currently up to ten arguments <code class="computeroutput">func_0</code>
- to <code class="computeroutput">funct_9</code> can be
- specified.
- </dd>
+ Currently up to ten arguments <code class="computeroutput">func_0</code>
+ to <code class="computeroutput">funct_9</code> can
+ be specified.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_destructor"></a><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_destructor" title="
- Destructor">
- Destructor</a>
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_destructor"></a><a class="link" href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_destructor" title="Destructor">Destructor</a>
</h5></div></div></div>
-<pre class="programlisting">
- ~thread_tuple_once();
-u</pre>
+<pre class="programlisting">~thread_tuple_once();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- If *this have associateds thread of execution, calls detach() on
- them. Destroys *this.
- </dd>
+ If *this have associateds thread of execution, calls detach() on
+ them. Destroys *this.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_joinable"></a><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_joinable" title="
- Member function joinables()">
- Member function <code class="computeroutput">joinables()</code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_joinable"></a><a class="link" href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_joinable" title="Member function joinables()">Member
+ function <code class="computeroutput">joinables()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- bool joinables() const;
-s</pre>
+<pre class="programlisting">bool joinables() const;
+</pre>
<div class="variablelist">

<dl>
<dt>Returns:</dt>
<dd>
- <code class="computeroutput">true</code> if <code class="computeroutput">*this</code>
- refers to threads of execution, <code class="computeroutput">false</code>
- otherwise.
- </dd>
+ <code class="computeroutput">true</code> if <code class="computeroutput">*this</code>
+ refers to threads of execution, <code class="computeroutput">false</code>
+ otherwise.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_join"></a><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_join" title="
- Member function join_all()">
- Member function <code class="computeroutput">join_all()</code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_join"></a><a class="link" href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_join" title="Member function join_all()">Member
+ function <code class="computeroutput">join_all()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- void join_all();
-e</pre>
+<pre class="programlisting">void join_all();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">join()</code>
- on each <code class="computeroutput">boost::thread</code> object in the tuple.
- </dd>
+ Call <code class="computeroutput">join()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the tuple.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- Every thread in the tuple has terminated.
- </dd>
+ Every thread in the tuple has terminated.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Note:</dt>
<dd>
- Since <code class="computeroutput">boost::thread::join</code> is one of the predefined interruption
- points, <code class="computeroutput">thread_tuple_once<>::join_all()</code> is also an interruption point.
- </dd>
+ Since <code class="computeroutput">boost::thread::join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_tuple_once<>::join_all()</code> is also an interruption point.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_all_until___"></a><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_all_until___" title="Member
- function join_all_until()">Member
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_all_until___"></a><a class="link" href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_all_until___" title="Member function join_all_until()">Member
 function <code class="computeroutput">join_all_until()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- bool join_all_until(const system_time& wait_until);
- template<typename TimeDuration>
- bool join_all_for(TimeDuration const& rel_time);
-cod</pre>
+<pre class="programlisting">bool join_all_until(const system_time& wait_until);
+template<typename TimeDuration>
+bool join_all_for(TimeDuration const& rel_time);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">timed_join()</code>
- on each <code class="computeroutput">boost::thread</code> object in the tuple.
- </dd>
+ Call <code class="computeroutput">timed_join()</code> on each <code class="computeroutput">boost::thread</code>
+ object in the tuple.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- Every thread in the tuple has terminated.
- </dd>
+ Every thread in the tuple has terminated.
+ </dd>
<dt>Returns:</dt>
<dd>
- true if joined.
- </dd>
+ true if joined.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Note:</dt>
<dd>
- Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
- interruption points, <code class="computeroutput">thread_tuple_once<>::timed_join_all()</code> is also an interruption point.
- </dd>
+ Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_tuple_once<>::timed_join_all()</code> is also an interruption point.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_any___"></a><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_any___" title="Member
- function join_any()">Member
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_any___"></a><a class="link" href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.member_function__join_any___" title="Member function join_any()">Member
 function <code class="computeroutput">join_any()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- std::size_t join_any();
-e</pre>
+<pre class="programlisting">std::size_t join_any();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">join_first()</code>
- and the <code class="computeroutput">interrup_all()</code>.
- </dd>
+ Call <code class="computeroutput">join_first()</code> and the <code class="computeroutput">interrup_all()</code>.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- Every thread in the tuple has terminated.
- </dd>
+ Every thread in the tuple has terminated.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Note:</dt>
<dd>
- Since <code class="computeroutput">boost::thread::join</code> is one of the predefined interruption
- points, <code class="computeroutput">thread_tuple_once<>::join_all()</code> is also an interruption point.
- </dd>
+ Since <code class="computeroutput">boost::thread::join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_tuple_once<>::join_all()</code> is also an interruption point.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.timed_join_first_then_interrupt"></a><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.timed_join_first_then_interrupt" title="
- Member function timed_join_first_then_interrupt()">
- Member function <code class="computeroutput">timed_join_first_then_interrupt()</code></a>
-</h5></div></div></div>
-<pre class="programlisting">
- std::pair<bool,std::size_t> timed_join_first_then_interrupt(
- const system_time& wait_until);
- template<typename TimeDuration>
- std::pair<bool,std::size_t> timed_join_first_then_interrupt(
- TimeDuration const& rel_time);
-#####</pre>
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.timed_join_first_then_interrupt"></a><a class="link" href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.timed_join_first_then_interrupt" title="Member function timed_join_first_then_interrupt()">Member
+ function <code class="computeroutput">timed_join_first_then_interrupt()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">std::pair<bool,std::size_t> timed_join_first_then_interrupt(
+ const system_time& wait_until);
+template<typename TimeDuration>
+std::pair<bool,std::size_t> timed_join_first_then_interrupt(
+ TimeDuration const& rel_time);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">timed_join_first()</code> and the <code class="computeroutput">interrup_all()</code>.
- </dd>
+ Call <code class="computeroutput">timed_join_first()</code> and the <code class="computeroutput">interrup_all()</code>.
+ </dd>
<dt>Postcondition:</dt>
<dd>
- Every thread in the tuple has terminated.
- </dd>
+ Every thread in the tuple has terminated.
+ </dd>
<dt>Returns:</dt>
<dd>
- true if joined.
- </dd>
+ true if joined.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing
- </dd>
+ Nothing
+ </dd>
<dt>Note:</dt>
<dd>
- Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
- interruption points, <code class="computeroutput">thread_tuple_once<>::timed_join_all()</code> is also an interruption point.
- </dd>
+ Since <code class="computeroutput">boost::thread::timed_join</code> is one of the predefined
+ interruption points, <code class="computeroutput">thread_tuple_once<>::timed_join_all()</code> is also an interruption point.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.detach_all"></a><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.detach_all" title="
- Member function detach_all()">
- Member function <code class="computeroutput">detach_all()</code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.detach_all"></a><a class="link" href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.detach_all" title="Member function detach_all()">Member
+ function <code class="computeroutput">detach_all()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- void detach_all();
-<</pre>
+<pre class="programlisting">void detach_all();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">detach()</code>
- on each <code class="computeroutput">boost::thread</code> object in the tuple.
- </dd>
+ Call <code class="computeroutput">detach()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the tuple.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_interrupt_all"></a><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_interrupt_all" title="
- Member function interrupt_all()">
- Member function <code class="computeroutput">interrupt_all()</code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_interrupt_all"></a><a class="link" href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_interrupt_all" title="Member function interrupt_all()">Member
+ function <code class="computeroutput">interrupt_all()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
- void interrupt_all();
-r</pre>
+<pre class="programlisting">void interrupt_all();
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- Call <code class="computeroutput">thread::interrupt()</code>
- on each <code class="computeroutput">boost::thread</code> object in the tuple.
- </dd>
+ Call <code class="computeroutput">thread::interrupt()</code>
+ on each <code class="computeroutput">boost::thread</code> object in the tuple.
+ </dd>
</dl>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_size"></a><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_size" title="
- Member function size()">
- Member function <code class="computeroutput">size()</code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_size"></a><a class="link" href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_class.thread_tuple_once_size" title="Member function size()">Member
+ function <code class="computeroutput">size()</code></a>
</h5></div></div></div>
-<pre class="programlisting">
-int size();
+<pre class="programlisting">int size();
</pre>
<div class="variablelist">

<dl>
<dt>Returns:</dt>
<dd>
- The number of threads in the tuple.
- </dd>
+ The number of threads in the tuple.
+ </dd>
<dt>Throws:</dt>
<dd>
- Nothing.
- </dd>
+ Nothing.
+ </dd>
</dl>
</div>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_make_thread_tuple_once"></a><a href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_make_thread_tuple_once" title="
- Non Member Function make_thread_tuple_once()">
- Non Member Function <code class="computeroutput">make_thread_tuple_once()</code></a>
+<a name="toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_make_thread_tuple_once"></a><a class="link" href="thread_tuple_once_hpp.html#toward_boost_interthreads.reference.thread_tuple_once_hpp.thread_tuple_once_make_thread_tuple_once" title="Non Member Function make_thread_tuple_once()">Non
+ Member Function <code class="computeroutput">make_thread_tuple_once()</code></a>
</h4></div></div></div>
-<pre class="programlisting">
- template<typename F0, ..., typename Fn-1>
- thread_tuple_once make_thread_tuple_once(F0 f0, ..., Fn fn-1);
-ra</pre>
+<pre class="programlisting">template<typename F0, ..., typename Fn-1>
+thread_tuple_once make_thread_tuple_once(F0 f0, ..., Fn fn-1);
+</pre>
<div class="variablelist">

<dl>
<dt>Effects:</dt>
<dd>
- makes a new thread_tuple_once<>.
- </dd>
+ makes a new thread_tuple_once<>.
+ </dd>
<dt>Returns:</dt>
<dd>
- the created thread tuple.
- </dd>
+ the created thread tuple.
+ </dd>
</dl>
</div>
</div>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,15 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title> Users'Guide</title>
-<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../index.html" title="Toward Boost.InterThreads">
-<link rel="prev" href="overview/motivation.html" title=" Motivation">
-<link rel="next" href="users_guide/getting_started.html" title="
- Getting Started">
+<title>Users'Guide</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Toward Boost.InterThreads 0.1.3">
+<link rel="up" href="../index.html" title="Toward Boost.InterThreads 0.1.3">
+<link rel="prev" href="overview.html" title="Overview">
+<link rel="next" href="reference.html" title="Reference">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -22,47 +20,1744 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="overview/motivation.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="users_guide/getting_started.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="overview.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reference.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="toward_boost_interthreads.users_guide"></a> Users'Guide
+<a name="toward_boost_interthreads.users_guide"></a><a class="link" href="users_guide.html" title="Users'Guide">Users'Guide</a>
</h2></div></div></div>
<div class="toc"><dl>
-<dt><a href="users_guide/getting_started.html">
- Getting Started</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.getting_started">Getting
+ Started</a></dt>
<dd><dl>
-<dt><a href="users_guide/getting_started.html#toward_boost_interthreads.users_guide.getting_started.install">
- Installing InterThreads</a></dt>
-<dt><a href="users_guide/getting_started.html#toward_boost_interthreads.users_guide.getting_started.hello_world__decorator">Hello
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.install">Installing
+ InterThreads</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.hello_world__decorator">Hello
 World! decorator</a></dt>
-<dt><a href="users_guide/getting_started.html#toward_boost_interthreads.users_guide.getting_started.monotonic_thread_id">Monotonic
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.monotonic_thread_id">Monotonic
 Thread Id</a></dt>
-<dt><a href="users_guide/getting_started.html#toward_boost_interthreads.users_guide.getting_started.basic_keep_alive">Basic
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.basic_keep_alive">Basic
 keep alive</a></dt>
</dl></dd>
-<dt> Tutorial</dt>
+<dt>Tutorial</dt>
<dd><dl>
-<dt><a href="users_guide/tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator">Thread
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator">Thread
 Decorator</a></dt>
-<dt><a href="users_guide/tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer">Thread
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer">Thread
 Specific Shared Pointer</a></dt>
-<dt><a href="users_guide/tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive">Keep
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive">Keep
 alive</a></dt>
-<dt><a href="users_guide/tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple">Thread
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple">Thread
 Tuple</a></dt>
</dl></dd>
-<dt><a href="users_guide/bibliography.html">
- References</a></dt>
-<dt> Glossary</dt>
+<dt>Examples</dt>
+<dd><dl><dt><a href="users_guide.html#toward_boost_interthreads.users_guide.examples.thread_safe_deferred_traces">Thread
+ safe deferred traces</a></dt></dl></dd>
+<dt>References</dt>
+<dt>Glossary</dt>
</dl></div>

 [/
 
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.users_guide.getting_started"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.getting_started" title="Getting Started">Getting
+ Started</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.install">Installing
+ InterThreads</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.hello_world__decorator">Hello
+ World! decorator</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.monotonic_thread_id">Monotonic
+ Thread Id</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.basic_keep_alive">Basic
+ keep alive</a></dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.users_guide.getting_started.install"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.install" title="Installing InterThreads">Installing
+ InterThreads</a>
+</h4></div></div></div>
+<a name="toward_boost_interthreads.users_guide.getting_started.install.getting_boost_interthreads"></a><h6>
+<a name="id3024068"></a>
+ <a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.install.getting_boost_interthreads">Getting
+ Boost.InterThreads</a>
+ </h6>
+
+ You can get the last stable release of Boost.InterThreads
+ by downloading <code class="literal">interthreads.zip</code> from the <a href="http://www.boost-consulting.com/vault/index.php?directory=Concurrent%20Programming" target="_top">Boost
+ Vault</a>
+ 
+
+ You can also access the latest (unstable?) state from the <a href="https://svn.boost.org/svn/boost/sandbox/interthreads" target="_top">Boost
+ Sandbox</a>.
+ 
+<a name="toward_boost_interthreads.users_guide.getting_started.install.building_boost_interthreads"></a><h6>
+<a name="id3024122"></a>
+ <a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.install.building_boost_interthreads">Building
+ Boost.InterThreads</a>
+ </h6>
+
+ Boost.InterThreads is not a header only
+ library. You need to compile it before use.
+ 
+<pre class="programlisting">cd libs/interthreads/build
+bjam
+</pre>
+<a name="toward_boost_interthreads.users_guide.getting_started.install.build_requirements"></a><h6>
+<a name="id3024192"></a>
+ <a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.install.build_requirements">Build
+ Requirements</a>
+ </h6>
+
+ Boost.InterThreads depends on Boost. You
+ must use either Boost version 1.38.x or the version in SVN trunk. In particular,
+ Boost.InterThreads depends on:
+ 
+<div class="variablelist">
+
+<dl>
+<dt>Boost.Array</dt>
+<dd>
+ for array, ...
+ </dd>
+<dt>Boost.Bind</dt>
+<dd>
+ for bind, ...
+ </dd>
+<dt>Boost.Config</dt>
+<dd>
+ for ??? and abi_prefic_sufix, ...
+ </dd>
+<dt>Boost.Function</dt>
+<dd>
+ for function, ...
+ </dd>
+<dt>Boost.Fusion</dt>
+<dd>
+ for tuples, and sequence algorithms ...
+ </dd>
+<dt>Boost.MPL</dt>
+<dd>
+ for transform, ...
+ </dd>
+<dt>Boost.Preprocesor</dt>
+<dd>
+ to simulate variadic templates , ...
+ </dd>
+<dt>Boost.SmartPtr</dt>
+<dd>
+ for shared_ptr, ...
+ </dd>
+<dt>Boost.Threads</dt>
+<dd>
+ for thread, thread_specific_ptr, call_once, mutex, condition_variable,
+ ...
+ </dd>
+<dt>Boost.TypeOf</dt>
+<dd>
+ to register the ACT types.
+ </dd>
+<dt>Boost.TypeTrais</dt>
+<dd>
+ for is_void, remove_references, ...
+ </dd>
+<dt>Boost.Utility</dt>
+<dd>
+ for result_of, enable_if...
+ </dd>
+</dl>
+</div>
+<a name="toward_boost_interthreads.users_guide.getting_started.install.exceptions_safety"></a><h6>
+<a name="id3024483"></a>
+ <a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.install.exceptions_safety">Exceptions
+ safety</a>
+ </h6>
+
+ All functions in the library are exception-neutral and provide strong guarantee
+ of exception safety as long as the underlying parameters provide it.
+ 
+<a name="toward_boost_interthreads.users_guide.getting_started.install.thread_safety"></a><h6>
+<a name="id3024510"></a>
+ <a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.install.thread_safety">Thread
+ safety</a>
+ </h6>
+
+ All functions in the library are thread-unsafe except when noted explicitly.
+ 
+<a name="toward_boost_interthreads.users_guide.getting_started.install.tested_compilers"></a><h6>
+<a name="id3024535"></a>
+ <a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.install.tested_compilers">Tested
+ compilers</a>
+ </h6>
+
+ Currently, Boost.InterThreads has been
+ tested in the following compilers/platforms:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ GCC 3.4.4 Cygwin
+ </li>
+<li class="listitem">
+ GCC 3.4.6 Linux
+ </li>
+<li class="listitem">
+ GCC 4.1.2 Linux
+ </li>
+</ul></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ Please send any questions, comments and bug reports to boost <at>
+ lists <dot> boost <dot> org.
+ </td></tr>
+</table></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.users_guide.getting_started.hello_world__decorator"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.hello_world__decorator" title="Hello World! decorator">Hello
+ World! decorator</a>
+</h4></div></div></div>
+
+ This is a little bit more than a Hello World! example. It will also say
+ Bye, Bye!
+ 
+<pre class="programlisting">#include <boost/interthreads/thread_decorator.hpp>
+#include <boost/thread.hpp>
+#include <iostream>
+
+namespace bith = boost::interthreads;
+
+void my_setup() {
+ std::cout << "Hello World!" << std::endl;
+}
+
+void my_cleanup() {
+ std::cout << "Bye, Bye!" << std::endl;
+}
+
+bith::thread_decoration my_decoration(my_setup, my_cleanup);
+
+void my_thread() {
+ std::cout << "..." << std::endl;
+}
+
+int main() {
+ boost::thread th(bith::make_decorator(my_thread));
+ th.join();
+ return 0;
+}
+</pre>
+
+ When <code class="computeroutput">th</code> is created with
+ the <code class="computeroutput">bith::thread_decorator</code> wrapper, it will initialize
+ all the decorations before calling <code class="computeroutput">my_thread</code>.
+ This <code class="computeroutput">my_cleanup</code> will be
+ registered with the <code class="computeroutput">boost:this_thread::at_thread_exit</code>
+ if the <code class="computeroutput">my_setup</code> function
+ succeeds i.e. does not throw. Then the thread function <code class="computeroutput">my_thread</code>
+ is called. At the thread exit, the <code class="computeroutput">my_cleanup</code>
+ function is called. This results on the following output
+ 
+<pre class="programlisting">Hello World!
+...
+Bye, Bye!
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.users_guide.getting_started.monotonic_thread_id"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.monotonic_thread_id" title="Monotonic Thread Id">Monotonic
+ Thread Id</a>
+</h4></div></div></div>
+
+ This example use thread decorator and thread specific pointers to implement
+ a monotonic thread identifier.
+ 
+
+ The monotonic thread identifier is managed by the mono_thread_id class.
+ There is a mutex protecting the access to the monotonic counter. The main
+ difference between a thread_specific_shared_ptr and a thread_specific_ptr
+ is that we can get the specific pointer of another thread (*) With the
+ help of bith::thread_decoration, the setting of the thread specific shared
+ pointer is done transparently, as far as the thread is created using a
+ thread decorator. This setup function resets the specific pointer with
+ the value of the monotonic counter which will be self increased.
+ 
+<pre class="programlisting">#include <boost/interthreads/thread_decorator.hpp>
+#include <boost/interthreads/thread_specific_shared_ptr.hpp>
+#include <boost/thread.hpp>
+#include <iostream>
+
+namespace bith = boost::interthreads;
+
+class mono_thread_id {
+ static bith::thread_decoration decoration_;
+ typedef bith::thread_specific_shared_ptr<unsigned> tssp_type;
+ static tssp_type current_;
+ static unsigned counter_;
+ static boost::mutex sync_;
+
+ static unsigned create() {
+ boost::lock_guard<boost::mutex> lock(sync_);
+ unsigned res = counter_;
+ ++counter;
+ return res;
+ }
+ static void setup() {
+ current_.reset(new unsigned(create());
+ }
+public:
+ static unsigned id() {
+ return *current_;
+ }
+ static unsigned id(boost::thread::id id) {
+ return *current_[id]; // (*)
+ }
+
+};
+
+bith::thread_decoration mono_thread_id::decoration(mono_thread_id::setup);
+mono_thread_id::tssp_type mono_thread_id::current_;
+unsigned mono_thread_id::counter_=0;
+boost::mutex mono_thread_id::sync_;
+</pre>
+
+ In this way the applications using the thread_decorator can have access
+ to a monotonic thread id mono_thread_id::id() and this id is accesible
+ to other threads providing the boost::thread::id.
+ 
+<pre class="programlisting">void my_thread() {
+ std::cout << "mono_thread_id=" << mono_thread_id::id() << std::endl;
+ sleep(5);
+}
+
+struct mono_thread_id_out {
+ template<typename T>
+ void operator()(T& t) const {
+ std::cout << "thread::id=" << t.get_id()
+ << " mono_thread_id=" << mono_thread_id::id(t.get_id())
+ << std::endl;
+ }
+};
+
+int main() {
+ bith::shared_threader_decorator ae;
+ BOOST_AUTO(handles, bith::fork_all(basic_threader_decorator, my_thread, my_thread));
+ boost::fusion::for_each(handles, mono_thread_id_out());
+ bith.join_all();
+ return 0;
+}
+</pre>
+
+ This results on the following output
+ 
+<pre class="programlisting">mono_thread_id=1
+mono_thread_id=2
+thread::id=xxxx mono_thread_id=1
+thread::id=xxxx mono_thread_id=2
+
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.users_guide.getting_started.basic_keep_alive"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.getting_started.basic_keep_alive" title="Basic keep alive">Basic
+ keep alive</a>
+</h4></div></div></div>
+
+ This example shows the keep_alive basics.
+ 
+<pre class="programlisting">#include <boost/interthreads/thread_decorator.hpp>
+#include <boost/interthreads/keep_alive.hpp>
+#include <boost/thread/thread.hpp>
+#include <iostream>
+
+namespace bith = boost::interthreads;
+
+void my_thread() {
+ bith::this_thread::enable_keep_alive enabler;
+ for (int i=0; i<5; i++) {
+ bith::this_thread::keep_alive_point();
+ std::cout << "thread_id=" << boost::this_thread::get_id() << std::endl;
+ sleep(1);
+ }
+}
+
+int main() {
+ bith::shared_threader_decorator ae;
+ bith::wait_for_all(ae, my_thread, my_thread, my_thread, my_thread);
+
+ return 0;
+}
+</pre>
+
+ The user creates 4 threads using the shared_threader_decorator <code class="computeroutput">AsynchronousExecutor</code> to be able to use
+ the keep_alive mechanism. It uses the default enabler (one keep_alive_point
+ every 2 seconds).
+ 
+
+ This results on the following output
+ 
+<pre class="programlisting"></pre>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial" title="Tutorial">Tutorial</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator">Thread
+ Decorator</a></dt>
+<dd><dl>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.declaring_a_decoration">Declaring
+ a decoration</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.creating_threads_with_decorators">Creating
+ threads with decorators</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.decorator_explicit_call">Calling
+ explictly the decoration on a thread</a></dt>
+</dl></dd>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer">Thread
+ Specific Shared Pointer</a></dt>
+<dd><dl>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.key_initialization">Key
+ initialization</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.context_initialization">Context
+ initialization</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_on_the_current_thread">Obtain
+ the pointer to the thread-specific object on the current thread</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_of_another_thread">Obtain
+ the pointer to the thread-specific object of another thread</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.iterating_through_all_the_thread_specific_context">Iterating
+ through all the thread specific context</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.deleting_the_context">Deleting
+ the context</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.cleanup_at_thread_exit">Cleanup
+ at thread exit</a></dt>
+</dl></dd>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive">Keep
+ alive</a></dt>
+<dd><dl>
+<dt>Interface</dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_mechanism_initialization">Keep
+ alive mechanism initialization</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_threads">Which
+ threads can be controlled?</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_enabling">Enabling
+ the keep alive mechanism</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_disabling">Disabling
+ the keep alive mechanism</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_persistent">Configuring
+ the dead persistency</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from_the_current_thread">Access
+ from the current thread</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from__the_controller_thread">Access
+ from the controller thread</a></dt>
+</dl></dd>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple">Thread
+ Tuple</a></dt>
+<dd><dl>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_launching">Launching
+ thread tuple</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_exceptions">Exceptions
+ in thread functions</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_joining">Joining
+ and detaching</a></dt>
+<dt>Interruption</dt>
+</dl></dd>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_decorator"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator" title="Thread Decorator">Thread
+ Decorator</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.declaring_a_decoration">Declaring
+ a decoration</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.creating_threads_with_decorators">Creating
+ threads with decorators</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.decorator_explicit_call">Calling
+ explictly the decoration on a thread</a></dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_decorator.declaring_a_decoration"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.declaring_a_decoration" title="Declaring a decoration">Declaring
+ a decoration</a>
+</h5></div></div></div>
+
+ Objects of type <code class="computeroutput">thread_decoration</code>
+ are usualy static and initialized with a <code class="computeroutput">Callable</code>
+ object:
+ 
+<pre class="programlisting">static boost::interthreads::thread_decoration d;
+void setup();
+
+bith::thread_decoration d(setup);
+</pre>
+
+ These decorations will be called either when we request this explicitly
+ at the initialization of the thread (this is needed on the main thread)
+ or when we create a thread using specific decorator wrapper. This is
+ explained in more detail in the next sections.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_decorator.creating_threads_with_decorators"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.creating_threads_with_decorators" title="Creating threads with decorators">Creating
+ threads with decorators</a>
+</h5></div></div></div>
+
+ When we want the decorations to decorate one thread of execution we can
+ create the thread using the decorator wrapper.
+ 
+<pre class="programlisting">boost::thread th(bith::thread_decorator(fct));
+</pre>
+
+ This behavion is obtained also using one of the <code class="computeroutput">AsynchronousExecutor</code>
+ decorators of the Boost.Async library, as
+ 
+<pre class="programlisting">bith::basic_threader_decorator ae;
+BOOST_AUTO(th, bith::fork(ae, fct));
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_decorator.decorator_explicit_call"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.decorator_explicit_call" title="Calling explictly the decoration on a thread">Calling
+ explictly the decoration on a thread</a>
+</h5></div></div></div>
+
+ For threads that are not created using the boost::thread class, as it
+ is the case of the main thread, we need to call explicitly the function
+ <code class="computeroutput">bith::decorate</code> at the begining of the thread.
+ 
+<pre class="programlisting">int main() {
+ bith::decorate();
+ // ...
+}
+</pre>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer" title="Thread Specific Shared Pointer">Thread
+ Specific Shared Pointer</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.key_initialization">Key
+ initialization</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.context_initialization">Context
+ initialization</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_on_the_current_thread">Obtain
+ the pointer to the thread-specific object on the current thread</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_of_another_thread">Obtain
+ the pointer to the thread-specific object of another thread</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.iterating_through_all_the_thread_specific_context">Iterating
+ through all the thread specific context</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.deleting_the_context">Deleting
+ the context</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.cleanup_at_thread_exit">Cleanup
+ at thread exit</a></dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.key_initialization"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.key_initialization" title="Key initialization">Key
+ initialization</a>
+</h5></div></div></div>
+
+ As the curent implementation uses the address of the thread_specific_shared_ptr<>
+ object, there is no need to do anything to get the key.
+ 
+<pre class="programlisting">bith::thread_specific_shared_ptr<myclass> ptr;
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.context_initialization"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.context_initialization" title="Context initialization">Context
+ initialization</a>
+</h5></div></div></div>
+
+ Initially the pointer has a value of <code class="computeroutput">0</code>
+ in each thread, but the value for the current thread can be set using
+ the <code class="computeroutput">reset()</code>
+ member functions.
+ 
+
+ If the value of the pointer for the current thread is changed using
+ <code class="computeroutput">reset()</code>,
+ then the previous value is destroyed by calling the deleter routine.
+ Alternatively, the stored value can be reset to <code class="computeroutput">0</code>
+ and the prior value returned by calling the <code class="computeroutput">release()</code> member function, allowing the application
+ to take back responsibility for destroying the object.
+ 
+
+ Initialization can be done
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ explicitly on the curret thread. Basically it works like a thread
+ local storage from inside the thread.
+ </li></ul></div>
+<pre class="programlisting">bith::thread_specific_shared_ptr<myclass> ptr;
+void func() { // current thread
+ // ...
+ ptr.reset(p);
+ // ...
+}
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ When we associate a thread decoration to the thread_specific_shared_ptr<>
+ we initialize implicitly every thread created with a thread_decorator.
+ </li></ul></div>
+<pre class="programlisting">bith::thread_specific_shared_ptr<myclass> ptr;
+void myclass_setup() {
+ ptr.reset(new myclass(any specific parameters));
+}
+bith::thread_decoration myclass_decoration(myclass_setup);
+
+void func() { // ptr.reset(p); done implicitly
+
+}
+
+boost::thread th=bith::make_decorated_thread(func);
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_on_the_current_thread"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_on_the_current_thread" title="Obtain the pointer to the thread-specific object on the current thread">Obtain
+ the pointer to the thread-specific object on the current thread</a>
+</h5></div></div></div>
+
+ All functions known from boost::thread_specific_ptr are available except
+ the release function. The value for the current thread can be obtained
+ using the <code class="computeroutput">get()</code>
+ member function, or by using the <code class="computeroutput">*</code>
+ and <code class="computeroutput">-></code> pointer deference
+ operators.
+ 
+<pre class="programlisting">void func() {
+{ // current thread
+ // ...
+ if (ptr.get()==0) ptr.reset(new myclass);
+ // ...
+ ptr->someFct();
+}
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_of_another_thread"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_of_another_thread" title="Obtain the pointer to the thread-specific object of another thread">Obtain
+ the pointer to the thread-specific object of another thread</a>
+</h5></div></div></div>
+
+ Besides, other threads can get access to the data provided a thread::id
+ by:
+ 
+<pre class="programlisting">boost::thread th=bith::make_decorated_thread(func);
+
+ptr[th->get_id()]->foo();
+</pre>
+
+ where <code class="computeroutput">foo()</code>
+ is a function of <code class="computeroutput">myclass</code>.
+ 
+
+ This could work or not. The issue appears as we can get a reference to
+ a thread before the thread has started, so the setting of the thread
+ specific context could be not yet done. One way to manage with this error
+ is to get the shared pointer and check if it contains something or not.
+ 
+<pre class="programlisting">shared_ptr<myclass> shp = ptr[th->get_id()]->foo();
+if (shp.get() != 0) shp->foo();
+else ...
+</pre>
+
+ When we need this we can pool:
+ 
+<pre class="programlisting">shared_ptr<myclass> shp;
+do {
+ shp = ptr[th->get_id()]->foo();
+} while(shp.get() == 0);
+shp->foo();
+</pre>
+
+ The library provides a synchonization mechanism to solve this issue.
+ The wait_and_get() function allows a thread to synchronize with the setting
+ from another thread.
+ 
+<pre class="programlisting">shared_ptr<myclass> shp = ptr.wait_and_get(th->get_id());
+shp->foo();
+</pre>
+
+ or
+ 
+<pre class="programlisting">ptr.wait_and_get(th->get_id()->foo();
+</pre>
+
+ In order to ensure that the decorations have been called, a cleaner and
+ safer option is not to return the thread until it has been started. This
+ behavior is obtained each time the thread is created with an <code class="computeroutput">AsynchronousExecutor</code> decorator when
+ using the Boost.Async library, as
+ 
+<pre class="programlisting">bith::basic_threader_decorator ae;
+BOOST_AUTO(th, bith::fork(ae, func));
+// here you are sure all the decorations have been called
+// so we can access any thread_specific_shared_ptr of the created thread.
+</pre>
+
+ The lifetime of the myclass instance is managed by a shared_ptr. One
+ reference is held by the thread (by means of a tss), a second is held
+ by the thread::id to shared_ptr<T> map and additional references
+ might be held by other threads, obtained by <code class="computeroutput">*pmyclass[th]</code>.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.iterating_through_all_the_thread_specific_context"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.iterating_through_all_the_thread_specific_context" title="Iterating through all the thread specific context">Iterating
+ through all the thread specific context</a>
+</h5></div></div></div>
+
+ Another use case appears when some global controller needs to access
+ the thread specific data of all the threads. Several approaches are here
+ possible; the library has choosen to provide a map getter using a external
+ locking mechanism that 'ensure' that the map access is locked during
+ the map query.
+ 
+<pre class="programlisting">{
+ bith::thread_specific_shared_ptr<myclass>::lock_type lock(ptr.get_mutex());
+ const bith::thread_specific_shared_ptr<myclass>::map_type amap = ptr.get_map(lock);
+ // use the map
+}
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.deleting_the_context"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.deleting_the_context" title="Deleting the context">Deleting
+ the context</a>
+</h5></div></div></div>
+
+ When a thread exits, the objects associated with each <code class="computeroutput">boost::thread_specific_shared_ptr<></code> instance is not inmediately destroyed
+ due to its shared nature. It is detached from the current thread and
+ removed from the map. Only when there are no more references to the shared
+ pointer it will be destroyed. By default, the object pointed to by a
+ pointer <code class="computeroutput">p</code> is destroyed
+ by invoking <code class="computeroutput">delete p</code>,
+ but this can be overridden for a specific instance of <code class="computeroutput">boost::thread_specific_shared_ptr<></code> by providing a deleter routine
+ to the constructor. In this case, the object is destroyed by invoking
+ <code class="computeroutput">deleter(p)</code>
+ where <code class="computeroutput">deleter</code> is the
+ deleter routine supplied to the constructor. The deleter function is
+ called only when there are no more references to the shared pointer.
+ 
+<pre class="programlisting">// Add use of deleter !!!
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.cleanup_at_thread_exit"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.cleanup_at_thread_exit" title="Cleanup at thread exit">Cleanup
+ at thread exit</a>
+</h5></div></div></div>
+
+ When a thread exits, the objects associated with each thread_specific_shared_ptr<>
+ instance is not inmediately destroyed due to its shared nature. Only
+ when there are no more references to the shared pointer it will be destroyed.
+ By default, the object pointed to by a pointer p is destroyed by invoking
+ delete p, but this can be overridden for a specific instance of boost::thread_specific_shared_ptr<>
+ by providing a cleanup routine to the constructor. In this case, the
+ object is destroyed by invoking func(p) where func is the cleanup routine
+ supplied to the constructor. The cleanup functions are called in an unspecified
+ order. If a cleanup routine sets the value of associated with an instance
+ of boost::thread_specific_shared_ptr<> that has already been cleaned
+ up, that value is added to the cleanup list. Cleanup finishes when there
+ are no outstanding instances of boost::thread_specific_shared_ptr<>
+ with values. If a cleanup routine sets the value associated with an instance
+ of <code class="computeroutput">boost::thread_specific_shared_ptr<></code>
+ that has already been cleaned up, that value is added to the cleanup
+ list. Cleanup finishes when there are no outstanding instances of <code class="computeroutput">boost::thread_specific_shared_ptr<></code>
+ with values.
+ 
+<pre class="programlisting">// Add use of at thread_exit!!!
+</pre>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive" title="Keep alive">Keep
+ alive</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt>Interface</dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_mechanism_initialization">Keep
+ alive mechanism initialization</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_threads">Which
+ threads can be controlled?</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_enabling">Enabling
+ the keep alive mechanism</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_disabling">Disabling
+ the keep alive mechanism</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_persistent">Configuring
+ the dead persistency</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from_the_current_thread">Access
+ from the current thread</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from__the_controller_thread">Access
+ from the controller thread</a></dt>
+</dl></div>
+
+ We will use the implementation of the keep alive mechanism as tutorial
+ for the thread decorators, thread specific shared pointers and the keep
+ alive mechanism itself.
+ 
+
+ We want to detect situations on which a thread is looping or blocked on
+ some component. The user needs to state when this mechanism is enabled
+ or disabled.
+ 
+
+ Since the only purpose is to find threads that don't work, the thread needs
+ to say if it is alive to a controller. The controler requests at predefined
+ intervals if the thread is dead, and in this case it will call a user specific
+ function which by default aborts the program.
+ 
+
+ A thread is considered dead if during a given period the number of checkins
+ is inferior to a given threshold. These two parameters are given when the
+ keep alive mechanislm is enabled. At the begining of a thread the keep
+ alive mechanism is disabled.
+ 
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.interface"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.interface" title="Interface">Interface</a>
+</h5></div></div></div>
+
+ Next follows the keep alive interface.
+ 
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+ namespace this_thread {
+ class enable_keep_alive {
+ public:
+ enable_keep_alive(std::size_t periods=2, std::size_t checkins=1);
+ ~enable_keep_alive();
+ };
+
+ class disable_keep_alive {
+ public:
+ disable_keep_alive();
+ ~disable_keep_alive();
+ };
+
+ void keep_alive_point();
+ bool keep_alive_enabled();
+
+ typedef void (*on_dead_thread_type)(thread::id, thread*);
+ void set_on_dead_thread(on_dead_thread_type fct, thread* th=0);
+
+ }
+ bool keep_alive_enabled(thread::id);
+ void set_on_dead_thread(thread::id, on_dead_thread_type fct, thread* th=0);
+}
+}
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_mechanism_initialization"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_mechanism_initialization" title="Keep alive mechanism initialization">Keep
+ alive mechanism initialization</a>
+</h5></div></div></div>
+
+ There is a single controller <code class="computeroutput">keep_alive_mgr</code>.
+ The controler needs to access some thread specific shared context <code class="computeroutput">thread_keep_alive_ctx</code> to be able to
+ control a thread.
+ 
+<pre class="programlisting">namespace detail {
+ struct thread_keep_alive_ctx {
+ // ...
+ static void init();
+
+ typedef thread_specific_shared_ptr<thread_keep_alive_ctx> tssp;
+ static tssp instance_;
+ static thread_decoration initializer_;
+ thread_keep_alive_internal* data_;
+ };
+ struct keep_alive_mgr {
+ // ...
+ static void initialize() {
+ boost::call_once(flag, init);
+ }
+ static void init() {
+ instance_=new keep_alive_mgr();
+ }
+ boost::thread thread_;
+ static boost::once_flag flag_;
+ static keep_alive_mgr* instance_;
+ };
+}
+</pre>
+
+ The initialization of the controller itself and the setting the thread
+ specific context is done using an internal thread decoration <code class="computeroutput">thread_keep_alive_ctx::initializer_</code> with <code class="computeroutput">thread_keep_alive_ctx::init</code>
+ as setup function.
+ 
+<pre class="programlisting">thread_specific_shared_ptr<detail::thread_keep_alive_ctx> thread_keep_alive_ctx::instance_;
+thread_decoration thread_keep_alive_ctx::initializer_(thread_keep_alive_ctx::init);
+boost::once_flag keep_alive_mgr::flag;
+</pre>
+
+ This setup function will initialize the <code class="computeroutput">keep_alive_mgr</code>
+ and then set the <code class="computeroutput">thread_specific_shared_ptr<></code> with a new <code class="computeroutput">thread_keep_alive_ctx</code>.
+ 
+<pre class="programlisting">void thread_keep_alive_ctx::init() {
+ keep_alive_mgr::initialize();
+ instance_.reset(new thread_keep_alive_ctx());
+}
+</pre>
+
+ The <code class="computeroutput">keep_alive_mgr::initialize</code> function ensures just that
+ the init function is called once using the <code class="computeroutput">boost::call_once</code>.
+ This <code class="computeroutput">init</code> function creates
+ the instance of the <code class="computeroutput">keep_alive_mgr</code>
+ singleton.
+ 
+<pre class="programlisting">void keep_alive_mgr::initialize() {
+ boost::call_once(flag_, init);
+}
+void keep_alive_mgr::init() {
+ instance_=new keep_alive_mgr();
+}
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_threads"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_threads" title="Which threads can be controlled?">Which
+ threads can be controlled?</a>
+</h5></div></div></div>
+
+ As the keep alive mechanism uses a thread decoration, the user needs
+ to explicitly call the <code class="computeroutput">bith::decorate</code>
+ function at the begining of the thread function or by wrapping the thread
+ function. Instead of having a specific function to call or use a thread
+ function wrapper, the keep alive uses the functions provided by the thread
+ decorator (<code class="computeroutput">bith::decorate</code> and <code class="computeroutput">bith::thread_decorator</code>).
+ So we must either call <code class="computeroutput">bith::decorate</code>
+ explicitly on the thread function
+ 
+<pre class="programlisting">void fct() {
+ bith::decorate();
+ // ...
+}
+</pre>
+
+ or create the thread with the <code class="computeroutput">bith::make_decorator</code>
+ wrapper
+ 
+<pre class="programlisting">boost::thread th(bith::make_decorator(fct));
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_enabling"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_enabling" title="Enabling the keep alive mechanism">Enabling
+ the keep alive mechanism</a>
+</h5></div></div></div>
+
+ To be controled by the keep alive manager we need to enable the mechanism
+ using the enable_keep_alive. By default this enabler requires the application
+ to do at least one check point every 2 seconds using the <code class="computeroutput">bith::keep_alive_point()</code>
+ function.
+ 
+<pre class="programlisting">void fct() {
+ using bith::this_thread;
+
+ // ...
+ enable_keep_alive ena;
+ // states that the thread will be declared dead if threre are
+ // less that 1 check_points in 2 seconds.
+ for(;;) {
+ // do a check point
+ keep_alive_point();
+ // ...
+ }
+}
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_disabling"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_disabling" title="Disabling the keep alive mechanism">Disabling
+ the keep alive mechanism</a>
+</h5></div></div></div>
+
+ Some times we need to do an external task that could take an undefined
+ time. We can then disable the keep alive mechanisme by using a disabler
+ <code class="computeroutput">bith::disable_keep_alive</code>.
+ 
+<pre class="programlisting">void fct() {
+ using bith::this_thread;
+
+ // ...
+ // states that the thread will be declared dead if threre are
+ // less that 1 check_points in 2 seconds.
+ enable_keep_alive enabler;
+ for(;;) {
+ // do a check point
+ keep_alive_point();
+
+ if (cnd) {
+ // when a blocking task spending an undefined time
+ // you can disable the keep alive mechanism
+ disable_keep_alive disabler;
+
+ }
+ }
+}
+</pre>
+
+ If on the contrary we don't want to disable the keep alive mechanism,
+ it should be interesting to do a <code class="computeroutput">boost::interruption_check_point()</code> just after the blocking task. In this
+ way if the task takes too much time and the thread is declared dead,
+ the possibility to manage the keep alive error by interrupting the dead
+ thread remains, once the task is finished.
+ 
+<pre class="programlisting">void fct() {
+ using boost::this_thread;
+ using bith::this_thread;
+
+ // ...
+ // states that the thread will be declared dead if threre are
+ // less that 1 check_points in 2 seconds.
+ enable_keep_alive enabler;
+ for(;;) {
+ // do a check point
+ keep_alive_point();
+
+ if (cnd) {
+ // when a blocking task spending an undefined time
+ // you can disable the keep alive mechanism
+ unknow_time_task();
+ interruption_check_point();
+
+ }
+ }
+}
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_persistent"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_persistent" title="Configuring the dead persistency">Configuring
+ the dead persistency</a>
+</h5></div></div></div>
+
+ The default enabling parameters could be too restrictive in some cases.
+ But the <code class="computeroutput">enable_keep_alive</code>
+ configures it with the two parameters. We can declare a thread dead when
+ the thread has not done a number of checkins in a given period. This
+ can be useful when one knows the time a given task should take.
+ 
+<pre class="programlisting">void fct() {
+ using bith::this_thread;
+
+ // ...
+ // states that the thread will be declared dead if threre are
+ // less that 4 check_points in 30 seconds.
+ enable_keep_alive enabler(15, 1);
+ for(;;) {
+
+ if (cnd) {
+ // it is know that this task will take no more than 15 seconds
+ enable_keep_alive control(15, 1);
+ know_time_task();
+ keep_alive_point();
+ this_thread::interruprion_check_point();
+ }
+
+
+ }
+ // ...
+}
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from_the_current_thread"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from_the_current_thread" title="Access from the current thread">Access
+ from the current thread</a>
+</h5></div></div></div>
+
+ But how all this works. We start with enablers/disablers. Enablers/disablers
+ use RAII, so they can be nested and the context be restored on the destructor.
+ At the construction they store the current state of the keep alive of
+ this thread using the backup function and then they enable/disable the
+ KA mechanism. On destruction they restore the backed up context.
+ 
+<pre class="programlisting">enable_keep_alive::enable_keep_alive(
+ std::size_t periods, std::size_t checkins)
+{
+ backup_=detail::thread_keep_alive_ctx::instance()->backup(data_);
+ detail::thread_keep_alive_ctx::instance()->enable_keep_alive(periods, checkins);
+}
+
+enable_keep_alive::~enable_keep_alive() {
+ detail::thread_keep_alive_ctx::instance()->restore(backup_);
+}
+
+disable_keep_alive::disable_keep_alive() {
+ backup_=detail::thread_keep_alive_ctx::instance()->backup(data_);
+ detail::thread_keep_alive_ctx::instance()->disable_keep_alive();
+}
+
+disable_keep_alive::~disable_keep_alive() {
+ detail::thread_keep_alive_ctx::instance()->restore(backup_);
+}
+</pre>
+
+ These functions are quite simple
+ 
+<pre class="programlisting">thread_keep_alive_internal* thread_keep_alive_ctx::backup(thread_keep_alive_internal* new_data) {
+ thread_keep_alive_internal* the_backup=data_;
+ data_=new_data
+ return the_backup;
+}
+
+void thread_keep_alive_ctx::restore(thread_keep_alive_internal* backup) {
+ data_=backup;
+}
+
+void thread_keep_alive_ctx::enable_keep_alive() {
+ data_->enabled_=true;
+}
+void thread_keep_alive_ctx::disable_keep_alive() {
+ data_->enabled_ = false;
+}
+</pre>
+
+ Note that there is no need to check if the <code class="computeroutput">detail::thread_keep_alive_ctx::instance_</code>
+ contains a pointer because we have ensured that at initialization time.
+ 
+
+ Next there is the central function <code class="computeroutput">keep_alive_point()</code>. This function does nothing more than
+ relaying the request to the specific context of this thread. This function
+ just increases the number of <code class="computeroutput">checkins_</code>.
+ 
+<pre class="programlisting">void keep_alive_point() {
+ detail::thread_keep_alive_ctx::instance()->check_point();
+}
+
+void thread_keep_alive_ctx::check_point() {
+ ++data_->checkins_;
+}
+</pre>
+
+ The <code class="computeroutput">set_on_dead_thread()</code> does the same. This function just stores
+ the on-dead action.
+ 
+<pre class="programlisting">void set_on_dead_thread(on_dead_thread_type fct, thread* th) {
+ detail::thread_keep_alive_ctx::instance()->set_on_dead_thread(fct, th);
+}
+
+ void set_on_dead_thread(on_dead_thread_type fct, thread* th) {
+ data_->on_dead_=fct;
+ data_->thread_ptr_=th;
+ }
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from__the_controller_thread"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from__the_controller_thread" title="Access from the controller thread">Access
+ from the controller thread</a>
+</h5></div></div></div>
+
+ Up to now we have seen the use of <code class="computeroutput">bith::thread_keep_alive_ctx</code>
+ as a <code class="computeroutput">boost::thread_specific_ptr</code>, i.e. it is used
+ from the current thread.
+ 
+
+ We will see now how the controler behaves. The single instance of the
+ keep_alive_mgr has been created on the init function.
+ 
+
+ The constructor just constructs a thread with the loop function.
+ 
+<pre class="programlisting">keep_alive_mgr() : end_(false), thread_(boost::bind(loop, boost::ref(end_))) {}
+</pre>
+
+ The loop function will iterate, every second, over all the thread_keep_alive_ctx
+ threads specific contexts asking them to control themselves. Note that
+ as the map can be modified when threads are created or finished, we need
+ to protect the iteration externally with a lock on the protecting mutex.
+ 
+<pre class="programlisting">static void loop(bool& end) {
+ boost::xtime t;
+ boost::xtime_get(&t,1);
+ while(!end) {
+ t.sec += 1;
+ boost::thread::sleep(t);
+ lock_type lock(thread_keep_alive_ctx::instance().get_mutex());
+ const detail::thread_keep_alive_ctx::tssp::map_type& tmap(
+ thread_keep_alive_ctx::instance().get_map());
+ thread_keep_alive_ctx::tssp::map_type::const_iterator it = tmap.begin();
+ for (;it != tmap.end(); ++it) {
+ it->second.control(it->first);
+ }
+ }
+}
+</pre>
+
+ The thread loops until the end variable is true. In order to stop proprely
+ this thread we will use the destructor of singleton instance. This end
+ variable is a reference to a variable stored on the keep_alive_mgr context
+ which has been initialized staticly. So its destrcutor will be called
+ when the program finishes. So it is up to the destructor to set this
+ variable and wait for the thread completion
+ 
+<pre class="programlisting">~keep_alive_mgr() {
+ end_=true;
+ thread_.join();
+}
+</pre>
+
+ The thread_keep_alive_ctx::control function behaves as follows: if it
+ is enabled, it decreases the number of remaining periods and if the thread
+ is declared dead it executes the on dead action and resets the check-ins
+ and periods.
+ 
+<pre class="programlisting">void control(thread::id id) {
+ if (data_->enabled_) {
+ --data_->periods_;
+ if (dead()) {
+ on_dead(id);
+ data_->checkins_=0;
+ data_->periods_=data_->total_periods;
+ }
+ }
+}
+</pre>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple" title="Thread Tuple">Thread
+ Tuple</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_launching">Launching
+ thread tuple</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_exceptions">Exceptions
+ in thread functions</a></dt>
+<dt><a href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_joining">Joining
+ and detaching</a></dt>
+<dt>Interruption</dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_launching"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_launching" title="Launching thread tuple">Launching
+ thread tuple</a>
+</h5></div></div></div>
+
+ A new thread tuple is launched by passing a collection of objects of
+ some callable type, that can be invoked with no parameters. These objects
+ are then copied into internal storage, and invoked on the newly-created
+ threads of execution. If the objects must not (or cannot) be copied,
+ then <code class="computeroutput">boost::ref</code> can be used to pass in a reference
+ to the function object. In this case, the user of <code class="computeroutput">thread_tuple<></code> must ensure that the referred-to
+ object outlives the newly-created thread of execution.
+ 
+<pre class="programlisting">struct callable
+{
+ void operator()();
+};
+
+bith::thread_tuple<2> copies_are_safe()
+{
+ callable x;
+ callable y;
+ return bith::thread_tuple<2>(x, y);
+} // x and y are destroyed, but the newly-created threads have a copy, so this is OK
+
+bith::thread_tuple<2> oops()
+{
+ callable x;
+ callable y;
+ return bith::thread_tuple<2>(boost::ref(x), boost::ref(y));
+} // x and y are destroyed, but the newly-created threads still have a reference
+ // this leads to undefined behaviour
+</pre>
+
+ If you wish to construct an instance of <code class="computeroutput">thread_tuple<></code> with a function or callable object
+ that requires arguments to be supplied, this can NOT be done by passing
+ additional arguments as is the case for threads to the <code class="computeroutput">thread_tuple<></code>
+ constructor, and you will need to use bind explicitly.
+ 
+<pre class="programlisting">void find_the_question(int the_answer);
+
+bith::thread_tuple<2> deep_thought_2(boost::bind(find_the_question,42), boost::bind(find_the_question,16));
+</pre>
+
+ The arguments are copied into the internals of Boost.Bind
+ structure: if a reference is required, use <code class="computeroutput">boost::ref</code>,
+ just as for references to callable functions.
+ 
+
+ The limit on the number of additional arguments that can be passed are
+ specified by the Boost.Bind.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_exceptions"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_exceptions" title="Exceptions in thread functions">Exceptions
+ in thread functions</a>
+</h5></div></div></div>
+
+ If the function or callable object passed to the <code class="computeroutput">thread_tuple<></code> constructor propagates an exception
+ that is not of type <code class="computeroutput">boost::thread_interrupted</code>,
+ when invoked, <code class="computeroutput">std::terminate()</code>
+ is called.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_joining"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_joining" title="Joining and detaching">Joining
+ and detaching</a>
+</h5></div></div></div>
+
+ When the <code class="computeroutput">thread_tuple<></code> object that represents a collection
+ of threads of execution is destroyed, the threads become detached.
+ Once threads are detached, they will continue executing until the invocation
+ of the functions or callable objects supplied on construction completes,
+ or the program is terminated. The threads of a <code class="computeroutput">thread_tuple<></code> can also be detached by explicitly
+ invoking the detach member function on the <code class="computeroutput">thread_tuple<></code> object. In this case, all the
+ threads of the <code class="computeroutput">thread_tuple<></code> object cease to represent the
+ now-detached thread, and instead represents 'Not-a-Thread.
+ 
+
+ In order to wait for a tuple of threads of execution to finish, the
+ <code class="computeroutput">join()</code>
+ or <code class="computeroutput">timed_join()</code>
+ member functions of the <code class="computeroutput">thread_tuple<></code> object must be used. <code class="computeroutput">join()</code>
+ will block the calling thread until the all the threads represented by
+ the <code class="computeroutput">thread_tuple<></code>
+ object have completed. If the threads of execution represented by the
+ <code class="computeroutput">thread_tuple<></code>
+ object have already completed, or the <code class="computeroutput">thread_tuple<></code> objects represents Not-a-Thread,
+ then <code class="computeroutput">join()</code>
+ returns immediately. <code class="computeroutput">timed_join()</code> is similar, except that a call to
+ <code class="computeroutput">timed_join()</code>
+ will also return if the threads being waited for do not complete when
+ the specified time has elapsed.
+ 
+
+ There is also a possibility to wait until the first thread completes,
+ interrupting the rest of the threads.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_interruption"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_interruption" title="Interruption">Interruption</a>
+</h5></div></div></div>
+
+ A tuple of running threads can be interrupted by
+ invoking the <code class="computeroutput">interrupt_all()</code> member function of the corresponding
+ <code class="computeroutput">thread_tuple<></code>
+ object. When the interrupted threads next execute one of the specified
+ interruption points (or if it is currently blocked
+ whilst executing one) with interruption enabled, then a <code class="computeroutput">boost::thread_interrupted</code> exception will be
+ thrown in the interrupted thread. If not caught, this will cause the
+ execution of the interrupted thread to terminate. As with any other exception,
+ the stack will be unwound, and destructors for objects of automatic storage
+ duration will be executed.
+ 
+
+ See the Boost.Threads
+ library on how to avoid a thread being interrupted.
+ 
+
+ At any point, the interruption state for the current thread can be queried
+ by calling <code class="computeroutput">interruption_enabled</code>.
+ 
+
+ <a name="interruption_points"></a> See the Boost.Threads library for the Predefined
+ Interruption Points.
+ 
+</div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.users_guide.examples"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.examples" title="Examples">Examples</a>
+</h3></div></div></div>
+<div class="toc"><dl><dt><a href="users_guide.html#toward_boost_interthreads.users_guide.examples.thread_safe_deferred_traces">Thread
+ safe deferred traces</a></dt></dl></div>
+
+ This section do includes complete examples using the library.
+ 
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_interthreads.users_guide.examples.thread_safe_deferred_traces"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.examples.thread_safe_deferred_traces" title="Thread safe deferred traces">Thread
+ safe deferred traces</a>
+</h4></div></div></div>
+
+ When executing on a multi thread environment, the output lines on std::cout
+ could interleave. We can synchronize these outputs with a global mutex
+ 
+<pre class="programlisting">{
+ boost::lock_guard<boost::mutex> lock(global_cout_mutex);
+ std::cout << ... << std::endl ;
+}
+</pre>
+
+ This mutex could be the bottleneck of the system. Only one mutex resource
+ for all the user threads.
+ 
+<pre class="programlisting">U U
+ /
+ /
+ U ----- R ----- U
+ |
+ |
+ U
+</pre>
+
+ Another approach could be using a queue of output stream buffers for each
+ thread. Each buffer is timestamped with the creation date and there is
+ a concentrator that takes one by one the elements ordered by their timestamp.
+ Only the current thread can push on this queue because it is specific to
+ the thread. There is a single thread, the concentrator, that pops from
+ these queue. In this context we can ensure thread safety without locking
+ as far as the queue has at least two messages.
+ 
+<pre class="programlisting">U ----- R ------+
+ \
+ U ----- R ------\
+ \
+ U ----- R -------- C
+ / /
+ U ----- R ------/ /
+ /
+ U ----- R ------+
+</pre>
+
+ This can be encapsulated in an async_ostream class
+ 
+<pre class="programlisting">class async_ostream : public iostreams::stream<detail::async_ostream_sink> {
+public:
+ typedef char char_type;
+ typedef iostreams::sink_tag category;
+
+ async_ostream(std::ostream& os);
+ void flush();
+};
+
+extern async_ostream cout_;
+</pre>
+
+ With this interface the user can use cout_ as it used std::cout.
+ 
+<pre class="programlisting">cout_ << "Hello World!" << std::endl ;
+</pre>
+
+ All the magic is in the <code class="computeroutput">template
+ class boost::iostreams::stream<></code>. The parameter must be a model
+ of a sink (See Boost.Iostreams). Here it is.
+ 
+<pre class="programlisting">namespace detail {
+ struct async_ostream_sink {
+ typedef char char_type;
+ typedef boost::iostreams::sink_tag category;
+ async_ostream_sink(std::ostream& os);
+ std::streamsize write(const char* s, std::streamsize n);
+ void flush();
+ private:
+ friend class async_ostream_concentrator;
+ friend class async_ostream;
+ struct impl;
+ boost::shared_ptr<impl> impl_;
+ };
+}
+</pre>
+
+ This class declares the just minimum in order to model a sink. In addition,
+ in order to mask the implementation, the Pimpl idiom is used. The implementation
+ of these functions is straigtforward:
+ 
+<pre class="programlisting">async_ostream::async_ostream(std::ostream& os)
+ : base_type(os) {}
+
+void async_ostream::flush() {
+ this->base_type::flush();
+ async_ostream& d = *this;
+ d->flush();
+}
+
+async_ostream_sink::async_ostream_sink(std::ostream& os)
+ : impl_(new async_ostream_sink::impl(os)) {}
+
+std::streamsize detail::async_ostream_sink::write(const char* s, std::streamsize n) {
+ return impl_->write(s,n);
+}
+
+void async_ostream_sink::flush() {
+ return impl_->flush();
+}
+</pre>
+
+ Let me continue with the handle of the Pimpl pattern:
+ 
+<pre class="programlisting">struct detail::async_ostream_sink::impl {
+ impl(std::ostream& os);
+ std::ostream& os_;
+ tsss_type tsss_;
+ priority_queue_type queue_;
+ boost::thread thread_;
+
+ std::streamsize write(const char* s, std::streamsize n);
+
+ static void terminate(shared_ptr<async_ostream_thread_ctx> that);
+ static void loop(impl* that);
+};
+</pre>
+
+ Of course we need to store a reference to the final ostream.
+ 
+
+ The <code class="computeroutput">thread_specific_shared_ptr
+ tsss_</code> is used to encapsulate
+ the logic specific to each thread.
+ 
+<pre class="programlisting">typedef thread_specific_shared_ptr<async_ostream_thread_ctx> tsss_type;
+</pre>
+
+ A priority queue <code class="computeroutput">queue_</code>
+ will be used by the concentrator thread to order the stringstreams by date.
+ 
+<pre class="programlisting">template <typename T>
+struct detail::timestamped {
+ system_time date_;
+ unsigned seq_;
+ T value_;
+ void reset_date(unsigned seq) {
+ date_ = system_time();
+ seq_ = seq;
+ }
+ struct ptr_comparator_gt {
+ typedef timestamped* value_type;
+ bool operator()(const value_type&lhs, const value_type&rhs) {
+ return (lhs->date_ > rhs->date_) ? true :
+ (lhs->date_ == rhs->date_) && (lhs->seq_ > rhs->seq_)? true:false;
+ }
+ };
+};
+
+typedef timestamped<std::stringstream> element_type;
+typedef std::priority_queue<queue_type*, std::deque<element_type*>, element_type::ptr_comparator_gt> priority_queue_type;
+</pre>
+
+ In addition to the timestamp <code class="computeroutput">date_</code>
+ we need a sequence number to order the stringstreams pushed without enough
+ time granularity, e.g. on the same microsecond.
+ 
+
+ To finish the field declaration there is the concentrator thread implemented
+ by the loop function.
+ 
+<pre class="programlisting">, thread_(boost::bind(loop, this))
+</pre>
+
+ Comming back to the sink implementation,
+ 
+<pre class="programlisting">async_ostream_sink::impl::impl(std::ostream& os)
+: os_(os)
+, tsss_(terminate)
+, thread_(boost::bind(loop, this))
+{}
+</pre>
+
+ The terminate cleanup function is used to ensure that the queue is empty
+ before the thread finishes. To avoid optimizations a non const call inc
+ is done while waiting the queue empties.
+ 
+<pre class="programlisting">void async_ostream_sink::impl::terminate(shared_ptr<async_ostream_thread_ctx> that) {
+ while (!that->empty()) {
+ that->inc();
+ }
+}
+</pre>
+
+ The central sink function is write. Here instead to lock a mutex the function
+ forwards to the thread specific shared pointer. We will see below how
+ <code class="computeroutput">async_ostream_thread_ctx</code>
+ handles this call.
+ 
+<pre class="programlisting">std::streamsize write(const char* s, std::streamsize n) {
+ return tsss_->write(s, n);
+}
+</pre>
+
+ It is time to analyze the thread specific context before seeing how the
+ concentrator is implemented.
+ 
+<pre class="programlisting">struct async_ostream_thread_ctx {
+ async_ostream_thread_ctx();
+ std::streamsize write(const char* s, std::streamsize n);
+ void flush();
+ element_type* get();
+ bool empty() const {return queue_.empty();}
+ void inc() {++inc_;}
+private:
+ unsigned seq_;
+ element_type *current_;
+ queue_type queue_;
+ boost::mutex mutex_;
+ std::stringstream& buffer() {return current_->value_;}
+};
+</pre>
+
+ Each thread has a pointer to the current timestamped stringstream wich
+ is used for the current output flow, i.e. by the write function.
+ 
+<pre class="programlisting">std::streamsize write(const char* s, std::streamsize n) {
+ buffer().write(s, n);
+ return n;
+}
+</pre>
+
+ Once the user does a flush, the current element is pushed on the queue.
+ The <code class="computeroutput">sec_</code> integer is used
+ as monotonic sequence in conjuntion with the timestamp.
+ 
+<pre class="programlisting">void flush() {
+ current_->reset_date(seq_);
+ ++seq_;
+ if (queue_.size()>2) {
+ queue_.push(current_);
+ } else {
+ boost::lock_guard<boost::mutex> lock(mutex_);
+ queue_.push(current_);
+ }
+ current_ = new element_type();
+}
+</pre>
+
+ As stated in the introduction, we don't need to lock the mutex if the number
+ of elements in the queue is enough.
+ 
+
+ These queue elements will be read by the concentrator using the get function.
+ 
+<pre class="programlisting">element_type* get() {
+ if (queue_.size()>1) {
+ return get_i();
+ } else {
+ boost::lock_guard<boost::mutex> lock(mutex_);
+ return get_i();
+ }
+}
+
+element_type* get_i() {
+ if (queue_.empty()) return 0;
+ element_type* e= queue_.front();
+ queue_.pop();
+ return e;
+}
+</pre>
+
+ The concentrator loop looks like:
+ 
+<pre class="programlisting">void async_ostream_sink_impl::loop(async_ostream_sink::impl* that) {
+ std::ostream& os_ = that->os_;
+ for(;;) {
+ // sleeps a little bit
+ this_thread::sleep(boost::posix_time::milliseconds(1));
+ { // scope needed don't remove
+ // lock the map access
+ tsss_type::lock_type lock(that->tsss_.get_mutex());
+ const tsss_type::map_type& tmap(that->tsss_.get_map(lock));
+ for (tsss_type::map_type::const_iterator it = tmap.begin(); it != tmap.end(); ++it) {
+ // takes the first element of each thread queue (if it exists) and push it on the ordered queue.
+ element_type* e= it->second->get();
+ if (e != 0) that->queue_.push(e);
+ }
+ }
+ if (that->queue_.empty()) { //when the queue is empty sleeps a little more
+ this_thread::sleep(boost::posix_time::milliseconds(10));
+ } else {
+ // takes the fist element of the ordered queue, write them on the output stream and delete it.
+ element_type* e = that->queue_.top();
+ that->queue_.pop();
+ os_ << "["<< e->date_ <<"-" << e->seq_ << "] " << e->value_.str();
+ delete e;
+ }
+ }
+}
+</pre>
+</div>
+
+ /
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.users_guide.bibliography"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.bibliography" title="References">References</a>
+</h3></div></div></div>
+<div class="variablelist">
+
+<dl>
+<dt>Boost.Thread (A. Williams)</dt>
+<dd></dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_interthreads.users_guide.glosary"></a><a class="link" href="users_guide.html#toward_boost_interthreads.users_guide.glosary" title="Glossary">Glossary</a>
+</h3></div></div></div>
+<div class="variablelist">
+
+<dl>
+<dt>alive (thread)</dt>
+<dd>
+ a thread is considered alive when not dead.
+ </dd>
+<dt>cleanup decoration</dt>
+<dd>
+ function called at thread exit.
+ </dd>
+<dt>dead (thread)</dt>
+<dd>
+ a thread is considered dead when has not done enough keep alive check
+ points for a given duration.
+ </dd>
+<dt>decoration</dt>
+<dd>
+ Couple of setup/cleanup thread decorating functions.
+ </dd>
+<dt>decorator</dt>
+<dd>
+ Functor wrapper decorating a thread with all the setups and cleanups
+ decorations.
+ </dd>
+<dt>deleter TSSS</dt>
+<dd>
+ specific function used to delete the TSSS.
+ </dd>
+<dt>KA</dt>
+<dd>
+ Keep Alive.
+ </dd>
+<dt>setup decoration</dt>
+<dd>
+ function called before the thread starts.
+ </dd>
+<dt>TSS</dt>
+<dd>
+ Thread Specific Storage.
+ </dd>
+<dt>TSSS</dt>
+<dd>
+ Thread Specific Shared Storage.
+ </dd>
+</dl>
+</div>
+</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 © 2008 -2009 Vicente J. Botet Escriba
+<td align="right"><div class="copyright-footer">Copyright © 2008 -2009,2011 Vicente J. Botet Escriba
 Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 
@@ -70,7 +1765,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="overview/motivation.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="users_guide/getting_started.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="overview.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reference.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/bibliography.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/bibliography.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/bibliography.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,15 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>
- References</title>
+<title>References</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../users_guide.html" title=" Users'Guide">
-<link rel="prev" href="tutorial.html" title=" Tutorial">
-<link rel="next" href="glosary.html" title=" Glossary">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
+<link rel="up" href="../users_guide.html" title="Users'Guide">
+<link rel="prev" href="tutorial.html" title="Tutorial">
+<link rel="next" href="glosary.html" title="Glossary">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -24,19 +22,15 @@
<div class="spirit-nav">
<a accesskey="p" href="tutorial.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="glosary.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.users_guide.bibliography"></a><a href="bibliography.html" title="
- References">
- References</a>
+<a name="toward_boost_interthreads.users_guide.bibliography"></a><a class="link" href="bibliography.html" title="References">References</a>
</h3></div></div></div>
<div class="variablelist">

<dl>
-<dt><a href="http://www.boost.org/libs/thread" target="_top">Boost.Thread
- (A. Williams)</a></dt>
-<dd>
- </dd>
+<dt>Boost.Thread (A. Williams)</dt>
+<dd></dd>
</dl>
</div>
</div>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/getting_started.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/getting_started.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/getting_started.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,15 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>
- Getting Started</title>
+<title>Getting Started</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../users_guide.html" title=" Users'Guide">
-<link rel="prev" href="../users_guide.html" title=" Users'Guide">
-<link rel="next" href="tutorial.html" title=" Tutorial">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
+<link rel="up" href="../users_guide.html" title="Users'Guide">
+<link rel="prev" href="../users_guide.html" title="Users'Guide">
+<link rel="next" href="tutorial.html" title="Tutorial">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -24,15 +22,14 @@
<div class="spirit-nav">
<a accesskey="p" href="../users_guide.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tutorial.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.users_guide.getting_started"></a><a href="getting_started.html" title="
- Getting Started">
- Getting Started</a>
+<a name="toward_boost_interthreads.users_guide.getting_started"></a><a class="link" href="getting_started.html" title="Getting Started">Getting
+ Started</a>
</h3></div></div></div>
<div class="toc"><dl>
-<dt><a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install">
- Installing InterThreads</a></dt>
+<dt><a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install">Installing
+ InterThreads</a></dt>
<dt><a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.hello_world__decorator">Hello
 World! decorator</a></dt>
<dt><a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.monotonic_thread_id">Monotonic
@@ -40,17 +37,16 @@
<dt><a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.basic_keep_alive">Basic
 keep alive</a></dt>
</dl></div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.users_guide.getting_started.install"></a><a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install" title="
- Installing InterThreads">
- Installing InterThreads</a>
+<a name="toward_boost_interthreads.users_guide.getting_started.install"></a><a class="link" href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install" title="Installing InterThreads">Installing
+ InterThreads</a>
</h4></div></div></div>
-<a name="toward_boost_interthreads.users_guide.getting_started.install.getting_boost_interthreads"></a><h5>
-<a name="id4943219"></a>
- <a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install.getting_boost_interthreads">Getting
+<a name="toward_boost_interthreads.users_guide.getting_started.install.getting_boost_interthreads"></a><h6>
+<a name="id3194614"></a>
+ <a class="link" href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install.getting_boost_interthreads">Getting
 Boost.InterThreads</a>
- </h5>
+ </h6>

 You can get the last stable release of Boost.InterThreads
 by downloading <code class="literal">interthreads.zip</code> from the <a href="http://www.boost-consulting.com/vault/index.php?directory=Concurrent%20Programming" target="_top">Boost
@@ -60,24 +56,23 @@
 You can also access the latest (unstable?) state from the <a href="https://svn.boost.org/svn/boost/sandbox/interthreads" target="_top">Boost
 Sandbox</a>.
 
-<a name="toward_boost_interthreads.users_guide.getting_started.install.building_boost_interthreads"></a><h5>
-<a name="id4943275"></a>
- <a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install.building_boost_interthreads">Building
+<a name="toward_boost_interthreads.users_guide.getting_started.install.building_boost_interthreads"></a><h6>
+<a name="id3194668"></a>
+ <a class="link" href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install.building_boost_interthreads">Building
 Boost.InterThreads</a>
- </h5>
+ </h6>

 Boost.InterThreads is not a header only
 library. You need to compile it before use.
 
-<pre class="programlisting">
-cd libs/interthreads/build
+<pre class="programlisting">cd libs/interthreads/build
bjam
</pre>
-<a name="toward_boost_interthreads.users_guide.getting_started.install.build_requirements"></a><h5>
-<a name="id4943349"></a>
- <a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install.build_requirements">Build
+<a name="toward_boost_interthreads.users_guide.getting_started.install.build_requirements"></a><h6>
+<a name="id3194738"></a>
+ <a class="link" href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install.build_requirements">Build
 Requirements</a>
- </h5>
+ </h6>

 Boost.InterThreads depends on Boost. You
 must use either Boost version 1.38.x or the version in SVN trunk. In particular,
@@ -88,91 +83,91 @@
<dl>
<dt>Boost.Array</dt>
<dd>
- for array, ...
- </dd>
+ for array, ...
+ </dd>
<dt>Boost.Bind</dt>
<dd>
- for bind, ...
- </dd>
+ for bind, ...
+ </dd>
<dt>Boost.Config</dt>
<dd>
- for ??? and abi_prefic_sufix, ...
- </dd>
+ for ??? and abi_prefic_sufix, ...
+ </dd>
<dt>Boost.Function</dt>
<dd>
- for function, ...
- </dd>
+ for function, ...
+ </dd>
<dt>Boost.Fusion</dt>
<dd>
- for tuples, and sequence algorithms ...
- </dd>
+ for tuples, and sequence algorithms ...
+ </dd>
<dt>Boost.MPL</dt>
<dd>
- for transform, ...
- </dd>
+ for transform, ...
+ </dd>
<dt>Boost.Preprocesor</dt>
<dd>
- to simulate variadic templates , ...
- </dd>
+ to simulate variadic templates , ...
+ </dd>
<dt>Boost.SmartPtr</dt>
<dd>
- for shared_ptr, ...
- </dd>
+ for shared_ptr, ...
+ </dd>
<dt>Boost.Threads</dt>
<dd>
- for thread, thread_specific_ptr, call_once, mutex, condition_variable,
- ...
- </dd>
+ for thread, thread_specific_ptr, call_once, mutex, condition_variable,
+ ...
+ </dd>
<dt>Boost.TypeOf</dt>
<dd>
- to register the ACT types.
- </dd>
+ to register the ACT types.
+ </dd>
<dt>Boost.TypeTrais</dt>
<dd>
- for is_void, remove_references, ...
- </dd>
+ for is_void, remove_references, ...
+ </dd>
<dt>Boost.Utility</dt>
<dd>
- for result_of, enable_if...
- </dd>
+ for result_of, enable_if...
+ </dd>
</dl>
</div>
-<a name="toward_boost_interthreads.users_guide.getting_started.install.exceptions_safety"></a><h5>
-<a name="id4943631"></a>
- <a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install.exceptions_safety">Exceptions
+<a name="toward_boost_interthreads.users_guide.getting_started.install.exceptions_safety"></a><h6>
+<a name="id3195028"></a>
+ <a class="link" href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install.exceptions_safety">Exceptions
 safety</a>
- </h5>
+ </h6>

 All functions in the library are exception-neutral and provide strong guarantee
 of exception safety as long as the underlying parameters provide it.
 
-<a name="toward_boost_interthreads.users_guide.getting_started.install.thread_safety"></a><h5>
-<a name="id4943659"></a>
- <a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install.thread_safety">Thread
+<a name="toward_boost_interthreads.users_guide.getting_started.install.thread_safety"></a><h6>
+<a name="id3195055"></a>
+ <a class="link" href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install.thread_safety">Thread
 safety</a>
- </h5>
+ </h6>

 All functions in the library are thread-unsafe except when noted explicitly.
 
-<a name="toward_boost_interthreads.users_guide.getting_started.install.tested_compilers"></a><h5>
-<a name="id4943686"></a>
- <a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install.tested_compilers">Tested
+<a name="toward_boost_interthreads.users_guide.getting_started.install.tested_compilers"></a><h6>
+<a name="id3195081"></a>
+ <a class="link" href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install.tested_compilers">Tested
 compilers</a>
- </h5>
+ </h6>

 Currently, Boost.InterThreads has been
 tested in the following compilers/platforms:
 
-<div class="itemizedlist"><ul type="disc">
-<li>
- GCC 3.4.4 Cygwin
- </li>
-<li>
- GCC 3.4.6 Linux
- </li>
-<li>
- GCC 4.1.2 Linux
- </li>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ GCC 3.4.4 Cygwin
+ </li>
+<li class="listitem">
+ GCC 3.4.6 Linux
+ </li>
+<li class="listitem">
+ GCC 4.1.2 Linux
+ </li>
</ul></div>
<div class="note"><table border="0" summary="Note">
<tr>
@@ -185,18 +180,16 @@
 </td></tr>
</table></div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.users_guide.getting_started.hello_world__decorator"></a><a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.hello_world__decorator" title="Hello
- World! decorator">Hello
+<a name="toward_boost_interthreads.users_guide.getting_started.hello_world__decorator"></a><a class="link" href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.hello_world__decorator" title="Hello World! decorator">Hello
 World! decorator</a>
</h4></div></div></div>

 This is a little bit more than a Hello World! example. It will also say
 Bye, Bye!
 
-<pre class="programlisting">
-#include <boost/interthreads/thread_decorator.hpp>
+<pre class="programlisting">#include <boost/interthreads/thread_decorator.hpp>
#include <boost/thread.hpp>
#include <iostream>

@@ -238,10 +231,9 @@
Bye, Bye!
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.users_guide.getting_started.monotonic_thread_id"></a><a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.monotonic_thread_id" title="Monotonic
- Thread Id">Monotonic
+<a name="toward_boost_interthreads.users_guide.getting_started.monotonic_thread_id"></a><a class="link" href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.monotonic_thread_id" title="Monotonic Thread Id">Monotonic
 Thread Id</a>
</h4></div></div></div>

@@ -258,8 +250,7 @@
 thread decorator. This setup function resets the specific pointer with
 the value of the monotonic counter which will be self increased.
 
-<pre class="programlisting">
-#include <boost/interthreads/thread_decorator.hpp>
+<pre class="programlisting">#include <boost/interthreads/thread_decorator.hpp>
#include <boost/interthreads/thread_specific_shared_ptr.hpp>
#include <boost/thread.hpp>
#include <iostream>
@@ -302,8 +293,7 @@
 to a monotonic thread id mono_thread_id::id() and this id is accesible
 to other threads providing the boost::thread::id.
 
-<pre class="programlisting">
-void my_thread() {
+<pre class="programlisting">void my_thread() {
 std::cout << "mono_thread_id=" << mono_thread_id::id() << std::endl;
 sleep(5);
}
@@ -335,17 +325,15 @@

</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.users_guide.getting_started.basic_keep_alive"></a><a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.basic_keep_alive" title="Basic
- keep alive">Basic
+<a name="toward_boost_interthreads.users_guide.getting_started.basic_keep_alive"></a><a class="link" href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.basic_keep_alive" title="Basic keep alive">Basic
 keep alive</a>
</h4></div></div></div>

 This example shows the keep_alive basics.
 
-<pre class="programlisting">
-#include <boost/interthreads/thread_decorator.hpp>
+<pre class="programlisting">#include <boost/interthreads/thread_decorator.hpp>
#include <boost/interthreads/keep_alive.hpp>
#include <boost/thread/thread.hpp>
#include <iostream>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/glosary.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/glosary.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/glosary.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,15 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title> Glossary</title>
+<title>Glossary</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../users_guide.html" title=" Users'Guide">
-<link rel="prev" href="bibliography.html" title="
- References">
-<link rel="next" href="../reference.html" title=" Reference">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
+<link rel="up" href="../users_guide.html" title="Users'Guide">
+<link rel="prev" href="bibliography.html" title="References">
+<link rel="next" href="../reference.html" title="Reference">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -24,55 +22,55 @@
<div class="spirit-nav">
<a accesskey="p" href="bibliography.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.users_guide.glosary"></a> Glossary
+<a name="toward_boost_interthreads.users_guide.glosary"></a><a class="link" href="glosary.html" title="Glossary">Glossary</a>
</h3></div></div></div>
<div class="variablelist">

<dl>
<dt>alive (thread)</dt>
<dd>
- a thread is considered alive when not dead.
- </dd>
+ a thread is considered alive when not dead.
+ </dd>
<dt>cleanup decoration</dt>
<dd>
- function called at thread exit.
- </dd>
+ function called at thread exit.
+ </dd>
<dt>dead (thread)</dt>
<dd>
- a thread is considered dead when has not done enough keep alive check
- points for a given duration.
- </dd>
+ a thread is considered dead when has not done enough keep alive check
+ points for a given duration.
+ </dd>
<dt>decoration</dt>
<dd>
- Couple of setup/cleanup thread decorating functions.
- </dd>
+ Couple of setup/cleanup thread decorating functions.
+ </dd>
<dt>decorator</dt>
<dd>
- Functor wrapper decorating a thread with all the setups and cleanups
- decorations.
- </dd>
+ Functor wrapper decorating a thread with all the setups and cleanups
+ decorations.
+ </dd>
<dt>deleter TSSS</dt>
<dd>
- specific function used to delete the TSSS.
- </dd>
+ specific function used to delete the TSSS.
+ </dd>
<dt>KA</dt>
<dd>
- Keep Alive.
- </dd>
+ Keep Alive.
+ </dd>
<dt>setup decoration</dt>
<dd>
- function called before the thread starts.
- </dd>
+ function called before the thread starts.
+ </dd>
<dt>TSS</dt>
<dd>
- Thread Specific Storage.
- </dd>
+ Thread Specific Storage.
+ </dd>
<dt>TSSS</dt>
<dd>
- Thread Specific Shared Storage.
- </dd>
+ Thread Specific Shared Storage.
+ </dd>
</dl>
</div>
</div>

Modified: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/tutorial.html
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/tutorial.html (original)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/tutorial.html 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,16 +1,13 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title> Tutorial</title>
+<title>Tutorial</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="../../index.html" title="Toward Boost.InterThreads">
-<link rel="up" href="../users_guide.html" title=" Users'Guide">
-<link rel="prev" href="getting_started.html" title="
- Getting Started">
-<link rel="next" href="bibliography.html" title="
- References">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Toward Boost.InterThreads">
+<link rel="up" href="../users_guide.html" title="Users'Guide">
+<link rel="prev" href="getting_started.html" title="Getting Started">
+<link rel="next" href="bibliography.html" title="References">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -25,9 +22,9 @@
<div class="spirit-nav">
<a accesskey="p" href="getting_started.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="bibliography.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h3 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial"></a> Tutorial
+<a name="toward_boost_interthreads.users_guide.tutorial"></a><a class="link" href="tutorial.html" title="Tutorial">Tutorial</a>
</h3></div></div></div>
<div class="toc"><dl>
<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator">Thread
@@ -37,8 +34,8 @@
 a decoration</a></dt>
<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.creating_threads_with_decorators">Creating
 threads with decorators</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.decorator_explicit_call">
- Calling explictly the decoration on a thread</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.decorator_explicit_call">Calling
+ explictly the decoration on a thread</a></dt>
</dl></dd>
<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer">Thread
 Specific Shared Pointer</a></dt>
@@ -64,14 +61,14 @@
<dt>Interface</dt>
<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_mechanism_initialization">Keep
 alive mechanism initialization</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_threads">
- Which threads can be controlled?</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_enabling">
- Enabling the keep alive mechanism</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_disabling">
- Disabling the keep alive mechanism</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_persistent">
- Configuring the dead persistency</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_threads">Which
+ threads can be controlled?</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_enabling">Enabling
+ the keep alive mechanism</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_disabling">Disabling
+ the keep alive mechanism</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_persistent">Configuring
+ the dead persistency</a></dt>
<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from_the_current_thread">Access
 from the current thread</a></dt>
<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from__the_controller_thread">Access
@@ -80,20 +77,18 @@
<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple">Thread
 Tuple</a></dt>
<dd><dl>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_launching">
- Launching thread tuple</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_exceptions">
- Exceptions in thread functions</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_joining">
- Joining and detaching</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_interruption">
- Interruption</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_launching">Launching
+ thread tuple</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_exceptions">Exceptions
+ in thread functions</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_joining">Joining
+ and detaching</a></dt>
+<dt>Interruption</dt>
</dl></dd>
</dl></div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_decorator"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator" title="Thread
- Decorator">Thread
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_decorator"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator" title="Thread Decorator">Thread
 Decorator</a>
</h4></div></div></div>
<div class="toc"><dl>
@@ -101,13 +96,12 @@
 a decoration</a></dt>
<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.creating_threads_with_decorators">Creating
 threads with decorators</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.decorator_explicit_call">
- Calling explictly the decoration on a thread</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.decorator_explicit_call">Calling
+ explictly the decoration on a thread</a></dt>
</dl></div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_decorator.declaring_a_decoration"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.declaring_a_decoration" title="Declaring
- a decoration">Declaring
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_decorator.declaring_a_decoration"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.declaring_a_decoration" title="Declaring a decoration">Declaring
 a decoration</a>
</h5></div></div></div>

@@ -115,8 +109,7 @@
 are usualy static and initialized with a <code class="computeroutput">Callable</code>
 object:
 
-<pre class="programlisting">
-static boost::interthreads::thread_decoration d;
+<pre class="programlisting">static boost::interthreads::thread_decoration d;
void setup();

bith::thread_decoration d(setup);
@@ -128,51 +121,45 @@
 explained in more detail in the next sections.
 
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_decorator.creating_threads_with_decorators"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.creating_threads_with_decorators" title="Creating
- threads with decorators">Creating
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_decorator.creating_threads_with_decorators"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.creating_threads_with_decorators" title="Creating threads with decorators">Creating
 threads with decorators</a>
</h5></div></div></div>

 When we want the decorations to decorate one thread of execution we can
 create the thread using the decorator wrapper.
 
-<pre class="programlisting">
-boost::thread th(bith::thread_decorator(fct));
+<pre class="programlisting">boost::thread th(bith::thread_decorator(fct));
</pre>

 This behavion is obtained also using one of the <code class="computeroutput">AsynchronousExecutor</code>
 decorators of the Boost.Async library, as
 
-<pre class="programlisting">
-bith::basic_threader_decorator ae;
+<pre class="programlisting">bith::basic_threader_decorator ae;
BOOST_AUTO(th, bith::fork(ae, fct));
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_decorator.decorator_explicit_call"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.decorator_explicit_call" title="
- Calling explictly the decoration on a thread">
- Calling explictly the decoration on a thread</a>
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_decorator.decorator_explicit_call"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.decorator_explicit_call" title="Calling explictly the decoration on a thread">Calling
+ explictly the decoration on a thread</a>
</h5></div></div></div>

 For threads that are not created using the boost::thread class, as it
 is the case of the main thread, we need to call explicitly the function
 <code class="computeroutput">bith::decorate</code> at the begining of the thread.
 
-<pre class="programlisting">
-int main() {
+<pre class="programlisting">int main() {
 bith::decorate();
 // ...
}
</pre>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer" title="Thread
- Specific Shared Pointer">Thread
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer" title="Thread Specific Shared Pointer">Thread
 Specific Shared Pointer</a>
</h4></div></div></div>
<div class="toc"><dl>
@@ -191,24 +178,21 @@
<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.cleanup_at_thread_exit">Cleanup
 at thread exit</a></dt>
</dl></div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.key_initialization"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.key_initialization" title="Key
- initialization">Key
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.key_initialization"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.key_initialization" title="Key initialization">Key
 initialization</a>
</h5></div></div></div>

 As the curent implementation uses the address of the thread_specific_shared_ptr<>
 object, there is no need to do anything to get the key.
 
-<pre class="programlisting">
-bith::thread_specific_shared_ptr<myclass> ptr;
+<pre class="programlisting">bith::thread_specific_shared_ptr<myclass> ptr;
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.context_initialization"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.context_initialization" title="Context
- initialization">Context
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.context_initialization"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.context_initialization" title="Context initialization">Context
 initialization</a>
</h5></div></div></div>

@@ -228,24 +212,22 @@

 Initialization can be done
 
-<div class="itemizedlist"><ul type="disc"><li>
- explicitly on the curret thread. Basically it works like a thread local
- storage from inside the thread.
- </li></ul></div>
-<pre class="programlisting">
-bith::thread_specific_shared_ptr<myclass> ptr;
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ explicitly on the curret thread. Basically it works like a thread
+ local storage from inside the thread.
+ </li></ul></div>
+<pre class="programlisting">bith::thread_specific_shared_ptr<myclass> ptr;
void func() { // current thread
 // ...
 ptr.reset(p);
 // ...
}
</pre>
-<div class="itemizedlist"><ul type="disc"><li>
- When we associate a thread decoration to the thread_specific_shared_ptr<>
- we initialize implicitly every thread created with a thread_decorator.
- </li></ul></div>
-<pre class="programlisting">
-bith::thread_specific_shared_ptr<myclass> ptr;
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ When we associate a thread decoration to the thread_specific_shared_ptr<>
+ we initialize implicitly every thread created with a thread_decorator.
+ </li></ul></div>
+<pre class="programlisting">bith::thread_specific_shared_ptr<myclass> ptr;
void myclass_setup() {
 ptr.reset(new myclass(any specific parameters));
}
@@ -258,10 +240,9 @@
boost::thread th=bith::make_decorated_thread(func);
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_on_the_current_thread"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_on_the_current_thread" title="Obtain
- the pointer to the thread-specific object on the current thread">Obtain
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_on_the_current_thread"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_on_the_current_thread" title="Obtain the pointer to the thread-specific object on the current thread">Obtain
 the pointer to the thread-specific object on the current thread</a>
</h5></div></div></div>

@@ -272,8 +253,7 @@
 and <code class="computeroutput">-></code> pointer deference
 operators.
 
-<pre class="programlisting">
-void func() {
+<pre class="programlisting">void func() {
{ // current thread
 // ...
 if (ptr.get()==0) ptr.reset(new myclass);
@@ -282,18 +262,16 @@
}
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_of_another_thread"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_of_another_thread" title="Obtain
- the pointer to the thread-specific object of another thread">Obtain
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_of_another_thread"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.obtain_the_pointer_to_the_thread_specific_object_of_another_thread" title="Obtain the pointer to the thread-specific object of another thread">Obtain
 the pointer to the thread-specific object of another thread</a>
</h5></div></div></div>

 Besides, other threads can get access to the data provided a thread::id
 by:
 
-<pre class="programlisting">
-boost::thread th=bith::make_decorated_thread(func);
+<pre class="programlisting">boost::thread th=bith::make_decorated_thread(func);

ptr[th->get_id()]->foo();
</pre>
@@ -307,16 +285,14 @@
 specific context could be not yet done. One way to manage with this error
 is to get the shared pointer and check if it contains something or not.
 
-<pre class="programlisting">
-shared_ptr<myclass> shp = ptr[th->get_id()]->foo();
+<pre class="programlisting">shared_ptr<myclass> shp = ptr[th->get_id()]->foo();
if (shp.get() != 0) shp->foo();
else ...
</pre>

 When we need this we can pool:
 
-<pre class="programlisting">
-shared_ptr<myclass> shp;
+<pre class="programlisting">shared_ptr<myclass> shp;
do {
 shp = ptr[th->get_id()]->foo();
} while(shp.get() == 0);
@@ -327,16 +303,13 @@
 The wait_and_get() function allows a thread to synchronize with the setting
 from another thread.
 
-<pre class="programlisting">
-shared_ptr<myclass> shp = ptr.wait_and_get(th->get_id());
+<pre class="programlisting">shared_ptr<myclass> shp = ptr.wait_and_get(th->get_id());
shp->foo();
</pre>

- shared_ptr<myclass> shp = ptr.wait_and_get(th->get_id()); shp->foo();
 or
 
-<pre class="programlisting">
-ptr.wait_and_get(th->get_id()->foo();
+<pre class="programlisting">ptr.wait_and_get(th->get_id()->foo();
</pre>

 In order to ensure that the decorations have been called, a cleaner and
@@ -344,8 +317,7 @@
 behavior is obtained each time the thread is created with an <code class="computeroutput">AsynchronousExecutor</code> decorator when
 using the Boost.Async library, as
 
-<pre class="programlisting">
-bith::basic_threader_decorator ae;
+<pre class="programlisting">bith::basic_threader_decorator ae;
BOOST_AUTO(th, bith::fork(ae, func));
// here you are sure all the decorations have been called
// so we can access any thread_specific_shared_ptr of the created thread.
@@ -357,10 +329,9 @@
 might be held by other threads, obtained by <code class="computeroutput">*pmyclass[th]</code>.
 
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.iterating_through_all_the_thread_specific_context"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.iterating_through_all_the_thread_specific_context" title="Iterating
- through all the thread specific context">Iterating
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.iterating_through_all_the_thread_specific_context"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.iterating_through_all_the_thread_specific_context" title="Iterating through all the thread specific context">Iterating
 through all the thread specific context</a>
</h5></div></div></div>

@@ -370,18 +341,16 @@
 locking mechanism that 'ensure' that the map access is locked during
 the map query.
 
-<pre class="programlisting">
-{
+<pre class="programlisting">{
 bith::thread_specific_shared_ptr<myclass>::lock_type lock(ptr.get_mutex());
 const bith::thread_specific_shared_ptr<myclass>::map_type amap = ptr.get_map(lock);
 // use the map
}
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.deleting_the_context"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.deleting_the_context" title="Deleting
- the context">Deleting
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.deleting_the_context"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.deleting_the_context" title="Deleting the context">Deleting
 the context</a>
</h5></div></div></div>

@@ -398,14 +367,12 @@
 deleter routine supplied to the constructor. The deleter function is
 called only when there are no more references to the shared pointer.
 
-<pre class="programlisting">
-// Add use of deleter !!!
+<pre class="programlisting">// Add use of deleter !!!
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.cleanup_at_thread_exit"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.cleanup_at_thread_exit" title="Cleanup
- at thread exit">Cleanup
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.cleanup_at_thread_exit"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.cleanup_at_thread_exit" title="Cleanup at thread exit">Cleanup
 at thread exit</a>
</h5></div></div></div>

@@ -427,29 +394,27 @@
 list. Cleanup finishes when there are no outstanding instances of <code class="computeroutput">boost::thread_specific_shared_ptr<></code>
 with values.
 
-<pre class="programlisting">
-// Add use of at thread_exit!!!
+<pre class="programlisting">// Add use of at thread_exit!!!
</pre>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive" title="Keep
- alive">Keep
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive" title="Keep alive">Keep
 alive</a>
</h4></div></div></div>
<div class="toc"><dl>
<dt>Interface</dt>
<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_mechanism_initialization">Keep
 alive mechanism initialization</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_threads">
- Which threads can be controlled?</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_enabling">
- Enabling the keep alive mechanism</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_disabling">
- Disabling the keep alive mechanism</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_persistent">
- Configuring the dead persistency</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_threads">Which
+ threads can be controlled?</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_enabling">Enabling
+ the keep alive mechanism</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_disabling">Disabling
+ the keep alive mechanism</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_persistent">Configuring
+ the dead persistency</a></dt>
<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from_the_current_thread">Access
 from the current thread</a></dt>
<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from__the_controller_thread">Access
@@ -477,15 +442,14 @@
 keep alive mechanislm is enabled. At the begining of a thread the keep
 alive mechanism is disabled.
 
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.interface"></a>Interface
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.interface"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.interface" title="Interface">Interface</a>
</h5></div></div></div>

 Next follows the keep alive interface.
 
-<pre class="programlisting">
-namespace boost {
+<pre class="programlisting">namespace boost {
namespace interthreads {
 namespace this_thread {
 class enable_keep_alive {
@@ -513,10 +477,9 @@
}
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_mechanism_initialization"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_mechanism_initialization" title="Keep
- alive mechanism initialization">Keep
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_mechanism_initialization"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_mechanism_initialization" title="Keep alive mechanism initialization">Keep
 alive mechanism initialization</a>
</h5></div></div></div>

@@ -524,8 +487,7 @@
 The controler needs to access some thread specific shared context <code class="computeroutput">thread_keep_alive_ctx</code> to be able to
 control a thread.
 
-<pre class="programlisting">
-namespace detail {
+<pre class="programlisting">namespace detail {
 struct thread_keep_alive_ctx {
 // ...
 static void init();
@@ -554,8 +516,7 @@
 specific context is done using an internal thread decoration <code class="computeroutput">thread_keep_alive_ctx::initializer_</code> with <code class="computeroutput">thread_keep_alive_ctx::init</code>
 as setup function.
 
-<pre class="programlisting">
-thread_specific_shared_ptr<detail::thread_keep_alive_ctx> thread_keep_alive_ctx::instance_;
+<pre class="programlisting">thread_specific_shared_ptr<detail::thread_keep_alive_ctx> thread_keep_alive_ctx::instance_;
thread_decoration thread_keep_alive_ctx::initializer_(thread_keep_alive_ctx::init);
boost::once_flag keep_alive_mgr::flag;
</pre>
@@ -563,8 +524,7 @@
 This setup function will initialize the <code class="computeroutput">keep_alive_mgr</code>
 and then set the <code class="computeroutput">thread_specific_shared_ptr<></code> with a new <code class="computeroutput">thread_keep_alive_ctx</code>.
 
-<pre class="programlisting">
-void thread_keep_alive_ctx::init() {
+<pre class="programlisting">void thread_keep_alive_ctx::init() {
 keep_alive_mgr::initialize();
 instance_.reset(new thread_keep_alive_ctx());
}
@@ -576,8 +536,7 @@
 the instance of the <code class="computeroutput">keep_alive_mgr</code>
 singleton.
 
-<pre class="programlisting">
-void keep_alive_mgr::initialize() {
+<pre class="programlisting">void keep_alive_mgr::initialize() {
 boost::call_once(flag_, init);
}
void keep_alive_mgr::init() {
@@ -585,11 +544,10 @@
}
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_threads"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_threads" title="
- Which threads can be controlled?">
- Which threads can be controlled?</a>
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_threads"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_threads" title="Which threads can be controlled?">Which
+ threads can be controlled?</a>
</h5></div></div></div>

 As the keep alive mechanism uses a thread decoration, the user needs
@@ -601,8 +559,7 @@
 So we must either call <code class="computeroutput">bith::decorate</code>
 explicitly on the thread function
 
-<pre class="programlisting">
-void fct() {
+<pre class="programlisting">void fct() {
 bith::decorate();
 // ...
}
@@ -611,15 +568,13 @@
 or create the thread with the <code class="computeroutput">bith::make_decorator</code>
 wrapper
 
-<pre class="programlisting">
-boost::thread th(bith::make_decorator(fct));
+<pre class="programlisting">boost::thread th(bith::make_decorator(fct));
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_enabling"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_enabling" title="
- Enabling the keep alive mechanism">
- Enabling the keep alive mechanism</a>
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_enabling"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_enabling" title="Enabling the keep alive mechanism">Enabling
+ the keep alive mechanism</a>
</h5></div></div></div>

 To be controled by the keep alive manager we need to enable the mechanism
@@ -627,8 +582,7 @@
 to do at least one check point every 2 seconds using the <code class="computeroutput">bith::keep_alive_point()</code>
 function.
 
-<pre class="programlisting">
-void fct() {
+<pre class="programlisting">void fct() {
 using bith::this_thread;

 // ...
@@ -643,19 +597,17 @@
}
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_disabling"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_disabling" title="
- Disabling the keep alive mechanism">
- Disabling the keep alive mechanism</a>
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_disabling"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_disabling" title="Disabling the keep alive mechanism">Disabling
+ the keep alive mechanism</a>
</h5></div></div></div>

 Some times we need to do an external task that could take an undefined
 time. We can then disable the keep alive mechanisme by using a disabler
 <code class="computeroutput">bith::disable_keep_alive</code>.
 
-<pre class="programlisting">
-void fct() {
+<pre class="programlisting">void fct() {
 using bith::this_thread;

 // ...
@@ -682,8 +634,7 @@
 the possibility to manage the keep alive error by interrupting the dead
 thread remains, once the task is finished.
 
-<pre class="programlisting">
-void fct() {
+<pre class="programlisting">void fct() {
 using boost::this_thread;
 using bith::this_thread;

@@ -706,11 +657,10 @@
}
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_persistent"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_persistent" title="
- Configuring the dead persistency">
- Configuring the dead persistency</a>
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_persistent"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.keep_alive_persistent" title="Configuring the dead persistency">Configuring
+ the dead persistency</a>
</h5></div></div></div>

 The default enabling parameters could be too restrictive in some cases.
@@ -719,8 +669,7 @@
 the thread has not done a number of checkins in a given period. This
 can be useful when one knows the time a given task should take.
 
-<pre class="programlisting">
-void fct() {
+<pre class="programlisting">void fct() {
 using bith::this_thread;

 // ...
@@ -743,10 +692,9 @@
}
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from_the_current_thread"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from_the_current_thread" title="Access
- from the current thread">Access
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from_the_current_thread"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from_the_current_thread" title="Access from the current thread">Access
 from the current thread</a>
</h5></div></div></div>

@@ -756,8 +704,7 @@
 this thread using the backup function and then they enable/disable the
 KA mechanism. On destruction they restore the backed up context.
 
-<pre class="programlisting">
-enable_keep_alive::enable_keep_alive(
+<pre class="programlisting">enable_keep_alive::enable_keep_alive(
 std::size_t periods, std::size_t checkins)
{
 backup_=detail::thread_keep_alive_ctx::instance()->backup(data_);
@@ -780,8 +727,7 @@

 These functions are quite simple
 
-<pre class="programlisting">
-thread_keep_alive_internal* thread_keep_alive_ctx::backup(thread_keep_alive_internal* new_data) {
+<pre class="programlisting">thread_keep_alive_internal* thread_keep_alive_ctx::backup(thread_keep_alive_internal* new_data) {
 thread_keep_alive_internal* the_backup=data_;
 data_=new_data
 return the_backup;
@@ -807,8 +753,7 @@
 relaying the request to the specific context of this thread. This function
 just increases the number of <code class="computeroutput">checkins_</code>.
 
-<pre class="programlisting">
-void keep_alive_point() {
+<pre class="programlisting">void keep_alive_point() {
 detail::thread_keep_alive_ctx::instance()->check_point();
}

@@ -820,8 +765,7 @@
 The <code class="computeroutput">set_on_dead_thread()</code> does the same. This function just stores
 the on-dead action.
 
-<pre class="programlisting">
-void set_on_dead_thread(on_dead_thread_type fct, thread* th) {
+<pre class="programlisting">void set_on_dead_thread(on_dead_thread_type fct, thread* th) {
 detail::thread_keep_alive_ctx::instance()->set_on_dead_thread(fct, th);
}

@@ -831,10 +775,9 @@
 }
</pre>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from__the_controller_thread"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from__the_controller_thread" title="Access
- from the controller thread">Access
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from__the_controller_thread"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive.access_from__the_controller_thread" title="Access from the controller thread">Access
 from the controller thread</a>
</h5></div></div></div>

@@ -849,8 +792,7 @@

 The constructor just constructs a thread with the loop function.
 
-<pre class="programlisting">
-keep_alive_mgr() : end_(false), thread_(boost::bind(loop, boost::ref(end_))) {}
+<pre class="programlisting">keep_alive_mgr() : end_(false), thread_(boost::bind(loop, boost::ref(end_))) {}
</pre>

 The loop function will iterate, every second, over all the thread_keep_alive_ctx
@@ -858,8 +800,7 @@
 as the map can be modified when threads are created or finished, we need
 to protect the iteration externally with a lock on the protecting mutex.
 
-<pre class="programlisting">
-static void loop(bool& end) {
+<pre class="programlisting">static void loop(bool& end) {
 boost::xtime t;
 boost::xtime_get(&t,1);
 while(!end) {
@@ -883,8 +824,7 @@
 when the program finishes. So it is up to the destructor to set this
 variable and wait for the thread completion
 
-<pre class="programlisting">
-~keep_alive_mgr() {
+<pre class="programlisting">~keep_alive_mgr() {
 end_=true;
 thread_.join();
}
@@ -895,8 +835,7 @@
 is declared dead it executes the on dead action and resets the check-ins
 and periods.
 
-<pre class="programlisting">
-void control(thread::id id) {
+<pre class="programlisting">void control(thread::id id) {
 if (data_->enabled_) {
 --data_->periods_;
 if (dead()) {
@@ -909,27 +848,24 @@
</pre>
</div>
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple" title="Thread
- Tuple">Thread
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple" title="Thread Tuple">Thread
 Tuple</a>
</h4></div></div></div>
<div class="toc"><dl>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_launching">
- Launching thread tuple</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_exceptions">
- Exceptions in thread functions</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_joining">
- Joining and detaching</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_interruption">
- Interruption</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_launching">Launching
+ thread tuple</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_exceptions">Exceptions
+ in thread functions</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_joining">Joining
+ and detaching</a></dt>
+<dt>Interruption</dt>
</dl></div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_launching"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_launching" title="
- Launching thread tuple">
- Launching thread tuple</a>
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_launching"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_launching" title="Launching thread tuple">Launching
+ thread tuple</a>
</h5></div></div></div>

 A new thread tuple is launched by passing a collection of objects of
@@ -940,8 +876,7 @@
 to the function object. In this case, the user of <code class="computeroutput">thread_tuple<></code> must ensure that the referred-to
 object outlives the newly-created thread of execution.
 
-<pre class="programlisting">
-struct callable
+<pre class="programlisting">struct callable
{
 void operator()();
};
@@ -967,8 +902,7 @@
 additional arguments as is the case for threads to the <code class="computeroutput">thread_tuple<></code>
 constructor, and you will need to use bind explicitly.
 
-<pre class="programlisting">
-void find_the_question(int the_answer);
+<pre class="programlisting">void find_the_question(int the_answer);

bith::thread_tuple<2> deep_thought_2(boost::bind(find_the_question,42), boost::bind(find_the_question,16));
</pre>
@@ -982,11 +916,10 @@
 specified by the Boost.Bind.
 
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_exceptions"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_exceptions" title="
- Exceptions in thread functions">
- Exceptions in thread functions</a>
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_exceptions"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_exceptions" title="Exceptions in thread functions">Exceptions
+ in thread functions</a>
</h5></div></div></div>

 If the function or callable object passed to the <code class="computeroutput">thread_tuple<></code> constructor propagates an exception
@@ -995,11 +928,10 @@
 is called.
 
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_joining"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_joining" title="
- Joining and detaching">
- Joining and detaching</a>
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_joining"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_joining" title="Joining and detaching">Joining
+ and detaching</a>
</h5></div></div></div>

 When the <code class="computeroutput">thread_tuple<></code> object that represents a collection
@@ -1032,11 +964,9 @@
 interrupting the rest of the threads.
 
</div>
-<div class="section" lang="en">
+<div class="section">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_interruption"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_interruption" title="
- Interruption">
- Interruption</a>
+<a name="toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_interruption"></a><a class="link" href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_interruption" title="Interruption">Interruption</a>
</h5></div></div></div>

 A tuple of running threads can be interrupted by
@@ -1058,11 +988,9 @@
 At any point, the interruption state for the current thread can be queried
 by calling <code class="computeroutput">interruption_enabled</code>.
 
-<a name="interruption_points"></a>
- 

- See the Boost.Threads
- library for the Predefined Interruption Points.
+ <a name="interruption_points"></a> See the Boost.Threads library for the Predefined
+ Interruption Points.
 
</div>
</div>

Modified: sandbox/interthreads/libs/interthreads/doc/interthreads.qbk
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/interthreads.qbk (original)
+++ sandbox/interthreads/libs/interthreads/doc/interthreads.qbk 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -8,12 +8,13 @@

[article Toward Boost.InterThreads
     [quickbook 1.5]
+ [version 0.1.3]
     [authors [Botet Escriba, Vicente J.]]
- [copyright 2008-2009 Vicente J. Botet Escriba]
- [purpose C++ Library extending the Boost.Thread library adding some inter threads mechanisms as
+ [copyright 2008-2009,2011 Vicente J. Botet Escriba]
+ [/purpose C++ Library extending the Boost.Thread library adding some inter threads mechanisms as
     asynchronous executors and asyncronous completion tokes framework with threaders/joiners, launcher.
     thread decorator, specific shared pointers and keep alive mechanism]
- [category text]
+ [/category text]
     [license
         Distributed under the Boost Software License, Version 1.0.
         (See accompanying file LICENSE_1_0.txt or copy at
@@ -161,6 +162,4 @@

[include reference.qbk]

-[include case_studies.qbk]
-
[include appendices.qbk]

Modified: sandbox/interthreads/libs/interthreads/doc/overview.qbk
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/overview.qbk (original)
+++ sandbox/interthreads/libs/interthreads/doc/overview.qbk 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -9,8 +9,43 @@
[section:overview Overview]
[/========================]

+
+[/====================================]
+[heading How to Use This Documentation]
+[/====================================]
+
+This documentation makes use of the following naming and formatting conventions.
+
+* Code is in `fixed width font` and is syntax-highlighted.
+* Replaceable text that you will need to supply is in [~italics].
+* If a name refers to a free function, it is specified like this:
+ `free_function()`; that is, it is in code font and its name is followed by `()`
+ to indicate that it is a free function.
+* If a name refers to a class template, it is specified like this:
+ `class_template<>`; that is, it is in code font and its name is followed by `<>`
+ to indicate that it is a class template.
+* If a name refers to a function-like macro, it is specified like this: `MACRO()`;
+ that is, it is uppercase in code font and its name is followed by `()` to
+ indicate that it is a function-like macro. Object-like macros appear without the
+ trailing `()`.
+* Names that refer to /concepts/ in the generic programming sense are
+ specified in CamelCase.
+
+[note In addition, notes such as this one specify non-essential information that
+provides additional background or rationale.]
+
+Finally, you can mentally add the following to any code fragments in this document:
+
+ // Include all of InterThreads
+ #include <boost/interthreads/interthreads.hpp>
+
+ // Create a namespace aliases
+ namespace bith = boost::interthreads;
+
+[include introduction.qbk]
+
[/==================]
-[heading Description]
+[section Description]
[/==================]

__boost_interthreads__ extends __boost_thread__ adding some features:
@@ -44,39 +79,6 @@
[note thread_decorator and thread_specific_shared_ptr are based on the original implementation of [@http://www.boost-consulting.com/vault/index.php?directory=Concurrent%20Programming [*threadalert]]
written by Roland Schwarz.]

+[endsect]

-
-[/====================================]
-[heading How to Use This Documentation]
-[/====================================]
-
-This documentation makes use of the following naming and formatting conventions.
-
-* Code is in `fixed width font` and is syntax-highlighted.
-* Replaceable text that you will need to supply is in [~italics].
-* If a name refers to a free function, it is specified like this:
- `free_function()`; that is, it is in code font and its name is followed by `()`
- to indicate that it is a free function.
-* If a name refers to a class template, it is specified like this:
- `class_template<>`; that is, it is in code font and its name is followed by `<>`
- to indicate that it is a class template.
-* If a name refers to a function-like macro, it is specified like this: `MACRO()`;
- that is, it is uppercase in code font and its name is followed by `()` to
- indicate that it is a function-like macro. Object-like macros appear without the
- trailing `()`.
-* Names that refer to /concepts/ in the generic programming sense are
- specified in CamelCase.
-
-[note In addition, notes such as this one specify non-essential information that
-provides additional background or rationale.]
-
-Finally, you can mentally add the following to any code fragments in this document:
-
- // Include all of InterThreads
- #include <boost/interthreads/interthreads.hpp>
-
- // Create a namespace aliases
- namespace bith = boost::interthreads;
-
-[include introduction.qbk]
[endsect]

Modified: sandbox/interthreads/libs/interthreads/doc/rationale.qbk
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/rationale.qbk (original)
+++ sandbox/interthreads/libs/interthreads/doc/rationale.qbk 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -10,7 +10,7 @@
[/=======================================]

[/=======================]
-[section Thread Decorator]
+[section:decorator Thread Decorator]
[/=======================]

[variablelist
@@ -26,7 +26,7 @@
[endsect]

[/==============================]
-[section Thread Specific Storage]
+[section:tss Thread Specific Storage]
[/==============================]

[variablelist
@@ -69,11 +69,11 @@
]

[/==============================]
-[heading Comparaing TSSS and TSS]
+[heading:hcmp_tss Comparaing TSSS and TSS]
[/==============================]

-[table Comparaing TSSS and TSS
+[table:tcmp_tss Comparaing TSSS and TSS
[[Feature][thread_specific_shared_ptr][thread_specific_ptr][Compatible]]
[[ownership][shared][exclusive][no]]
[[default constructor][[*yes]][[*yes]][[*yes]]]
@@ -97,7 +97,7 @@
[endsect]

[/=================]
-[section Keep Alive]
+[section:ka Keep Alive]
[/=================]

[variablelist
@@ -121,7 +121,7 @@

[/===================]
-[section Thread Tuple]
+[section:tuple Thread Tuple]
[/===================]

[variablelist
@@ -166,11 +166,11 @@
]

[/=======================================================]
-[heading Comparaing thread, thread_group and thread_tuple]
+[heading:hcmp_thread Comparaing thread, thread_group and thread_tuple]
[/=======================================================]

-[table Comparaing thread, thread_group and thread_tuple
+[table:tcmp_thread Comparaing thread, thread_group and thread_tuple
[[Feature][thread][thread_group][thread_tuple][Compatible]]
[[default constructor][[*yes]][[*yes]][[*yes]][[*yes]]]
[[copiable][no][no][no][[*yes]]]

Modified: sandbox/interthreads/libs/interthreads/doc/users_guide.qbk
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/users_guide.qbk (original)
+++ sandbox/interthreads/libs/interthreads/doc/users_guide.qbk 2011-02-16 14:38:13 EST (Wed, 16 Feb 2011)
@@ -1,4 +1,4 @@
-[/
+
[/
(C) Copyright 2008-2009 Vicente J. Botet Escriba
Distributed under the Boost Software License, Version 1.0.
@@ -13,6 +13,7 @@
[include getting_started.qbk]
[include tutorial.qbk]

+[include case_studies.qbk]

[/==============================]
[section:bibliography References]
@@ -48,4 +49,4 @@

[endsect]

-[endsect]
\ No newline at end of file
+[endsect]

Date view	Thread view	Subject view	Author view