Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r56906 - in sandbox/interthreads: . libs/interthreads/build libs/interthreads/doc libs/interthreads/doc/html libs/interthreads/doc/html/toward_boost_interthreads libs/interthreads/doc/html/toward_boost_interthreads/appendices libs/interthreads/doc/html/toward_boost_interthreads/examples libs/interthreads/doc/html/toward_boost_interthreads/reference libs/interthreads/doc/html/toward_boost_interthreads/users_guide libs/interthreads/test
From: vicente.botet_at_[hidden]
Date: 2009-10-16 04:38:43

Author: viboes
Date: 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
New Revision: 56906
URL: http://svn.boost.org/trac/boost/changeset/56906

Log:
TBoost.Interthreads:
* Review version
Added:
   sandbox/interthreads/boost.png (contents, props changed)
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/keep_alive_file_hpp.html (contents, props changed)
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/set_once_hpp.html (contents, props changed)
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_decoration_hpp.html (contents, props changed)
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_decorator_hpp.html (contents, props changed)
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_group_once_hpp.html (contents, props changed)
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_specific_shared_ptr_hpp.html (contents, props changed)
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_tuple_hpp.html (contents, props changed)
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_tuple_once_hpp.html (contents, props changed)
Text files modified:
   sandbox/interthreads/libs/interthreads/build/Jamfile.v2 | 7
   sandbox/interthreads/libs/interthreads/doc/case_studies.qbk | 2
   sandbox/interthreads/libs/interthreads/doc/html/index.html | 29
   sandbox/interthreads/libs/interthreads/doc/html/standalone_HTML.manifest | 11
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices.html | 7
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/changes.html | 4
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/rationale.html | 8
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/appendices/todo.html | 18
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/examples.html | 18
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/examples/thread_safe_deferred_traces.html | 6
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/overview.html | 2
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference.html | 74 +
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/concepts.html | 8
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide.html | 12
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/getting_started.html | 4
   sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/users_guide/tutorial.html | 1115 ++++++++++++++++++++-------------------
   sandbox/interthreads/libs/interthreads/doc/reference.qbk | 8
   sandbox/interthreads/libs/interthreads/doc/tutorial.qbk | 10
   sandbox/interthreads/libs/interthreads/test/Jamfile.v2 | 7
   19 files changed, 723 insertions(+), 627 deletions(-)

Added: sandbox/interthreads/boost.png
==============================================================================
Binary file. No diff available.

Modified: sandbox/interthreads/libs/interthreads/build/Jamfile.v2
==============================================================================
--- sandbox/interthreads/libs/interthreads/build/Jamfile.v2 (original)
+++ sandbox/interthreads/libs/interthreads/build/Jamfile.v2 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -36,6 +36,10 @@
import indirect ;
import path ;

+if ! $(BOOST_ROOT)
+{
+ BOOST_ROOT = [ modules.peek : BOOST_ROOT ] ;
+}
project boost/interthreads
 : source-location ../src
 : requirements
@@ -46,7 +50,8 @@
# <define>BOOST_THREAD_HAS_THREAD_ATTR

 <include>../../..
- <include>$BOOST_ROOT
+ <include>/boost_1_39_0
+ #<include>$BOOST_ROOT
 <link>static:<define>BOOST_INTERTHREADS_BUILD_LIB=1
 <link>shared:<define>BOOST_INTERTHREADS_BUILD_DLL=1
# <link>shared:<library>/boost/thread//boost_thread/<link>shared

Modified: sandbox/interthreads/libs/interthreads/doc/case_studies.qbk
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/case_studies.qbk (original)
+++ sandbox/interthreads/libs/interthreads/doc/case_studies.qbk 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -286,6 +286,7 @@

[endsect]

+[/
[/========================]
[section:stm STM]
[/========================]
@@ -566,4 +567,5 @@

[endsect]

+]/
[endsect]

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 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -53,17 +53,26 @@
<dt> Reference</dt>
<dd><dl>
<dt>Concepts</dt>
-<dt><a href="toward_boost_interthreads/reference/thread_extensions_reference.html">Thread
- Extensions Reference</a></dt>
-<dt><a href="toward_boost_interthreads/reference/thread_array_reference.html">Thread
- Array Reference</a></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
+ <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>
</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>
-<dt> STM</dt>
-</dl></dd>
+<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
@@ -97,7 +106,7 @@

