Scoped Threads

Motivation
Tutorial
Free Thread Functors

- Synopsis + Synopsis

//#include <boost/thread/scoped_thread.hpp>
 
@@ -95,7 +95,7 @@
 
 Free Thread Functors
 
-
+
 Functor
         detach
 Functor
@@ -163,7 +163,7 @@
 
 Class strict_scoped_thread
 
-
+
 Constructor
         from a thread
 Move
@@ -206,20 +206,20 @@
       
 
 
-        Example
+        Example
       
 boost::strict_scoped_thread<> t((boost::thread(F)));
 
 
 
 Constructor
-        from a thread
+        from a thread
 
 explicit strict_scoped_thread(thread&& t) noexcept;
 
 
 
-
+
 Effects:
 
                 move the thread to own t_
@@ -241,7 +241,7 @@

Effects:

Construct an internal thread in place. @@ -266,7 +266,7 @@

Effects:

Equivalent to CallableThread()(t_). @@ -284,7 +284,7 @@

Class `scoped_thread`

Default Constructor
Move @@ -398,7 +398,7 @@

- Example + Example

boost::scoped_thread<> t((boost::thread(F))); t.interrupt(); @@ -412,7 +412,7 @@

-
+

Effects:

Constructs a scoped_thread instance that wraps to Not-a-Thread. @@ -437,7 +437,7 @@

-
+

Effects:

Transfers ownership of the scoped_thread managed by other (if any) to the newly constructed @@ -465,24 +465,12 @@

-
+

Effects:
-
-
- Transfers ownership of the scoped_thread managed by other (if any) to *this. -
-
- - if defined BOOST_THREAD_DONT_PROVIDE_THREAD_MOVE_ASSIGN_CALLS_TERMINATE_IF_JOINABLE: - If there was a scoped_thread - previously associated with *this then that scoped_thread - is detached, DEPRECATED -
-
- - if defined BOOST_THREAD_PROVIDES_THREAD_MOVE_ASSIGN_CALLS_TERMINATE_IF_JOINABLE: - If the scoped_thread - is joinable calls to std::terminate. -
-
+
+ Transfers ownership of the scoped_thread managed by other (if any) to *this + after having called to CallableThread()(t_). +

Postconditions:

other->get_id()==thread::id() @@ -491,7 +479,8 @@

Throws:

- Nothing + Nothing: The CallableThread()(t_) should not throw when joining the + thread as the scoped variable is on a scope outside the thread function.

@@ -499,13 +488,13 @@

Move - Constructor from a thread + Constructor from a thread

scoped_thread(thread&& t);

-
+

Effects:

Transfers ownership of the thread managed by other @@ -533,7 +522,7 @@

-
+

Effects:

Construct an internal thread in place. @@ -558,7 +547,7 @@

-
+

Effects:

Equivalent to CallableThread()(t_). @@ -580,7 +569,7 @@

-
+

Returns:

Equivalent to return t_.joinable(). @@ -601,7 +590,7 @@

-
+

Effects:

Equivalent to t_.join(). @@ -619,7 +608,7 @@

-
+

Effects:

Equivalent to return t_.try_join_for(rel_time). @@ -637,7 +626,7 @@

-
+

Effects:

Equivalent to return t_.try_join_until(abs_time). @@ -654,7 +643,7 @@

-
+

Effects:

Equivalent to t_.detach(). @@ -671,7 +660,7 @@

-
+

Effects:

Equivalent to return t_.get_id(). @@ -688,7 +677,7 @@

-
+

Effects:

Equivalent to t_.interrupt(). @@ -705,7 +694,7 @@

-
+

Effects:

Equivalent to return thread::hardware_concurrency(). @@ -722,7 +711,7 @@

-
+

Effects:

Equivalent to return thread::physical_concurrency(). @@ -740,7 +729,7 @@

-
+

Effects:

Equivalent to return t_.native_handle(). @@ -757,7 +746,7 @@

-
+

Effects:

Equivalent t_.swap(other.t_). @@ -777,7 +766,7 @@

-
+

Effects:

lhs.swap(rhs). @@ -788,7 +777,7 @@
-

Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -15 Vicente J. Botet Escriba
+
Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -16 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)
diff --git a/doc/html/thread/acknowledgements.html b/doc/html/thread/acknowledgements.html index 082c7d25f5..3c828cd8b8 100644 --- a/doc/html/thread/acknowledgements.html +++ b/doc/html/thread/acknowledgements.html @@ -4,9 +4,9 @@ Acknowledgments - + - + @@ -53,7 +53,7 @@
-

Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -15 Vicente J. Botet Escriba
+
Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -16 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)
diff --git a/doc/html/thread/build.html b/doc/html/thread/build.html index f7b68e6b68..32b5b99636 100644 --- a/doc/html/thread/build.html +++ b/doc/html/thread/build.html @@ -4,10 +4,10 @@ Using and building the library - + - - + + @@ -27,7 +27,7 @@
Using and building the library
-
+

Configuration

Limitations

@@ -54,7 +54,7 @@
Boost.Thread depends on some non header-only libraries.
-
+

Boost.System: This dependency is mandatory and you will need to link with the library. @@ -95,7 +95,7 @@
Configuration
-
+

Boost.Chrono

Boost.Move

Boost.DateTime
@@ -131,7 +131,7 @@
Version

-
Table 33.1. Default Values for Configurable Features
+
Table 35.1. Default Values for Configurable Features

@@ -810,10 +810,10 @@
The Boost.DateTime time related functions introduced in Boost 1.35.0, using - the Boost.Date_Time library are deprecated. + the Boost.Date_Time library are deprecated. These include (but are not limited to):
-
+

boost::this_thread::sleep()
@@ -868,7 +868,7 @@
The following operators are deprecated:
-
+

boost::thread::operator==
@@ -883,7 +883,7 @@
Use instead
-
+

boost::thread::id::operator==
@@ -945,7 +945,7 @@
The following nested typedefs are deprecated:
-
+

boost::mutex::scoped_lock,
@@ -1276,7 +1276,7 @@ is defined Boost.Thread provides this C++ feature if the following are not defined
-
+

BOOST_NO_SFINAE_EXPR
@@ -1363,7 +1363,7 @@ the Boost.Thread version. The default version is 2. In this case the following breaking or extending macros are defined if the opposite is not requested:
-
+
BOOST_THREAD_PROVIDES_PROMISE_LAZY

@@ -1371,7 +1371,7 @@ to 3. In this case the following breaking or extending macros are defined if the opposite is not requested:
-
+

Breaking change BOOST_THREAD_PROVIDES_EXPLICIT_LOCK_CONVERSION @@ -1406,7 +1406,7 @@ to 4. In this case the following breaking or extending macros are defined if the opposite is not requested:
-
+

Conformity & Breaking change BOOST_THREAD_PROVIDES_SIGNATURE_PACKAGED_TASK @@ -1431,7 +1431,7 @@
Limitations
-
+

SunPro

VACPP

WCE
@@ -1446,13 +1446,13 @@
If __SUNPRO_CC < 0x5100 the library defines
-
+
BOOST_THREAD_DONT_USE_MOVE

If __SUNPRO_CC < 0x5100 the library defines
-
+
BOOST_THREAD_DONT_PROVIDE_FUTURE_CTOR_ALLOCATORS

@@ -1463,7 +1463,7 @@
If __IBMCPP__ < 1100 the library defines
-
+

BOOST_THREAD_DONT_USE_CHRONO
@@ -1482,7 +1482,7 @@
If _WIN32_WCE && _WIN32_WCE==0x501 the library defines
-
+
BOOST_THREAD_DONT_PROVIDE_FUTURE_CTOR_ALLOCATORS

@@ -1490,7 +1490,7 @@

-

Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -15 Vicente J. Botet Escriba
+
Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -16 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)
diff --git a/doc/html/thread/changes.html b/doc/html/thread/changes.html index 810a4f05c6..e43df95c25 100644 --- a/doc/html/thread/changes.html +++ b/doc/html/thread/changes.html @@ -4,9 +4,9 @@ History - + - + @@ -29,13 +29,118 @@

- Version + Version + 4.7.1 - boost 1.62 +
+
+ Know Bugs: +
+
+ #3926 + thread_specific_ptr + dlopen library causes a SIGSEGV. +
+
+ Please define BOOST_THREAD_PATCH to apply the patch that could unfortunately + results is a regression as described in #12049. +
+
+ Please take a look at thread + Know Bugs to see the current state. +
+
+ Please take a look at thread + trunk regression test to see the last regression test snapshot. +
+
+ Fixed Bugs: +
+
+
+ #11097 + test_scheduled_tp - ThreadSanitizer: heap-use-after-free +
+
+ #11951 + Memory leak in boost::when_all +
+
+ #12102 + condition_variable_fwd.hpp fails to compile when BOOST_THREAD_PROVIDES_INTERRUPTIONS + is disabled +
+
+ #12120 + Performance improvement in thread/barrier.hpp +
+
+ #12146 + make_exceptional_future is not mentioned in the docs +
+
+ #12202 + shared_lock should be in shared_mutex header +
+
+ #12220 + Memory leak in future::then() +
+
+ #12293 + boost::future::then lambda called before future is ready. +
+
+ #12350 + shared_mutex (pthreads) unlocked too early in unlock_shared() +
+
+ #12371 + boost thread/future.hpp fails to build +
+
+
+ and several PR +
+
+
+ #88 fix typos in boost::upgrade_lock +
+
+ #89 fix a bug in upgrade_to_unique_lock<>::operator=() +
+
+ #90 fix a bug in try_lock_wrapper<>::operator=() +
+
+ #91 Add shared_lock_guard to the included lock types +
+
+ #92 Fixed compilation with MSVC-8. +
+
+ #93 Fix variable shadowing warnings (Clang) +
+
+ #94 fix bugs in boost::barrier +
+
+ #95 fix a mistake in boost::completion_latch +
+
+ #96 rename async_func.hpp to invoker.hpp. +
+
+ #97 fix a mistake in sync_timed_queue<>::pull_until() +
+
+
+ + Version 4.7.0 - boost 1.61

Know Bugs:
-
+
#3926 thread_specific_ptr + dlopen library causes a SIGSEGV.
@@ -43,7 +148,7 @@ Please define BOOST_THREAD_PATCH to apply the patch that could unfortunately results is a regression as described in #12049.
-
+

#4833 MinGW/test_tss_lib: Support of automatic tss cleanup for native threading @@ -70,14 +175,14 @@
New Experimental Features:
-
+
#11772 Add a launch::sync policy

Fixed Bugs:
-
+

#11494 boost::this_thread::yield() is marked as deprecated in the synopsis @@ -98,14 +203,14 @@

- - Version + + Version 4.6.0 - boost 1.60

Know Bugs:
-
+

#4833 MinGW/test_tss_lib: Support of automatic tss cleanup for native threading @@ -136,7 +241,7 @@
New Experimental Features:
-
+

#11231 Allow to set continuation future's destructor behavior to non-blocking @@ -164,7 +269,7 @@
Fixed Bugs:
-
+

#6377 Condition variable blocks when changing time @@ -303,14 +408,14 @@

- - Version + + Version 4.5.0 - boost 1.58

Know Bugs:
-
+

#3926 thread_specific_ptr + dlopen library causes a SIGSEGV. @@ -357,7 +462,7 @@ There are some severe bugs that prevent the use of the library on concrete contexts, in particular:
-
+
on thread specific storage that prevent the library to be used with dynamic libraries ( #3926, ), @@ -365,7 +470,7 @@
New Experimental Features:
-
+

#9600 Async: Add task_region @@ -386,7 +491,7 @@
Fixed Bugs:
-
+

#6787 boost::thread::sleep() hangs if system time is rolled back @@ -451,14 +556,14 @@

- - Version + + Version 4.4.0 - boost 1.57

Know Bugs:
-
+

#2442 Application statically linked with Boost.Thread crashes when Google Desktop @@ -522,14 +627,14 @@ There are some severe bugs that prevent the use of the library on concrete contexts, in particular:
-
+
on thread specific storage that prevent the library to be used with dynamic libraries,

New Experimental Features:
-
+

#6227 Synchro: Use of variadic templates on Generic Locking Algorithms on compilers @@ -551,7 +656,7 @@
Fixed Bugs:
-
+

#6782 call_once uses incorrect barrier intrinsic on Visual Studio @@ -659,14 +764,14 @@

- - Version + + Version 4.3.0 - boost 1.56

Know Bugs:
-
+

#2442 Application statically linked with Boost.Thread crashes when Google Desktop @@ -737,7 +842,7 @@ There are some severe bugs that prevent the use of the library on concrete contexts, in particular:
-
+

on thread specific storage that prevent the library to be used with dynamic libraries, @@ -750,7 +855,7 @@
New Experimental Features:
-
+

#7446 Async: Add when_any. @@ -783,7 +888,7 @@
Fixed Bugs:
-
+

#8070 prefer GetTickCount64 over GetTickCount @@ -831,14 +936,14 @@

- - Version + + Version 4.2.0 - boost 1.55

Know Bugs:
-
+

#2442 Application statically linked with Boost.Thread crashes when Google Desktop @@ -896,7 +1001,7 @@ There are some severe bugs that prevent the use of the library on concrete contexts, in particular:
-
+

on thread specific storage that prevent the library to be used with dynamic libraries, @@ -909,7 +1014,7 @@
New Features:
-
+

#8519 Synchro: Update class barrier with a completion function. @@ -950,7 +1055,7 @@
Fixed Bugs:
-
+

#7461 detail::win32::ReleaseSemaphore may be called with count_to_release equal @@ -999,14 +1104,14 @@

- - Version + + Version 4.1.0 - boost 1.54

New Features:
-
+

#7285 C++11 compliance: Allow to pass movable arguments for call_once. @@ -1023,7 +1128,7 @@
Fixed Bugs:
-
+

#4878 MinGW 4.5.0 undefined reference to bool interruptible_wait(detail::win32::handle @@ -1160,8 +1265,8 @@

- - Version + + Version 4.0.0 - boost 1.53

@@ -1176,7 +1281,7 @@ Deprecated features since boost 1.53 will be available only until boost 1.58.

-
+

C++11 compliance: packaged_task<R> is deprecated, use instead packaged_task<R()>. See BOOST_THREAD_PROVIDES_SIGNATURE_PACKAGED_TASK and BOOST_THREAD_DONT_PROVIDE_SIGNATURE_PACKAGED_TASK @@ -1189,7 +1294,7 @@
New Features:
-
+

#6270 c++11 compliance: Add thread constructor from movable callable and movable @@ -1289,7 +1394,7 @@
Fixed Bugs:
-
+

#5752 boost::call_once() is unreliable on some platforms @@ -1357,8 +1462,8 @@

- - Version + + Version 3.1.0 - boost 1.52

@@ -1376,7 +1481,7 @@ will be only available until boost 1.55, that is you have yet 1 year to move to the new features.
-
+
Time related functions don't using the Boost.Chrono library, use the chrono overloads instead.
@@ -1390,7 +1495,7 @@ corresponding macro. As for the deprecated features, these broken features will be only available until boost 1.55.
-
+

#6229 Rename the unique_future to future following the c++11. @@ -1407,7 +1512,7 @@
New Features:
-
+

#2361 thread_specific_ptr: document nature of the key, complexity and rationale. @@ -1428,7 +1533,7 @@
Fixed Bugs:
-
+

#2797 Two problems with thread_specific_ptr. @@ -1522,8 +1627,8 @@

- - Version + + Version 3.0.1 - boost 1.51

@@ -1541,7 +1646,7 @@ will be only available until boost 1.55, that is you have 1 year and a half to move to the new features.
-
+
Time related functions don't using the Boost.Chrono library, use the chrono overloads instead.
@@ -1555,7 +1660,7 @@ corresponding macro. As for the deprecated features, these broken features will be only available until boost 1.55.
-
+

#6229 Rename the unique_future to future following the c++11. @@ -1572,7 +1677,7 @@
Fixed Bugs:
-
+

#4258 Linking with boost thread does not work on mingw/gcc 4.5. @@ -1613,14 +1718,14 @@

- - Version + + Version 3.0.0 - boost 1.50

Breaking changes when BOOST_THREAD_VERSION==3:
-
+

#6229 Breaking change: Rename the unique_future to future following the c++11. @@ -1637,7 +1742,7 @@
New Features:
-
+

#1850 Request for unlock_guard to compliment lock_guard. @@ -1733,7 +1838,7 @@
Fixed Bugs:
-
+

#2380 boost::move from lvalue does not work with gcc. @@ -1826,14 +1931,14 @@

- - Version + + Version 2.1.1 - boost 1.49

Fixed Bugs:
-
+

#2309 Lack of g++ symbol visibility support in Boost.Thread. @@ -1924,8 +2029,8 @@

- - Version 2.1.0 + + Version 2.1.0 - Changes since boost 1.40

@@ -1933,14 +2038,14 @@ a few minor changes.

- - Changes + + Changes since boost 1.35

The 1.36.0 release of Boost includes a few new features in the thread library:
-
+

New generic lock() and try_lock() @@ -1970,8 +2075,8 @@

- - Version 2.0.0 + + Version 2.0.0 - Changes since boost 1.34

@@ -1981,11 +2086,11 @@ with the old code. The new features and breaking changes are described below.

- - New + + New Features
-
+

Instances of boost::thread and of the various lock types are now movable. @@ -2024,15 +2129,15 @@

- - Breaking + + Breaking Changes

The list below should cover all changes to the public interface which break backwards compatibility.
-
+

boost::try_mutex has been removed, and the functionality subsumed into boost::mutex. boost::try_mutex is left as a typedef, but is no longer a separate class. @@ -2092,7 +2197,7 @@
-

Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -15 Vicente J. Botet Escriba
+
Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -16 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)
diff --git a/doc/html/thread/compliance.html b/doc/html/thread/compliance.html index 8d0777a053..d9fcf41da4 100644 --- a/doc/html/thread/compliance.html +++ b/doc/html/thread/compliance.html @@ -4,11 +4,11 @@ Conformance and Extension - + - + - + @@ -27,7 +27,7 @@
Conformance and Extension
-
+

C++11 standard Thread library

C++14 standard Thread library - accepted changes
@@ -54,7 +54,7 @@ ]

-
Table 33.2. C++11 standard Conformance
+
Table 35.2. C++11 standard Conformance

@@ -1607,7 +1607,7 @@

-
Table 33.3. Extension
+
Table 35.3. Extension

@@ -1721,7 +1721,7 @@

-
Table 33.4. [@http://isocpp.org/files/papers/N3659.html N3659 Shared locking in +
Table 35.4. [@http://isocpp.org/files/papers/N3659.html N3659 Shared locking in C++ revision 2] Conformance

@@ -1841,7 +1841,7 @@

-
Table 33.5. Improvements to std::future<T> and related APIs]
+
Table 35.5. Improvements to std::future<T> and related APIs]

@@ -2124,7 +2124,7 @@ C++1z TS Concurrency - On going proposals -
+

C++ Latches and Barriers

C++ Concurrent Queues

Executors and Schedulers
@@ -2154,7 +2154,7 @@

-
Table 33.6. C++ Latches and Barriers Conformance
+
Table 35.6. C++ Latches and Barriers Conformance

@@ -2253,7 +2253,7 @@

-
Table 33.7. C++ Concurrent Queues Conformance
+
Table 35.7. C++ Concurrent Queues Conformance

@@ -3100,7 +3100,7 @@

-
Table 33.8. Executors and Schedulers
+
Table 35.8. Executors and Schedulers

@@ -3409,7 +3409,7 @@

-
Table 33.9. `async, future/shared_future::then`and Executors
+
Table 35.9. `async, future/shared_future::then`and Executors

@@ -3514,7 +3514,7 @@

-
Table 33.10. Executors and Schedulers - revision 4
+
Table 35.10. Executors and Schedulers - revision 4

@@ -3877,7 +3877,7 @@

-

Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -15 Vicente J. Botet Escriba
+
Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -16 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)
diff --git a/doc/html/thread/emulations.html b/doc/html/thread/emulations.html index 0f513dbf33..cb83dc430b 100644 --- a/doc/html/thread/emulations.html +++ b/doc/html/thread/emulations.html @@ -4,9 +4,9 @@ Emulations - + - + @@ -27,7 +27,7 @@
Emulations
-
+

=delete emulation

Move semantics

Bool explicit @@ -62,7 +62,7 @@
Move semantics
-
+

Deprecated Version 2 interface

Portable interface
@@ -83,7 +83,7 @@ Deprecated Version 2 interface
-
+

Helpers class and function

Movable @@ -141,7 +141,7 @@ We can write a MovableOny class as follows. You just need to follow these simple steps:
-
+

Add a conversion to the detail::thread_move_t<classname>
@@ -195,7 +195,7 @@
Portable interface
-
+

BOOST_THREAD_NO_COPYABLE(CLASS)

BOOST_THREAD_MOVABLE(CLASS)