</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: October 05, 2009 at 16:58:26 GMT</td>
+<td align="left">Last revised: October 16, 2009 at 08:11:02 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 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -8,11 +8,16 @@
toward_boost_interthreads/users_guide/glosary.html
toward_boost_interthreads/reference.html
toward_boost_interthreads/reference/concepts.html
-toward_boost_interthreads/reference/thread_extensions_reference.html
-toward_boost_interthreads/reference/thread_array_reference.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/examples/stm.html
toward_boost_interthreads/appendices.html
toward_boost_interthreads/appendices/changes.html
toward_boost_interthreads/appendices/rationale.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 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -6,7 +6,8 @@
<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/stm.html" title=" STM">
+<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">
</head>
@@ -21,7 +22,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="examples/stm.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="appendices/changes.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="examples/thread_safe_deferred_traces.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="appendices/changes.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -91,7 +92,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="examples/stm.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="appendices/changes.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="examples/thread_safe_deferred_traces.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="appendices/changes.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

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 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -136,11 +136,11 @@
<a name="toward_boost_interthreads.appendices.changes.__bugs_"></a>Bugs
</h4></div></div></div>
<a name="toward_boost_interthreads.appendices.changes.__bugs_._emphasis_role__bold__open_bugs___emphasis_"></a><h5>
-<a name="id4854878"></a>
+<a name="id4849833"></a>
 <a href="changes.html#toward_boost_interthreads.appendices.changes.__bugs_._emphasis_role__bold__open_bugs___emphasis_">Open Bugs:</a>
 </h5>
<a name="toward_boost_interthreads.appendices.changes.__bugs_._emphasis_role__bold__fixed_bugs___emphasis_"></a><h5>
-<a name="id4854907"></a>
+<a name="id4849861"></a>
 <a href="changes.html#toward_boost_interthreads.appendices.changes.__bugs_._emphasis_role__bold__fixed_bugs___emphasis_">Fixed Bugs:</a>
 </h5>

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 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -135,12 +135,12 @@
</dl>
</div>
<a name="toward_boost_interthreads.appendices.rationale.thread_specific_storage.comparaing_tsss_and_tss"></a><h5>
-<a name="id4855813"></a>
+<a name="id4850767"></a>
 <a href="rationale.html#toward_boost_interthreads.appendices.rationale.thread_specific_storage.comparaing_tsss_and_tss">Comparaing
 TSSS and TSS</a>
 </h5>
<div class="table">
-<a name="id4855829"></a>Table 1. Comparaing TSSS and TSS
+<a name="id4850783"></a>Table 1. Comparaing TSSS and TSS
<table class="table" summary="Comparaing TSSS and TSS">
<colgroup>
<col>
@@ -651,12 +651,12 @@
</dl>
</div>
<a name="toward_boost_interthreads.appendices.rationale.thread_tuple.comparaing_thread__thread_group_and_thread_tuple"></a><h5>
-<a name="id4857229"></a>
+<a name="id4852183"></a>
 <a 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>
<div class="table">
-<a name="id4857246"></a>Table 2. Comparaing thread, thread_group and thread_tuple
+<a name="id4852200"></a>Table 2. Comparaing thread, thread_group and thread_tuple
<table class="table" summary="Comparaing thread, thread_group and thread_tuple">
<colgroup>
<col>

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 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -42,7 +42,7 @@
 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="id4858992"></a>
+<a name="id4853945"></a>
 <a href="todo.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.complete_the_tests">Complete
 the tests</a>
 </h5>
@@ -68,7 +68,7 @@
 </li>
</ul></div>
<a name="toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.add_more_examples"></a><h5>
-<a name="id4859047"></a>
+<a name="id4854001"></a>
 <a href="todo.html#toward_boost_interthreads.appendices.todo.tasks_to_do_before_review.add_more_examples">Add
 more examples</a>
 </h5>
@@ -81,7 +81,7 @@
 </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="id4859085"></a>
+<a name="id4854038"></a>
 <a 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>