BOOST_THREAD_MOVABLE_ONLY(CLASS)
@@ -217,7 +217,7 @@ See the Boost.Move documentation for a complete description on how to declare new Movable classes and its limitations.
-
+

BOOST_THREAD_RV_REF(TYPE) is the equivalent of BOOST_RV_REF(TYPE)
@@ -236,7 +236,7 @@
In addition the following macros are needed to make the code portable:
-
+

BOOST_THREAD_RV(V) macro to access the rvalue from a BOOST_THREAD_RV_REF(TYPE), @@ -256,7 +256,7 @@
Other macros are provided and must be included on the public section:
-
+

BOOST_THREAD_NO_COPYABLE declares a class no-copyable either deleting the copy constructors @@ -452,7 +452,7 @@ Bool explicit conversion
-
+

operator unspecified-bool-type() const

bool operator!() const

@@ -482,7 +482,7 @@

-
+

Returns:

If owns_lock() @@ -503,7 +503,7 @@

-
+

Returns:

! owns_lock(). @@ -554,7 +554,7 @@
There are however some limitations:
-
+

The type is not a C++ enum, so 'is_enum<future_errc>' will be false_type.
@@ -598,7 +598,7 @@
-

Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -15 Vicente J. Botet Escriba
+
Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -16 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)
diff --git a/doc/html/thread/future.html b/doc/html/thread/future.html index a2a1189fa2..924c52c95d 100644 --- a/doc/html/thread/future.html +++ b/doc/html/thread/future.html @@ -4,9 +4,9 @@ Future - + - + @@ -33,14 +33,14 @@

Add some minor features, in particular -
+
#7589 Synchro: Add polymorphic lockables.

Add some features based on C++ proposals, in particular -
+

#8273 Synchro: Add externally locked streams. @@ -53,7 +53,7 @@

And some additional extensions related to futures as: -
+
#8517 Async: Add a variadic shared_future::then.
@@ -62,7 +62,7 @@
-

Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -15 Vicente J. Botet Escriba
+
Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -16 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)
diff --git a/doc/html/thread/parallel.html b/doc/html/thread/parallel.html index 36eccfce2b..8e79354975 100644 --- a/doc/html/thread/parallel.html +++ b/doc/html/thread/parallel.html @@ -4,9 +4,9 @@ Parallel - Fork-Join -- EXPERIMENTAL - + - + @@ -27,7 +27,7 @@
Parallel - Fork-Join -- EXPERIMENTAL
-
+

Fork-Join

Reference -- EXPERIMENTAL

@@ -35,7 +35,7 @@
Fork-Join
-
+

Introduction

Tutorial

Examples
@@ -177,7 +177,7 @@
Examples
-
+

Parallel Fibonacci

Parallel @@ -302,7 +302,7 @@
Reference -- EXPERIMENTAL
-
+

Parallel V1

Parallel V2

@@ -310,7 +310,7 @@
Parallel V1
-
Header <experimental/exception_list.hpp>
+
Header <experimental/exception_list.hpp>

Header <experimental/exception_list.hpp> @@ -372,7 +372,7 @@
Parallel V2
-
+

Concepts

Header <experimental/task_region.hpp>

@@ -604,7 +604,7 @@
-

Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -15 Vicente J. Botet Escriba
+
Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -16 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)
diff --git a/doc/html/thread/sds.html b/doc/html/thread/sds.html index 92762e7058..299a0e670c 100644 --- a/doc/html/thread/sds.html +++ b/doc/html/thread/sds.html @@ -4,9 +4,9 @@ Synchronized Data Structures - + - + @@ -27,7 +27,7 @@
Synchronized Data Structures
-
+

Synchronized Values - EXPERIMENTAL

Synchronized Queues -- @@ -38,7 +38,7 @@ Synchronized Values - EXPERIMENTAL
-
+

Tutorial

Reference
@@ -58,7 +58,7 @@
Tutorial
-
+

The Problem with Mutexes

Beyond @@ -259,7 +259,7 @@ Reference
-
+

Class synchronized_value

Non-Member @@ -382,7 +382,7 @@

-
+

Requires:

Lockable is Lockable. @@ -397,7 +397,7 @@

-
+

Requires:

T is DefaultConstructible. @@ -421,7 +421,7 @@

-
+

Requires:

T is CopyConstructible. @@ -445,7 +445,7 @@

-
+

Requires:

T is DefaultConstructible and Assignable. @@ -470,7 +470,7 @@

-
+

Requires:

T is MoveConstructible . @@ -494,7 +494,7 @@

-
+

Requires:

T is MoveConstructible . @@ -518,7 +518,7 @@

-
+

Requires:

T is Assignable. @@ -553,7 +553,7 @@

-
+

Requires:

T is Assignable. @@ -583,7 +583,7 @@

-
+

Requires:

T is CopyConstructible. @@ -617,7 +617,7 @@

-
+

Requires:

T is CopyConstructible. @@ -649,7 +649,7 @@

-
+

Requires:

T is Assignable. @@ -674,7 +674,7 @@

-
+

Requires:

T is Swapable. @@ -703,7 +703,7 @@

-
+

Return:

A strict_lock_ptr<>. @@ -732,7 +732,7 @@

-
+

Return:

A const_strict_lock_ptr @@ -769,7 +769,7 @@
-
+

Return:

A strict_lock_ptr @@ -791,7 +791,7 @@
- + Return: A const_strict_lock_ptr @@ -812,7 +812,7 @@ - + Return: A an @@ -846,7 +846,7 @@ - + Return: A an @@ -895,7 +895,7 @@ Synchronized Queues -- EXPERIMENTAL
-+ Introduction Tutorial Examples @@ -964,7 +964,7 @@ Reference - + Synchronized Queue Model Queue @@ -1053,7 +1053,7 @@ - + Throws: Any exception thrown by the internal locking. @@ -1071,7 +1071,7 @@ - + Throws: Any exception due to allocation errors. @@ -1098,7 +1098,7 @@ BasicConcurrentQueue requirements if the following expressions are well-formed and have the specified semantics - + Q::value_type @@ -1130,7 +1130,7 @@ where - + q denotes a value of type Q, @@ -1162,7 +1162,7 @@ - + Effects: Waits until the queue is not full (for bounded queues) and @@ -1201,7 +1201,7 @@ - + Effects: Waits until the queue is not full (for bounded queues) and @@ -1240,7 +1240,7 @@ - + Effects: Waits until the queue is not empty and then pull_front the @@ -1278,7 +1278,7 @@ - + Requires: Q::value_type is no throw move constructible. This is needed @@ -1334,7 +1334,7 @@ and the following expressions are well-formed and have the specified semantics - + s = q.try_push_back(e); @@ -1351,7 +1351,7 @@ where - + q denotes a value of type Q, @@ -1383,7 +1383,7 @@ - + Effects: If the queue q @@ -1435,7 +1435,7 @@ - + Effects: If the queue q @@ -1486,7 +1486,7 @@
- + Effects: If the queue is not empty pulls the element from the queue @@ -1543,7 +1543,7 @@ Non-blocking operations are provided only for lock based queues - + s = q.nonblocking_push_back(nb, @@ -1563,7 +1563,7 @@ where - + q denotes a value of type Q, @@ -1591,7 +1591,7 @@ - + Effects: If the queue q @@ -1646,7 +1646,7 @@ - + Effects: If the queue q @@ -1700,7 +1700,7 @@
- + Effects: If the queue is not empty pulls the element from the queue @@ -1754,7 +1754,7 @@ Bounded queues add the following valid expressions - + Q q(u); @@ -1770,7 +1770,7 @@ where - + q denotes a value of type Q, @@ -1790,7 +1790,7 @@ - + Return type: bool. @@ -1814,7 +1814,7 @@ - + Return type: Q::size_type. @@ -1835,7 +1835,7 @@ Closed queues add the following valid expressions - + q.close(); @@ -1862,7 +1862,7 @@ - + Effects: Close the queue. @@ -1876,7 +1876,7 @@
- + Return type: bool. @@ -1895,7 +1895,7 @@
- + Effects: Waits until the queue is not full (for bounded queues) and @@ -1943,7 +1943,7 @@
- + Effects: Waits until the queue is not full (for bounded queues) and @@ -1994,7 +1994,7 @@
- + Effects: if the queue is not empty and not closed, waits until the queue @@ -2199,22 +2199,14 @@ void push(const value_type& x); void push(BOOST_THREAD_RV_REF(value_type) x); - void pull(value_type& x); - value_type pull(); - queue_op_status try_push(const value_type& x); queue_op_status try_push(BOOST_THREAD_RV_REF(value_type) x); - queue_op_status try_pull(value_type& x); - queue_op_status nonblocking_push(const value_type& x); queue_op_status nonblocking_push(BOOST_THREAD_RV_REF(value_type) x); - queue_op_status nonblocking_pull(value_type& x); - queue_op_status wait_push(const value_type& x); queue_op_status wait_push(BOOST_THREAD_RV_REF(value_type) x); - queue_op_status wait_pull_front(value_type& x); }; @@ -2243,24 +2235,13 @@ // Modifiers void close(); - void push(const value_type& x); - void push(BOOST_THREAD_RV_REF(value_type) x); - void pull(value_type& x); value_type pull(); - queue_op_status try_push(const value_type& x); - queue_op_status try_push(BOOST_THREAD_RV_REF(value_type) x); - queue_op_status try_pull(value_type& x); - queue_op_status nonblocking_push(const value_type& x); - queue_op_status nonblocking_push(BOOST_THREAD_RV_REF(value_type) x); - queue_op_status nonblocking_pull(value_type& x); - queue_op_status wait_push(const value_type& x); - queue_op_status wait_push(BOOST_THREAD_RV_REF(value_type) x); queue_op_status wait_pull(value_type& x); }; @@ -2362,7 +2343,7 @@ - + Effects: Constructs a sync_bounded_queue with a maximum number of elements @@ -2385,7 +2366,7 @@ - + Effects: Constructs a sync_bounded_queue with a maximum number of elements @@ -2510,7 +2491,7 @@ - + Effects: Constructs an empty sync_queue. @@ -2531,7 +2512,7 @@ - + Returns: false. @@ -2548,7 +2529,7 @@ - + Returns: Moves internal queue. @@ -2591,7 +2572,7 @@ - Copyright © 2007 -11 Anthony Williams Copyright © 2011 -15 Vicente J. Botet Escriba + Copyright © 2007 -11 Anthony Williams Copyright © 2011 -16 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) diff --git a/doc/html/thread/synchronization.html b/doc/html/thread/synchronization.html index 7215e50e33..f6db23708b 100644 --- a/doc/html/thread/synchronization.html +++ b/doc/html/thread/synchronization.html @@ -4,9 +4,9 @@ Synchronization - + - + @@ -27,7 +27,7 @@ Synchronization - + Tutorial Mutex Concepts Lock Options @@ -53,7 +53,7 @@ Tutorial - + Internal Locking External @@ -81,7 +81,7 @@ Internal Locking - + Concurrent threads of execution Internal @@ -305,7 +305,7 @@ Notice that the code above doesn't compile, the mtx_ field is private. We have two possibilities: - + make mtx_ public which seems odd @@ -378,7 +378,7 @@ Notice that now acct is being locked by Withdraw after it has already been locked by guard. When running such code, one of two things happens. - + Your mutex implementation might support the so-called recursive mutex semantics. This means that the same thread can lock the same mutex @@ -447,7 +447,7 @@ Locking -- strict_lock and externally_locked classes - + Locks as permits Improving @@ -473,7 +473,7 @@ So what to do? Ideally, the BankAccount class should do the following: - + Support both locking models (internal and external). @@ -548,14 +548,14 @@ as what you can do. Let's see what you can and what you cannot do with a strict_lock instantiation: - + You can create a strict_lock<T> only starting from a valid T object. Notice that there is no other way you can create a strict_lock<T>. BankAccount myAccount("John Doe", "123-45-6789"); strict_lock<BankAccount> myLock(myAccount); // ok - + You cannot copy strict_locks to one another. In particular, you cannot pass strict_locks by value to functions or have them returned by functions: @@ -563,7 +563,7 @@ extern strict_lock<BankAccount> Foo(); // compile-time error extern void Bar(strict_lock<BankAccount>); // compile-time error - + However, you still can pass strict_locks by reference to and from functions: @@ -590,7 +590,7 @@ how do we harness its power in defining a safe, flexible interface for BankAccount? The idea is as follows: - + Each of BankAccount's interface functions (in our case, Deposit and Withdraw) comes in two overloaded variants. @@ -1118,7 +1118,7 @@ Mutex Concepts - + BasicLockable Concept Lockable Concept Recursive @@ -1146,7 +1146,7 @@ BasicLockable Concept - + m.lock(); m.unlock(); is_basic_lockable trait -- EXTENSION @@ -1168,7 +1168,7 @@ (m denotes a value of type L): - + m.lock(); @@ -1186,7 +1186,7 @@ - + Requires: The calling thread doesn't owns the mutex if the mutex is not recursive. @@ -1243,7 +1243,7 @@ - + Requires: The current thread owns m. @@ -1307,7 +1307,7 @@ Lockable Concept - + m.try_lock() is_lockable trait -- EXTENSION @@ -1325,7 +1325,7 @@ (m denotes a value of type L): - + m.try_lock() @@ -1338,7 +1338,7 @@ - + Requires: The calling thread doesn't owns the mutex if the mutex is not recursive. @@ -1419,7 +1419,7 @@ Recursive Lockable Concept - + is_recursive_mutex_sur_parole trait -- EXTENSION is_recursive_basic_lockable trait -- @@ -1504,7 +1504,7 @@ TimedLockable Concept - + m.try_lock_until(abs_time) m.try_lock_for(rel_time) m.timed_lock(abs_time) @@ -1531,7 +1531,7 @@ Variables: - + m denotes a value of type L, @@ -1549,7 +1549,7 @@ Expressions: - + m.try_lock_for(rel_time) @@ -1567,7 +1567,7 @@ - + Requires: The calling thread doesn't owns the mutex if the mutex is not recursive. @@ -1611,7 +1611,7 @@ - + Requires: The calling thread doesn't owns the mutex if the mutex is not recursive. @@ -1646,7 +1646,7 @@ Variables: - + rel_time denotes a value of an instantiation of an unspecified DurationType @@ -1661,7 +1661,7 @@ Expressions: - + m.timed_lock(rel_time) @@ -1679,7 +1679,7 @@ - + Effects: Attempt to obtain ownership for the current thread. Blocks until @@ -1711,7 +1711,7 @@ - + Effects: As-if timed_lock(boost::get_system_time()+rel_time). @@ -1724,7 +1724,7 @@ SharedLockable Concept -- C++14 - + m.lock_shared() m.try_lock_shared() m.try_lock_shared_for(rel_time) @@ -1757,7 +1757,7 @@ Variables: - + m denotes a value of type L, @@ -1775,7 +1775,7 @@ Expressions: - + m.lock_shared()(); @@ -1804,7 +1804,7 @@ - + Effects: The current thread blocks until shared ownership can be obtained @@ -1828,7 +1828,7 @@ - + Effects: Attempt to obtain shared ownership for the current thread without @@ -1859,7 +1859,7 @@ - + Effects: Attempt to obtain shared ownership for the current thread. Blocks @@ -1892,7 +1892,7 @@ - + Effects: Attempt to obtain shared ownership for the current thread. Blocks @@ -1925,7 +1925,7 @@ - + Precondition: The current thread has shared ownership of m. @@ -1964,14 +1964,14 @@ Variables: - + abs_time denotes a value of an instantiation of boost::system_time: Expressions: - + m.timed_lock_shared(abs_time); @@ -1984,7 +1984,7 @@ - + Effects: Attempt to obtain shared ownership for the current thread. Blocks @@ -2016,7 +2016,7 @@ UpgradeLockable Concept -- EXTENSION - + m.lock_upgrade() m.unlock_upgrade() m.try_lock_upgrade() @@ -2080,7 +2080,7 @@ Variables: - + m denotes a value of type L, @@ -2098,7 +2098,7 @@ Expressions: - + m.lock_upgrade(); @@ -2140,7 +2140,7 @@ If `BOOST_THREAD_PROVIDES_SHARED_MUTEX_UPWARDS_CONVERSION is defined the following expressions are also required: - + m.try_unlock_shared_and_lock(); @@ -2173,7 +2173,7 @@ - + Precondition: The calling thread has no ownership of the mutex. @@ -2206,7 +2206,7 @@ - + Precondition: The current thread has upgrade ownership of m. @@ -2238,7 +2238,7 @@ - + Precondition: The calling thread has no ownership of the mutex. @@ -2278,7 +2278,7 @@ - + Precondition: The calling thread has no ownership of the mutex. @@ -2330,7 +2330,7 @@ - + Precondition: The calling thread has no ownership of the mutex. @@ -2378,7 +2378,7 @@ - + Precondition: The calling thread must hold a shared lock on the mutex. @@ -2427,7 +2427,7 @@ - + Precondition: The calling thread shall hold a shared lock on the mutex. @@ -2485,7 +2485,7 @@ - + Precondition: The calling thread shall hold a shared lock on the mutex. @@ -2541,7 +2541,7 @@ - + Precondition: The calling thread shall hold an exclusive lock on m. @@ -2573,7 +2573,7 @@ - + Precondition: The calling thread shall hold a shared lock on the mutex. @@ -2621,7 +2621,7 @@ - + Precondition: The calling thread shall hold a shared lock on the mutex. @@ -2679,7 +2679,7 @@ - + Precondition: The calling thread shall hold a shared lock on the mutex. @@ -2734,7 +2734,7 @@ - + Precondition: The current thread has exclusive ownership of m. @@ -2766,7 +2766,7 @@ - + Precondition: The current thread has upgrade ownership of m. @@ -2799,7 +2799,7 @@ - + Precondition: The calling thread shall hold an upgrade lock on the mutex. @@ -2847,7 +2847,7 @@ - + Precondition: The calling thread shall hold an upgrade lock on the mutex. @@ -2905,7 +2905,7 @@ - + Precondition: The calling thread shall hold an upgrade lock on the mutex. @@ -2960,7 +2960,7 @@ - + Precondition: The current thread has upgrade ownership of m. @@ -2992,7 +2992,7 @@ Lock Options -Lock +Lock option tags // #include <boost/thread/locks.hpp> // #include <boost/thread/locks_options.hpp> @@ -3025,7 +3025,7 @@ These tags are used in scoped locks constructors to specify a specific behavior. - + defer_lock_t: is used to construct the scoped lock without locking it. @@ -3045,7 +3045,7 @@ Lock Guard - + Class template lock_guard Non @@ -3074,7 +3074,7 @@ Class template lock_guard - + lock_guard(Lockable & m) lock_guard(Lockable & @@ -3111,7 +3111,7 @@ - + Effects: Stores a reference to m. @@ -3131,7 +3131,7 @@ - + Precondition: The current thread owns a lock on m @@ -3155,7 +3155,7 @@ - + Effects: Invokes m.unlock() @@ -3180,7 +3180,7 @@ - + Returns: a lock_guard as if initialized with {m}. @@ -3202,7 +3202,7 @@ - + Returns: a lock_guard as if initialized with {m, adopt_lock}. @@ -3219,7 +3219,7 @@ With Lock Guard -Non +Non Member Function with_lock_guard // #include <boost/thread/with_lock_guard.hpp> @@ -3243,7 +3243,7 @@ - + Precondition: m must be in unlocked @@ -3291,14 +3291,14 @@ Lock Concepts -StrictLock +StrictLock -- EXTENSION StrictLock -- EXTENSION - + L::mutex_type is_strict_lock_sur_parole<L> cl.owns_lock(m); @@ -3322,7 +3322,7 @@ requirements if the following expressions are well-formed and have the specified semantics - + L::mutex_type @@ -3339,7 +3339,7 @@ where - + cl denotes a value of type L const&, @@ -3377,7 +3377,7 @@ - + Return Type: bool @@ -3400,7 +3400,7 @@ The following classes are models of StrictLock: - + strict_lock: ensured by construction, @@ -3422,7 +3422,7 @@ Lock Types - + Class template unique_lock Class template @@ -3463,7 +3463,7 @@ Class template unique_lock - + unique_lock() unique_lock(Lockable & m) @@ -3605,7 +3605,7 @@ - + Effects: Creates a lock object with no associated mutex. @@ -3630,7 +3630,7 @@ - + Effects: Stores a reference to m. @@ -3656,7 +3656,7 @@ - + Precondition: The current thread owns an exclusive lock on m. @@ -3686,7 +3686,7 @@ - + Effects: Stores a reference to m. @@ -3711,7 +3711,7 @@ - + Effects: Stores a reference to m. @@ -3744,7 +3744,7 @@ - + Requires: The supplied Mutex @@ -3795,7 +3795,7 @@ - + Requires: The supplied Mutex @@ -3846,7 +3846,7 @@ - + Requires: The supplied Mutex @@ -3897,7 +3897,7 @@ - + Effects: Stores a reference to m. @@ -3930,7 +3930,7 @@ - + Effects: Stores a reference to m. @@ -3962,7 +3962,7 @@ - + Effects: Stores a reference to m. @@ -3992,7 +3992,7 @@ - + Effects: Invokes mutex()-> unlock() @@ -4012,7 +4012,7 @@ - + Returns: true if the *this @@ -4032,7 +4032,7 @@ - + Returns: A pointer to the Lockable object associated @@ -4055,7 +4055,7 @@ - + Returns: owns_lock()(). @@ -4073,7 +4073,7 @@ - + Effects: The association between *this and the Lockable object is removed, @@ -4111,7 +4111,7 @@ Class template shared_lock - C++14 - + shared_lock() shared_lock(Lockable & m) @@ -4225,7 +4225,7 @@ - + Effects: Creates a lock object with no associated mutex. @@ -4250,7 +4250,7 @@ - + Effects: Stores a reference to m. @@ -4276,7 +4276,7 @@ - + Precondition: The current thread owns an exclusive lock on m. @@ -4306,7 +4306,7 @@ - + Effects: Stores a reference to m. @@ -4331,7 +4331,7 @@ - + Effects: Stores a reference to m. @@ -4363,7 +4363,7 @@ - + Effects: Stores a reference to m. @@ -4394,7 +4394,7 @@ - + Effects: Invokes mutex()-> unlock_shared() @@ -4414,7 +4414,7 @@ - + Returns: true if the *this @@ -4434,7 +4434,7 @@ - + Returns: A pointer to the Lockable object associated @@ -4457,7 +4457,7 @@ - + Returns: owns_lock(). @@ -4475,7 +4475,7 @@ - + Effects: The association between *this and the Lockable object is removed, @@ -4700,7 +4700,7 @@ Other Lock Types - EXTENSION - + Strict Locks Locking @@ -4717,7 +4717,7 @@ Strict Locks - + Class template strict_lock Class @@ -4787,8 +4787,8 @@ - See - also boost::lock_guard + See + also boost::lock_guard @@ -4797,7 +4797,7 @@ - + Effects: Stores a reference to m. @@ -4816,7 +4816,7 @@ - + Effects: Invokes m.unlock() @@ -4864,8 +4864,8 @@ - See - also strict_lock, boost::unique_lock + See + also strict_lock, boost::unique_lock @@ -4874,7 +4874,7 @@ - + Requires: lk.mutex() @@ -4909,7 +4909,7 @@ - + Effects: Restores ownership to the nesting lock. @@ -4926,7 +4926,7 @@ - + Return: Whether if this lock is locking that mutex. @@ -4945,7 +4945,7 @@ - + Returns: a strict_lock as if initialized with {m}. @@ -4967,7 +4967,7 @@ - + Returns: a nested_strict_lock as if initialized with {lk}. @@ -4985,7 +4985,7 @@ Locking pointers - + Class template const_strict_lock_ptr @@ -5042,7 +5042,7 @@ - + Effects: Invokes m.lock(), @@ -5063,7 +5063,7 @@ - + Effects: Stores a reference to it and to the value type val. @@ -5083,7 +5083,7 @@ - + Effects: Invokes m.unlock() @@ -5106,7 +5106,7 @@ - + Return: return a constant pointer to the protected value. @@ -5127,7 +5127,7 @@ - + Return: return a constant reference to the protected value. @@ -5172,7 +5172,7 @@ - + Effects: Invokes m.lock(), @@ -5193,7 +5193,7 @@ - + Effects: Stores a reference to it and to the value type val. @@ -5213,7 +5213,7 @@ - + Effects: Invokes m.unlock() @@ -5235,7 +5235,7 @@ - + Return: return a pointer to the protected value. @@ -5255,7 +5255,7 @@ - + Return: return a reference to the protected value. @@ -5274,7 +5274,7 @@ Externally Locked - + Template Class externally_locked Template @@ -5357,7 +5357,7 @@ - + Requires: T is a model of CopyConstructible. @@ -5382,7 +5382,7 @@ - + Requires: T is a model of Movable. @@ -5407,7 +5407,7 @@ - + Requires: T is a model of DefaultConstructible. @@ -5432,7 +5432,7 @@ - + Requires: T is a model of Movable. @@ -5457,7 +5457,7 @@ - + Requires: T is a model of Copyable. @@ -5482,7 +5482,7 @@ - + Requires: T is a model of Movable. @@ -5507,7 +5507,7 @@ - + Requires: T is a model of Copyable. @@ -5533,7 +5533,7 @@ - + Requires: The lk parameter @@ -5563,7 +5563,7 @@ - + Requires: is_same<mutex_type, @@ -5594,7 +5594,7 @@ - + Requires: Lock is a model @@ -5681,7 +5681,7 @@ - + Effects: Constructs an externally locked object copying the cloaked reference. @@ -5697,7 +5697,7 @@ - + Effects: Moves an externally locked object by moving the cloaked type @@ -5714,7 +5714,7 @@ - + Effects: Move assigns an externally locked object by copying the cloaked @@ -5731,7 +5731,7 @@ - + Requires: T is a model of Copyable. @@ -5757,7 +5757,7 @@ - + Requires: The lk parameter @@ -5787,7 +5787,7 @@ - + Requires: is_same<mutex_type, @@ -5818,7 +5818,7 @@ - + Requires: Lock is a model @@ -5855,7 +5855,7 @@ Class template shared_lock_guard - + shared_lock_guard(SharedLockable & m) shared_lock_guard(SharedLockable & @@ -5895,7 +5895,7 @@ - + Effects: Stores a reference to m. @@ -5915,7 +5915,7 @@ - + Precondition: The current thread owns a lock on m @@ -5939,7 +5939,7 @@ - + Effects: Invokes m.unlock_shared()() on the SharedLockable object @@ -5958,7 +5958,7 @@ Class template reverse_lock - + reverse_lock(Lock & m) ~reverse_lock() @@ -5996,7 +5996,7 @@ - + Effects: Stores a reference to m. @@ -6022,7 +6022,7 @@ - + Effects: Let be mtx the stored mutex*. If not 0 Invokes mtx->lock() @@ -6050,7 +6050,7 @@ Lock functions - + Non-member function lock(Lockable1,Lockable2,...) Non-member @@ -6088,7 +6088,7 @@ - + Effects: Locks the Lockable objects supplied @@ -6126,7 +6126,7 @@ - + Preconditions: The value_type of @@ -6178,7 +6178,7 @@ - + Effects: @@ -6228,7 +6228,7 @@ - + Preconditions: The value_type of @@ -6280,7 +6280,7 @@ Lock Factories - EXTENSION - + Non Member Function make_unique_lock(Lockable&) Non @@ -6317,7 +6317,7 @@ - + Returns: a boost::unique_lock as if initialized @@ -6346,7 +6346,7 @@ - + Returns: a boost::unique_lock as if initialized @@ -6370,7 +6370,7 @@ - + Effect: Locks all the mutexes. @@ -6392,7 +6392,7 @@ Mutex Types - + Class mutex Typedef try_mutex @@ -6415,7 +6415,7 @@ Class mutex -Member +Member function native_handle() #include <boost/thread/mutex.hpp> @@ -6456,7 +6456,7 @@ - + Effects: Returns an instance of native_handle_type @@ -6493,7 +6493,7 @@ Class timed_mutex -Member +Member function native_handle() #include <boost/thread/mutex.hpp> @@ -6549,7 +6549,7 @@ - + Effects: Returns an instance of native_handle_type @@ -6571,7 +6571,7 @@ Class recursive_mutex -Member +Member function native_handle() #include <boost/thread/recursive_mutex.hpp> @@ -6619,7 +6619,7 @@ - + Effects: Returns an instance of native_handle_type @@ -6655,7 +6655,7 @@ Class recursive_timed_mutex -Member +Member function native_handle() #include <boost/thread/recursive_mutex.hpp> @@ -6721,7 +6721,7 @@ - + Effects: Returns an instance of native_handle_type @@ -6996,7 +6996,7 @@ Condition Variables - + Class condition_variable Class @@ -7008,7 +7008,7 @@ - Synopsis + Synopsis namespace boost { @@ -7103,7 +7103,7 @@ Class condition_variable - + condition_variable() ~condition_variable() void notify_one() @@ -7203,7 +7203,7 @@ - + Effects: Constructs an object of class condition_variable. @@ -7222,7 +7222,7 @@ - + Precondition: All threads waiting on *this have been notified by a call @@ -7249,7 +7249,7 @@ - + Effects: If any threads are currently blocked waiting @@ -7271,7 +7271,7 @@ - + Effects: If any threads are currently blocked waiting @@ -7293,7 +7293,7 @@ - + Precondition: lock is locked @@ -7340,7 +7340,7 @@ - + Effects: @@ -7365,7 +7365,7 @@ - + Precondition: lock is locked @@ -7420,7 +7420,7 @@ - + Precondition: lock is locked @@ -7485,7 +7485,7 @@ - + Effects: @@ -7514,7 +7514,7 @@ - + Precondition: lock is locked @@ -7570,7 +7570,7 @@ - + Precondition: lock is locked @@ -7638,7 +7638,7 @@ - + Effects: @@ -7668,7 +7668,7 @@ - + Effects: @@ -7688,7 +7688,7 @@ Class condition_variable_any - + condition_variable_any() ~condition_variable_any() void notify_one() @@ -7791,7 +7791,7 @@ - + Effects: Constructs an object of class condition_variable_any. @@ -7810,7 +7810,7 @@ - + Precondition: All threads waiting on *this have been notified by a call @@ -7837,7 +7837,7 @@ - + Effects: If any threads are currently blocked waiting @@ -7859,7 +7859,7 @@ - + Effects: If any threads are currently blocked waiting @@ -7882,7 +7882,7 @@ - + Effects: Atomically call lock.unlock() and blocks the current thread. @@ -7917,7 +7917,7 @@ - + Effects: @@ -7941,7 +7941,7 @@ - + Effects: Atomically call lock.unlock() and blocks the current thread. @@ -7986,7 +7986,7 @@ - + Effects: Atomically call lock.unlock() and blocks the current thread. @@ -8040,7 +8040,7 @@ - + Effects: @@ -8070,7 +8070,7 @@ - + Effects: Atomically call lock.unlock() and blocks the current thread. @@ -8115,7 +8115,7 @@ - + Effects: Atomically call lock.unlock() and blocks the current thread. @@ -8170,7 +8170,7 @@ - + Effects: @@ -8200,7 +8200,7 @@ - + Effects: @@ -8247,7 +8247,7 @@ - + Requires: lk is locked by the @@ -8281,7 +8281,7 @@ One-time Initialization - + Typedef once_flag Non-member function call_once @@ -8360,7 +8360,7 @@ - + Requires: Function and each @@ -8433,7 +8433,7 @@ Barriers -- EXTENSION -Class barrier +Class barrier A barrier is a simple concept. Also known as a rendezvous, it is a synchronization point between multiple threads. The barrier is configured @@ -8447,7 +8447,7 @@ Class barrier - + Constructor barrier(unsigned int) Constructor @@ -8489,7 +8489,7 @@ - + Effects: Construct a barrier for count @@ -8512,7 +8512,7 @@ - + Requires: The result type of the completion function call completion() is void @@ -8540,7 +8540,7 @@ - + Precondition: No threads are waiting on *this. @@ -8565,7 +8565,7 @@ - + Effects: Block until count @@ -8617,7 +8617,7 @@ - + Effects: Block until count @@ -8660,7 +8660,7 @@ Latches -- EXPERIMENTAL - + Introdcution Examples Class latch @@ -8681,7 +8681,7 @@ Sample use cases for the latch include: - + Setting multiple threads to perform a task, and then waiting until all threads have reached a common point. @@ -8736,7 +8736,7 @@ Class latch - + Constructor latch(std::size_t) Destructor @@ -8796,7 +8796,7 @@ - + Effects: Construct a latch with is initial value for the internal counter. @@ -8821,7 +8821,7 @@ - + Precondition: No threads are waiting or invoking count_down on *this. @@ -8847,7 +8847,7 @@ - + Effects: Block the calling thread until the internal count reaches the value @@ -8883,7 +8883,7 @@ - + Returns: Returns true if the internal count is 0, and false otherwise. Does @@ -8908,7 +8908,7 @@ - + Effects: Block the calling thread until the internal count reaches the value @@ -8951,7 +8951,7 @@ - + Effects: Block the calling thread until the internal count reaches the value @@ -8993,7 +8993,7 @@ - + Requires: The internal counter is non zero. @@ -9033,7 +9033,7 @@ - + Requires: The internal counter is non zero. @@ -9077,7 +9077,7 @@ - + Requires: This function may only be invoked when there are no other threads @@ -9105,7 +9105,7 @@ Executors and Schedulers -- EXPERIMENTAL - + Introduction Examples Design @@ -9266,7 +9266,7 @@ Examples -Parallel +Parallel Quick Sort @@ -9350,7 +9350,7 @@ to it, usually asynchronously. There could be multiple models of the Executor class. Some specific design notes: - + Thread pools are well know models of the Executor concept, and this library does indeed include a basic_thread_pool class, but other implementations @@ -9394,7 +9394,7 @@ - Closure + Closure One important question is just what a closure is. This library has a very @@ -9442,7 +9442,7 @@ - Scheduled + Scheduled work @@ -9469,7 +9469,7 @@ This has several advantages: - + The scheduled operations are available for all the executors via wrappers. @@ -9487,7 +9487,7 @@ - Not + Not Handled Exceptions @@ -9500,7 +9500,7 @@ - At + At thread entry @@ -9517,7 +9517,7 @@ - Cancelation + Cancelation The library does not provision yet for the ability to cancel/interrupt @@ -9537,7 +9537,7 @@ - Current + Current executor @@ -9563,7 +9563,7 @@ - Default + Default executor @@ -9586,7 +9586,7 @@ Reference - + Concept Closure Concept @@ -9644,7 +9644,7 @@ A type E meets the Executor requirements if the following expressions are well-formed and have the specified semantics - + e.submit(lc); @@ -9668,7 +9668,7 @@ where - + e denotes a value of type E, @@ -9692,7 +9692,7 @@ - + Effects: The specified closure will be scheduled for execution at some @@ -9726,7 +9726,7 @@ - + Effects: The specified closure will be scheduled for execution at some @@ -9760,7 +9760,7 @@ - + Effects: close the executor e @@ -9793,7 +9793,7 @@ - + Return type: bool. @@ -9816,7 +9816,7 @@ - + Effects: try to execute one work. @@ -9847,7 +9847,7 @@ - + Requires: This must be called from a scheduled work @@ -9885,7 +9885,7 @@ - + Requires: work is a model of 'Closure' @@ -9937,7 +9937,7 @@ - + Effects: Constructs an executor. @@ -9958,7 +9958,7 @@ - + Effects: Destroys the executor. @@ -10019,7 +10019,7 @@ - + Effects: Constructs an executor_adaptor. @@ -10040,7 +10040,7 @@ - + Effects: Destroys the executor_adaptor. @@ -10062,7 +10062,7 @@ - + Return: The underlying executor instance. @@ -10157,7 +10157,7 @@ - + Effects: Constructs a scheduler. @@ -10178,7 +10178,7 @@ - + Effects: Destroys the scheduler. @@ -10201,7 +10201,7 @@ - + Effects: Schedule a closure @@ -10224,7 +10224,7 @@ - + Effects: Schedule a closure @@ -10289,7 +10289,7 @@ - + Effects: Constructs a at_executor. @@ -10310,7 +10310,7 @@ - + Effects: Destroys the at_executor. @@ -10332,7 +10332,7 @@ - + Return: The underlying scheduler instance. @@ -10350,7 +10350,7 @@ - + Effects: Schedule the closure @@ -10374,7 +10374,7 @@ - + Effects: Schedule a closure @@ -10397,7 +10397,7 @@ - + Effects: Schedule a closure @@ -10465,7 +10465,7 @@ - + Effects: Constructs a scheduler_executor_wrapper. @@ -10486,7 +10486,7 @@ - + Effects: Destroys the scheduler_executor_wrapper. @@ -10508,7 +10508,7 @@ - + Return: The underlying scheduler instance. @@ -10525,7 +10525,7 @@ - + Return: The underlying executor instance. @@ -10543,7 +10543,7 @@ - + Effects: Submit the closure @@ -10566,7 +10566,7 @@ - + Effects: Resubmit the closure @@ -10589,7 +10589,7 @@ - + Effects: Resubmit the closure @@ -10659,7 +10659,7 @@ - + Effects: Constructs a resubmit_at_executor. @@ -10680,7 +10680,7 @@ - + Effects: Destroys the executor_adaptor. @@ -10702,7 +10702,7 @@ - + Return: The underlying executor instance. @@ -10719,7 +10719,7 @@ - + Return: The underlying scheduler instance. @@ -10737,7 +10737,7 @@ - + Effects: Resubmit the closure @@ -10761,7 +10761,7 @@ - + Effects: Resubmit the closure @@ -10784,7 +10784,7 @@ - + Effects: Resubmit the closure @@ -10844,7 +10844,7 @@ - + Effects: Constructs a serial_executor. @@ -10865,7 +10865,7 @@ - + Effects: Destroys the serial_executor. @@ -10887,7 +10887,7 @@ - + Return: The underlying executor instance. @@ -10945,7 +10945,7 @@ - + Effects: Constructs a serial_executor. @@ -10966,7 +10966,7 @@ - + Effects: Destroys the serial_executor. @@ -10988,7 +10988,7 @@ - + Return: The underlying executor instance. @@ -11038,7 +11038,7 @@ - + Effects: Constructs an inline_executor. @@ -11059,7 +11059,7 @@ - + Effects: Destroys the inline_executor. @@ -11116,7 +11116,7 @@ - + Effects: creates a thread pool that runs closures on thread_count @@ -11138,7 +11138,7 @@ - + Effects: Destroys the thread pool. @@ -11190,7 +11190,7 @@ - + Effects: creates a thread_executor. @@ -11211,7 +11211,7 @@ - + Effects: Waits for closures (if any) to complete, then joins and destroys @@ -11270,7 +11270,7 @@ - + Effects: creates an executor that runs closures using one of its closure-executing @@ -11292,7 +11292,7 @@ - + Effects: Destroys the executor. @@ -11314,7 +11314,7 @@ - + Return: reschedule works until closed() or empty. @@ -11336,7 +11336,7 @@ - + Return: reschedule the enqueued works. @@ -11356,7 +11356,7 @@ Futures - + Overview Creating asynchronous values @@ -11646,7 +11646,7 @@ - Multiple get + Multiple get The second get() @@ -11684,7 +11684,7 @@ - share() + share() Naming the return type when declaring the shared_future @@ -11707,7 +11707,7 @@ - Writing + Writing on get() @@ -11761,7 +11761,7 @@ - make_ready_future + make_ready_future This function creates a future for a given value. If no value is given @@ -11839,7 +11839,7 @@ Some points to note are: - + Each continuation will not begin until the preceding has completed. @@ -11851,7 +11851,7 @@ Input Parameters: - + Lambda function: One option which can be considered is to take two functions, one for success and one for error handling. However this @@ -11887,7 +11887,7 @@ Futures Reference - + Enumeration state Enumeration @@ -11930,8 +11930,8 @@ - EXTENSION Non-member function make_ready_future() EXTENSION -Non-member - function make_exceptional() EXTENSION +Non-member + function make_exceptional_future() EXTENSION Non-member function make_future() DEPRECATED @@ -12055,10 +12055,10 @@ future<typename decay<T>::type> make_ready_future(T&& value); // EXTENSION future<void> make_ready_future(); // EXTENSION - exceptional_ptr make_exceptional(exception_ptr ex); // EXTENSION + exceptional_ptr make_exceptional_future(exception_ptr ex); // EXTENSION template <typename E> - exceptional_ptr make_exceptional(E ex); // EXTENSION - exceptional_ptr make_exceptional(); // EXTENSION + exceptional_ptr make_exceptional_future(E ex); // EXTENSION + exceptional_ptr make_exceptional_future(); // EXTENSION template <typename T> @@ -12165,7 +12165,7 @@ - + Returns: error_code(static_cast<int>(e), @@ -12186,7 +12186,7 @@ - + Returns: error_condition(static_cast<int>(e), future_category()). @@ -12203,7 +12203,7 @@ - + Returns: A reference to an object of a type derived from class error_category. @@ -12241,7 +12241,7 @@ - + Effects: Constructs a future_error. @@ -12266,7 +12266,7 @@ - + Returns: The value of ec @@ -12311,7 +12311,7 @@ - + Effects: The exception that is passed in to the constructor or the current @@ -12354,7 +12354,7 @@ // move support future( future && other) noexcept; - future( future< future<R>>&& rhs); // EXTENSION + explicit future( future< future<R>>&& rhs); // EXTENSION future& operator=( future && other) noexcept; // factories @@ -12412,7 +12412,7 @@ - + Effects: Constructs an uninitialized future. @@ -12437,7 +12437,7 @@ - + Effects: Destroys *this. @@ -12458,7 +12458,7 @@ - + Effects: Constructs a new future, and transfers @@ -12491,7 +12491,7 @@ Unwrap Move Constructor - EXTENSION - future( future< future<R>>&& other); // EXTENSION +explicit future( future< future<R>>&& other); // EXTENSION @@ -12506,7 +12506,7 @@ - + Requires: @@ -12552,7 +12552,7 @@ - + Effects: Transfers ownership of the shared state associated with other to *this. @@ -12589,7 +12589,7 @@ - + Effects: Swaps ownership of the shared states associated with other and *this. @@ -12624,7 +12624,7 @@ - + Effects: If *this @@ -12701,7 +12701,7 @@ - + Effects: If *this @@ -12756,7 +12756,7 @@ - + Effects: If *this @@ -12820,7 +12820,7 @@

-
+

Effects:

If *this @@ -12894,7 +12894,7 @@

-
+

Effects:

If *this @@ -12953,7 +12953,7 @@

-
+

Effects:

If *this @@ -13024,7 +13024,7 @@

-
+

Effects:

If *this @@ -13093,7 +13093,7 @@

-
+

Returns:

true if *this @@ -13122,7 +13122,7 @@

-
+

Returns:

true if *this @@ -13153,7 +13153,7 @@

-
+

Returns:

true if *this @@ -13182,7 +13182,7 @@

-
+

Returns:

true if *this @@ -13211,7 +13211,7 @@

-
+

Effects:

If *this @@ -13246,7 +13246,7 @@

-
+

Effects:

Determine the state of the shared state associated with *this, @@ -13279,7 +13279,7 @@

-
+

Returns:

shared_future<R>(boost::move(*this)). @@ -13332,7 +13332,7 @@

-
+

Notes:

The three functions differ only by input parameters. The first @@ -13477,7 +13477,7 @@

-
+

Notes:

Removes the outermost future and returns a future with the associated @@ -13580,7 +13580,7 @@

-
+

Effects:

Constructs an uninitialized shared_future. @@ -13608,7 +13608,7 @@

-
+

Effects:

If *this @@ -13659,7 +13659,7 @@