@@ -93,25 +93,25 @@
 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="id4859127"></a>
+<a name="id4854080"></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
 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="id4859157"></a>
+<a name="id4854110"></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
 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="id4859188"></a>
+<a name="id4854140"></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
 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="id4859219"></a>
+<a name="id4854171"></a>
 <a 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>
@@ -120,12 +120,12 @@
 when dead.
 
<a name="toward_boost_interthreads.appendices.todo.for_later_releases.optimize_the_tsss_maps_using_intrusive_containers"></a><h5>
-<a name="id4859257"></a>
+<a name="id4854208"></a>
 <a 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="id4859280"></a>
+<a name="id4854230"></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
 both specific pointers in a template class basic_thread_specific_ptr</a>
 </h5>

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 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -6,8 +6,8 @@
<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_array_reference.html" title="Thread
- Array Reference">
+<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">
</head>
@@ -22,20 +22,20 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="reference/thread_array_reference.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="examples/thread_safe_deferred_traces.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="reference/thread_group_once_hpp.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="examples/thread_safe_deferred_traces.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="toward_boost_interthreads.examples"></a>Examples
</h2></div></div></div>
-<div class="toc"><dl>
-<dt><a href="examples/thread_safe_deferred_traces.html">Thread
- safe deferred traces</a></dt>
-<dt> STM</dt>
-</dl></div>
+<div class="toc"><dl><dt><a href="examples/thread_safe_deferred_traces.html">Thread
+ safe deferred traces</a></dt></dl></div>

 This section do includes complete examples using the library.
 
+
+ /
+ 
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -47,7 +47,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="reference/thread_array_reference.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="examples/thread_safe_deferred_traces.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="reference/thread_group_once_hpp.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="examples/thread_safe_deferred_traces.html"><img src="../../../../../doc/html/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 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -8,7 +8,7 @@
<link rel="start" 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="stm.html" title=" STM">
+<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,7 +21,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../examples.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../examples.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="stm.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../examples.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../examples.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../appendices.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
@@ -331,7 +331,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../examples.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../examples.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="stm.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../examples.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../examples.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../appendices.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

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 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -105,7 +105,7 @@
 </td></tr>
</table></div>
<a name="toward_boost_interthreads.overview.how_to_use_this_documentation"></a><h3>
-<a name="id4764766"></a>
+<a name="id4764765"></a>
 <a href="overview.html#toward_boost_interthreads.overview.how_to_use_this_documentation">How
 to Use This Documentation</a>
 </h3>

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 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -29,29 +29,63 @@
<div class="toc"><dl>
<dt>Concepts</dt>
<dd><dl><dt>Decorator</dt></dl></dd>
-<dt><a href="reference/thread_extensions_reference.html">Thread
- Extensions Reference</a></dt>
+<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_extensions_reference.html#toward_boost_interthreads.reference.thread_extensions_reference.thread_decoration_hpp">
- Header <code class="computeroutput"><boost/interthreads/thread_decoration.hpp></code></a></dt>
-<dt><a href="reference/thread_extensions_reference.html#toward_boost_interthreads.reference.thread_extensions_reference.thread_decorator_hpp">
- Header <code class="computeroutput"><boost/interthreads/thread_decorator.hpp></code></a></dt>
-<dt><a href="reference/thread_extensions_reference.html#toward_boost_interthreads.reference.thread_extensions_reference.thread_specific_shared_ptr_hpp">
- Header <code class="computeroutput"><boost/interthreads/thread_specific_shared_ptr.hpp></code></a></dt>
-<dt><a href="reference/thread_extensions_reference.html#toward_boost_interthreads.reference.thread_extensions_reference.keep_alive_file_hpp">
- Header <code class="computeroutput"><boost/interthreads/thread_keep_alive.hpp></code></a></dt>
+<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_array_reference.html">Thread
- Array Reference</a></dt>
+<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/thread_array_reference.html#toward_boost_interthreads.reference.thread_array_reference.set_once_hpp">
- Header <code class="computeroutput"><boost/interthreads/set_once.hpp></code></a></dt>
-<dt><a href="reference/thread_array_reference.html#toward_boost_interthreads.reference.thread_array_reference.thread_tuple_hpp">
- Header <code class="computeroutput"><boost/interthreads/thread_tuple.hpp></code></a></dt>
-<dt><a href="reference/thread_array_reference.html#toward_boost_interthreads.reference.thread_array_reference.thread_tuple_once_hpp">
- Header <code class="computeroutput"><boost/interthreads/thread_tuple_once.hpp></code></a></dt>
-<dt><a href="reference/thread_array_reference.html#toward_boost_interthreads.reference.thread_array_reference.thread_group_once_hpp">
- Header <code class="computeroutput"><boost/interthreads/thread_group_once.hpp></code></a></dt>
+<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>
+</dl></dd>
+<dt><a href="reference/set_once_hpp.html"> 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>
</dl></dd>
</dl></div>
</div>

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 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -7,8 +7,8 @@
<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_extensions_reference.html" title="Thread
- Extensions 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>
@@ -21,7 +21,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../reference.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="thread_extensions_reference.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../reference.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="thread_decoration_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
@@ -42,7 +42,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../reference.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="thread_extensions_reference.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../reference.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="thread_decoration_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Added: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/keep_alive_file_hpp.html
==============================================================================
--- (empty file)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/keep_alive_file_hpp.html 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -0,0 +1,300 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<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>">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="thread_specific_shared_ptr_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="set_once_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<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>
+</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>
+<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>
+</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>
+<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>
+</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>
+</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" lang="en">
+<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>
+</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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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>
+<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
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="thread_specific_shared_ptr_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="set_once_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/set_once_hpp.html
==============================================================================
--- (empty file)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/set_once_hpp.html 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -0,0 +1,93 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<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>">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="keep_alive_file_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="thread_tuple_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<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
+ <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;
+}
+}
+</pre>
+<div class="section" lang="en">
+<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>
+</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>
+<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
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="keep_alive_file_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="thread_tuple_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_decoration_hpp.html
==============================================================================
--- (empty file)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_decoration_hpp.html 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -0,0 +1,194 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<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">
+<link rel="prev" href="concepts.html" title="Concepts">
+<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>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="concepts.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="thread_decorator_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<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>
+</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>
+<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.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" lang="en">
+<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>
+</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.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" lang="en">
+<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>
+</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/html/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" lang="en">
+<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
+ 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/html/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>
+<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
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="concepts.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="thread_decorator_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_decorator_hpp.html
==============================================================================
--- (empty file)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_decorator_hpp.html 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -0,0 +1,473 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<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>">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="thread_decoration_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="thread_specific_shared_ptr_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<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>
+</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>
+<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>
+</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>
+</dl></div>
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+ class thread_decorator;
+ void decorate();
+}
+}
+</pre>
+<div class="section" lang="en">
+<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>
+</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>
+</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/html/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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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>
+<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
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="thread_decoration_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="thread_specific_shared_ptr_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_group_once_hpp.html
==============================================================================
--- (empty file)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_group_once_hpp.html 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -0,0 +1,458 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<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>">
+<link rel="next" href="../examples.html" title="Examples">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="thread_tuple_once_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../examples.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<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>
+</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>
+<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><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>
+</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>
+</dl></div>
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+
+ template <std::size_t N>
+ class thread_group;
+
+}
+}
+</pre>
+<div class="section" lang="en">
+<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>
+</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><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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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
+ 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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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>
+<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
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="thread_tuple_once_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../examples.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_specific_shared_ptr_hpp.html
==============================================================================
--- (empty file)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_specific_shared_ptr_hpp.html 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -0,0 +1,604 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<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>">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="thread_decorator_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="keep_alive_file_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<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>
+</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>
+<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">
+ 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>
+</dl></dd>
+</dl></div>
+<pre class="programlisting">namespace boost {
+namespace interthreads {
+
+ template <typename T>
+ class thread_specific_shared_ptr;
+
+}
+}
+</pre>
+<div class="section" lang="en">
+<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>
+</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">
+ 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>
+</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" 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>
+</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>
+</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>
+</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_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>
+</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" 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_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>
+</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" 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_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>
+</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/html/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" 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_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;
+</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/html/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" 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_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;
+</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" 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_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>
+</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" 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_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>
+</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" 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_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>
+</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" 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_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>
+</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" 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.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>
+</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" 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.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>
+</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>
+<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
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="thread_decorator_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="keep_alive_file_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_tuple_hpp.html
==============================================================================
--- (empty file)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_tuple_hpp.html 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -0,0 +1,536 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<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>">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="set_once_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="thread_tuple_once_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<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>
+</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>
+<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><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.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>
+</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>
+</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" lang="en">
+<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>
+</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><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.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>
+</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" lang="en">
+<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
+ 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>
+<div class="section" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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
+ 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" lang="en">
+<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
+ 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" lang="en">
+<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();
+</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" lang="en">
+<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
+ 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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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>
+<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
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="set_once_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="thread_tuple_once_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_tuple_once_hpp.html
==============================================================================
--- (empty file)
+++ sandbox/interthreads/libs/interthreads/doc/html/toward_boost_interthreads/reference/thread_tuple_once_hpp.html 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -0,0 +1,502 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<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>">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="thread_tuple_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="thread_group_once_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<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>
+</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>
+<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><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>
+</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>
+</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" lang="en">
+<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>
+</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><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>
+</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" lang="en">
+<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
+ 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>
+<div class="section" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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
+ 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" lang="en">
+<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
+ 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" lang="en">
+<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>
+<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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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>
+<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
+ 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)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="thread_tuple_hpp.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="thread_group_once_hpp.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

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 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -41,8 +41,16 @@
keep alive</a></dt>
</dl></dd>
<dt> Tutorial</dt>
-<dd><dl><dt><a href="users_guide/tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions">Thread
- Extensions</a></dt></dl></dd>
+<dd><dl>
+<dt><a href="users_guide/tutorial.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
+ Specific Shared Pointer</a></dt>
+<dt><a href="users_guide/tutorial.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
+ Tuple</a></dt>
+</dl></dd>
<dt><a href="users_guide/bibliography.html">
References</a></dt>
<dt> Glossary</dt>

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 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -72,7 +72,7 @@
bjam
</pre>
<a name="toward_boost_interthreads.users_guide.getting_started.install.build_requirements"></a><h5>
-<a name="id4759412"></a>
+<a name="id4759411"></a>
 <a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install.build_requirements">Build
 Requirements</a>
 </h5>