-
+

Effects:

If *this @@ -13708,7 +13708,7 @@

-
+

Effects:

If *this @@ -13767,7 +13767,7 @@

-
+

Effects:

If *this @@ -13826,7 +13826,7 @@

-
+

Effects:

If *this @@ -13897,7 +13897,7 @@

-
+

Effects:

If *this @@ -13966,7 +13966,7 @@

-
+

Returns:

true if *this @@ -13990,7 +13990,7 @@

-
+

Returns:

true if *this @@ -14015,7 +14015,7 @@

-
+

Returns:

true if *this @@ -14039,7 +14039,7 @@

-
+

Returns:

true if *this @@ -14063,7 +14063,7 @@

-
+

Effects:

If *this @@ -14093,7 +14093,7 @@

-
+

Effects:

Determine the state of the shared state associated with *this, @@ -14153,7 +14153,7 @@

-
+

Notes:

The three functions differ only by input parameters. The first @@ -14315,7 +14315,7 @@

-
+

Effects:

Constructs a new boost::promise with no associated @@ -14338,7 +14338,7 @@

-
+

Effects:

Constructs a new boost::promise with no associated @@ -14364,7 +14364,7 @@

-
+

Effects:

Constructs a new boost::promise, and transfers @@ -14394,7 +14394,7 @@