@@ -145,7 +145,7 @@
 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="id4759722"></a>
+<a name="id4759721"></a>
 <a href="getting_started.html#toward_boost_interthreads.users_guide.getting_started.install.thread_safety">Thread
 safety</a>
 </h5>

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 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -29,103 +29,134 @@
<a name="toward_boost_interthreads.users_guide.tutorial"></a> Tutorial
</h3></div></div></div>
<div class="toc"><dl>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions">Thread
- Extensions</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator">Thread
+ Decorator</a></dt>
<dd><dl>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_decorator">Thread
- Decorator</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer">Thread
- Specific Shared Pointer</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive">Keep
- alive</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple">Thread
- Tuple</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.declaring_a_decoration">Declaring
+ 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>
+</dl></dd>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer">Thread
+ Specific Shared Pointer</a></dt>
+<dd><dl>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.key_initialization">Key
+ initialization</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.context_initialization">Context
+ initialization</a></dt>
+<dt><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">Obtain
+ the pointer to the thread-specific object on the current thread</a></dt>
+<dt><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">Obtain
+ the pointer to the thread-specific object of another thread</a></dt>
+<dt><a href="tutorial.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="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.deleting_the_context">Deleting
+ the context</a></dt>
+<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></dd>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.keep_alive">Keep
+ alive</a></dt>
+<dd><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.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
+ from the controller thread</a></dt>
+</dl></dd>
+<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>
</dl></dd>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions" title="Thread
- Extensions">Thread
- Extensions</a>
+<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
+ Decorator</a>
</h4></div></div></div>
<div class="toc"><dl>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_decorator">Thread
- Decorator</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer">Thread
- Specific Shared Pointer</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive">Keep
- alive</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple">Thread
- Tuple</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_decorator.declaring_a_decoration">Declaring
+ 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>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_decorator"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_decorator" title="Thread
- Decorator">Thread
- Decorator</a>
+<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 decoration</a>
</h5></div></div></div>
-<div class="toc"><dl>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_decorator.declaring_a_decoration">Declaring
- a decoration</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_decorator.creating_threads_with_decorators">Creating
- threads with decorators</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_decorator.decorator_explicit_call">
- Calling explictly the decoration on a thread</a></dt>
-</dl></div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_decorator.declaring_a_decoration"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_decorator.declaring_a_decoration" title="Declaring
- a decoration">Declaring
- a decoration</a>
-</h6></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:
- 
+
+ 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" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_decorator.creating_threads_with_decorators"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_decorator.creating_threads_with_decorators" title="Creating
- threads with decorators">Creating
- threads with decorators</a>
-</h6></div></div></div>
-
- When we want the decorations to decorate one thread of execution we
- can create the thread using the decorator wrapper.
- 
+ 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" lang="en">
+<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
+ 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>

- or using one of the <code class="computeroutput">AsynchronousExecutor</code>
- decorators, as
- 
+ 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" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_decorator.decorator_explicit_call"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_decorator.decorator_explicit_call" title="
- Calling explictly the decoration on a thread">
- Calling explictly the decoration on a thread</a>
-</h6></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.
- 
+<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>
+</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();
 // ...
@@ -134,67 +165,67 @@
</div>
</div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer" title="Thread
- Specific Shared Pointer">Thread
- Specific Shared Pointer</a>
-</h5></div></div></div>
+<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
+ Specific Shared Pointer</a>
+</h4></div></div></div>
<div class="toc"><dl>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer.key_initialization">Key
- initialization</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer.context_initialization">Context
- initialization</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.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="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.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="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer.iterating_through_all_the_thread_specific_context">Iterating
- through all the thread specific context</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer.deleting_the_context">Deleting
- the context</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer.cleanup_at_thread_exit">Cleanup
- at thread exit</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.key_initialization">Key
+ initialization</a></dt>
+<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.context_initialization">Context
+ initialization</a></dt>
+<dt><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">Obtain
+ the pointer to the thread-specific object on the current thread</a></dt>
+<dt><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">Obtain
+ the pointer to the thread-specific object of another thread</a></dt>
+<dt><a href="tutorial.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="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_specific_shared_pointer.deleting_the_context">Deleting
+ the context</a></dt>
+<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="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer.key_initialization"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer.key_initialization" title="Key
- initialization">Key
- initialization</a>
-</h6></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.
- 
+<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
+ 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" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer.context_initialization"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer.context_initialization" title="Context
- initialization">Context
- initialization</a>
-</h6></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.
- 
+<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
+ 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
- 
+ 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>
+ 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
 // ...
@@ -203,9 +234,9 @@
}
</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>
+ 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));
@@ -220,19 +251,19 @@
</pre>
</div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.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_extensions.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>
-</h6></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.
- 
+<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
+ 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
 // ...
@@ -243,37 +274,36 @@
</pre>
</div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.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_extensions.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>
-</h6></div></div></div>
-
- Besides, other threads can get access to the data provided a thread::id
- by:
- 
+<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
+ 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.
- 
+ 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:
- 
+ When we need this we can pool:
+ 
<pre class="programlisting">shared_ptr<myclass> shp;
do {
 shp = ptr[th->get_id()]->foo();
@@ -281,51 +311,50 @@
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.
- 
+ 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>

- shared_ptr<myclass> shp = ptr.wait_and_get(th->get_id());
- shp->foo(); or
- 
+ 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>

- 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, as
- 
+ 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" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer.iterating_through_all_the_thread_specific_context"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.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>
-</h6></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.
- 
+ 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" lang="en">
+<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
+ 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);
@@ -334,109 +363,109 @@
</pre>
</div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer.deleting_the_context"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer.deleting_the_context" title="Deleting
- the context">Deleting
- the context</a>
-</h6></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.
- 
+<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
+ 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" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer.cleanup_at_thread_exit"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_specific_shared_pointer.cleanup_at_thread_exit" title="Cleanup
- at thread exit">Cleanup
- at thread exit</a>
-</h6></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.
- 
+<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
+ 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" lang="en">
-<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive" title="Keep
- alive">Keep
- alive</a>
-</h5></div></div></div>
+<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
+ alive</a>
+</h4></div></div></div>
<div class="toc"><dl>
-<dt>Interface</dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_mechanism_initialization">Keep
- alive mechanism initialization</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_threads">
- Which threads can be controlled?</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_enabling">
- Enabling the keep alive mechanism</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_disabling">
- Disabling the keep alive mechanism</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_persistent">
- Configuring the dead persistency</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.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.thread_extensions.keep_alive.access_from__the_controller_thread">Access
- from the controller thread</a></dt>
+<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.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
+ 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.
- 
+ 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" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.interface"></a>Interface
-</h6></div></div></div>
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_interthreads.users_guide.tutorial.keep_alive.interface"></a>Interface
+</h5></div></div></div>