-
+

Effects:

Transfers ownership of the result associated with other to *this, leaving other @@ -14425,7 +14425,7 @@

-
+

Effects:

Destroys *this. @@ -14450,7 +14450,7 @@

-
+

Effects:

If *this @@ -14480,7 +14480,7 @@

-
+

Effects:

@@ -14533,7 +14533,7 @@

-
+

Effects:

@@ -14584,7 +14584,7 @@

-
+

Effects:

Stores the value r in the shared state without making that state @@ -14624,7 +14624,7 @@

-
+

Effects:

Stores the exception pointer p in the shared state without making @@ -14668,7 +14668,7 @@

-
+

Preconditions:

The expression f(t) where t @@ -14758,7 +14758,7 @@

-
+

Preconditions:

f() @@ -14807,7 +14807,7 @@

-
+

Preconditions:

f() @@ -14846,7 +14846,7 @@

-
+

Effects:

Constructs a new boost::packaged_task, and transfers @@ -14876,7 +14876,7 @@

-
+

Effects:

Transfers ownership of the task associated with other to *this, leaving other @@ -14906,7 +14906,7 @@

-
+

Effects:

Destroys *this. @@ -14931,7 +14931,7 @@

-
+

Effects:

Returns a future associated with @@ -14956,7 +14956,7 @@

-
+

Effects:

Invoke the task associated with *this and store the result in the @@ -14993,7 +14993,7 @@

-
+

Effects:

Invoke the task associated with *this and store the result in the @@ -15029,7 +15029,7 @@

-
+

Effects:

Reset the state of the packaged_task so that it can be called @@ -15054,7 +15054,7 @@

-
+

Preconditions:

The expression f(t) where t @@ -15107,7 +15107,7 @@

- Non-Variadic + Non-Variadic variant

template <class F> @@ -15122,7 +15122,7 @@

-
+

Requires:

@@ -15259,7 +15259,7 @@

- Variadic + Variadic variant

template <class F, class... Args> @@ -15286,7 +15286,7 @@

-
+

Requires:

@@ -15445,7 +15445,7 @@

-
+

Preconditions:

The types Fn shall @@ -15504,7 +15504,7 @@

-
+

Preconditions:

The types Fn shall @@ -15543,7 +15543,7 @@

-
+

Requires:

- For the first overload, InputIterator's @@ -15667,7 +15667,7 @@

-
+

Requires:

- For the first overload, InputIterator's @@ -15792,7 +15792,7 @@

-
+

Remark:

where V is determined @@ -15849,17 +15849,17 @@

-Non-member - function make_exceptional() EXTENSION +Non-member + function make_exceptional_future() EXTENSION
-
exceptional_ptr make_exceptional(exception_ptr ex); // EXTENSION +
exceptional_ptr make_exceptional_future(exception_ptr ex); // EXTENSION template <typename E> - exceptional_ptr make_exceptional(E ex); // EXTENSION -exceptional_ptr make_exceptional(); // EXTENSION + exceptional_ptr make_exceptional_future(E ex); // EXTENSION +exceptional_ptr make_exceptional_future(); // EXTENSION

-
+

Effects:

The exception that is passed in to the function or the current @@ -15887,7 +15887,7 @@

-
+

Effects:

The value that is passed into the function is moved to the shared @@ -15930,7 +15930,7 @@

-
+

Effects:

The value that is passed in to the function is moved to the shared @@ -15968,7 +15968,7 @@
-

Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -15 Vicente J. Botet Escriba
+
Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -16 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)
diff --git a/doc/html/thread/thread_local_storage.html b/doc/html/thread/thread_local_storage.html index 90288f5550..a2cd474106 100644 --- a/doc/html/thread/thread_local_storage.html +++ b/doc/html/thread/thread_local_storage.html @@ -4,9 +4,9 @@ Thread Local Storage - + - + @@ -27,11 +27,11 @@
Thread Local Storage
-
Class +
Class thread_specific_ptr

- Synopsis + Synopsis

Thread local storage allows multi-threaded applications to have a separate @@ -54,7 +54,7 @@

- Portable + Portable thread-local storage with boost::thread_specific_ptr

@@ -75,7 +75,7 @@

- Cleanup + Cleanup at thread exit

@@ -101,7 +101,7 @@

- Rationale + Rationale about the nature of the key

@@ -115,7 +115,7 @@ Class thread_specific_ptr
-
+

thread_specific_ptr();

explicit thread_specific_ptr(void (*cleanup_function)(T*));

~thread_specific_ptr();
@@ -153,7 +153,7 @@

-
+

Requires:

delete this->get() is well-formed. @@ -181,7 +181,7 @@

-
+

Requires:

cleanup_function(this->get()) does not throw any exceptions. @@ -208,7 +208,7 @@

-
+

Requires:

All the thread specific instances associated to this thread_specific_ptr @@ -251,7 +251,7 @@

-
+

Returns:

The pointer associated with the current thread. @@ -279,7 +279,7 @@

-
+

Returns:

this->get() @@ -297,7 +297,7 @@

-
+

Requires:

this->get is not NULL. @@ -320,7 +320,7 @@

-
+

Effects:

If this->get()!=new_value and this->get() is non-NULL, @@ -345,7 +345,7 @@

-
+

Effects:

Return this->get() @@ -368,7 +368,7 @@
-

Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -15 Vicente J. Botet Escriba
+
Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -16 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)
diff --git a/doc/html/thread/thread_management.html b/doc/html/thread/thread_management.html index c0260c2687..3dc409f987 100644 --- a/doc/html/thread/thread_management.html +++ b/doc/html/thread/thread_management.html @@ -4,9 +4,9 @@ Thread Management - + - + @@ -27,7 +27,7 @@
Thread Management
-
+

Synopsis

Tutorial

Class thread
@@ -85,7 +85,7 @@
Tutorial
-
+

Launching threads

Thread @@ -401,10 +401,13 @@ thread next executes one of the specified interruption points (or if it is currently blocked whilst executing one) with interruption enabled, then a boost::thread_interrupted - 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. + exception will be thrown in the interrupted thread. Unless this exception + is caught inside the interrupted thread's thread-main function, the stack + unwinding process (as with any other exception) causes the destructors + with automatic storage duration to be executed. Unlike other exceptions, + when boost::thread_interrupted is propagated out + of thread-main function, this does not cause the call to std::terminate; the effect is as though the + thread-main function has returned normally.

If a thread wishes to avoid being interrupted, it can create an instance @@ -457,7 +460,7 @@

- Predefined + Predefined Interruption Points

@@ -466,7 +469,7 @@ enabled for the current thread, and interruption is requested for the current thread:
-
+

boost::thread::join()
@@ -612,7 +615,7 @@

- pthread_exit POSIX limitation + pthread_exit POSIX limitation

pthread_exit in glibc/NPTL @@ -631,7 +634,7 @@
Class thread
-
+

Default Constructor

Move @@ -780,7 +783,7 @@

-
+

Effects:

Constructs a boost::thread instance that refers @@ -806,7 +809,7 @@

-
+

Effects:

Transfers ownership of the thread managed by other @@ -834,7 +837,7 @@

-
+

Effects:

@@ -874,7 +877,7 @@

-
+

Requires:

Callable must be @@ -920,7 +923,7 @@

-
+

Preconditions:

Callable must be @@ -967,7 +970,7 @@

-
+

Preconditions:

Callable must be @@ -1013,7 +1016,7 @@

-
+

Preconditions:

Callable must be @@ -1060,7 +1063,7 @@

-
+

Preconditions:

F and each An must be copyable or movable. @@ -1107,7 +1110,7 @@

-
+

Effects:

@@ -1148,7 +1151,7 @@

-
+

Returns:

true if *this @@ -1171,7 +1174,7 @@

-
+

Preconditions:

the thread is joinable. @@ -1252,7 +1255,7 @@

-
+

Preconditions:

the thread is joinable. @@ -1320,7 +1323,7 @@

-
+

Preconditions:

the thread is joinable. @@ -1387,7 +1390,7 @@

-
+

Preconditions:

the thread is joinable. @@ -1452,7 +1455,7 @@

-
+

Preconditions:

the thread is joinable. @@ -1496,7 +1499,7 @@

-
+

Returns:

If *this @@ -1520,7 +1523,7 @@

-
+

Effects:

If *this @@ -1529,7 +1532,7 @@ points with interruption enabled, or if it is currently blocked in a call to one of the predefined interruption points - with interruption enabled . + with interruption enabled. Otherwise do noting.

Throws:

@@ -1547,7 +1550,7 @@

-
+

Returns:

The number of hardware threads available on the current system (e.g. @@ -1570,7 +1573,7 @@

-
+

Returns:

The number of physical cores available on the current system. In @@ -1594,7 +1597,7 @@

-
+

Effects:

Returns an instance of native_handle_type @@ -1633,7 +1636,7 @@

-
+

Returns:

get_id()==other.get_id() @@ -1665,7 +1668,7 @@

-
+

Returns:

get_id()!=other.get_id() @@ -1698,7 +1701,7 @@

-
+

Effects:

Suspends the current thread until the specified time has been reached. @@ -1741,7 +1744,7 @@

-
+

Effects:

See boost::this_thread::yield(). @@ -1758,7 +1761,7 @@

-
+

Effects:

Exchanges the threads of execution associated with *this @@ -1789,7 +1792,7 @@

-
+

Effects:

lhs.swap(rhs). @@ -1801,7 +1804,7 @@
Class boost::thread::id
-
+

Default constructor

operator==
@@ -1841,7 +1844,7 @@

-
+

Effects:

Constructs a boost::thread::id instance that represents @@ -1862,7 +1865,7 @@

-
+

Returns:

true if *this @@ -1885,7 +1888,7 @@

-
+

Returns:

true if *this @@ -1908,7 +1911,7 @@

-
+

Returns:

true if *this!=y @@ -1937,7 +1940,7 @@

-
+

Returns:

y<*this @@ -1957,7 +1960,7 @@

-
+

Returns:

!(y<*this) @@ -1977,7 +1980,7 @@

-
+

Returns:

!(*this<y) @@ -2000,7 +2003,7 @@

-
+

Effects:

Writes a representation of the boost::thread::id instance x to the stream os, such that the representation @@ -2021,7 +2024,7 @@ Class boost::thread::attributes EXTENSION
-
+

Default constructor

Member @@ -2056,7 +2059,7 @@

-
+

Effects:

Constructs a thread attributes instance with its default values. @@ -2077,7 +2080,7 @@

-
+

Effects:

Stores the stack size to be used to create a thread. This is a @@ -2106,7 +2109,7 @@

-
+

Returns:

The stack size to be used on the creation of a thread. Note that @@ -2131,7 +2134,7 @@

-
+

Effects:

Returns an instance of native_handle_type @@ -2154,7 +2157,7 @@
Namespace this_thread
-
+

Non-member function get_id()

Non-member @@ -2219,7 +2222,7 @@

-
+

Returns:

An instance of boost::thread::id that represents that @@ -2247,7 +2250,7 @@

-
+

Effects:

Check to see if the current thread has been interrupted. @@ -2275,7 +2278,7 @@

-
+

Returns:

true if interruption @@ -2303,7 +2306,7 @@

-
+

Returns:

true if interruption @@ -2350,7 +2353,7 @@

-
+

Effects:

Suspends the current thread until the time period specified by rel_time has elapsed or the time @@ -2391,7 +2394,7 @@

-
+

Effects:

Suspends the current thread until the time point specified by abs_time has been reached. @@ -2436,7 +2439,7 @@

-
+

Effects:

Suspends the current thread until the duration specified by rel_time has elapsed. @@ -2475,7 +2478,7 @@

-
+

Effects:

Gives up the remainder of the current thread's time slice, to allow @@ -2493,7 +2496,7 @@ Class disable_interruption EXTENSION
-
+

Constructor

Destructor

@@ -2525,7 +2528,7 @@

-
+

Effects:

Stores the current state of boost::this_thread::interruption_enabled() @@ -2552,7 +2555,7 @@

-
+

Preconditions:

Must be called from the same thread from which *this was constructed. @@ -2581,7 +2584,7 @@ Class restore_interruption EXTENSION
-
+

Constructor

Destructor

@@ -2614,7 +2617,7 @@

-
+

Preconditions:

Must be called from the same thread from which disabler @@ -2646,7 +2649,7 @@

-
+

Preconditions:

Must be called from the same thread from which *this was constructed. @@ -2680,7 +2683,7 @@

-
+

Effects:

A copy of func is @@ -2717,7 +2720,7 @@
Class thread_group EXTENSION
-
+

Constructor

Destructor

Member @@ -2775,7 +2778,7 @@

-
+

Effects:

Create a new thread group with no threads. @@ -2791,7 +2794,7 @@

-
+

Effects:

Destroy *this @@ -2811,7 +2814,7 @@

-
+

Effects:

Create a new boost::thread object as-if by @@ -2838,7 +2841,7 @@

-
+

Precondition:

The expression delete thrd is well-formed and will not @@ -2867,7 +2870,7 @@

-
+

Effects:

If thrd is a member @@ -2891,7 +2894,7 @@

-
+

Requires:

is_this_thread_in() == false. @@ -2923,7 +2926,7 @@

-
+

Returns:

true if there is a thread th @@ -2941,7 +2944,7 @@

-
+

Returns:

true if there is a thread th @@ -2959,7 +2962,7 @@

-
+

Effects:

Call interrupt() @@ -2977,7 +2980,7 @@

-
+

Returns:

The number of threads in the group. @@ -2993,7 +2996,7 @@
-

Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -15 Vicente J. Botet Escriba
+
Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -16 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)
diff --git a/doc/html/thread/time.html b/doc/html/thread/time.html index 2bc9973f0b..af2a12799a 100644 --- a/doc/html/thread/time.html +++ b/doc/html/thread/time.html @@ -4,9 +4,9 @@ Time Requirements - + - + @@ -27,13 +27,13 @@
Time Requirements
-
Deprecated
+
Deprecated

As of Boost 1.50.0, the Boost.Thread library uses Boost.Chrono library for all operations that require a time out as defined in the standard c++11. These include (but are not limited to):
-
+

boost::this_thread::sleep_for
@@ -69,16 +69,16 @@
Deprecated
-
+

Typedef system_time

Non-member function get_system_time()

- The time related functions introduced in Boost 1.35.0, using the Boost.Date_Time + The time related functions introduced in Boost 1.35.0, using the Boost.Date_Time library are deprecated. These include (but are not limited to):
-
+

boost::this_thread::sleep()
@@ -150,7 +150,7 @@

-
+

Returns:

The current time. @@ -166,7 +166,7 @@
-

Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -15 Vicente J. Botet Escriba
+
Copyright © 2007 -11 Anthony Williams
Copyright © 2011 -16 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)
-- cgit v1.2.3

- Synopsis + Synopsis

- Example + Example

Constructor - from a thread + from a thread

- Example + Example

Move - Constructor from a thread + Constructor from a thread

- Version + Version + 4.7.1 - boost 1.62 +

+ + Version 4.7.0 - boost 1.61

- - Version + + Version 4.6.0 - boost 1.60

- - Version + + Version 4.5.0 - boost 1.58

- - Version + + Version 4.4.0 - boost 1.57

- - Version + + Version 4.3.0 - boost 1.56

- - Version + + Version 4.2.0 - boost 1.55

- - Version + + Version 4.1.0 - boost 1.54

- - Version + + Version 4.0.0 - boost 1.53

- - Version + + Version 3.1.0 - boost 1.52

- - Version + + Version 3.0.1 - boost 1.51

- - Version + + Version 3.0.0 - boost 1.50

- - Version + + Version 2.1.1 - boost 1.49

- - Version 2.1.0 + + Version 2.1.0 - Changes since boost 1.40

- - Changes + + Changes since boost 1.35

- - Version 2.0.0 + + Version 2.0.0 - Changes since boost 1.34

- - New + + New Features

- - Breaking + + Breaking Changes

- See - also boost::lock_guard + See + also boost::lock_guard

@@ -4797,7 +4797,7 @@

- See - also strict_lock, boost::unique_lock + See + also strict_lock, boost::unique_lock

@@ -4874,7 +4874,7 @@

- Synopsis + Synopsis

- Closure + Closure

- Scheduled + Scheduled work

- Not + Not Handled Exceptions

- At + At thread entry

- Cancelation + Cancelation

- Current + Current executor

- Default + Default executor

- Multiple get + Multiple get

- share() + share()

- Writing + Writing on get()

- make_ready_future + make_ready_future

- Non-Variadic + Non-Variadic variant

- Variadic + Variadic variant

-Non-member - function make_exceptional() EXTENSION +Non-member + function make_exceptional_future() EXTENSION

- Synopsis + Synopsis

- Portable + Portable thread-local storage with boost::thread_specific_ptr

- Cleanup + Cleanup at thread exit

- Rationale + Rationale about the nature of the key

- Predefined + Predefined Interruption Points

- pthread_exit POSIX limitation + pthread_exit POSIX limitation

Constructor - from a `thread` + from a `thread`

Move - Constructor from a `thread` + Constructor from a `thread`

- See - also `boost::lock_guard` + See + also `boost::lock_guard`

- See - also `strict_lock`, `boost::unique_lock` + See + also `strict_lock`, `boost::unique_lock`

-Non-member - function `make_exceptional()` EXTENSION +Non-member + function `make_exceptional_future()` EXTENSION

- Portable + Portable thread-local storage with `boost::thread_specific_ptr`

- `pthread_exit` POSIX limitation + `pthread_exit` POSIX limitation