- Next follows the keep alive interface.
- 
+ Next follows the keep alive interface.
+ 
<pre class="programlisting">namespace boost {
namespace interthreads {
 namespace this_thread {
@@ -466,17 +495,16 @@
</pre>
</div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_mechanism_initialization"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_mechanism_initialization" title="Keep
- alive mechanism initialization">Keep
- alive mechanism initialization</a>
-</h6></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.
- 
+<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
+ 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 {
 // ...
@@ -502,30 +530,30 @@
}
</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.
- 
+ 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>.
- 
+ 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.
- 
+ 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);
}
@@ -535,46 +563,45 @@
</pre>
</div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_threads"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_threads" title="
- Which threads can be controlled?">
- Which threads can be controlled?</a>
-</h6></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
- 
+<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>
+</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
- 
+ 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" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_enabling"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_enabling" title="
- Enabling the keep alive mechanism">
- Enabling the keep alive mechanism</a>
-</h6></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.
- 
+<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>
+</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;

@@ -591,16 +618,16 @@
</pre>
</div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_disabling"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_disabling" title="
- Disabling the keep alive mechanism">
- Disabling the keep alive mechanism</a>
-</h6></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>.
- 
+<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>
+</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;

@@ -622,12 +649,12 @@
}
</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.
- 
+ 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;
@@ -652,18 +679,18 @@
</pre>
</div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_persistent"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.keep_alive_persistent" title="
- Configuring the dead persistency">
- Configuring the dead persistency</a>
-</h6></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.
- 
+<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>
+</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;

@@ -688,18 +715,18 @@
</pre>
</div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.access_from_the_current_thread"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.access_from_the_current_thread" title="Access
- from the current thread">Access
- from the current thread</a>
-</h6></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.
- 
+<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
+ 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)
{
@@ -721,8 +748,8 @@
}
</pre>

- These functions are quite simple
- 
+ 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
@@ -741,14 +768,14 @@
}
</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>.
- 
+ 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();
}
@@ -758,9 +785,9 @@
}
</pre>

- The <code class="computeroutput">set_on_dead_thread()</code> does the same. This function just
- stores the on-dead action.
- 
+ 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);
}
@@ -772,32 +799,31 @@
</pre>
</div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.access_from__the_controller_thread"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.keep_alive.access_from__the_controller_thread" title="Access
- from the controller thread">Access
- from the controller thread</a>
-</h6></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.
- 
+<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
+ 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.
- 
+ 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.
- 
+ 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);
@@ -815,24 +841,24 @@
}
</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
- 
+ 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.
- 
+ 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_;
@@ -847,36 +873,36 @@
</div>
</div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h5 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple" title="Thread
- Tuple">Thread
- Tuple</a>
-</h5></div></div></div>
+<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
+ Tuple</a>
+</h4></div></div></div>
<div class="toc"><dl>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple.thread_tuple_launching">
- Launching thread tuple</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple.thread_tuple_exceptions">
- Exceptions in thread functions</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple.thread_tuple_joining">
- Joining and detaching</a></dt>
-<dt><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.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><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_tuple.thread_tuple_interruption">
+ Interruption</a></dt>
</dl></div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple.thread_tuple_launching"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple.thread_tuple_launching" title="
- Launching thread tuple">
- Launching thread tuple</a>
-</h6></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.
- 
+<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>
+</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()();
@@ -898,108 +924,107 @@
 // 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.
- 
+ 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" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple.thread_tuple_exceptions"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple.thread_tuple_exceptions" title="
- Exceptions in thread functions">
- Exceptions in thread functions</a>
-</h6></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" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple.thread_tuple_joining"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple.thread_tuple_joining" title="
- Joining and detaching">
- Joining and detaching</a>
-</h6></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" lang="en">
-<div class="titlepage"><div><div><h6 class="title">
-<a name="toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple.thread_tuple_interruption"></a><a href="tutorial.html#toward_boost_interthreads.users_guide.tutorial.thread_extensions.thread_tuple.thread_tuple_interruption" title="
- Interruption">
- Interruption</a>
-</h6></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>
- 
+ 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.
+ 

- See the Boost.Threads
- library for the Predefined Interruption Points.
- 
+ The limit on the number of additional arguments that can be passed are
+ specified by the Boost.Bind.
+ 
+</div>
+<div class="section" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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" lang="en">
+<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>
+</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>

Modified: sandbox/interthreads/libs/interthreads/doc/reference.qbk
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/reference.qbk (original)
+++ sandbox/interthreads/libs/interthreads/doc/reference.qbk 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -10,17 +10,17 @@
[/==========================]
[include concepts.qbk]

-[section Thread Extensions Reference]
+[/section Thread Extensions Reference]
[include reference/thread_decoration.qbk]
[include reference/thread_decorator.qbk]

[include reference/thread_specific_shared_ptr.qbk]

[include reference/thread_keep_alive.qbk]
-[endsect]
+[/endsect]

-[section Thread Array Reference]
+[/section Thread Array Reference]

[include reference/set_once.qbk]
[include reference/thread_tuple.qbk]
@@ -28,6 +28,6 @@
[include reference/thread_group_once.qbk]

[/include reference/thread_and_join.qbk]
-[endsect]
+[/endsect]

[endsect]

Modified: sandbox/interthreads/libs/interthreads/doc/tutorial.qbk
==============================================================================
--- sandbox/interthreads/libs/interthreads/doc/tutorial.qbk (original)
+++ sandbox/interthreads/libs/interthreads/doc/tutorial.qbk 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -8,7 +8,7 @@
[section:tutorial Tutorial]
[/========================]

-[section Thread Extensions]
+[/section Thread Extensions]

[section Thread Decorator]
[/==========================================================================================]
@@ -30,11 +30,13 @@

     boost::thread th(bith::thread_decorator(fct));

-or using one of the __AE__ decorators, as
+
+This behavion is obtained also using one of the __AE__ decorators of the Boost.Async library, as

     bith::basic_threader_decorator ae;
     BOOST_AUTO(th, bith::fork(ae, fct));

+
[endsect]

[section:decorator_explicit_call Calling explictly the decoration on a thread]
@@ -159,7 +161,7 @@

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 __AE__ decorator, as
+This behavior is obtained each time the thread is created with an __AE__ decorator when using the Boost.Async library, as

     bith::basic_threader_decorator ae;
     BOOST_AUTO(th, bith::fork(ae, func));
@@ -686,7 +688,7 @@

[endsect]
[endsect]
-[endsect]
+[/endsect]

[endsect]
\ No newline at end of file

Modified: sandbox/interthreads/libs/interthreads/test/Jamfile.v2
==============================================================================
--- sandbox/interthreads/libs/interthreads/test/Jamfile.v2 (original)
+++ sandbox/interthreads/libs/interthreads/test/Jamfile.v2 2009-10-16 04:38:39 EDT (Fri, 16 Oct 2009)
@@ -19,6 +19,11 @@
# bring in rules for testing
import testing ;

+if ! $(BOOST_ROOT)
+{
+ BOOST_ROOT = [ modules.peek : BOOST_ROOT ] ;
+}
+
project
 : requirements
 <library>/boost/test//boost_unit_test_framework/<link>static
@@ -27,7 +32,7 @@
 #<library>/sandbox/interthreads/libs/interthreads/build//boost_interthreads/<link>static

 <include>../../..
- <include>$(BOOST_ROOT)
+ <include>/boost_1_39_0
 <threading>multi
# <target-os>cygwin
# <interthreadapi>pthread

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk