mirror of
https://github.com/boostorg/thread.git
synced 2026-02-13 12:52:11 +00:00
Compare commits
1 Commits
svn-branch
...
boost-1.25
| Author | SHA1 | Date | |
|---|---|---|---|
|
ec824ccf29 |
@@ -1,2 +0,0 @@
|
|||||||
bin*
|
|
||||||
*.pdb
|
|
||||||
@@ -3,68 +3,47 @@
|
|||||||
# in all copies. This software is provided "as is" without express or implied
|
# in all copies. This software is provided "as is" without express or implied
|
||||||
# warranty, and with no claim as to its suitability for any purpose.
|
# warranty, and with no claim as to its suitability for any purpose.
|
||||||
#
|
#
|
||||||
# Boost.Threads build Jamfile
|
# Boost.Threads build and test Jamfile
|
||||||
#
|
#
|
||||||
# Declares the following targets:
|
# Declares the following targets:
|
||||||
# 1. libboost_thread, a static link library.
|
# 1. libboost_thread, a static link library.
|
||||||
# 1a. On Win32 (when PTW32 is not defined), a dynamic link library
|
# 1a. On Win32, a dynamic link library libboost_threadmon,
|
||||||
# boost_threadmon, which must be used in conjunction with
|
# which must be used in conjunction with libboost_thread.
|
||||||
# libboost_thread. Note that this DLL *must* be used through static
|
|
||||||
# linking to the import library. Dynamic loading will cause undefined
|
|
||||||
# behavior.
|
|
||||||
# Additional configuration variables used:
|
|
||||||
# 1. PTW32 may be used on Win32 platforms to specify that the pthreads-win32
|
|
||||||
# library should be used instead of "native" threads. This feature is
|
|
||||||
# mostly used for testing and it's generally recommended you use the
|
|
||||||
# native threading libraries instead. PTW32 should be set to be a list
|
|
||||||
# of two strings, the first specifying the installation path of the
|
|
||||||
# pthreads-win32 library and the second specifying which library
|
|
||||||
# variant to link against (see the pthreads-win32 documentation).
|
|
||||||
# Example: jam -sPTW32="c:\pthreads-win32 pthreadVCE.lib"
|
|
||||||
|
|
||||||
# Declare the location of this subproject relative to the root.
|
# declare the location of this subproject relative to the root
|
||||||
subproject libs/thread/build ;
|
subproject libs/thread/build ;
|
||||||
|
|
||||||
# Include threads.jam for Boost.Threads global build information.
|
|
||||||
# This greatly simplifies the Jam code needed to configure the build
|
|
||||||
# for the various Win32 build types.
|
|
||||||
SEARCH on <module@>threads.jam = $(SUBDIR) ;
|
|
||||||
include <module@>threads.jam ;
|
|
||||||
|
|
||||||
#######################
|
#######################
|
||||||
# Conditionally declare the Boost.Threads dynamic link library boost_threadmon.
|
|
||||||
|
|
||||||
if $(NT) && ! $(PTW32)
|
#
|
||||||
|
# Declare the Boost.Threads static link library.
|
||||||
|
#
|
||||||
|
|
||||||
|
# For Win32 we need to build a special DLL, libboost_threadmon, to handle
|
||||||
|
# TSS destruction.
|
||||||
|
if $(NT)
|
||||||
{
|
{
|
||||||
dll boost_threadmon
|
if $(PTW32)
|
||||||
: ../src/threadmon.cpp
|
{
|
||||||
: <sysinclude>$(BOOST_ROOT)
|
PTW32_REQUIREMENTS = <define>BOOST_HAS_PTHREADS <define>PtW32NoCatchWarn ;
|
||||||
<threading>multi
|
}
|
||||||
: debug release <runtime-link>static/dynamic
|
else
|
||||||
;
|
{
|
||||||
|
dll libboost_threadmon : ../src/threadmon.cpp
|
||||||
|
# requirements
|
||||||
|
: <include>$(BOOST_ROOT)
|
||||||
|
<threading>multi
|
||||||
|
: debug release ;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#######################
|
# Base names of the source files for libboost_thread
|
||||||
# Declare the Boost.Threads static link library libboost_thread.
|
|
||||||
|
|
||||||
# Base names of the source files for libboost_thread.
|
|
||||||
CPP_SOURCES =
|
CPP_SOURCES =
|
||||||
condition mutex recursive_mutex thread tss xtime once exceptions ;
|
condition mutex recursive_mutex thread tss xtime once exceptions ;
|
||||||
|
|
||||||
lib boost_thread
|
lib libboost_thread : ../src/$(CPP_SOURCES).cpp
|
||||||
: ../src/$(CPP_SOURCES).cpp
|
# requirements
|
||||||
: <sysinclude>$(BOOST_ROOT)
|
: <include>$(BOOST_ROOT)
|
||||||
<threading>multi
|
$(PTW32_REQUIREMENTS)
|
||||||
$(pthreads-win32)
|
<threading>multi
|
||||||
: debug release <runtime-link>static/dynamic
|
: debug release ;
|
||||||
;
|
|
||||||
|
|
||||||
#######################
|
|
||||||
# Stage the generated targets.
|
|
||||||
|
|
||||||
#stage bin-stage
|
|
||||||
# : <lib>boost_thread $(threadmon)
|
|
||||||
# : <tag><runtime-link-static>"s"
|
|
||||||
# <tag><debug>"d"
|
|
||||||
# : debug release <runtime-link>static/dynamic
|
|
||||||
#;
|
|
||||||
|
|||||||
@@ -1,23 +0,0 @@
|
|||||||
# Do some OS-specific setup
|
|
||||||
|
|
||||||
threadmon = ;
|
|
||||||
pthreads-win32 = ;
|
|
||||||
|
|
||||||
if $(NT)
|
|
||||||
{
|
|
||||||
if $(PTW32)
|
|
||||||
{
|
|
||||||
local install-path = $(PTW32[1]) ;
|
|
||||||
local lib = $(PTW32[2]) ;
|
|
||||||
pthreads-win32 =
|
|
||||||
<define>BOOST_HAS_PTHREADS
|
|
||||||
<define>PtW32NoCatchWarn
|
|
||||||
<include>$(install-path)/pre-built/include
|
|
||||||
<library-file>$(install-path)/pre-built/lib/$(lib)
|
|
||||||
;
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
threadmon = <dll>../build/boost_threadmon ;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Binary file not shown.
77
doc/acknowledgements.html
Normal file
77
doc/acknowledgements.html
Normal file
@@ -0,0 +1,77 @@
|
|||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content=
|
||||||
|
"text/html; charset=windows-1252">
|
||||||
|
<meta name="GENERATOR" content="Microsoft FrontPage 4.0">
|
||||||
|
<meta name="ProgId" content="FrontPage.Editor.Document">
|
||||||
|
|
||||||
|
<title>Boost.Threads Acknowledgements</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body bgcolor="#FFFFFF" text="#000000">
|
||||||
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
|
width="100%">
|
||||||
|
<tr>
|
||||||
|
<td valign="top" width="300">
|
||||||
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
|
"277" height="86"></h3>
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td valign="top">
|
||||||
|
<h1 align="center">Boost.Threads</h1>
|
||||||
|
|
||||||
|
<h2 align="center">Acknowledgements</h2>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<h2>Acknowledgments</h2>
|
||||||
|
|
||||||
|
<p><a href="../../../people/william_kempf.htm">William E. Kempf</a> was
|
||||||
|
the architect, designer, and implementor of <b>Boost.Threads</b>.</p>
|
||||||
|
|
||||||
|
<p>Important contributions were also made by Jeremy Siek (lots of input
|
||||||
|
on the design and on the implementation), Alexander Terekhov (lots of
|
||||||
|
input on the Win32 implementation, especially in regards to
|
||||||
|
boost::condition, as well as a lot of explanation of POSIX behavior),
|
||||||
|
Greg Colvin (lots of input on the design), and Paul Mclachlan, Thomas
|
||||||
|
Matelich and Iain Hanson (for help in trying to get the build to work
|
||||||
|
on other platforms).</p>
|
||||||
|
|
||||||
|
<p>The documentation was written by William E. Kempf. Beman Dawes
|
||||||
|
provided additional documentation material and editing.</p>
|
||||||
|
|
||||||
|
<p>Discussions on the boost.org mailing list were essential in the
|
||||||
|
development of <b>Boost.Threads</b>. As of August 1, 2001, participants
|
||||||
|
included Alan Griffiths, Albrecht Fritzsche, Aleksey Gurtovoy,
|
||||||
|
Alexander Terekhov, Andrew Green, Andy Sawyer, Asger Alstrup Nielsen,
|
||||||
|
Beman Dawes, Bill Klein, Bill Rutiser, Bill Wade, Branko Èibej,
|
||||||
|
Brent Verner, Craig Henderson, Csaba Szepesvari, Dale Peakall, Damian
|
||||||
|
Dixon, Dan Nuffer, Darryl Green, Daryle Walker, David Abrahams, David
|
||||||
|
Allan Finch, Dejan Jelovic, Dietmar Kuehl, Doug Gregor, Douglas Gregor,
|
||||||
|
Duncan Harris, Ed Brey, Eric Swanson, Eugene Karpachov, Fabrice
|
||||||
|
Truillot, Frank Gerlach, Gary Powell, Gernot Neppert, Geurt Vos, Ghazi
|
||||||
|
Ramadan, Greg Colvin, Gregory Seidman, HYS, Iain Hanson, Ian Bruntlett,
|
||||||
|
J Panzer, Jeff Garland, Jeff Paquette, Jens Maurer, Jeremy Siek, Jesse
|
||||||
|
Jones, Joe Gottman, John (EBo) David, John Bandela, John Maddock, John
|
||||||
|
Max Skaller, John Panzer, Jon Jagger , Karl Nelson, Kevlin Henney, KG
|
||||||
|
Chandrasekhar, Levente Farkas, Lie-Quan Lee, Lois Goldthwaite, Luis
|
||||||
|
Pedro Coelho, Marc Girod, Mark A. Borgerding, Mark Rodgers, Marshall
|
||||||
|
Clow, Matthew Austern, Matthew Hurd, Michael D. Crawford, Michael H.
|
||||||
|
Cox , Mike Haller, Miki Jovanovic, Nathan Myers, Paul Moore, Pavel
|
||||||
|
Cisler, Peter Dimov, Petr Kocmid, Philip Nash, Rainer Deyke, Reid
|
||||||
|
Sweatman, Ross Smith, Scott McCaskill, Shalom Reich , Steve Cleary,
|
||||||
|
Steven Kirk, Thomas Holenstein, Thomas Matelich, Trevor Perrin,
|
||||||
|
Valentin Bonnard, Vesa Karvonen, Wayne Miller, and William Kempf.</p>
|
||||||
|
|
||||||
|
<p>Apologies for anyone inadvertently missed.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p>© <i>Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001</i></p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
|
||||||
<title>Boost.Threads - Acknowledgments</title>
|
|
||||||
</head>
|
|
||||||
<body link="#0000ff" vlink="#800080">
|
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
|
||||||
"header">
|
|
||||||
<tr>
|
|
||||||
<td valign="top" width="300">
|
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
|
||||||
</td>
|
|
||||||
<td valign="top">
|
|
||||||
<h1 align="center">Boost.Threads</h1>
|
|
||||||
<h2 align="center">Acknowledgments</h2>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<hr>
|
|
||||||
<p><a href="../../../people/william_kempf.htm">William E. Kempf</a> was the architect,
|
|
||||||
designer, and implementor of <b>Boost.Threads</b>.</p>
|
|
||||||
<p>Mac OS Carbon implementation written by <a href="../../../people/mac_murrett.htm">Mac
|
|
||||||
Murrett</a>.</p>
|
|
||||||
<p>Important contributions were also made by Jeremy Siek (lots of input on the
|
|
||||||
design and on the implementation), Alexander Terekhov (lots of input on the
|
|
||||||
Win32 implementation, especially in regards to boost::condition, as well as
|
|
||||||
a lot of explanation of POSIX behavior), Greg Colvin (lots of input on the design),
|
|
||||||
Paul Mclachlan, Thomas Matelich and Iain Hanson (for help in trying to get the
|
|
||||||
build to work on other platforms), and Kevin S. Van Horn (for several updates/corrections
|
|
||||||
to the documentation).</p>
|
|
||||||
<p>The documentation was written by William E. Kempf. Beman Dawes provided additional
|
|
||||||
documentation material and editing.</p>
|
|
||||||
<p>Discussions on the boost.org mailing list were essential in the development
|
|
||||||
of <b>Boost.Threads</b>. As of August 1, 2001, participants included Alan Griffiths,
|
|
||||||
Albrecht Fritzsche, Aleksey Gurtovoy, Alexander Terekhov, Andrew Green, Andy
|
|
||||||
Sawyer, Asger Alstrup Nielsen, Beman Dawes, Bill Klein, Bill Rutiser, Bill Wade,
|
|
||||||
Branko Èibej, Brent Verner, Craig Henderson, Csaba Szepesvari, Dale Peakall,
|
|
||||||
Damian Dixon, Dan Nuffer, Darryl Green, Daryle Walker, David Abrahams, David
|
|
||||||
Allan Finch, Dejan Jelovic, Dietmar Kuehl, Doug Gregor, Douglas Gregor, Duncan
|
|
||||||
Harris, Ed Brey, Eric Swanson, Eugene Karpachov, Fabrice Truillot, Frank Gerlach,
|
|
||||||
Gary Powell, Gernot Neppert, Geurt Vos, Ghazi Ramadan, Greg Colvin, Gregory
|
|
||||||
Seidman, HYS, Iain Hanson, Ian Bruntlett, J Panzer, Jeff Garland, Jeff Paquette,
|
|
||||||
Jens Maurer, Jeremy Siek, Jesse Jones, Joe Gottman, John (EBo) David, John Bandela,
|
|
||||||
John Maddock, John Max Skaller, John Panzer, Jon Jagger , Karl Nelson, Kevlin
|
|
||||||
Henney, KG Chandrasekhar, Levente Farkas, Lie-Quan Lee, Lois Goldthwaite, Luis
|
|
||||||
Pedro Coelho, Marc Girod, Mark A. Borgerding, Mark Rodgers, Marshall Clow, Matthew
|
|
||||||
Austern, Matthew Hurd, Michael D. Crawford, Michael H. Cox , Mike Haller, Miki
|
|
||||||
Jovanovic, Nathan Myers, Paul Moore, Pavel Cisler, Peter Dimov, Petr Kocmid,
|
|
||||||
Philip Nash, Rainer Deyke, Reid Sweatman, Ross Smith, Scott McCaskill, Shalom
|
|
||||||
Reich , Steve Cleary, Steven Kirk, Thomas Holenstein, Thomas Matelich, Trevor
|
|
||||||
Perrin, Valentin Bonnard, Vesa Karvonen, Wayne Miller, and William Kempf.</p>
|
|
||||||
<p>Apologies for anyone inadvertently missed.</p>
|
|
||||||
<hr>
|
|
||||||
<p>Revised
|
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
|
||||||
05 November, 2001
|
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
|
||||||
</p>
|
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
|
||||||
All Rights Reserved.</i></p>
|
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
|
||||||
makes no representations about the suitability of this software for any purpose.
|
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,165 +1,222 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Type" content=
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
"text/html; charset=windows-1252">
|
||||||
<title>Boost.Threads - Bibliography</title>
|
<meta name="GENERATOR" content="Microsoft FrontPage 4.0">
|
||||||
</head>
|
<meta name="ProgId" content="FrontPage.Editor.Document">
|
||||||
<body link="#0000ff" vlink="#800080">
|
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
<title>Boost.Threads Bibliography</title>
|
||||||
"header">
|
</head>
|
||||||
<tr>
|
|
||||||
<td valign="top" width="300">
|
<body bgcolor="#FFFFFF" text="#000000">
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
</td>
|
width="100%">
|
||||||
<td valign="top">
|
<tr>
|
||||||
<h1 align="center">Boost.Threads</h1>
|
<td valign="top" width="300">
|
||||||
<h2 align="center">Bibliography</h2>
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
</td>
|
"277" height="86"></h3>
|
||||||
</tr>
|
</td>
|
||||||
</table>
|
|
||||||
<hr>
|
<td valign="top">
|
||||||
<table summary="Bibliography" border="0" cellpadding="5" width="777">
|
<h1 align="center">Boost.Threads</h1>
|
||||||
<tr>
|
|
||||||
<td width="102" valign="top" align="left"><b>[<a name=
|
<h2 align="center">Bibliography</h2>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<h2>Bibliography</h2>
|
||||||
|
|
||||||
|
<table summary="Bibliography" border="0" cellpadding="5" width="777">
|
||||||
|
<tr>
|
||||||
|
<td width="102" valign="top" align="left"><b>[<a name=
|
||||||
"Andrews-83">Andrews 83</a>]</b></td>
|
"Andrews-83">Andrews 83</a>]</b></td>
|
||||||
<td width="645"> Gregory R. Andrews, Fred B. Schneider, <cite>Concepts and
|
|
||||||
Notations for Concurrent Programming</cite>, ACM Computing Surveys, Vol.
|
<td width="645">
|
||||||
15, No. 1, March, 1983. <a href=
|
Gregory R. Andrews, Fred B. Schneider, <cite>Concepts and
|
||||||
"http://www.acm.org/pubs/citations/journals/surveys/1983-15-1/p3-andrews/">
|
Notations for Concurrent Programming</cite>, ACM Computing
|
||||||
http://www.acm.org/pubs/citations/journals/surveys/1983-15-1/p3-andrews/</a>
|
Surveys, Vol. 15, No. 1, March, 1983. <a href=
|
||||||
<p>Good general background reading. Includes descriptions of Path Expressions,
|
"http://www.acm.org/pubs/citations/journals/surveys/1983-15-1/p3-andrews/">
|
||||||
Message Passing, and Remote Procedure Call in addition to the basics.</p>
|
http://www.acm.org/pubs/citations/journals/surveys/1983-15-1/p3-andrews/</a>
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<p>Good general background reading. Includes descriptions
|
||||||
<td width="102" valign="top" align="left"><b>[<a name=
|
of Path Expressions, Message Passing, and Remote Procedure
|
||||||
|
Call in addition to the basics.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td width="102" valign="top" align="left"><b>[<a name=
|
||||||
"Boost">Boost</a>]</b></td>
|
"Boost">Boost</a>]</b></td>
|
||||||
<td width="645"> The <cite>Boost</cite> worldwide web site. <a href=
|
|
||||||
|
<td width="645">
|
||||||
|
The <cite>Boost</cite> world-wide web site. <a href=
|
||||||
"http://www.boost.org">http://www.boost.org</a>
|
"http://www.boost.org">http://www.boost.org</a>
|
||||||
<p>Boost.Threads is one of many Boost libraries. The Boost web site includes
|
|
||||||
a great deal of documentation and general information which applies to
|
<p>Boost.Threads is one of many Boost libraries. The Boost
|
||||||
all Boost libraries. Current copies of the libraries including documentation
|
web site includes a great deal of documentation and general
|
||||||
and test programs may be downloaded from the web site.</p>
|
information which applies to all Boost libraries. Current
|
||||||
</td>
|
copies of the libraries including documentation and test
|
||||||
</tr>
|
programs may be downloaded from the web site.</p>
|
||||||
<tr>
|
</td>
|
||||||
<td width="102" valign="top" align="left"><b>[<a name=
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td width="102" valign="top" align="left"><b>[<a name=
|
||||||
"Brinch-Hansen-73">Brinch Hansen 73</a>]</b></td>
|
"Brinch-Hansen-73">Brinch Hansen 73</a>]</b></td>
|
||||||
<td width="645"> Per Brinch Hansen, <cite>Concurrent Programming Concepts</cite>,
|
|
||||||
ACM Computing Surveys, Vol. 5, No. 4, December, 1973. <a href=
|
<td width="645">
|
||||||
"http://www.acm.org/pubs/articles/journals/surveys/1973-5-4/p223-hansen/p223-hansen.pdf">
|
Per Brinch Hansen, <cite>Concurrent Programming
|
||||||
http://www.acm.org/pubs/articles/journals/surveys/1973-5-4/p223-hansen/</a>
|
Concepts</cite>, ACM Computing Surveys, Vol. 5, No. 4,
|
||||||
<p>"This paper describes the evolution of language features for multiprogramming
|
December, 1973. <a href=
|
||||||
from event queues and semaphores to critical regions and monitors."
|
"http://www.acm.org/pubs/articles/journals/surveys/1973-5-4/p223-hansen/p223-hansen.pdf">
|
||||||
Includes analysis of why <i>events</i> are considered error-prone. Also
|
http://www.acm.org/pubs/articles/journals/surveys/1973-5-4/p223-hansen/</a>
|
||||||
noteworthy because of an introductory quotation from Christopher Alexander;
|
|
||||||
Brinch Hansen was years ahead of others in recognizing pattern concepts
|
|
||||||
applied to software too.</p>
|
<p>"This paper describes the evolution of language
|
||||||
</td>
|
features for multiprogramming from event queues and
|
||||||
</tr>
|
semaphores to critical regions and monitors." Includes
|
||||||
<tr>
|
analysis of why <i>events</i> are considered error-prone.
|
||||||
<td width="102" valign="top" align="left"><b>]<a name=
|
Also noteworthy because of an introductory quotation from
|
||||||
|
Christopher Alexander; Brinch Hansen was years ahead of
|
||||||
|
others in recognizing pattern concepts applied to software
|
||||||
|
too.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td width="102" valign="top" align="left"><b>]<a name=
|
||||||
"Butenhof-97">Butenhof 97</a>]</b></td>
|
"Butenhof-97">Butenhof 97</a>]</b></td>
|
||||||
<td width="645">
|
|
||||||
<p>David R. Butenhof, <cite>Programming with POSIX Threads</cite>, Addison-Wesley
|
<td width="645">
|
||||||
1997, ISBN 0-201-63392-2 <a
|
<p>David R. Butenhof, <cite>Programming with POSIX
|
||||||
href="http://cseng.aw.com/book/0,3828,0201633922,00.html">
|
Threads</cite>, Addison-Wesley 1997, ISBN 0-201-63392-2 <a
|
||||||
http://cseng.aw.com/book/0,3828,0201633922,00.html</a></p>
|
href="http://cseng.aw.com/book/0,3828,0201633922,00.html">
|
||||||
<p>This is a very readable explanation of threads and how to use them. Many
|
http://cseng.aw.com/book/0,3828,0201633922,00.html</a></p>
|
||||||
of the insights given apply to all multithreaded programming, not just
|
|
||||||
POSIX Threads.</p>
|
<p>This is a very readable explanation of threads and how
|
||||||
</td>
|
to use them. Many of the insights given apply to all
|
||||||
</tr>
|
multi-threaded programming, not just POSIX Threads.</p>
|
||||||
<tr>
|
</td>
|
||||||
<td width="102" valign="top" align="left"><b>[<a name=
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td width="102" valign="top" align="left"><b>[<a name=
|
||||||
"Hoare-74">Hoare 74</a>]</b></td>
|
"Hoare-74">Hoare 74</a>]</b></td>
|
||||||
<td width="645">
|
|
||||||
<p>C.A.R Hoare, <cite>Monitors: An Operating System Structuring Concept</cite>,
|
<td width="645">
|
||||||
Communications of the ACM, Vol. 17, No. 10. October 1974, pp. 549-557
|
<p>C.A.R Hoare, <cite>Monitors: An Operating System
|
||||||
<a href=
|
Structuring Concept</cite>, Communications of the ACM, Vol.
|
||||||
"http://www.acm.org/classics/feb96/"> http://www.acm.org/classics/feb96/</a></p>
|
17, No. 10. October 1974, pp. 549-557 <a href=
|
||||||
<p>Hoare and Brinch Hansen's work on Monitors is the basis for reliable
|
"http://www.acm.org/classics/feb96/">
|
||||||
multithreading patterns. This is one of the most often referenced papers
|
http://www.acm.org/classics/feb96/</a></p>
|
||||||
in all of computer science, and with good reason.</p>
|
|
||||||
</td>
|
<p>Hoare and Brinch Hansen's work on Monitors is the
|
||||||
</tr>
|
basis for reliable multi-threading patterns. This is one of
|
||||||
<tr>
|
the most often referenced papers in all of computer
|
||||||
<td width="102" valign="top" align="left"><b>[<a name=
|
science, and with good reason.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td width="102" valign="top" align="left"><b>[<a name=
|
||||||
"ISO-98">ISO 98</a>]</b></td>
|
"ISO-98">ISO 98</a>]</b></td>
|
||||||
<td width="645">
|
|
||||||
<p>ISO/IEC 14882:1998(E) <cite>Programming Language C++</cite> <a href="http://www.ansi.org">
|
<td width="645">
|
||||||
http://www.ansi.org</a></p>
|
<p>ISO/IEC 14882:1998(E) <cite>Programming Language
|
||||||
<p>This is the official C++ Standards document. Available from the ANSI
|
C++</cite> <a href="http://www.ansi.org">
|
||||||
(American National Standards Institute) Electronic Standards Store.</p>
|
http://www.ansi.org</a></p>
|
||||||
</td>
|
|
||||||
</tr>
|
<p>This is the official C++ Standards document. Available
|
||||||
<tr>
|
from the ANSI (American National Standards Institute)
|
||||||
<td width="102" valign="top" align="left"><b>[<a name=
|
Electronic Standards Store.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td width="102" valign="top" align="left"><b>[<a name=
|
||||||
"McDowell-89">McDowell 89</a>]</b></td>
|
"McDowell-89">McDowell 89</a>]</b></td>
|
||||||
<td width="645"> Charles E McDowell, David P. Helmbold, <cite>Debugging Concurrent
|
|
||||||
Programs</cite>, ACM Computing Surveys, Vol. 21, No. 2, December, 1989.
|
<td width="645">
|
||||||
<a href=
|
Charles E McDowell, David P. Helmbold, <cite>Debugging
|
||||||
"http://www.acm.org/pubs/citations/journals/surveys/1989-21-4/p593-mcdowell/">
|
Concurrent Programs</cite>, ACM Computing Surveys, Vol. 21,
|
||||||
http://www.acm.org/pubs/citations/journals/surveys/1989-21-4/p593-mcdowell/</a>
|
No. 2, December, 1989. <a href=
|
||||||
<p>Identifies many of the unique failure modes and debugging difficulties
|
"http://www.acm.org/pubs/citations/journals/surveys/1989-21-4/p593-mcdowell/">
|
||||||
associated with concurrent programs.</p>
|
http://www.acm.org/pubs/citations/journals/surveys/1989-21-4/p593-mcdowell/</a>
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<p>Identifies many of the unique failure modes and
|
||||||
<td width="102" valign="top" align="left"><b>[<a name=
|
debugging difficulties associated with concurrent
|
||||||
|
programs.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td width="102" valign="top" align="left"><b>[<a name=
|
||||||
"Schmidt">Schmidt</a>]</b> </td>
|
"Schmidt">Schmidt</a>]</b> </td>
|
||||||
<td width="645">
|
|
||||||
<p>Douglas C. Schmidt and Irfan Pyarali, <cite>Strategies for Implementing
|
<td width="645">
|
||||||
POSIX Condition Variables on Win32</cite>, Department of Computer Science,
|
<p>Douglas C. Schmidt and Irfan Pyarali, <cite>Strategies
|
||||||
Washington University, St. Louis, Missouri. <a href=
|
for Implementing POSIX Condition Variables on Win32</cite>,
|
||||||
"http://www.cs.wustl.edu/~schmidt/win32-cv-1.html"> http://www.cs.wustl.edu/~schmidt/win32-cv-1.html</a></p>
|
Department of Computer Science, Washington University, St.
|
||||||
<p>Rationale for understanding Boost.Threads condition variables. Note that
|
Louis, Missouri. <a href=
|
||||||
Alexander Terekhov found some bugs in the implementation given in this
|
"http://www.cs.wustl.edu/~schmidt/win32-cv-1.html">
|
||||||
article, so pthreads-win32 and Boost.Threads are even more complicated
|
http://www.cs.wustl.edu/~schmidt/win32-cv-1.html</a></p>
|
||||||
yet.</p>
|
|
||||||
</td>
|
<p>Rationale for understanding Boost.Threads condition
|
||||||
</tr>
|
variables. Note that Alexander Terekhov found some bugs in
|
||||||
<tr>
|
the implementation given in this article, so pthreads-win32
|
||||||
<td width="102" valign="top" align="left"><b>[<a name=
|
and Boost.Threads are even more complicated yet.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td width="102" valign="top" align="left"><b>[<a name=
|
||||||
"Schmidt-00">Schmidt 00</a>]</b> </td>
|
"Schmidt-00">Schmidt 00</a>]</b> </td>
|
||||||
<td width="645">
|
|
||||||
<p>Douglas C. Schmidt, Michael Stal, Hans Rohnert and Frank Buschmann, <cite>Pattern-Oriented
|
<td width="645">
|
||||||
Software Architecture Volume 2 - Patterns for Concurrent and Networked
|
<p>Douglas C. Schmidt, Michael Stal, Hans Rohnert and Frank
|
||||||
Objects</cite>, Wiley 2000, ISBN 0-471-60695-2 <a href=
|
Buschmann, <cite>Pattern-Oriented Software Architecture
|
||||||
"http://www.wiley.com/Corporate/Website/Objects/Products/0,9049,104671,00.html">
|
Volume 2 - Patterns for Concurrent and Networked
|
||||||
http://www.wiley.com/Corporate/Website/Objects/Products/0,9049,104671,00.html</a></p>
|
Objects</cite>, Wiley 2000, ISBN 0-471-60695-2 <a href=
|
||||||
<p>This is a very good explanation of how to apply several patterns useful
|
"http://www.wiley.com/Corporate/Website/Objects/Products/0,9049,104671,00.html">
|
||||||
for concurrent programming. Among the patterns documented is the Monitor
|
http://www.wiley.com/Corporate/Website/Objects/Products/0,9049,104671,00.html</a></p>
|
||||||
Pattern mentioned frequently in the <b>Boost.Threads</b> documentation.</p>
|
|
||||||
</td>
|
<p>This is a very good explanation of how to apply several
|
||||||
</tr>
|
patterns useful for concurrent programming. Among the
|
||||||
<tr>
|
patterns documented is the Monitor Pattern mentioned
|
||||||
<td width="102" valign="top" align="left"><b>[<a name=
|
frequently in the <b>Boost.Threads</b> documentation.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td width="102" valign="top" align="left"><b>[<a name=
|
||||||
"Stroustrup-00">Stroustrup 00</a>]</b></td>
|
"Stroustrup-00">Stroustrup 00</a>]</b></td>
|
||||||
<td width="645"> Bjarne Stroustrup, <cite>The C++ Programming Language</cite>,
|
|
||||||
Special Edition, Addison-Wesley 2000, ISBN 0-201-70073-5 <a href=
|
<td width="645">
|
||||||
"http://cseng.aw.com/book/0,3828,0201700735,00.html"> http://cseng.aw.com/book/0,3828,0201700735,00.html</a>
|
Bjarne Stroustrup, <cite>The C++ Programming
|
||||||
<p>The first book a C++ programmer should own. Note that the 3rd edition
|
Language</cite>, Special Edition, Addison-Wesley 2000, ISBN
|
||||||
(and subsequent editions like the Special Edition) has been rewritten
|
0-201-70073-5 <a href=
|
||||||
to cover the ISO standard language and library.</p>
|
"http://cseng.aw.com/book/0,3828,0201700735,00.html">
|
||||||
</td>
|
http://cseng.aw.com/book/0,3828,0201700735,00.html</a>
|
||||||
</tr>
|
|
||||||
</table>
|
<p>The first book a C++ programmer should own. Note that
|
||||||
<p>Note: The URL's above are provided in plain text form so that they will
|
the 3rd edition (and subsequent editions like the Special
|
||||||
be visible on printed copies of this document.</p>
|
Edition) has been rewritten to cover the ISO standard
|
||||||
<hr>
|
language and library.</p>
|
||||||
<p>Revised
|
</td>
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
</tr>
|
||||||
05 November, 2001
|
</table>
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
|
||||||
</p>
|
<p>Note: The URL's above are provided in plain text form so that
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> and
|
they will be visible on printed copies of this document.</p>
|
||||||
Beman Dawes 2001-2002. All Rights Reserved.</i></p>
|
<hr>
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
<p>Revised
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %b %Y" startspan -->05 Nov 2001<!--webbot bot="Timestamp" endspan i-checksum="15246" --></p>
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
|
||||||
makes no representations about the suitability of this software for any purpose.
|
<p>© Copyright Beman Dawes, 2001</p>
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
</body>
|
||||||
</body>
|
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|||||||
132
doc/call_once.html
Normal file
132
doc/call_once.html
Normal file
@@ -0,0 +1,132 @@
|
|||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content=
|
||||||
|
"text/html; charset=iso-8859-1">
|
||||||
|
<meta name="keywords" content=
|
||||||
|
"threads, Boost.Threads, thread library, C++">
|
||||||
|
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||||
|
|
||||||
|
<title>Boost.Threads, call_once</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
|
width="100%">
|
||||||
|
<tr>
|
||||||
|
<td valign="top" width="300">
|
||||||
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
|
"277" height="86"></h3>
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td valign="top">
|
||||||
|
<h1 align="center">Boost.Threads</h1>
|
||||||
|
|
||||||
|
<h2 align="center">call_once</h2>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
|
<a href="#Header">Header</a><br>
|
||||||
|
<a href="#Synopsis">Synopsis</a><br>
|
||||||
|
<a href="#Members">Members</a><br>
|
||||||
|
<a href="#Example">Example</a></p>
|
||||||
|
|
||||||
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
|
|
||||||
|
<p>The <code>call_once</code> routine and <code>once_flag</code> type
|
||||||
|
can be used to run a routine exactly once. This can be used to
|
||||||
|
initialize data in a <a href="definitions.html#Thread-safe">
|
||||||
|
thread-safe</a> manner.</p>
|
||||||
|
|
||||||
|
<h2><a name="Header">Header</a></h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/once.hpp"><boost/thread/once.hpp></a>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Synopsis">Synopsis</a></h2>
|
||||||
|
<pre>
|
||||||
|
namespace boost {
|
||||||
|
|
||||||
|
typedef <i>[implementation defined]</i> once_flag;
|
||||||
|
const once_flag once_init = <i>[implementation defined]</i>;
|
||||||
|
void call_once(void (*func)(), once_flag& flag);
|
||||||
|
|
||||||
|
} // namespace boost
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Reference">Reference</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>once_flag</h3>
|
||||||
|
|
||||||
|
<p>This implementation defined type is used as a flag to insure a
|
||||||
|
routine is called only once. Instances of this type should be
|
||||||
|
statically initialized to <code>once_init</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>once_init</h3>
|
||||||
|
|
||||||
|
<p>This is a constant value used to initialize <code>once_flag</code>
|
||||||
|
instances to indicate that the logically associated routine has not
|
||||||
|
been run yet.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>call_once</h3>
|
||||||
|
<pre>
|
||||||
|
void call_once(void (*func)(), once_flag& flag);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Requires:</b> The function <code>func</code> shall not throw
|
||||||
|
exceptions.</p>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> As if (in an atomic fashion)</p>
|
||||||
|
<code> if (flag == once_init)<br>
|
||||||
|
func();</code>
|
||||||
|
|
||||||
|
<p><b>Postcondition:</b> <code>flag</code> != <code>
|
||||||
|
once_init</code></p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><a name="Example">Example Usage</a></h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/thread.hpp"><boost/thread/thread.hpp></a>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/tss.hpp"><boost/thread/once.hpp></a>
|
||||||
|
#include <cassert>
|
||||||
|
|
||||||
|
int value=0;
|
||||||
|
boost::once_flag once = boost::once_init;
|
||||||
|
|
||||||
|
void init()
|
||||||
|
{
|
||||||
|
++value;
|
||||||
|
}
|
||||||
|
|
||||||
|
void thread_proc()
|
||||||
|
{
|
||||||
|
boost::call_once(&init, once);
|
||||||
|
}
|
||||||
|
|
||||||
|
int main(int argc, char* argv[])
|
||||||
|
{
|
||||||
|
boost::thread_group threads;
|
||||||
|
for (int i=0; i<5; ++i)
|
||||||
|
threads.create_thread(&thread_proc);
|
||||||
|
threads.join_all();
|
||||||
|
assert(value == 1);
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
@@ -1,205 +1,253 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Type" content=
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
"text/html; charset=iso-8859-1">
|
||||||
<title>Boost.Threads - Header <boost/thread/condition.hpp></title>
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
</head>
|
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||||
<body link="#0000ff" vlink="#800080">
|
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
|
||||||
"header">
|
|
||||||
<tr>
|
|
||||||
<td valign="top" width="300">
|
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
|
||||||
</td>
|
|
||||||
<td valign="top">
|
|
||||||
<h1 align="center">Boost.Threads</h1>
|
|
||||||
<h2 align="center">Header <<a href="../../../boost/thread/condition.hpp">boost/thread/condition.hpp</a>></h2>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<hr>
|
|
||||||
<h2>Contents</h2>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#introduction">Introduction</a></dt>
|
|
||||||
<dt><a href="#classes">Classes</a></dt>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#class-condition">Class <code>condition</code></a></dt>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#class-condition-synopsis">Class <code>condition</code> synopsis</a></dt>
|
|
||||||
<dt><a href="#class-condition-ctors">Class <code>condition</code> constructors
|
|
||||||
and destructor</a></dt>
|
|
||||||
<dt><a href="#class-condition-modifiers">Class <code>condition</code> modifier
|
|
||||||
functions</a></dt>
|
|
||||||
</dl>
|
|
||||||
</dl>
|
|
||||||
<dt><a href="#examples">Example(s)</a></dt>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<h2><a name="introduction"></a>Introduction</h2>
|
|
||||||
<p>Include the header <<a href="../../../boost/thread/condition.hpp">boost/thread/condition.hpp</a>>
|
|
||||||
to define the class condition.</p>
|
|
||||||
<h2><a name="classes"></a>Classes</h2>
|
|
||||||
<h3><a name="class-condition"></a>Class <code>condition</code></h3>
|
|
||||||
<p>An object of class <code>condition</code> is a synchronization primitive used
|
|
||||||
to cause a thread to wait until a particular shared-data condition (or time)
|
|
||||||
is met. A <code>condition</code> object is always used in conjunction with a
|
|
||||||
mutex object (an object whose type is a model of <a href="mutex_concept.html">Mutex</a>
|
|
||||||
or one of its refinements). The mutex object must be locked prior to waiting
|
|
||||||
on the <code>condition</code>, which is verified by passing a lock object (an
|
|
||||||
object whose type is a model of <a href="lock_concept.html">Lock</a> or one
|
|
||||||
of its refinements) to the <code>condition</code> object's <code>wait</code>
|
|
||||||
functions. Upon blocking on the condition object, the thread unlocks the mutex
|
|
||||||
object. When the thread returns from a call to one of the condition object's
|
|
||||||
wait functions the mutex object is again locked. The tricky unlock/lock sequence
|
|
||||||
is performed automatically by the <code> condition</code> object's <code>wait</code>
|
|
||||||
functions.</p>
|
|
||||||
<p>The <code>condition</code> type is often used to implement the <i> Monitor
|
|
||||||
Object</i> and other important patterns (see <a href="bibliography.html#Schmidt-00">[Schmidt
|
|
||||||
00]</a> and <a href="bibliography.html#Hoare-74">[Hoare 74]</a>). Monitors are
|
|
||||||
one of the most important patterns for creating reliable multithreaded programs.</p>
|
|
||||||
<p>See <a href="definitions.html">Formal Definitions</a> for definitions of thread
|
|
||||||
states <a href="definitions.html#state"> blocked</a> and <a href="definitions.html#state">ready</a>.
|
|
||||||
Note that "waiting" is a synonym for blocked.</p>
|
|
||||||
<h4><a name="class-condition-synopsis"></a>Class <code>condition</code> synopsis</h4>
|
|
||||||
<pre>
|
|
||||||
namespace boost
|
|
||||||
{
|
|
||||||
class condition : private <a href="../../utility/utility.htm#Class noncopyable">boost::noncopyable</a> // Exposition only.
|
|
||||||
// Class condition meets the <a href="overview.html#non-copyable">NonCopyable</a> requirement.
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
condition();
|
|
||||||
~condition();
|
|
||||||
|
|
||||||
void notify_one();
|
<title>Boost.Threads, condition</title>
|
||||||
void notify_all();
|
</head>
|
||||||
template <typename <a href="lock_concept.html#Lock-concept">Lock</a>>
|
|
||||||
void wait(<a href="lock_concept.html#Lock-concept">Lock</a>& lock);
|
<body bgcolor="#ffffff" link="#0000ff" vlink="#800080" text="#000000">
|
||||||
template <typename <a href="lock_concept.html#Lock-concept">Lock</a>, typename <a href="http://www.sgi.com/tech/stl/Predicate.html">Predicate</a>>
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
void wait(<a href="lock_concept.html#Lock-concept">Lock</a>& lock, <a href="http://www.sgi.com/tech/stl/Predicate.html">Predicate</a> pred);
|
width="100%">
|
||||||
template <typename <a href="lock_concept.html#Lock-concept">Lock</a>>
|
<tr>
|
||||||
bool timed_wait(<a href="lock_concept.html#Lock-concept">Lock</a>& lock, const xtime& xt);
|
<td valign="top" width="300">
|
||||||
template <typename <a href="lock_concept.html#Lock-concept">Lock</a>, typename <a href="http://www.sgi.com/tech/stl/Predicate.html">Predicate</a>>
|
<h3><img height="86" alt="C++ Boost" src=
|
||||||
bool timed_wait(<a href="lock_concept.html#Lock-concept">Lock</a>& lock, const xtime& XT, <a href="http://www.sgi.com/tech/stl/Predicate.html">Predicate</a> pred);
|
"../../../c++boost.gif" width="277"></h3>
|
||||||
};
|
</td>
|
||||||
};
|
|
||||||
|
<td valign="top">
|
||||||
|
<h1 align="center">Boost.Threads</h1>
|
||||||
|
|
||||||
|
<h2 align="center">condition</h2>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
|
<a href="#Header">Header</a><br>
|
||||||
|
<a href="#Synopsis">Synopsis</a><br>
|
||||||
|
<a href="#Members">Members</a><br>
|
||||||
|
<a href="#Example">Example</a></p>
|
||||||
|
|
||||||
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
|
|
||||||
|
<p>An object of class <code>condition</code> is a synchronization
|
||||||
|
primitive used to cause a thread to wait until a particular shared-data
|
||||||
|
condition (or time) is met. A <code>condition</code> object is always
|
||||||
|
used in conjunction with a mutex object modeling a <a href=
|
||||||
|
"mutex_concept.html">Mutex Concept</a>. The mutex must be locked prior
|
||||||
|
to waiting on the <code>condition</code>, which is ensured by passing a
|
||||||
|
lock object modeling a <a href="lock_concept.html">Lock Concept</a> to
|
||||||
|
the <code>condition</code> object's <code>wait</code> functions.
|
||||||
|
While the thread is waiting on the <code>condition</code> object, the
|
||||||
|
mutex associated with the lock is unlocked. When the thread returns
|
||||||
|
from a call to one of the <code>condition</code> object's <code>
|
||||||
|
wait</code> functions, the mutex is again locked. The tricky
|
||||||
|
lock/unlock/lock sequence is performed automatically by the <code>
|
||||||
|
condition</code> object's <code>wait</code> functions.</p>
|
||||||
|
|
||||||
|
<p>The <code>condition</code> type is often used to implement the <i>
|
||||||
|
Monitor Object</i> and other important patterns. See <a href=
|
||||||
|
"bibliography.html#Schmidt-00">[Schmidt-00]</a> and <a href=
|
||||||
|
"bibliography.html#Hoare-74">[Hoare 74]</a>. Monitors are one of the
|
||||||
|
most important patterns for creating reliable multithreaded
|
||||||
|
programs.</p>
|
||||||
|
|
||||||
|
<p>See <a href="definitions.html">Formal Definitions</a> for
|
||||||
|
definitions of thread states <a href="definitions.html#state">
|
||||||
|
blocked</a> and <a href="definitions.html#state">ready</a>. Note that
|
||||||
|
"waiting" is a synonym for blocked.</p>
|
||||||
|
|
||||||
|
<h2><a name="Header">Header</a></h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/condition.hpp"><boost/thread/condition.hpp></a>
|
||||||
</pre>
|
</pre>
|
||||||
<h4><a name="class-condition-ctors"></a>Class <code>condition</code> constructors
|
|
||||||
and destructor</h4>
|
<h2><a name="Synopsis">Synopsis</a></h2>
|
||||||
|
<pre>
|
||||||
|
namespace boost {
|
||||||
|
|
||||||
|
class condition : private <a href=
|
||||||
|
"../../utility/utility.htm#Class noncopyable">boost::noncopyable</a> // Exposition only.
|
||||||
|
// Class condition meets the <a href=
|
||||||
|
"overview.html#NonCopyable">NonCopyable</a> requirement.
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
condition();
|
||||||
|
~condition();
|
||||||
|
|
||||||
|
void notify_one();
|
||||||
|
void notify_all();
|
||||||
|
template <typename <a href="scoped_lock.html">ScopedLock</a>>
|
||||||
|
void wait(<a href="scoped_lock.html">ScopedLock</a>& lock);
|
||||||
|
template <typename <a href="scoped_lock.html">ScopedLock</a>, typename <a
|
||||||
|
href="http://www.sgi.com/tech/stl/Predicate.html">Predicate</a>>
|
||||||
|
void wait(<a href="scoped_lock.html">ScopedLock</a>& lock, <a href=
|
||||||
|
"http://www.sgi.com/tech/stl/Predicate.html">Predicate</a> pred);
|
||||||
|
template <typename <a href="scoped_lock.html">ScopedLock</a>>
|
||||||
|
bool timed_wait(<a href=
|
||||||
|
"scoped_lock.html">ScopedLock</a>& lock, const xtime& xt);
|
||||||
|
template <typename <a href="scoped_lock.html">ScopedLock</a>, typename <a
|
||||||
|
href="http://www.sgi.com/tech/stl/Predicate.html">Predicate</a>>
|
||||||
|
bool timed_wait(<a href=
|
||||||
|
"scoped_lock.html">ScopedLock</a>& lock, const xtime& xt, <a href=
|
||||||
|
"http://www.sgi.com/tech/stl/Predicate.html">Predicate</a> pred);
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace boost
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Members">Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructor</h3>
|
||||||
<pre>
|
<pre>
|
||||||
condition();
|
condition();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> Constructs a <code>condition</code> object.</dt>
|
<p><b>Effects:</b> Constructs a <code>condition</code>.</p>
|
||||||
</dl>
|
<hr>
|
||||||
|
|
||||||
|
<h3>Destructor</h3>
|
||||||
<pre>
|
<pre>
|
||||||
~condition();
|
~condition();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> Destroys <code>*this</code>.</dt>
|
<p><b>Effects:</b> Destroys <code>*this</code>.</p>
|
||||||
</dl>
|
<hr>
|
||||||
<h4><a name="class-condition-modifiers"></a>Class <code>condition</code> modifier
|
|
||||||
functions</h4>
|
<h3>notify_one</h3>
|
||||||
<pre>
|
<pre>
|
||||||
void notify_one();
|
void notify_one();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> If there is a thread waiting on <code>*this</code>, change
|
<p><b>Effects:</b> If there is a thread waiting on <code>*this</code>,
|
||||||
that thread's state to ready. Otherwise there is no effect.</dt>
|
change that thread's state to ready. Otherwise there is no
|
||||||
<dt><b>Note:</b> If more than one thread is waiting on the condition, it is
|
effect.</p>
|
||||||
unspecified which is made ready. After returning to a ready state the notified
|
|
||||||
thread must still acquire the mutex again (which occurs within the call to
|
<p><b>Notes:</b> If more that one thread is waiting on the condition,
|
||||||
one of the <code>condition</code> object's wait functions).</dt>
|
it is unspecified which is made ready.</p>
|
||||||
</dl>
|
<hr>
|
||||||
|
|
||||||
|
<h3>notify_all</h3>
|
||||||
<pre>
|
<pre>
|
||||||
void notify_all();
|
void notify_all();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> Change the state of all threads waiting on <code> *this</code>
|
<p><b>Effects:</b> Change the state of all threads waiting on <code>
|
||||||
to ready. If there are no waiting threads, <code> notify_all()</code> has
|
*this</code> to ready. If there are no waiting threads, <code>
|
||||||
no effect.</dt>
|
notify_all()</code> has no effect.</p>
|
||||||
</dl>
|
<hr>
|
||||||
|
|
||||||
|
<h3>wait</h3>
|
||||||
<pre>
|
<pre>
|
||||||
template <typename ScopedLock>
|
template <typename ScopedLock>
|
||||||
void wait(ScopedLock& lock);
|
void wait(ScopedLock& lock);
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> <code>ScopedLock</code> meets the <a href="lock_concept.html#ScopedLock">ScopedLock</a>
|
<p><b>Requires:</b> ScopedLock meets the <a href=
|
||||||
requirements.</dt>
|
"lock_concept.html#ScopedLock">ScopedLock</a> requirements.</p>
|
||||||
<dt><b>Effects:</b> Releases the lock on the <a href="mutex_concept.html">mutex
|
|
||||||
model</a> associated with <code>lock</code>, blocks the current thread of
|
<p><b>Effects:</b> Releases the lock on the <a href=
|
||||||
execution until readied by a call to <code>this->notify_one()</code> or
|
"mutex_concept.html">mutex model</a> associated with <code>lock</code>,
|
||||||
<code> this->notify_all()</code>, and then reacquires the lock.</dt>
|
blocks the current thread of execution until readied by a call to
|
||||||
<dt><b>Throws:</b> <code><a href="exceptions.html#class-lock_error">lock_error</a></code>
|
<code>this->notify_one()</code> or <code>
|
||||||
if <code>!lock.locked()</code></dt>
|
this->notify_all()</code>, and then reacquires the lock. All effects
|
||||||
<dt><b>Danger:</b> This version should always be used within a loop checking
|
occur in an atomic fashion.</p>
|
||||||
that the state logically associated with the <code>condition</code> has become
|
|
||||||
true. Without the loop, race conditions can ensue due to possible "spurious
|
<p><b>Throws:</b> <code><a href="lock_error.html">lock_error</a></code>
|
||||||
wake ups". The second version encapsulates this loop idiom internally
|
if <code>!lock.locked()</code></p>
|
||||||
and is generally the preferred method.</dt>
|
|
||||||
</dl>
|
<p><b>Danger:</b> This version should always be used within a loop
|
||||||
|
checking that the state logically associated with the <code>
|
||||||
|
condition</code> has become true. Without the loop, race conditions can
|
||||||
|
ensue due to possible "spurious wake ups". The second version
|
||||||
|
encapsulates this loop idiom internally and is generally the preferred
|
||||||
|
method.</p>
|
||||||
<pre>
|
<pre>
|
||||||
Template<typename ScopedLock, typename Pr>
|
template <typename ScopedLock, typename Pr>
|
||||||
void wait(ScopedLock& lock, Pr pred);
|
void wait(ScopedLock& lock, Pr pred);
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> <code>ScopedLock</code> meets the <a href="lock_concept.html#ScopedLock">ScopedLock</a>
|
<p><b>Requires:</b> ScopedLock meets the <a href=
|
||||||
requirements, return from <code>pred()</code> convertible to bool.</dt>
|
"lock_concept.html#ScopedLock">ScopedLock</a> requirements, return from
|
||||||
<dt><b>Effects:</b> As if: <code>while (!pred()) wait(lock)</code></dt>
|
<code>pred()</code> convertible to bool.</p>
|
||||||
<dt><b>Throws:</b> <code><a href="exceptions.html#class-lock_error">lock_error</a></code>
|
|
||||||
if <code>!lock.locked()</code></dt>
|
<p><b>Effects:</b> As if:</p>
|
||||||
</dl>
|
<code> while (!pred()) wait(lock)</code>
|
||||||
|
|
||||||
|
<p><b>Throws:</b> <code><a href="lock_error.html">lock_error</a></code>
|
||||||
|
if <code>!lock.locked()</code></p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>timed_wait</h3>
|
||||||
<pre>
|
<pre>
|
||||||
template <typename ScopedLock>
|
template <typename ScopedLock>
|
||||||
bool timed_wait(ScopedLock& lock, const <a href="xtime.html">xtime</a>& XT);
|
bool timed_wait(ScopedLock& lock, const <a href=
|
||||||
|
"xtime.html">xtime</a>& xt);
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> <code>ScopedLock</code> meets the <a href="lock_concept.html#ScopedLock">ScopedLock</a>
|
<p><b>Requires:</b> ScopedLock meets the <a href=
|
||||||
requirements.</dt>
|
"lock_concept.html#ScopedLock">ScopedLock</a>
|
||||||
<dt><b>Effects:</b> Releases the lock on the <a href="mutex_concept.html">mutex
|
requirements.</p>
|
||||||
model</a> associated with the <code> lock</code>, blocks the current thread
|
|
||||||
of execution until readied by a call to <code>this->notify_one()</code>
|
<p><b>Effects:</b> Releases the lock on the <a href=
|
||||||
or <code> this->notify_all()</code>, or until <code>XT</code>, and then
|
"mutex_concept.html">mutex model</a> associated with the <code>
|
||||||
reacquires the lock.</dt>
|
lock</code>, blocks the current thread of execution until readied by a
|
||||||
<dt><b>Returns:</b> <code>false</code> if <code>XT</code> is reached, otherwise
|
call to <code>this->notify_one()</code> or <code>
|
||||||
<code>true</code>.</dt>
|
this->notify_all()</code>, or until <code>xt</code>, and then
|
||||||
<dt><b>Throws:</b> <code><a href="exceptions.html#class-lock_error">lock_error</a></code>
|
reacquires the lock. All effects occur in an atomic fashion.</p>
|
||||||
if <code>!lock.locked()</code></dt>
|
|
||||||
<dt><b>Danger:</b> This version should always be used within a loop checking
|
<p><b>Throws:</b> <code><a href="lock_error.html">lock_error</a></code>
|
||||||
that the state logically associated with the <code>condition</code> has become
|
if <code>!lock.locked()</code></p>
|
||||||
true. Without the loop, race conditions can ensue due to "spurious wake
|
|
||||||
ups". The second version encapsulates this loop idiom internally and
|
<p><b>Danger:</b> This version should always be used within a loop
|
||||||
is generally the preferred method.</dt>
|
checking that the state logically associated with the <code>
|
||||||
</dl>
|
condition</code> has become true. Without the loop, race conditions can
|
||||||
|
ensue due to "spurious wake ups". The second version
|
||||||
|
encapsulates this loop idiom internally and is generally the preferred
|
||||||
|
method.</p>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> <code>false</code> if <code>xt</code> is reached,
|
||||||
|
otherwise <code>true</code>.</p>
|
||||||
<pre>
|
<pre>
|
||||||
Template<typename ScopedLock, typename Pr>
|
template <typename ScopedLock, typename Pr>
|
||||||
bool timed_wait(ScopedLock& lock, const <a href="xtime.html">xtime</a>& XT, Pr pred);
|
bool timed_wait(ScopedLock& lock, const <a href=
|
||||||
|
"xtime.html">xtime</a>& xt, Pr pred);
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> <code>ScopedLock</code> meets the <a href="lock_concept.html#ScopedLock">ScopedLock</a>
|
<p><b>Requires:</b> ScopedLock meets the <a href=
|
||||||
requirements, return from <code>pred()</code> convertible to bool.</dt>
|
"lock_concept.html#ScopedLock">ScopedLock</a> requirements,
|
||||||
<dt><b>Effects:</b> As if:<br>
|
return from <code>pred()</code> convertible to bool.</p>
|
||||||
<pre>
|
|
||||||
while (!pred())
|
<p><b>Effects:</b> As if:</p>
|
||||||
{
|
<code> while (!pred())<br>
|
||||||
if (!timed_wait(lock, XT))
|
{<br>
|
||||||
return false;
|
if (!timed_wait(lock, xt))<br>
|
||||||
}
|
return
|
||||||
return true;
|
false;<br>
|
||||||
</pre>
|
}</code>
|
||||||
</dt>
|
|
||||||
<dt><b>Returns:</b> <code>false</code> if <code>XT</code> is reached, otherwise
|
<p><b>Throws:</b> <code><a href="lock_error.html">lock_error</a></code>
|
||||||
<code>true</code>.</dt>
|
if <code>!lock.locked()</code></p>
|
||||||
<dt><b>Throws:</b> <code><a href="exceptions.html#class-lock_error">lock_error</a></code>
|
|
||||||
if <code>!lock.locked()</code></dt>
|
<p><b>Returns:</b> <code>false</code> if <code>xt</code> is reached,
|
||||||
</dl>
|
otherwise <code>true</code>.</p>
|
||||||
<h2><a name="examples"></a>Example(s)</h2>
|
<hr>
|
||||||
|
|
||||||
|
<h2><a name="Example">Example Usage</a></h2>
|
||||||
<pre>
|
<pre>
|
||||||
#include <iostream>
|
#include <iostream>
|
||||||
#include <vector>
|
#include <vector>
|
||||||
#include <a href="../../../boost/utility.hpp"><boost/utility.hpp></a>
|
#include <a href="../../../boost/utility.hpp"><boost/utility.hpp></a>
|
||||||
#include <a href="../../../boost/thread/condition.hpp"><boost/thread/condition.hpp></a>
|
#include <a href=
|
||||||
#include <a href="../../../boost/thread/thread.hpp"><boost/thread/thread.hpp></a>
|
"../../../boost/thread/condition.hpp"><boost/thread/condition.hpp></a>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/thread.hpp"><boost/thread/thread.hpp></a>
|
||||||
|
|
||||||
class bounded_buffer : private boost::noncopyable
|
class bounded_buffer : private boost::noncopyable
|
||||||
{
|
{
|
||||||
@@ -264,7 +312,8 @@ int main(int, char*[])
|
|||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<p>Typical output (dependent on scheduling policies) is:</p>
|
|
||||||
|
<p>Typical output (dependent on scheduling policies) is:</p>
|
||||||
<pre>
|
<pre>
|
||||||
sent: 0
|
sent: 0
|
||||||
sent: 1
|
sent: 1
|
||||||
@@ -277,18 +326,13 @@ received: 3
|
|||||||
sent: 4
|
sent: 4
|
||||||
received: 4
|
received: 4
|
||||||
</pre>
|
</pre>
|
||||||
<p>Revised
|
<hr>
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
|
||||||
05 November, 2001
|
<p>Revised
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
</p>
|
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
All Rights Reserved.</i></p>
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
</body>
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
|
||||||
makes no representations about the suitability of this software for any purpose.
|
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|||||||
97
doc/config.html
Normal file
97
doc/config.html
Normal file
@@ -0,0 +1,97 @@
|
|||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content=
|
||||||
|
"text/html; charset=iso-8859-1">
|
||||||
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
|
|
||||||
|
<title>Boost.Threads, Configuration Information</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
|
width="100%">
|
||||||
|
<tr>
|
||||||
|
<td valign="top" width="300">
|
||||||
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
|
"277" height="86"></h3>
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td valign="top">
|
||||||
|
<h1 align="center">Boost.Threads</h1>
|
||||||
|
|
||||||
|
<h2 align="center">Configuration Information</h2>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p><b>Boost.Threads</b> uses several configuration macros in <a href=
|
||||||
|
"../../config/config.htm"><boost/config.hpp></a>. These macros
|
||||||
|
are documented here. Most of the macros are of interest only to
|
||||||
|
developers attempting to provide new implementations of <b>
|
||||||
|
Boost.Threads</b>. The one exception to this is BOOST_HAS_THREADS.</p>
|
||||||
|
|
||||||
|
<table summary="macros" cellspacing="10" width="100%">
|
||||||
|
<tr>
|
||||||
|
<td valign="top"><b>Macro</b> </td>
|
||||||
|
|
||||||
|
<td valign="top"><b>Meaning</b> </td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td valign="top">BOOST_HAS_THREADS</td>
|
||||||
|
|
||||||
|
<td valign="top">Indicates that threading support is available.
|
||||||
|
This means both that there is a platform specific
|
||||||
|
implementation for <b>Boost.Threads</b> and that threading
|
||||||
|
support has been enabled in a platform specific manner. For
|
||||||
|
instance, on the Win32 platform there's an implementation
|
||||||
|
for <b>Boost.Threads</b> but unless the program is compiled
|
||||||
|
against one of the multi-threading runtimes (often determined
|
||||||
|
by the compiler predefining the macro _MT) the
|
||||||
|
BOOST_HAS_THREADS macro remains undefined.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td valign="top">BOOST_HAS_WINTHREADS</td>
|
||||||
|
|
||||||
|
<td valign="top">Indicates that the platform has the Microsoft
|
||||||
|
Win32 threading libraries, and that they should be used to
|
||||||
|
implement <b>Boost.Threads</b>.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td valign="top">BOOST_HAS_PTHREADS</td>
|
||||||
|
|
||||||
|
<td valign="top">Indicates that the platform has the POSIX
|
||||||
|
pthreads libraries, and that they should be used to implement
|
||||||
|
<b>Boost.Threads</b>.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td valign="top">BOOST_HAS_FTIME</td>
|
||||||
|
|
||||||
|
<td valign="top">Indicates that the implementation should use
|
||||||
|
GetSystemTimeAsFileTime() and the FILETIME type to calculate
|
||||||
|
the current time. This is an implementation detail used by
|
||||||
|
boost::detail::getcurtime().</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td valign="top">BOOST_HAS_GETTTIMEOFDAY</td>
|
||||||
|
|
||||||
|
<td valign="top">Indicates that the implementation should use
|
||||||
|
gettimeofday() to calculate the current time. This is an
|
||||||
|
implementation detail used by boost::detail::getcurtime().</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
@@ -1,94 +0,0 @@
|
|||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
|
||||||
<title>Boost.Threads - Configuration</title>
|
|
||||||
</head>
|
|
||||||
<body link="#0000ff" vlink="#800080">
|
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
|
||||||
"header">
|
|
||||||
<tr>
|
|
||||||
<td valign="top" width="300">
|
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
|
||||||
</td>
|
|
||||||
<td valign="top">
|
|
||||||
<h1 align="center">Boost.Threads</h1>
|
|
||||||
<h2 align="center">Configuration</h2>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<hr>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#introduction">Introduction</a></dt>
|
|
||||||
<dt><a href="#lib-defined-public">Public Library Defined Macros</a></dt>
|
|
||||||
<dt><a href="#lib-defined-impl">Library Defined Implementation Macros</a></dt>
|
|
||||||
</dl>
|
|
||||||
<h2><a name="introduction"></a>Introduction</h2>
|
|
||||||
<p><b>Boost.Threads</b> uses several configuration macros in <a href="../../config/config.htm"><boost/config.hpp></a>,
|
|
||||||
as well as configuration macros meant to be supplied by the application. These
|
|
||||||
macros are documented here.</p>
|
|
||||||
<h2><a name="lib-defined-public"></a>Public Library Defined Macros</h2>
|
|
||||||
<p>These macros are defined by <b>Boost.Threads</b> but are expected to be used
|
|
||||||
by application code.</p>
|
|
||||||
<table summary="public library defined macros" cellspacing="10" width="100%">
|
|
||||||
<tr>
|
|
||||||
<td><b>Macro</b></td>
|
|
||||||
<td><b>Meaning</b></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>BOOST_HAS_THREADS</td>
|
|
||||||
<td>Indicates that threading support is available. This means both that there
|
|
||||||
is a platform specific implementation for <b>Boost.Threads</b> and that
|
|
||||||
threading support has been enabled in a platform specific manner. For instance,
|
|
||||||
on the Win32 platform there's an implementation for <b>Boost.Threads</b>
|
|
||||||
but unless the program is compiled against one of the multithreading runtimes
|
|
||||||
(often determined by the compiler predefining the macro _MT) the BOOST_HAS_THREADS
|
|
||||||
macro remains undefined.</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<h2><a name="lib-defined-impl"></a>Library Defined Implementation Macros</h2>
|
|
||||||
<p>These macros are defined by <b>Boost.Threads</b> and are implementation details
|
|
||||||
of interest only to implementors.</p>
|
|
||||||
<table summary="library defined implementation macros" cellspacing="10" width="100%">
|
|
||||||
<tr>
|
|
||||||
<td><b>Macro</b></td>
|
|
||||||
<td><b>Meaning</b></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>BOOST_HAS_WINTHREADS</td>
|
|
||||||
<td>Indicates that the platform has the Microsoft Win32 threading libraries,
|
|
||||||
and that they should be used to implement <b>Boost.Threads</b>.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>BOOST_HAS_PTHREADS</td>
|
|
||||||
<td>Indicates that the platform has the POSIX pthreads libraries, and that
|
|
||||||
they should be used to implement <b>Boost.Threads</b>.</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>BOOST_HAS_FTIME</td>
|
|
||||||
<td>Indicates that the implementation should use GetSystemTimeAsFileTime()
|
|
||||||
and the FILETIME type to calculate the current time. This is an implementation
|
|
||||||
detail used by boost::detail::getcurtime().</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>BOOST_HAS_GETTTIMEOFDAY</td>
|
|
||||||
<td>Indicates that the implementation should use gettimeofday() to calculate
|
|
||||||
the current time. This is an implementation detail used by boost::detail::getcurtime().</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<hr>
|
|
||||||
<p>Revised
|
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
|
||||||
05 November, 2001
|
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
|
||||||
</p>
|
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
|
||||||
All Rights Reserved.</i></p>
|
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
|
||||||
makes no representations about the suitability of this software for any purpose.
|
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,263 +1,348 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Language" content="en-us">
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
<meta http-equiv="Content-Type" content=
|
||||||
<title>Boost.Threads - Definitions</title>
|
"text/html; charset=windows-1252">
|
||||||
</head>
|
<meta name="GENERATOR" content="Microsoft FrontPage 4.0">
|
||||||
<body link="#0000ff" vlink="#800080">
|
<meta name="ProgId" content="FrontPage.Editor.Document">
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
|
||||||
"header">
|
<title>Boost.Threads Definitions</title>
|
||||||
<tr>
|
</head>
|
||||||
<td valign="top" width="300">
|
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
<body bgcolor="#FFFFFF">
|
||||||
</td>
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
<td valign="top">
|
width="100%">
|
||||||
<h1 align="center">Boost.Threads</h1>
|
<tr>
|
||||||
<h2 align="center">Definitions</h2>
|
<td valign="top" width="300">
|
||||||
</td>
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
</tr>
|
"277" height="86"></h3>
|
||||||
</table>
|
</td>
|
||||||
<hr>
|
|
||||||
<h2>Contents</h2>
|
<td valign="top">
|
||||||
<dl class="page-index">
|
<h1 align="center">Boost.Threads</h1>
|
||||||
<dt><a href="#introduction">Introduction</a></dt>
|
|
||||||
<dt><a href="#definitions">Definitions</a></dt>
|
<h2 align="center">Definitions</h2>
|
||||||
<dl class="page-index">
|
</td>
|
||||||
<dt><a href="#definition-thread">Thread</a></dt>
|
</tr>
|
||||||
<dt><a href="#definition-thread-safe">Thread-safe</a></dt>
|
</table>
|
||||||
<dt><a href="#definition-thread-state">Thread State</a></dt>
|
|
||||||
<dt><a href="#definition-race-condition">Race Condition</a></dt>
|
<h2>Introduction</h2>
|
||||||
<dt><a href="#definition-deadlock">Deadlock</a></dt>
|
|
||||||
<dt><a href="#definition-starvation">Starvation</a></dt>
|
<p>The definitions are given in terms of the <a href=
|
||||||
<dt><a href="#definition-priority-failure">Priority Failure</a></dt>
|
"bibliography.html#ISO-98">C++ Standard</a>. References to the standard
|
||||||
<dt><a href="#definition-visibility">Memory Visibility</a></dt>
|
are in the form [1.2.3/4], which represents the section number, with
|
||||||
</dl>
|
the paragraph number following the "/".</p>
|
||||||
<dt><a href="#acknowledgements">Acknowledgments</a></dt>
|
|
||||||
</dl>
|
<p>Because the definitions are written in something akin to
|
||||||
<hr>
|
"standardese", they can be difficult to understand. The
|
||||||
<h2><a name="introduction"></a>Introduction</h2>
|
intent isn't to confuse, but rather to clarify the additional
|
||||||
<p>The definitions are given in terms of the <a href=
|
requirements Boost.Threads places on a C++ implementation as defined by
|
||||||
"bibliography.html#ISO-98">C++ Standard</a>. References to the standard
|
the C++ Standard.</p>
|
||||||
are in the form [1.2.3/4], which represents the section number, with the paragraph
|
|
||||||
number following the "/".</p>
|
<h2>Definitions</h2>
|
||||||
<p>Because the definitions are written in something akin to "standardese",
|
|
||||||
they can be difficult to understand. The intent isn't to confuse, but rather
|
<h3>Thread</h3>
|
||||||
to clarify the additional requirements Boost.Threads places on a C++ implementation
|
|
||||||
as defined by the C++ Standard.</p>
|
<p>Thread is short for "thread of execution". A thread of
|
||||||
<h2><a name="definitions"></a>Definitions</h2>
|
execution is an execution environment [1.9/7] within the execution
|
||||||
<h3><a name="definition-thread"></a>Thread</h3>
|
environment of a C++ program [1.9]. The main() function [3.6.1] of the
|
||||||
<p>Thread is short for "thread of execution". A thread of execution
|
program is the initial function of the initial thread. A program in a
|
||||||
is an execution environment [1.9/7] within the execution environment of a C++
|
multi-threading environment always has an initial thread even if the
|
||||||
program [1.9]. The main() function [3.6.1] of the program is the initial function
|
program explicitly creates no additional threads.</p>
|
||||||
of the initial thread. A program in a multithreading environment always has
|
|
||||||
an initial thread even if the program explicitly creates no additional threads.</p>
|
<p>Unless otherwise specified, each thread shares all aspects of its
|
||||||
<p>Unless otherwise specified, each thread shares all aspects of its execution
|
execution environment with other threads in the program. Shared aspects
|
||||||
environment with other threads in the program. Shared aspects of the execution
|
of the execution environment include, but are not limited to, the
|
||||||
environment include, but are not limited to, the following:</p>
|
following:</p>
|
||||||
<ul>
|
|
||||||
<li>Static storage duration (static, extern) objects [3.7.1].</li>
|
<ul>
|
||||||
</ul>
|
<li>Static storage duration (static, extern) objects [3.7.1].</li>
|
||||||
<ul>
|
</ul>
|
||||||
<li>Dynamic storage duration (heap) objects [3.7.3]. Thus each memory allocation
|
|
||||||
will return a unique addresses, regardless of the thread making the allocation
|
<ul>
|
||||||
request.</li>
|
<li>Dynamic storage duration (heap) objects [3.7.3]. Thus each
|
||||||
</ul>
|
memory allocation will return a unique addresses, regardless of the
|
||||||
<ul>
|
thread making the allocation request.</li>
|
||||||
<li>Automatic storage duration (stack) objects [3.7.2] accessed via pointer
|
</ul>
|
||||||
or reference from another thread.</li>
|
|
||||||
</ul>
|
<ul>
|
||||||
<ul>
|
<li>Automatic storage duration (stack) objects [3.7.2] accessed via
|
||||||
<li>Resources provided by the operating system. For example, files.</li>
|
pointer or reference from another thread.</li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul>
|
|
||||||
<li>The program itself. In other words, each thread is executing some function
|
<ul>
|
||||||
of the same program, not a totally different program.</li>
|
<li>Resources provided by the operating system. For example,
|
||||||
</ul>
|
files.</li>
|
||||||
<p>Each thread has its own:</p>
|
</ul>
|
||||||
<ul>
|
|
||||||
<li>Registers and current execution sequence (program counter) [1.9/5].</li>
|
<ul>
|
||||||
</ul>
|
<li>The program itself. In other words, each thread is executing
|
||||||
<ul>
|
some function of the same program, not a totally different
|
||||||
<li>Automatic storage duration (stack) objects [3.7.2].</li>
|
program.</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h3><a name="definition-thread-safe"></a>Thread-safe</h3>
|
|
||||||
<p>A program is thread-safe if it has no <a href="#Race condition">race conditions</a>,
|
<p>Each thread has its own:</p>
|
||||||
does not <a href="#Deadlock">deadlock</a>, and has no <a href="#Priority failure">priority
|
|
||||||
failures</a>.</p>
|
<ul>
|
||||||
<p>Note that thread-safety does not necessarily imply efficiency, and than while
|
<li>Registers and current execution sequence (program counter)
|
||||||
some thread-safety violations can be determined statically at compile time,
|
[1.9/5].</li>
|
||||||
many thread-safety errors can only only be detected at runtime.</p>
|
</ul>
|
||||||
<h3><a name="definition-thread-state"></a>Thread State</h3>
|
|
||||||
<p>During the lifetime of a thread, it shall be in one of the following states:</p>
|
<ul>
|
||||||
<table summary="thread states" border="1" cellpadding="5">
|
<li>Automatic storage duration (stack) objects [3.7.2].</li>
|
||||||
<tr>
|
</ul>
|
||||||
<td><b>State</b></td>
|
|
||||||
<td><b>Description</b></td>
|
<h3><a name="Thread-safe">Thread-safe</a></h3>
|
||||||
</tr>
|
|
||||||
<tr>
|
<p>A program is thread-safe if it has no <a href="#Race condition">race
|
||||||
<td>Ready</td>
|
conditions</a>, does not <a href="#Deadlock">deadlock</a>, and has no
|
||||||
<td>Ready to run, but waiting for a processor.</td>
|
<a href="#Priority failure">priority failures</a>.</p>
|
||||||
</tr>
|
|
||||||
<tr>
|
<p>Note that thread-safety does not necessarily imply efficiency, and
|
||||||
<td>Running</td>
|
than while some thread-safety violations can be determined statically
|
||||||
<td>Currently executing on a processor. Zero or more threads may be running
|
at compile time, many thread-safety errors can only only be detected at
|
||||||
at any time, with a maximum equal to the number of processors.</td>
|
runtime.</p>
|
||||||
</tr>
|
|
||||||
<tr>
|
<h3>Thread <a name="State">State</a></h3>
|
||||||
<td>Blocked</td>
|
|
||||||
<td>Waiting for some resource other than a processor which is not currently
|
<p>During the lifetime of a thread, it shall be in one of the following
|
||||||
available, or for the completion of calls to library functions [1.9/6].
|
states:</p>
|
||||||
The term "waiting" is synonymous for "blocked"</td>
|
|
||||||
</tr>
|
<table summary="thread states" border="1" cellpadding="5">
|
||||||
<tr>
|
<tr>
|
||||||
<td>Terminated</td>
|
<td><b>State</b></td>
|
||||||
<td>Finished execution but not yet detached or joined.</td>
|
|
||||||
</tr>
|
<td><b>Description</b></td>
|
||||||
</table>
|
</tr>
|
||||||
<p>Thread state transitions shall occur only as specified:</p>
|
|
||||||
<table summary="state transitions" border="1" cellpadding="5">
|
<tr>
|
||||||
<tr>
|
<td>Ready</td>
|
||||||
<td><b>From</b></td>
|
|
||||||
<td><b>To</b></td>
|
<td>Ready to run, but waiting for a processor.</td>
|
||||||
<td><b>Cause</b></td>
|
</tr>
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td>
|
<td>Running</td>
|
||||||
<p align="left">[none]</p>
|
|
||||||
</td>
|
<td>Currently executing on a processor. Zero or more threads
|
||||||
<td>Ready</td>
|
may be running at any time, with a maximum equal to the number
|
||||||
<td>Thread is created by a call to a library function. In the case of the
|
of processors.</td>
|
||||||
initial thread, creation is implicit and occurs during the startup of the
|
</tr>
|
||||||
main() function [3.6.1].</td>
|
|
||||||
</tr>
|
<tr>
|
||||||
<tr>
|
<td>Blocked</td>
|
||||||
<td>Ready</td>
|
|
||||||
<td>Running</td>
|
<td>Waiting for some resource other than a processor which is
|
||||||
<td>Processor becomes available.</td>
|
not currently available, or for the completion of calls to
|
||||||
</tr>
|
library functions [1.9/6]. The term "waiting" is
|
||||||
<tr>
|
synonymous for "blocked"</td>
|
||||||
<td>Running</td>
|
</tr>
|
||||||
<td>Ready</td>
|
|
||||||
<td>Thread preempted.</td>
|
<tr>
|
||||||
</tr>
|
<td>Terminated</td>
|
||||||
<tr>
|
|
||||||
<td>Running</td>
|
<td>Finished execution but not yet detached or joined.</td>
|
||||||
<td>Blocked</td>
|
</tr>
|
||||||
<td>Thread calls a library function which waits for a resource or for the
|
</table>
|
||||||
completion of I/O.</td>
|
|
||||||
</tr>
|
<p>Thread state transitions shall occur only as specified:</p>
|
||||||
<tr>
|
|
||||||
<td>Running</td>
|
<table summary="state transitions" border="1" cellpadding="5">
|
||||||
<td>Terminated</td>
|
<tr>
|
||||||
<td>Thread returns from its initial function, calls a thread termination library
|
<td><b>From</b></td>
|
||||||
function, or is canceled by some other thread calling a thread termination
|
|
||||||
library function.</td>
|
<td><b>To</b></td>
|
||||||
</tr>
|
|
||||||
<tr>
|
<td><b>Cause</b></td>
|
||||||
<td>Blocked</td>
|
</tr>
|
||||||
<td>Ready</td>
|
|
||||||
<td>The resource being waited for becomes available, or the blocking library
|
<tr>
|
||||||
function completes.</td>
|
<td>
|
||||||
</tr>
|
<p align="left">[none]</p>
|
||||||
<tr>
|
</td>
|
||||||
<td>Terminated</td>
|
|
||||||
<td>[none]</td>
|
<td>Ready</td>
|
||||||
<td>Thread is detached or joined by some other thread calling the appropriate
|
|
||||||
library function, or by program termination [3.6.3].</td>
|
<td>Thread is created by a call to a library function. In the
|
||||||
</tr>
|
case of the initial thread, creation is implicit and occurs
|
||||||
</table>
|
during the startup of the main() function [3.6.1].</td>
|
||||||
<p>[Note: if a suspend() function is added to the threading library, additional
|
</tr>
|
||||||
transitions to the blocked state will have to be added to the above table.]</p>
|
|
||||||
<h3><a name="definition-race-condition"></a>Race Condition</h3>
|
<tr>
|
||||||
<p>A race condition is what occurs when multiple threads read and write to the
|
<td>Ready</td>
|
||||||
same memory without proper synchronization, resulting in an incorrect value
|
|
||||||
being read or written. The result of a race condition may be a bit pattern which
|
<td>Running</td>
|
||||||
isn't even a valid value for the data type. A race condition results in
|
|
||||||
undefined behavior [1.3.12].</p>
|
<td>Processor becomes available.</td>
|
||||||
<p>Race conditions can be prevented by serializing memory access using the tools
|
</tr>
|
||||||
provided by Boost.Threads.</p>
|
|
||||||
<h3><a name="definition-deadlock"></a>Deadlock</h3>
|
<tr>
|
||||||
<p>Deadlock is an execution state where for some set of threads, each thread in
|
<td>Running</td>
|
||||||
the set is blocked waiting for some action by one of the other threads in the
|
|
||||||
set. Since each is waiting on the others, none will ever become ready again.</p>
|
<td>Ready</td>
|
||||||
<h3><a name="definition-starvation"></a>Starvation</h3>
|
|
||||||
<p>The condition in which a thread is not making sufficient progress in its work
|
<td>Thread preempted.</td>
|
||||||
during a given time interval.</p>
|
</tr>
|
||||||
<h3><a name="definition-priority-failure"></a>Priority Failure</h3>
|
|
||||||
<p>A priority failure (such as priority inversion or infinite overtaking) occurs
|
<tr>
|
||||||
when threads executed in such a sequence that required work is not performed
|
<td>Running</td>
|
||||||
in time to be useful.</p>
|
|
||||||
<h3><a name="definition-visibility"></a>Memory Visibility</h3>
|
<td>Blocked</td>
|
||||||
<p>An address [1.7] shall always point to the same memory byte, regardless of
|
|
||||||
the thread or processor dereferencing the address.</p>
|
<td>Thread calls a library function which waits for a resource
|
||||||
<p>An object [1.8, 1.9] is accessible from multiple threads if it is of static
|
or for the completion of I/O.</td>
|
||||||
storage duration (static, extern) [3.7.1], or if a pointer or reference to it
|
</tr>
|
||||||
is explicitly or implicitly dereferenced in multiple threads.</p>
|
|
||||||
<p>For an object accessible from multiple threads, the value of the object accessed
|
<tr>
|
||||||
from one thread may be indeterminate or different than the value accessed from
|
<td>Running</td>
|
||||||
another thread, except under the conditions specified in the following table.
|
|
||||||
For the same row of the table, the value of an object accessible at the indicated
|
<td>Terminated</td>
|
||||||
sequence point in thread A will be determinate and the same if accessed at or
|
|
||||||
after the indicated sequence point in thread B, provided the object is not otherwise
|
<td>Thread returns from its initial function, calls a thread
|
||||||
modified. In the table, the "sequence point at a call" is the sequence
|
termination library function, or is cancelled by some other
|
||||||
point after the evaluation of all function arguments [1.9/17], while the "sequence
|
thread calling a thread termination library function.</td>
|
||||||
point after a call" is the sequence point after the copying of the returned
|
</tr>
|
||||||
value..." [1.9/17].</p>
|
|
||||||
<table summary="memory visibility" border="1" cellpadding="5">
|
<tr>
|
||||||
<tr>
|
<td>Blocked</td>
|
||||||
<td align="center"><b>Thread A</b></td>
|
|
||||||
<td align="center"><b>Thread B</b></td>
|
<td>Ready</td>
|
||||||
</tr>
|
|
||||||
<tr>
|
<td>The resource being waited for becomes available, or the
|
||||||
<td>The sequence point at a call to a library thread-creation function.</td>
|
blocking library function completes.</td>
|
||||||
<td>The first sequence point of the initial function in the new thread created
|
</tr>
|
||||||
by the Thread A call.</td>
|
|
||||||
</tr>
|
<tr>
|
||||||
<tr>
|
<td>Terminated</td>
|
||||||
<td>The sequence point at a call to a library function which locks a mutex,
|
|
||||||
directly or by waiting for a condition variable.</td>
|
<td>[none]</td>
|
||||||
<td>The sequence point after a call to a library function which unlocks the
|
|
||||||
same mutex.</td>
|
<td>Thread is detached or joined by some other thread calling
|
||||||
</tr>
|
the appropriate library function, or by program termination
|
||||||
<tr>
|
[3.6.3].</td>
|
||||||
<td>The last sequence point before thread termination.</td>
|
</tr>
|
||||||
<td>The sequence point after a call to a library function which joins the
|
</table>
|
||||||
terminated thread.</td>
|
|
||||||
</tr>
|
<p>[Note: if a suspend() function is added to the threading library,
|
||||||
<tr>
|
additional transitions to the blocked state will have to be added to
|
||||||
<td>The sequence point at a call to a library function which signals or broadcasts
|
the above table.]</p>
|
||||||
a condition variable.</td>
|
|
||||||
<td>The sequence point after the call to the library function which was waiting
|
<h3><a name="Race condition">Race condition</a></h3>
|
||||||
on that same condition variable or signal.</td>
|
|
||||||
</tr>
|
<p>A race condition is what occurs when multiple threads read and write
|
||||||
</table>
|
to the same memory without proper synchronization, resulting in an
|
||||||
<p>The architecture of the execution environment and the observable behavior of
|
incorrect value being read or written. The result of a race condition
|
||||||
the abstract machine [1.9] shall be the same on all processors.</p>
|
may be a bit pattern which isn't even a valid value for the data
|
||||||
<p>The latitude granted by the C++ standard for an implementation to alter the
|
type. A race condition results in undefined behavior [1.3.12].</p>
|
||||||
definition of observable behavior of the abstract machine to include additional
|
|
||||||
library I/O functions [1.9/6] is extended to include threading library functions.</p>
|
<p>Race conditions can be prevented by serializing memory access using
|
||||||
<p>When an exception is thrown and there is no matching exception handler in the
|
the tools provided by Boost.Threads.</p>
|
||||||
same thread, behavior is undefined. The preferred behavior is the same as when
|
|
||||||
there is no matching exception handler in a program [15.3/9]. That is, terminate()
|
<h3><a name="Deadlock">Deadlock</a></h3>
|
||||||
is called, and it is implementation defined whether or not the stack is unwound.</p>
|
|
||||||
<h2><a name="acknowledgements"></a>Acknowledgments</h2>
|
<p>Deadlock is an execution state where for some set of threads, each
|
||||||
<p>This document has been much improved by the incorporation of comments from
|
thread in the set is blocked waiting for some action by one of the
|
||||||
William Kempf.</p>
|
other threads in the set. Since each is waiting on the others, none
|
||||||
<p>The visibility rules are based on <a href=
|
will ever become ready again.</p>
|
||||||
|
|
||||||
|
<h3><a name="Priority failure">Priority failure</a></h3>
|
||||||
|
|
||||||
|
<p>A priority failure (such as priority inversion or infinite
|
||||||
|
overtaking) occurs when threads executed in such a sequence that
|
||||||
|
required work is not performed in time to be useful.</p>
|
||||||
|
|
||||||
|
<h2>Memory visibility between threads</h2>
|
||||||
|
|
||||||
|
<p>An address [1.7] shall always point to the same memory byte,
|
||||||
|
regardless of the thread or processor dereferencing the address.</p>
|
||||||
|
|
||||||
|
<p>An object [1.8, 1.9] is accessible from multiple threads if it is of
|
||||||
|
static storage duration (static, extern) [3.7.1], or if a pointer or
|
||||||
|
reference to it is explicitly or implicitly dereferenced in multiple
|
||||||
|
threads.</p>
|
||||||
|
|
||||||
|
<p>For an object accessible from multiple threads, the value of the
|
||||||
|
object accessed from one thread may be indeterminate or different than
|
||||||
|
the value accessed from another thread, except under the conditions
|
||||||
|
specified in the following table. For the same row of the table, the
|
||||||
|
value of an object accessible at the indicated sequence point in thread
|
||||||
|
A will be determinate and the same if accessed at or after the
|
||||||
|
indicated sequence point in thread B, provided the object is not
|
||||||
|
otherwise modified. In the table, the "sequence point at a
|
||||||
|
call" is the sequence point after the evaluation of all function
|
||||||
|
arguments [1.9/17], while the "sequence point after a call"
|
||||||
|
is the sequence point after the copying of the returned value..."
|
||||||
|
[1.9/17].</p>
|
||||||
|
|
||||||
|
<table summary="memory visibility" border="1" cellpadding="5">
|
||||||
|
<tr>
|
||||||
|
<td align="center"><b>Thread A</b></td>
|
||||||
|
|
||||||
|
<td align="center"><b>Thread B</b></td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>The sequence point at a call to a library thread-creation
|
||||||
|
function.</td>
|
||||||
|
|
||||||
|
<td>The first sequence point of the initial function in the new
|
||||||
|
thread created by the Thread A call.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>The sequence point at a call to a library function which
|
||||||
|
locks a mutex, directly or by waiting for a condition
|
||||||
|
variable.</td>
|
||||||
|
|
||||||
|
<td>The sequence point after a call to a library function which
|
||||||
|
unlocks the same mutex.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>The last sequence point before thread termination.</td>
|
||||||
|
|
||||||
|
<td>The sequence point after a call to a library function which
|
||||||
|
joins the terminated thread.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>The sequence point at a call to a library function which
|
||||||
|
signals or broadcasts a condition variable.</td>
|
||||||
|
|
||||||
|
<td>The sequence point after the call to the library function
|
||||||
|
which was waiting on that same condition variable or
|
||||||
|
signal.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<p>The architecture of the execution environment and the observable
|
||||||
|
behavior of the abstract machine [1.9] shall be the same on all
|
||||||
|
processors.</p>
|
||||||
|
|
||||||
|
<p>The latitude granted by the C++ standard for an implementation to
|
||||||
|
alter the definition of observable behavior of the abstract machine to
|
||||||
|
include additional library I/O functions [1.9/6] is extended to include
|
||||||
|
threading library functions.</p>
|
||||||
|
|
||||||
|
<p>When an exception is thrown and there is no matching exception
|
||||||
|
handler in the same thread, behavior is undefined. The preferred
|
||||||
|
behavior is the same as when there is no matching exception handler in
|
||||||
|
a program [15.3/9]. That is, terminate() is called, and it is
|
||||||
|
implementation defined whether or not the stack is unwound.</p>
|
||||||
|
|
||||||
|
<h2><a name="Acknowledgements">Acknowledgements</a></h2>
|
||||||
|
|
||||||
|
<p>This document has been much improved by the incorporation of
|
||||||
|
comments from William Kempf.</p>
|
||||||
|
|
||||||
|
<p>The visibility rules are based on <a href=
|
||||||
"bibliography.html#Butenhof-97">[Butenhof 97]</a>.</p>
|
"bibliography.html#Butenhof-97">[Butenhof 97]</a>.</p>
|
||||||
<hr>
|
<hr>
|
||||||
<p>Revised
|
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
<p>Revised
|
||||||
05 November, 2001
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %b %Y" startspan -->05 Nov 2001<!--webbot bot="Timestamp" endspan i-checksum="15246" --></p>
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
|
||||||
</p>
|
<p>© Copyright Beman Dawes, 2001</p>
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
</body>
|
||||||
All Rights Reserved.</i></p>
|
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
|
||||||
makes no representations about the suitability of this software for any purpose.
|
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|||||||
@@ -1,110 +0,0 @@
|
|||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
|
||||||
<title>Boost.Threads - Header <boost/thread/exceptions.hpp></title>
|
|
||||||
</head>
|
|
||||||
<body link="#0000ff" vlink="#800080">
|
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
|
||||||
"header">
|
|
||||||
<tr>
|
|
||||||
<td valign="top" width="300">
|
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
|
||||||
</td>
|
|
||||||
<td valign="top">
|
|
||||||
<h1 align="center">Boost.Threads</h1>
|
|
||||||
<h2 align="center">Header <<a href="../../../boost/thread/exceptions.hpp">boost/thread/exceptions.hpp</a>></h2>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<hr>
|
|
||||||
<h2>Contents</h2>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#introduction">Introduction</a></dt>
|
|
||||||
<dt><a href="#classes">Classes</a></dt>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#class-lock_error">Class <code>lock_error</code></a></dt>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#class-lock_error-synopsis">Class <code>lock_error</code> synopsis</a></dt>
|
|
||||||
<dt><a href="#class-lock_error-ctors">Class <code>lock_error</code> constructors
|
|
||||||
and destructor</a></dt>
|
|
||||||
</dl>
|
|
||||||
<dt><a href="#class-thread_resource_error">Class <code>thread_resource_error</code></a></dt>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#class-thread_resource_error-synopsis">Class <code>thread_resource_error</code>
|
|
||||||
synopsis</a></dt>
|
|
||||||
<dt><a href="#class-thread_resource_error-ctors">Class <code>thread_resource_error</code>
|
|
||||||
constructors and destructor</a></dt>
|
|
||||||
</dl>
|
|
||||||
</dl>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<h2><a name="introduction"></a>Introduction</h2>
|
|
||||||
<p>Include the header <<a href="../../../boost/thread/exceptions.hpp">boost/thread/exceptions.hpp</a>>
|
|
||||||
to define the exception types that may be thrown by <b>Boost.Threads</b> classes.</p>
|
|
||||||
<h2><a name="classes"></a>Classes</h2>
|
|
||||||
<h3><a name="class-lock_error"></a>Class <code>lock_error</code></h3>
|
|
||||||
<p>The lock_error class defines an exception type thrown to indicate a locking
|
|
||||||
related error has been detected. Examples of such errors include a lock operation
|
|
||||||
which can be determined to result in a deadlock, or unlock operations attempted
|
|
||||||
by a thread that does not own the lock. </p>
|
|
||||||
<h4><a name="class-lock_error-synopsis"></a>Class <code>lock_error</code> synopsis</h4>
|
|
||||||
<pre>
|
|
||||||
namespace boost
|
|
||||||
{
|
|
||||||
class lock_error : public std::logical_error
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
lock_error();
|
|
||||||
};
|
|
||||||
};
|
|
||||||
</pre>
|
|
||||||
<h4><a name="class-lock_error-ctors"></a>Class <code>lock_error</code> constructors
|
|
||||||
and destructor</h4>
|
|
||||||
<pre>
|
|
||||||
lock_error();
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> Constructs a <code>lock_error</code> object.</dt>
|
|
||||||
</dl>
|
|
||||||
<h3><a name="class-thread_resource_error"></a>Class <code>thread_resource_error</code></h3>
|
|
||||||
<p>The thread_resource_error class defines an exception type that is thrown by
|
|
||||||
constructors in the Boost.Threads library when thread related resources can
|
|
||||||
not be acquired. This does not include memory allocation failures which instead
|
|
||||||
throw std::bad_alloc. </p>
|
|
||||||
<h4><a name="class-thread_resource_error-synopsis"></a>Class <code>thread_resource_error</code>
|
|
||||||
synopsis</h4>
|
|
||||||
<pre>
|
|
||||||
namespace boost
|
|
||||||
{
|
|
||||||
class thread_resource_error : public std::runtime_error
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
thread_resource_error();
|
|
||||||
};
|
|
||||||
};
|
|
||||||
</pre>
|
|
||||||
<h4><a name="class-thread_resource_error-ctors"></a>Class <code>thread_resource_error</code>
|
|
||||||
constructors and destructor</h4>
|
|
||||||
<pre>
|
|
||||||
thread_resource_error();
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> Constructs a <code>thread_resource_error</code> object.</dt>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<p>Revised
|
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
|
||||||
05 November, 2001
|
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
|
||||||
</p>
|
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
|
||||||
All Rights Reserved.</i></p>
|
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
|
||||||
makes no representations about the suitability of this software for any purpose.
|
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
278
doc/faq.html
278
doc/faq.html
@@ -1,91 +1,95 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Type" content=
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
"text/html; charset=iso-8859-1">
|
||||||
<title>Boost.Threads - FAQ</title>
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
</head>
|
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||||
<body link="#0000ff" vlink="#800080">
|
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
<title>Boost.Threads, FAQ</title>
|
||||||
"header">
|
</head>
|
||||||
<tr>
|
|
||||||
<td valign="top" width="300">
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
</td>
|
width="100%">
|
||||||
<td valign="top">
|
<tr>
|
||||||
<h1 align="center">Boost.Threads</h1>
|
<td valign="top" width="300">
|
||||||
<h2 align="center">Frequently Asked Questions (FAQs)</h2>
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width="277" height="86"></h3>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
|
||||||
</table>
|
<td valign="top">
|
||||||
<hr>
|
<h1 align="center">Boost.Threads</h1>
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#question1">1. Are lock objects thread safe?</a></dt>
|
<h2 align="center">Frequently Asked Questions</h2>
|
||||||
<dt><a href="#question2a">2a. Why was <b>Boost.Threads</b> modeled after (specific
|
</td>
|
||||||
library name)?</a></dt>
|
</tr>
|
||||||
<dt><a href="#question2b">2b. Why wasn't <b>Boost.Threads</b> modeled after
|
</table>
|
||||||
(specific library name)?</a></dt>
|
<hr>
|
||||||
<dt><a href="#question3">3. Why do mutexes have noncopyable semantics?</a></dt>
|
|
||||||
<dt><a href="#question4">4. How can you prevent deadlock from occurring when
|
<h2>1. Are lock objects <a href="definitions.html#Thread-safe">
|
||||||
a thread must lock multiple mutexes?</a></dt>
|
thread-safe</a>?</h2>
|
||||||
<dt><a href="#question5">5. Don't noncopyable mutex semantics mean that a class
|
|
||||||
with a mutex member will be noncopyable as well?</a></dt>
|
<p><b>No!</b> Lock objects are not meant to be shared between threads.
|
||||||
<dt><a href="#question6">6. How can you lock a mutex member in a const member
|
They are meant to be short lived objects created on automatic storage
|
||||||
function (in order to implement the monitor pattern)?</a></dt>
|
within a code block. Any other usage is just likely to lead to errors
|
||||||
<dt><a href="#question7">7. Why supply condition variables rather than event
|
and won't really be of actual benefit any way. Share <a href=
|
||||||
variables?</a></dt>
|
"mutex_concept.html">mutexes</a>, not locks. For more information see
|
||||||
<dt><a href="#question8">8. Why isn't thread cancellation or termination provided?</a></dt>
|
the <a href="rationale.html#lock_objects">rationale</a> behind the
|
||||||
<dt><a href="#question9">9. Is it safe for threads to share automatic storage
|
design for lock objects.</p>
|
||||||
duration (stack) objects via pointers or references?</a></dt>
|
|
||||||
<dt><a href="#question10">10. Why has class semaphore disappeared?</a></dt>
|
<h2>2a. Why was Boost.Threads modeled after (specific library
|
||||||
</dl>
|
name)?</h2>
|
||||||
<h2><a name="question1"></a>1. Are lock objects <a href="definitions.html#definition-thread-safe">
|
|
||||||
thread safe</a>?</h2>
|
<p>It wasn't. Boost.Threads was designed from scratch. Extensive
|
||||||
<p><b>No!</b> Lock objects are not meant to be shared between threads. They are
|
design discussions involved numerous people representing a wide range
|
||||||
meant to be short-lived objects created on automatic storage within a code block.
|
of experience across many platforms. To ensure portability, the initial
|
||||||
Any other usage is just likely to lead to errors and won't really be of
|
implements were done in parallel using POSIX Threads and theWin32
|
||||||
actual benefit any way. Share <a href=
|
threading API. But the Boost.Threads design is very much in the spirit
|
||||||
"mutex_concept.html">mutexes</a>, not locks. For more information see
|
of C++, and thus doesn't model such C based APIs.</p>
|
||||||
the <a href="rationale.html#lock_objects">rationale</a> behind the design for
|
|
||||||
lock objects.</p>
|
<h2>2b. Why wasn't Boost.Threads modeled after (specific library
|
||||||
<h2><a name="question2a"></a>2a. Why was <b>Boost.Threads</b> modeled after (specific
|
name)?</h2>
|
||||||
library name)?</h2>
|
|
||||||
<p>It wasn't. Boost.Threads was designed from scratch. Extensive design discussions
|
<p>Existing C++ libraries either seemed dangerous (often failing to
|
||||||
involved numerous people representing a wide range of experience across many
|
take advantage of prior art to reduce errors) or had excessive
|
||||||
platforms. To ensure portability, the initial implements were done in parallel
|
dependencies on library components unrelated to threading. Existing C
|
||||||
using POSIX Threads and the Win32 threading API. But the Boost.Threads design
|
libraries couldn't meet our C++ requirements, and were also missing
|
||||||
is very much in the spirit of C++, and thus doesn't model such C based APIs.</p>
|
certain features. For instance, the WIN32 thread API lacks condition
|
||||||
<h2><a name="question2b"></a>2b. Why wasn't Boost.Threads modeled after (specific
|
variables, even though these are critical for the important Monitor
|
||||||
library name)?</h2>
|
pattern <a href="bibliography.html#Schmidt-00">[Schmidt 00]</a>.</p>
|
||||||
<p>Existing C++ libraries either seemed dangerous (often failing to take advantage
|
|
||||||
of prior art to reduce errors) or had excessive dependencies on library components
|
<h2>3. Why do <a href="mutex_concept.html">Mutexes</a> have noncopyable
|
||||||
unrelated to threading. Existing C libraries couldn't meet our C++ requirements,
|
semantics?</h2>
|
||||||
and were also missing certain features. For instance, the WIN32 thread API lacks
|
|
||||||
condition variables, even though these are critical for the important Monitor
|
<p>To ensure that <a href="definitions.html#Deadlock">deadlocks</a>
|
||||||
pattern <a href="bibliography.html#Schmidt-00">[Schmidt 00]</a>.</p>
|
don't occur. The only logical form of copy would be to use some
|
||||||
<h2><a name="question3"></a>3. Why do <a href="mutex_concept.html">Mutexes</a>
|
sort of shallow copy semantics in which multiple mutex objects could
|
||||||
have noncopyable semantics?</h2>
|
refer to the same mutex state. This means that if ObjA has a mutex
|
||||||
<p>To ensure that <a href="definitions.html#Deadlock">deadlocks</a> don't
|
object as part of its state and ObjB is copy constructed from it, then
|
||||||
occur. The only logical form of copy would be to use some sort of shallow copy
|
when ObjB::foo() locks the mutex it has effectively locked ObjA as
|
||||||
semantics in which multiple mutex objects could refer to the same mutex state.
|
well. This behavior can result in deadlock. Other copy semantics result
|
||||||
This means that if ObjA has a mutex object as part of its state and ObjB is
|
in similar problems (if you think you can prove this to be wrong then
|
||||||
copy constructed from it, then when ObjB::foo() locks the mutex it has effectively
|
supply us with an alternative and we'll reconsider).</p>
|
||||||
locked ObjA as well. This behavior can result in deadlock. Other copy semantics
|
|
||||||
result in similar problems (if you think you can prove this to be wrong then
|
<h2>4. How can you prevent <a href="definitions.html#Deadlock">
|
||||||
supply us with an alternative and we'll reconsider).</p>
|
deadlock</a> from occurring when a thread must lock multiple
|
||||||
<h2><a name="question4"></a>4. How can you prevent <a href="definitions.html#Deadlock">
|
mutexes?</h2>
|
||||||
deadlock</a> from occurring when a thread must lock multiple mutexes?</h2>
|
|
||||||
<p>Always lock them in the same order. One easy way of doing this is to use each
|
<p>Always lock them in the same order. One easy way of doing this is to
|
||||||
mutex's address to determine the order in which they are locked. A future
|
use each mutex's address to determine the order in which they are
|
||||||
Boost.Threads concept may wrap this pattern up in a reusable class.</p>
|
locked. A future Boost.Threads concept may wrap this pattern up in a
|
||||||
<h2><a name="question5"></a>5. Don't noncopyable <a href="mutex_concept.html">mutex</a>
|
reusable class.</p>
|
||||||
semantics mean that a class with a mutex member will be noncopyable as well?</h2>
|
|
||||||
<p>No, but what it does mean is that the compiler can't generate a copy constructor
|
<h2>5. Don't noncopyable <a href="mutex_concept.html">mutex</a>
|
||||||
and assignment operator, so they will have to be coded explicitly. This is a
|
semantics mean that a class with a mutex member will be noncopyable as
|
||||||
<b>good thing</b>, however, since the compiler generated operations would not
|
well?</h2>
|
||||||
be <a href=
|
|
||||||
"definitions.html#Thread-safe">thread-safe</a>. The following is a simple
|
<p>No, but what it does mean is that the compiler can't generate a
|
||||||
example of a class with copyable semantics and internal synchronization through
|
copy constructor and assignment operator, so they will have to be coded
|
||||||
a mutex member.</p>
|
explicitly. This is a <b>good thing</b>, however, since the compiler
|
||||||
|
generated operations would not be <a href=
|
||||||
|
"definitions.html#Thread-safe">thread-safe</a>. The following is a
|
||||||
|
simple example of a class with copyable semantics and internal
|
||||||
|
synchronization through a mutex member.</p>
|
||||||
<pre>
|
<pre>
|
||||||
class counter
|
class counter
|
||||||
{
|
{
|
||||||
@@ -97,7 +101,7 @@ public:
|
|||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|
||||||
// We only need to synchronize other for the same reason we don't have to
|
// We only need to syncronize other for the same reason we don't have to
|
||||||
// synchronize on construction!
|
// synchronize on construction!
|
||||||
counter(const counter& other)
|
counter(const counter& other)
|
||||||
{
|
{
|
||||||
@@ -134,50 +138,56 @@ private:
|
|||||||
int m_value;
|
int m_value;
|
||||||
};
|
};
|
||||||
</pre>
|
</pre>
|
||||||
<h2><a name="question6"></a>6. How can you lock a <a href="mutex_concept.html">mutex</a>
|
|
||||||
member in a const member function, in order to implement the Monitor Pattern?</h2>
|
<h2>6. How can you lock a <a href="mutex_concept.html">mutex</a> member
|
||||||
<p>The Monitor Pattern mutex <a href="bibliography.html#Schmidt-00"> [Schmidt
|
in a const member function, in order to implement the Monitor
|
||||||
00]</a> should simply be declared as mutable. See the example code above. The
|
Pattern?</h2>
|
||||||
internal state of mutex types could have been made mutable, with all lock calls
|
|
||||||
made via const functions, but this does a poor job of documenting the actual
|
<p>The Monitor Pattern mutex <a href="bibliography.html#Schmidt-00">
|
||||||
semantics (and in fact would be incorrect since the logical state of a locked
|
[Schmidt 00]</a> should simply be declared as mutable. See the example
|
||||||
mutex clearly differs from the logical state of an unlocked mutex). Declaring
|
code above. The internal state of mutex types could have been made
|
||||||
a mutex member as mutable clearly documents the intended semantics.</p>
|
mutable, with all lock calls made via const functions, but this does a
|
||||||
<h2><a name="question7"></a>7. Why supply <a href="condition.html">condition variables</a>
|
poor job of documenting the actual semantics. Declaring a mutex member
|
||||||
rather than <a href="rationale.html#Events">event variables</a>?</h2>
|
as mutable clearly documentations the intended semantics.</p>
|
||||||
<p>Condition variables result in user code much less prone to <a href=
|
|
||||||
"definitions.html#Race condition">race conditions</a> than event variables.
|
<h2>7. Why supply <a href="condition.html">condition variables</a>
|
||||||
See <a href="rationale.html#Events">Rationale</a> for analysis. Also see <a href="bibliography.html#Hoare-74">[Hoare
|
rather than <a href="rationale.html#Events">event variables</a>?</h2>
|
||||||
74]</a> and <a href="bibliography.html#Schmidt-00">[Schmidt 00]</a>.</p>
|
|
||||||
<h2><a name="question8"></a>8. Why isn't thread cancellation or termination
|
<p>Condition variables result in user code much less prone to <a href=
|
||||||
provided?</h2>
|
"definitions.html#Race condition">race conditions</a> than event
|
||||||
<p>There's a valid need for thread termination, so at some point Boost.Threads
|
variables. See <a href="rationale.html#Events">Rationale</a> for
|
||||||
probably will include it, but only after we can find a truly safe (and portable)
|
analysis. Also see <a href="bibliography.html#Hoare-74">[Hoare74]</a>
|
||||||
mechanism for this concept.</p>
|
and <a href="bibliography.html#Schmidt-00">[Schmidt 00]</a>.</p>
|
||||||
<h2><a name="question9"></a>9. Is it safe for threads to share automatic storage
|
|
||||||
duration (stack) objects via pointers or references?</h2>
|
<h2>8. Why isn't thread cancellation or termination provided?</h2>
|
||||||
<p>Only if you can guarantee that the lifetime of the stack object will not end
|
|
||||||
while other threads might still access the object. Thus the safest practice
|
<p>There's a valid need for thread termination, so at some point
|
||||||
is to avoid sharing stack objects, particularly in designs where threads are
|
Boost.Threads probably will include it, but only after we can find a
|
||||||
created and destroyed dynamically. Restrict sharing of stack objects to simple
|
truly safe (and portable) mechanism for this concept.</p>
|
||||||
designs with very clear and unchanging function and thread lifetimes. (Suggested
|
|
||||||
by Darryl Green).</p>
|
<h2>9. Is it safe for threads to share automatic storage duration
|
||||||
<h2><a name="question10"></a>10. Why has class semaphore disappeared?</h2>
|
(stack) objects via pointers or references?</h2>
|
||||||
<p>Semaphore was removed as too error prone. The same effect can be achieved with
|
|
||||||
greater safety by the combination of a mutex and a condition variable.</p>
|
<p>Only if you can guarantee that the lifetime of the stack object will
|
||||||
<hr>
|
not end while other threads might still access the object. Thus the
|
||||||
<p>Revised
|
safest practice is to avoid sharing stack objects, particularly in
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
designs where threads are created and destroyed dynamically. Restrict
|
||||||
05 November, 2001
|
sharing of stack objects to simple designs with very clear and
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
unchanging function and thread lifetimes. (Suggested by Darryl
|
||||||
</p>
|
Green).</p>
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
|
||||||
All Rights Reserved.</i></p>
|
<h2>10. Why has class semaphore disappeared?</h2>
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
<p>Semaphore was removed as too error prone. The same effect can be
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
achieved with greater safety by the combination of a mutex and a
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
condition variable.</p>
|
||||||
makes no representations about the suitability of this software for any purpose.
|
<hr>
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
|
||||||
</body>
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|||||||
289
doc/index.html
289
doc/index.html
@@ -1,155 +1,138 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Type" content=
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
"text/html; charset=iso-8859-1">
|
||||||
<title>Boost.Threads</title>
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
</head>
|
|
||||||
<body link="#0000ff" vlink="#800080">
|
<title>Boost.Threads, Index</title>
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
</head>
|
||||||
"header">
|
|
||||||
<tr>
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
<td valign="top" width="300">
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
width="100%">
|
||||||
</td>
|
<tr>
|
||||||
<td valign="top">
|
<td valign="top" width="300">
|
||||||
<h1 align="center">Boost.Threads</h1>
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
<h2 align="center">Index</h2>
|
"277" height="86"></h3>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
|
||||||
</table>
|
<td valign="top">
|
||||||
<hr>
|
<h1 align="center">Boost.Threads</h1>
|
||||||
<h2>Contents</h2>
|
|
||||||
<dl class="index">
|
<h2 align="center">Documentation Map</h2>
|
||||||
<dt><a href="overview.html">Overview</a></dt>
|
</td>
|
||||||
<dt><a href="mutex_concept.html">Mutex Concepts</a></dt>
|
</tr>
|
||||||
<dl class="index">
|
</table>
|
||||||
<dt><a href="mutex_concept.html#Mutex">Mutex</a></dt>
|
<hr>
|
||||||
<dt><a href="mutex_concept.html#TryMutex">TryMutex</a></dt>
|
|
||||||
<dt><a href="mutex_concept.html#TimedMutex">TimedMutex</a></dt>
|
<h2>Contents</h2>
|
||||||
</dl>
|
|
||||||
<dt><a href="lock_concept.html">Lock Concepts</a></dt>
|
<ul>
|
||||||
<dl class="index">
|
<li><a href="overview.html">Overview</a></li>
|
||||||
<dt><a href="lock_concept.html#Lock">Lock</a></dt>
|
|
||||||
<dt><a href="lock_concept.html#ScopedLock">ScopedLock</a></dt>
|
<li>
|
||||||
<dt><a href="lock_concept.html#ScopedTryLock">ScopedTryLock</a></dt>
|
<a href="mutex_concept.html">Mutex Concepts</a>
|
||||||
<dt><a href="lock_concept.html#ScopedTimedLock">ScopedTimedLock</a></dt>
|
|
||||||
</dl>
|
<ul>
|
||||||
<dt>Reference</dt>
|
<li><a href="mutex_concept.html#Mutex">Mutex</a></li>
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="condition.html"><code><boost/thread/condition.hpp></code></a></dt>
|
<li><a href="mutex_concept.html#TryMutex">TryMutex</a></li>
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="condition.html#classes">Classes</a></dt>
|
<li><a href="mutex_concept.html#TimedMutex">
|
||||||
<dl class="index">
|
TimedMutex</a></li>
|
||||||
<dt><a href="condition.html#class-condition"><code>condition</code></a></dt>
|
</ul>
|
||||||
</dl>
|
</li>
|
||||||
</dl>
|
|
||||||
</dl>
|
<li>
|
||||||
<dl class="index">
|
Mutex Classes
|
||||||
<dt><a href="exceptions.html"><code><boost/thread/exceptions.hpp></code></a></dt>
|
|
||||||
<dl class="index">
|
<ul>
|
||||||
<dt><a href="exceptions.html#classes">Classes</a></dt>
|
<li><a href="mutex.html">mutex / try_mutex /
|
||||||
<dl class="index">
|
timed_mutex</a></li>
|
||||||
<dt><a href="exceptions.html#class-lock_error"><code>lock_error</code></a></dt>
|
|
||||||
<dt><a href="exceptions.html#class-thread_resource_error"><code>thread_resource_error</code></a></dt>
|
<li><a href="recursive_mutex.html">recursive_mutex /
|
||||||
</dl>
|
recursive_try_mutex / recursive_timed_mutex</a></li>
|
||||||
</dl>
|
</ul>
|
||||||
</dl>
|
</li>
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="mutex.html"><code><boost/thread/mutex.hpp></code></a></dt>
|
<li>
|
||||||
<dl class="index">
|
<a href="lock_concept.html">Lock Concepts</a>
|
||||||
<dt><a href="mutex.html#classes">Classes</a></dt>
|
|
||||||
<dl class="index">
|
<ul>
|
||||||
<dt><a href="mutex.html#class-mutex"><code>mutex</code></a></dt>
|
<li><a href="lock_concept.html#Lock">Lock</a></li>
|
||||||
<dt><a href="mutex.html#class-try_mutex"><code>try_mutex</code></a></dt>
|
|
||||||
<dt><a href="mutex.html#class-timed_mutex"><code>timed_mutex</code></a></dt>
|
<li><a href="lock_concept.html#ScopedLock">
|
||||||
</dl>
|
ScopedLock</a></li>
|
||||||
</dl>
|
|
||||||
</dl>
|
<li><a href="lock_concept.html#ScopedTryLock">
|
||||||
<dl class="index">
|
ScopedTryLock</a></li>
|
||||||
<dt><a href="once.html"><code><boost/thread/once.hpp></code></a></dt>
|
|
||||||
<dl class="index">
|
<li><a href="lock_concept.html#ScopedTimedLock">
|
||||||
<dt><a href="once.html#macros">Macros</a></dt>
|
ScopedTimedLock</a></li>
|
||||||
<dl class="index">
|
</ul>
|
||||||
<dt><a href="once.html#macro-BOOST_ONCE_INIT"><code>BOOST_ONCE_INIT</code></a></dt>
|
</li>
|
||||||
</dl>
|
|
||||||
<dt><a href="once.html#types">Types</a></dt>
|
<li>
|
||||||
<dl class="index">
|
Lock Classes
|
||||||
<dt><a href="once.html#type-once_flag"><code>once_flag</code></a></dt>
|
|
||||||
</dl>
|
<ul>
|
||||||
<dt><a href="once.html#functions">Functions</a></dt>
|
<li><a href="scoped_lock.html">scoped_lock</a></li>
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="once.html#function-call_once"><code>call_once</code></a></dt>
|
<li><a href="scoped_try_lock.html">scoped_try_lock</a></li>
|
||||||
</dl>
|
|
||||||
</dl>
|
<li><a href="scoped_timed_lock.html">
|
||||||
</dl>
|
scoped_timed_lock</a></li>
|
||||||
<dl class="index">
|
</ul>
|
||||||
<dt><a href="recursive_mutex.html"><code><boost/thread/recursive_mutex.hpp></code></a></dt>
|
</li>
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="recursive_mutex.html#classes">Classes</a></dt>
|
<li>Class <a href="condition.html">condition</a></li>
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="recursive_mutex.html#class-recursive_mutex"><code>recursive_mutex</code></a></dt>
|
<li>Class <a href="thread_specific_ptr.html">
|
||||||
<dt><a href="recursive_mutex.html#class-recursive_try_mutex"><code>recursive_try_mutex</code></a></dt>
|
thread_specific_ptr</a></li>
|
||||||
<dt><a href="recursive_mutex.html#class-recursive_timed_mutex"><code>recursive_timed_mutex</code></a></dt>
|
|
||||||
</dl>
|
<li>Class <a href="thread.html">thread</a></li>
|
||||||
</dl>
|
|
||||||
</dl>
|
<li>Class <a href="thread_group.html">thread_group</a></li>
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="thread.html"><code><boost/thread/thread.hpp></code></a></dt>
|
<li>Class <a href="xtime.html">xtime</a></li>
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="thread.html#classes">Classes</a></dt>
|
<li>Class <a href="lock_error.html">lock_error</a></li>
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="thread.html#class-thread"><code>thread</code></a></dt>
|
<li>Class <a href="thread_resource_error.html">
|
||||||
<dt><a href="thread.html#class-thread_group"><code>thread_group</code></a></dt>
|
thread_resource_error</a></li>
|
||||||
</dl>
|
|
||||||
</dl>
|
<li>Routine <a href="call_once.html">call_once</a></li>
|
||||||
</dl>
|
|
||||||
<dl class="index">
|
<li><a href="config.html">Configuration Information</a></li>
|
||||||
<dt><a href="tss.html"><code><boost/thread/tss.hpp></code></a></dt>
|
|
||||||
<dl class="index">
|
<li><a href="introduction.html">Introduction to design</a></li>
|
||||||
<dt><a href="tss.html#classes">Classes</a></dt>
|
|
||||||
<dl class="index">
|
<li><a href="rationale.html">Rationale for design
|
||||||
<dt><a href="tss.html#class-thread_specific_ptr"><code>thread_specific_ptr</code></a></dt>
|
decisions</a></li>
|
||||||
</dl>
|
|
||||||
</dl>
|
<li><a href="definitions.html">Definitions</a></li>
|
||||||
</dl>
|
|
||||||
<dl class="index">
|
<li><a href="faq.html">Frequently Asked Questions</a></li>
|
||||||
<dt><a href="xtime.html"><code><boost/thread/xtime.hpp></code></a></dt>
|
|
||||||
<dl class="index">
|
<li><a href="bibliography.html">Bibliography</a></li>
|
||||||
<dt><a href="xtime.html#values">Values</a></dt>
|
|
||||||
<dl class="page-index">
|
<li><a href="acknowledgements.html">Acknowledgements</a></li>
|
||||||
<dt><a href="xtime.html#value-spec"><code>TIME_UTC</code></a></dt>
|
</ul>
|
||||||
</dl>
|
<hr>
|
||||||
<dt><a href="xtime.html#classes">Classes</a></dt>
|
|
||||||
<dl class="page-index">
|
<p>Revised
|
||||||
<dt><a href="xtime.html#class-xtime"><code>xtime</code></a></dt>
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
</dl>
|
|
||||||
<dt><a href="xtime.html#functions">Functions</a></dt>
|
<p>© <i>Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
<dl class="page-index">
|
William E. Kempf</a> 2001</i></p>
|
||||||
<dt><a href="xtime.html#function-xtime_get"><code>xtime_get</code></a></dt>
|
|
||||||
</dl>
|
<p>Permission to use, copy, modify, distribute and sell this software
|
||||||
</dl>
|
and its documentation for any purpose is hereby granted without fee,
|
||||||
</dl>
|
provided that the above copyright notice appear in all copies and that
|
||||||
<dt><a href="configuration.html">Configuration Information</a></dt>
|
both that copyright notice and this permission notice appear in
|
||||||
<dt><a href="introduction.html">Introduction to Design</a></dt>
|
supporting documentation. William E. Kempf makes no representations
|
||||||
<dt><a href="rationale.html">Rationale</a></dt>
|
about the suitability of this software for any purpose. It is provided
|
||||||
<dt><a href="definitions.html">Definitions</a></dt>
|
"as is" without express or implied warranty.</p>
|
||||||
<dt><a href="faq.html">Frequently Asked Questions (FAQs)</a></dt>
|
</body>
|
||||||
<dt><a href="bibliography.html">Bibliography</a></dt>
|
|
||||||
<dt><a href="acknowledgments.html">Acknowledgments</a></dt>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<p>Revised
|
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
|
||||||
05 November, 2001
|
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
|
||||||
</p>
|
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
|
||||||
All Rights Reserved.</i></p>
|
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
|
||||||
makes no representations about the suitability of this software for any purpose.
|
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|||||||
@@ -1,159 +1,194 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Type" content=
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
"text/html; charset=iso-8859-1">
|
||||||
<title>Boost.Threads - Introduction to Design</title>
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
</head>
|
|
||||||
<body link="#0000ff" vlink="#800080">
|
<title>Boost.Threads, Introduction</title>
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
</head>
|
||||||
"header">
|
|
||||||
<tr>
|
<body bgcolor="#ffffff" link="#0000ff" vlink="#800080">
|
||||||
<td valign="top" width="300">
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
width="100%">
|
||||||
</td>
|
<tr>
|
||||||
<td valign="top">
|
<td valign="top" width="300">
|
||||||
<h1 align="center">Boost.Threads</h1>
|
<h3><img height="86" alt="C++ Boost" src=
|
||||||
<h2 align="center">Introduction to Design</h2>
|
"../../../c++boost.gif" width="277"></h3>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
|
||||||
</table>
|
<td valign="top">
|
||||||
<hr>
|
<h1 align="center">Boost.Threads</h1>
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#motivation">Motivation</a></dt>
|
<h2 align="center">Introduction</h2>
|
||||||
<dt><a href="#goals">Goals</a></dt>
|
</td>
|
||||||
<dt><a href="#phases">Iterative Phases</a></dt>
|
</tr>
|
||||||
<dl class="page-index">
|
</table>
|
||||||
<dt><a href="#phase1">Phase 1, Synchronization Primitives</a></dt>
|
<hr>
|
||||||
<dt><a href="#phase2">Phase 2, Thread Management and Thread Specific Storage</a></dt>
|
|
||||||
<dt><a href="#next-phase">The Next Phase</a></dt>
|
<h3>Motivation</h3>
|
||||||
</dl>
|
|
||||||
</dl>
|
<p>With client/server and three-tier architectures becoming common
|
||||||
<h2><a name="motivation"></a>Motivation</h2>
|
place in today's world, it's becoming increasingly important
|
||||||
<p>With client/server and three-tier architectures becoming common place in today's
|
for programs to be able to handle parallel processing. Modern day
|
||||||
world, it's becoming increasingly important for programs to be able to handle
|
operating systems usually provide some support for this through native
|
||||||
parallel processing. Modern day operating systems usually provide some support
|
thread APIs. Unfortunately, writing portable code that makes use of
|
||||||
for this through native thread APIs. Unfortunately, writing portable code that
|
parallel processing in C++ is made very difficult by a lack of a
|
||||||
makes use of parallel processing in C++ is made very difficult by a lack of
|
standard interface for these native APIs. Further, these APIs are
|
||||||
a standard interface for these native APIs. Further, these APIs are almost universally
|
almost universally C APIs and fail to take advantage of C++'s
|
||||||
C APIs and fail to take advantage of C++'s strengths, or to address C++'s
|
strengths, or to address C++'s issues.</p>
|
||||||
issues.</p>
|
|
||||||
<p>The <b>Boost.Threads</b> library is an attempt to define a portable interface
|
<p>The <b>Boost.Threads</b> library is an attempt to define a portable
|
||||||
for writing parallel processes in C++.</p>
|
interface for writing parallel processes in C++.</p>
|
||||||
<h2><a name="goals"></a>Goals</h2>
|
|
||||||
<p>The <b>Boost.Threads</b> library has several goals that should help to set
|
<h3>Goals</h3>
|
||||||
it apart from other solutions. These goals are listed in order of precedence
|
|
||||||
with full descriptions below.</p>
|
<p>The <b>Boost.Threads</b> library has several goals that should help
|
||||||
<ul>
|
to set it apart from other solutions. These goals are listed in order
|
||||||
<li> <b>Portability</b>
|
of precedence with full descriptions below.</p>
|
||||||
<p><b>Boost.Threads</b> was designed to be highly portable. The goal is for
|
|
||||||
the interface to be easily implemented on any platform that supports threads,
|
<ul>
|
||||||
and possibly even on platforms without native thread support.</p>
|
<li>
|
||||||
</li>
|
<b>Portability</b>
|
||||||
<li> <b>Safety</b>
|
|
||||||
<p><b>Boost.Threads</b> was designed to be as safe as possible. Writing <a href="definitions.html#Thread-safe">thread-safe</a>
|
<p><b>Boost.Threads</b> was designed to be highly portable. The
|
||||||
code is very difficult and successful libraries must strive to insulate
|
goal is for the interface to be easily implemented on any
|
||||||
the programmer from dangerous constructs as much as possible. This is accomplished
|
platform that supports threads, and possibly even on platforms
|
||||||
in several ways:</p>
|
without native thread support.</p>
|
||||||
<ul>
|
</li>
|
||||||
<li>
|
|
||||||
<p align="left">C++ language features are used make correct usage easy
|
<li>
|
||||||
(if possible, the default) and error-prone impossible or at least more
|
<b>Safety</b>
|
||||||
difficult. For example, see the <a href="mutex_concept.html">Mutex</a>
|
|
||||||
and <a href="lock_concept.html">Lock</a> designs, and how note how they
|
<p><b>Boost.Threads</b> was designed to be as safe as possible.
|
||||||
interact.</p>
|
Writing <a href="definitions.html#Thread-safe">thread-safe</a>
|
||||||
</li>
|
code is very difficult and successful libraries must strive to
|
||||||
<li>
|
insulate the programmer from dangerous constructs as much as
|
||||||
<p align="left">Certain traditional concurrent programming features are
|
possible. This is accomplished in several ways:</p>
|
||||||
considered so error-prone that they are not provided at all. For example,
|
|
||||||
see the <a
|
<ul>
|
||||||
href="rationale.html#Events">Events Not Provided</a> rationale.</p>
|
<li>
|
||||||
</li>
|
<p align="left">C++ language features are used make
|
||||||
<li>
|
correct usage easy (if possible, the default) and
|
||||||
<p align="left">Dangerous features, or features which may be misused,
|
error-prone impossible or at least more difficult. For
|
||||||
are identified as such in the documentation to make users aware of potential
|
example, see the <a href="mutex_concept.html">Mutex</a>
|
||||||
pitfalls.</p>
|
and <a href="lock_concept.html">Lock</a> designs, and
|
||||||
</li>
|
how note how they interact.</p>
|
||||||
</ul>
|
</li>
|
||||||
</li>
|
|
||||||
<li> <b>Flexibility</b>
|
<li>
|
||||||
<p><b>Boost.Threads</b> was designed to be flexible. This goal is often at
|
<p align="left">Certain traditional concurrent
|
||||||
odds with <i>safety</i>. When functionality might be compromised by the
|
programming features are considered so error-prone that
|
||||||
desire to keep the interface safe, <b> Boost.Threads</b> has been designed
|
they are not provided at all. For example, see the <a
|
||||||
to provide the functionality, but to make it's use prohibitive for general
|
href="rationale.html#Events">Events Not Provided</a>
|
||||||
use. In other words, the interfaces have been designed such that it's usually
|
rationale.</p>
|
||||||
obvious when something is unsafe, and the documentation is written to explain
|
</li>
|
||||||
why.</p>
|
|
||||||
</li>
|
<li>
|
||||||
<li> <b>Efficiency</b>
|
<p align="left">Dangerous features, or features which
|
||||||
<p><b>Boost.Threads</b> was designed to be as efficient as possible. When
|
may be misused, are identified as such in the
|
||||||
building a library on top of another library there is always a danger that
|
documentation to make users aware of potential
|
||||||
the result will be so much slower than the "native" API that programmers
|
pitfalls.</p>
|
||||||
are inclined to ignore the higher level API. <b>Boost.Threads</b> was designed
|
</li>
|
||||||
to minimize the chances of this occurring. The interfaces have been crafted
|
</ul>
|
||||||
to allow an implementation the greatest chance of being as efficient as
|
</li>
|
||||||
possible. This goal is often at odds with the goal for <i>safety</i>. Every
|
|
||||||
effort was made to ensure efficient implementations, but when in conflict
|
<li>
|
||||||
<i>safety</i> has always taken precedence.</p>
|
<b>Flexibility</b>
|
||||||
</li>
|
|
||||||
</ul>
|
<p><b>Boost.Threads</b> was designed to be flexible. This goal
|
||||||
<h2><a name="phases"></a>Iterative Phases</h2>
|
is often at odds with <i>safety</i>. When functionality might
|
||||||
<p>Another goal of <b>Boost.Threads</b> was to take a dynamic, iterative approach
|
be compromised by the desire to keep the interface safe, <b>
|
||||||
in its development. The computing industry is still exploring the concepts of
|
Boost.Threads</b> has been designed to provide the
|
||||||
parallel programming. Most thread libraries supply only simple primitive concepts
|
functionality, but to make it's use prohibitive for general
|
||||||
for thread synchronization. These concepts are very simple, but they are very
|
use.</p>
|
||||||
difficult to use safely or to provide formal proofs for constructs built on
|
</li>
|
||||||
top of them. There has been a lot of research in other concepts, such as in
|
|
||||||
"Communicating Sequential Processes." <b>Boost.Threads</b> was designed
|
<li>
|
||||||
in iterative steps, providing the building blocks necessary for the next step,
|
<b>Efficiency</b>
|
||||||
and giving the researcher the tools necessary to explore new concepts in a portable
|
|
||||||
manner.</p>
|
<p><b>Boost.Threads</b> was designed to be as efficient as
|
||||||
<p>Given the goal of following a dynamic, iterative approach <b> Boost.Threads</b>
|
possible. When building a library on top of another library
|
||||||
shall go through several growth cycles. Each phase in its development shall
|
there is always a danger that the result will be so much slower
|
||||||
be roughly documented here.</p>
|
than the "native" API that programmers are inclined
|
||||||
<h3><a name="phase1"></a>Phase 1, Synchronization Primitives</h3>
|
to ignore the higher level API. <b>Boost.Threads</b> was
|
||||||
<p>Boost is all about providing high quality libraries with implementations for
|
designed to minimize the chances of this occurring. The
|
||||||
many platforms. Unfortunately, there's a big problem faced by developers
|
interfaces have been crafted to allow an implementation the
|
||||||
wishing to supply such high quality libraries, namely thread-safety. The C++
|
greatest chance of being as efficient as possible. This goal is
|
||||||
standard doesn't address threads at all, but real world programs often make
|
often at odds with the goal for <i>safety</i>. Every effort was
|
||||||
use of native threading support. A portable library that doesn't address
|
made to ensure efficient implementations, but when in conflict
|
||||||
the issue of thread-safety is there for not much help to a programmer who wants
|
<i>safety</i> has always taken precedence.</p>
|
||||||
to use the library in his multithreaded application. So there's a very great
|
</li>
|
||||||
need for portable primitives that will allow the library developer to create
|
</ul>
|
||||||
<a href="definitions.html#Thread-safe"> thread-safe</a> implementations. This
|
|
||||||
need far out weighs the need for portable methods to create and manage threads.</p>
|
<h3>Iterative Phases</h3>
|
||||||
<p>Because of this need, the first phase of <b>Boost.Threads</b> focuses solely
|
|
||||||
on providing portable primitive concepts for thread synchronization. Types provided
|
<p>Another goal of <b>Boost.Threads</b> was to take a dynamic,
|
||||||
in this phase include the <a href="mutex.html"> mutex/try_mutex/timed_mutex</a>,
|
iterative approach in its development. The computing industry is still
|
||||||
<a href="recursive_mutex.html"> recursive_mutex/recursive_try_mutex/recursive_timed_mutex</a>
|
exploring the concepts of parallel programming. Most thread libraries
|
||||||
and <a href="exceptions.html#class-lock_error">lock_error</a>. These are considered
|
supply only simple primitive concepts for thread synchronization. These
|
||||||
the "core" synchronization primitives, though there are others that
|
concepts are very simple, but they are very difficult to use safely or
|
||||||
will be added in later phases.</p>
|
to provide formal proofs for constructs built on top of them. Until
|
||||||
<h3><a name="phase2"></a>Phase 2, Thread Management and Thread Specific Storage</h3>
|
recently, these primitives were "state of the art" and the
|
||||||
<p>This phase addresses the creation and management of threads and provides a
|
only concepts available to programmers. Recently there has been a lot
|
||||||
mechanism for thread specific storage (data associated with a thread instance).
|
of research in other concepts, such as in "Communicating
|
||||||
Thread management is a tricky issue in C++, so this phase addresses only the
|
Sequential Processes." <b>Boost.Threads</b> was designed in
|
||||||
basic needs of multithreaded program. Later phases are likely to add additional
|
iterative steps, providing the building blocks necessary for the next
|
||||||
functionality in this area. This phase of <b>Boost.Threads</b> adds the <a href="thread.html">thread</a>
|
step, and giving the researcher the tools necessary to explore new
|
||||||
and <a href="tss.html#class-thread_specific_ptr">thread_specific_ptr</a> types.
|
concepts in a portable manner.</p>
|
||||||
With these additions the <b>Boost.Threads</b> library can be considered minimal
|
|
||||||
but complete.</p>
|
<p>Given the goal of following a dynamic, iterative approach <b>
|
||||||
<h3><a name="next-phase"></a>The Next Phase</h3>
|
Boost.Threads</b> shall go through several growth cycles. Each phase in
|
||||||
<p>The next phase will address more advanced synchronization concepts, such as
|
its development shall be roughly documented here.</p>
|
||||||
read/write mutexes and barriers.</p>
|
|
||||||
<hr>
|
<h4>Phase 1, Synchronization Primitives</h4>
|
||||||
<hr>
|
|
||||||
<p>Revised
|
<p>Boost is all about providing high quality libraries with
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
implementations for many platforms. Unfortunately, there's a big
|
||||||
05 November, 2001
|
problem faced by developers wishing to supply such high quality
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
libraries, namely thread-safety. The C++ standard doesn't address
|
||||||
</p>
|
threads at all, but real world programs often make use of native
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
threading support. A portable library that doesn't address the
|
||||||
All Rights Reserved.</i></p>
|
issue of thread-safety is there for not much help to a programmer who
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
wants to use the library in his multi-threaded application. So
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
there's a very great need for portable primitives that will allow
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
the library developer to create <a href="definitions.html#Thread-safe">
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
thread-safe</a> implementations. This need far out weighs the need for
|
||||||
makes no representations about the suitability of this software for any purpose.
|
portable methods to create and manage threads.</p>
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
|
||||||
</body>
|
<p>Because of this need, the first phase of <b>Boost.Threads</b>
|
||||||
|
focuses solely on providing portable primitive concepts for thread
|
||||||
|
synchronization. Types provided in this phase include the <a href="mutex.html">
|
||||||
|
mutex/try_mutex/timed_mutex</a>, <a href="recursive_mutex.html">
|
||||||
|
recursive_mutex/recursive_try_mutex/recursive_timed_mutex</a>, <a href=
|
||||||
|
"scoped_lock.html">scoped_lock</a>, <a href="scoped_try_lock.html">
|
||||||
|
scoped_try_lock</a>, <a href="scoped_timed_lock.html">
|
||||||
|
scoped_timed_lock</a> and <a href="lock_error.html">lock_error</a>.
|
||||||
|
These are considered the "core" synchronization primitives,
|
||||||
|
though there are others that will be added in later phases.</p>
|
||||||
|
|
||||||
|
<h4>Phase 2, Thread Management and Thread Specific Storage</h4>
|
||||||
|
|
||||||
|
<p>This phase addresses the creation and management of threads and
|
||||||
|
provides a mechanism for thread specific storage (data associated with
|
||||||
|
a thread instance). Thread management is a tricky issue in C++, so this
|
||||||
|
phase addresses only the basic needs of multi-threaded program. Later
|
||||||
|
phases are likely to add additional functionality in this area. This
|
||||||
|
phase of <b>Boost.Threads</b> adds the <a href="thread.html">thread</a>
|
||||||
|
and <a href="thread_specific_ptr.html">thread_specific_ptr</a> types.
|
||||||
|
With these additions the <b>Boost.Threads</b> library can be considered
|
||||||
|
minimal but complete.</p>
|
||||||
|
|
||||||
|
<h4>The Next Phase</h4>
|
||||||
|
|
||||||
|
<p>The next phase will address more advanced synchronization concepts,
|
||||||
|
such as read/write mutexes and barriers.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|||||||
@@ -1,194 +1,300 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Type" content=
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
"text/html; charset=iso-8859-1">
|
||||||
<title>Boost.Threads - ScopedLock Concept</title>
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
</head>
|
|
||||||
<body link="#0000ff" vlink="#800080">
|
<title>Boost.Threads, Lock Concept</title>
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
</head>
|
||||||
"header">
|
|
||||||
<tr>
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
<td valign="top" width="300">
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
width="100%">
|
||||||
</td>
|
<tr>
|
||||||
<td valign="top">
|
<td valign="top" width="300">
|
||||||
<h1 align="center">Boost.Threads</h1>
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
<h2 align="center">ScopedLock Concept</h2>
|
"277" height="86"></h3>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
|
||||||
</table>
|
<td valign="top">
|
||||||
<hr>
|
<h1 align="center">Boost.Threads</h1>
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#introduction">Introduction</a></dt>
|
<h2 align="center">Lock Concepts</h2>
|
||||||
<dt><a href="#concept-requirements">Concept Requirements</a></dt>
|
</td>
|
||||||
<dl class="page-index">
|
</tr>
|
||||||
<dt><a href="#Lock-concept">Lock Concept</a></dt>
|
</table>
|
||||||
<dt><a href="#ScopedLock-concept">ScopedLock Concept</a></dt>
|
<hr>
|
||||||
<dt><a href="#ScopedTryLock-concept">ScopedTryLock Concept</a></dt>
|
|
||||||
<dt><a href="#ScopedTimedLock-concept">ScopedTimedLock Concept</a></dt>
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
</dl>
|
<a href="#Requirements">Concept Requirements</a><br>
|
||||||
</dl>
|
<a href="#Lock">Lock Concept</a><br>
|
||||||
<h2><a name="introduction"></a>Introduction</h2>
|
<a href="#ScopedLock">ScopedLock Concept</a><br>
|
||||||
<p>A lock object provides a safe means for locking and unlocking a mutex object
|
<a href="#ScopedTryLock">ScopedTryLock Concept</a><br>
|
||||||
(an object whose type is a model of <a href="mutex_concept.html">Mutex</a> or
|
<a href="#ScopedTimedLock">ScopedTimedLock Concept</a><br>
|
||||||
one of its refinements). In other words they are an implementation of the <i>Scoped
|
<a href="#Models">Models</a></p>
|
||||||
Locking</i> <a href="bibliography.html#Schmidt-00">[Schmidt 00]</a> pattern.
|
|
||||||
The <a href="#ScopedLock-concept">ScopedLock</a> concept, with <a href="#ScopedTryLock-concept">ScopedTryLock</a>
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
and <a href="#ScopedTimedLock-concept">ScopedTimedLock</a> refinements, formalize
|
|
||||||
the requirements.</p>
|
<p>The lock concepts provide exception safe means for locking and
|
||||||
<p>Lock objects are constructed with a reference to a mutex object and typically
|
unlocking a <a href="mutex_concept.html">mutex model</a>. In other
|
||||||
acquire ownership of the mutex object by setting its state to locked. They also
|
words they are an implementation of the <i>Scoped Locking</i> <a href=
|
||||||
ensure ownership is relinquished in the destructor. Lock objects also expose
|
"bibliography.html#Schmidt 00">[Schmidt 00]</a> pattern. The <a href=
|
||||||
functions to query the lock status and to manually lock and unlock the mutex
|
"#ScopedLock">ScopedLock</a> concept, with <a href="#ScopedTryLock">
|
||||||
object.</p>
|
ScopedTryLock</a> and <a href="#ScopedTimedLock">ScopedTimedLock</a>
|
||||||
<p>Lock objects are meant to be short lived, expected to be used at block scope
|
refinements, formalize the requirements.</p>
|
||||||
only. The lock objects are not <a href="definitions.html#definition-thread-safe">thread-safe</a>.
|
|
||||||
Lock objects must maintain state to indicate whether or not they've been
|
<p>Lock models are constructed with a reference to a <a href=
|
||||||
locked and this state is not protected by any synchronization concepts. For
|
"mutex_concept.html">mutex model</a> and typically acquire ownership of
|
||||||
this reason a lock object should never be shared between multiple threads.</p>
|
the <a href="mutex_concept.html">mutex model</a> by setting its state
|
||||||
<h2><a name="concept-requirements"></a>Concept Requirements</h2>
|
to locked. They also ensure ownership is relinquished in the
|
||||||
<h3><a name="Lock-concept"></a>Lock Concept</h3>
|
destructor. Lock models also expose functions to query the lock status
|
||||||
<p>For a Lock type <code>L</code> and an object <code>lk</code> and const object
|
and to manually lock and unlock the <a href="mutex_concept.html">mutex
|
||||||
<code>clk</code> of that type, the following expressions must be well-formed
|
model</a>.</p>
|
||||||
and have the indicated effects.</p>
|
|
||||||
<table summary="Lock expressions" border="1" cellpadding="5">
|
<p>Instances of lock models are meant to be short lived, expected to be
|
||||||
<tr>
|
used at block scope only. The lock models are not <a href=
|
||||||
<td><b>Expression</b></td>
|
"definitions.html#Thread-safe">thread-safe</a>. Lock models must
|
||||||
<td><b>Effects</b></td>
|
maintain state to indicate whether or not they've been locked and
|
||||||
</tr>
|
this state is not protected by any synchronization concepts. For this
|
||||||
<tr>
|
reason an instance of a lock model should never be shared between
|
||||||
<td valign="top"><code>(&lk)->~L();</code></td>
|
multiple threads.</p>
|
||||||
<td><code>if (locked()) unlock();</code></td>
|
|
||||||
</tr>
|
<h2>Concept <a name="Requirements">Requirements</a></h2>
|
||||||
<tr>
|
|
||||||
<td valign="top"><code>(&clk)->operator const void*()</code></td>
|
<p>[For documentation purposes, portions of the concept requirements
|
||||||
<td>Returns type void*, non-zero if if the associated mutex object has been
|
are repeated in the documentation for specific lock classes. Those
|
||||||
locked by <code>clk</code>, otherwise 0.</td>
|
copies need to be kept in sync with the requirements here.]</p>
|
||||||
</tr>
|
|
||||||
<tr>
|
<h3><a name="Lock">Lock</a> Concept</h3>
|
||||||
<td valign="top"><code>clk.locked()</code></td>
|
|
||||||
<td>Returns a <code>bool</code>, <code>(&clk)->operator const void*()
|
<p>For a <a href="#ScopedLock">ScopedLock</a>, <a href=
|
||||||
!= 0</code></td>
|
"#ScopedTryLock">ScopedTryLock</a>, or <a href="#ScopedTimedLock">
|
||||||
</tr>
|
ScopedTimedLock</a> type <code>L</code> and an object <code>lk</code>
|
||||||
<tr>
|
and const object <code>clk</code> of that type, the following
|
||||||
<td valign="top"><code>lk.lock()</code></td>
|
expressions must be well-formed and have the indicated effects.</p>
|
||||||
<td>Throws <code>lock_error</code> if <code>locked()</code>. If the associated
|
|
||||||
mutex object is already locked by some other thread, places the current
|
<p>The Lock concept is used as a base for the <a href="#ScopedLock">
|
||||||
thread in the <a href="definitions.html#State">Blocked</a> state until the
|
ScopedLock</a>, <a href="#ScopedTryLock">ScopedTryLock</a>, and <a
|
||||||
associated mutex is unlocked, after which the current thread is placed in
|
href="#ScopedTimedLock">ScopedTimedLock</a> refinements. The associated
|
||||||
the <a href="definitions.html#State"> Ready</a> state, eventually to be
|
mutex type is as specified for each of those refinements
|
||||||
returned to the <a href="definitions.html#State">Running</a> state. If the
|
respectively.</p>
|
||||||
associated mutex object is already locked by the same thread the behavior
|
|
||||||
is dependent on the <a href="mutex_concept.html#locking-strategies">locking
|
<table summary="Lock expressions" border="1" cellpadding="5">
|
||||||
strategy</a> of the associated mutex object.<br>
|
<tr>
|
||||||
Postcondition: <code>locked() == true</code></td>
|
<td><b>Expression</b></td>
|
||||||
</tr>
|
|
||||||
<tr>
|
<td><b>Effects</b></td>
|
||||||
<td valign="top"><code>lk.unlock()</code></td>
|
</tr>
|
||||||
<td>If <code>!locked()</code>, throws <code>lock_error</code>, otherwise unlocks
|
|
||||||
the associated mutex.<br>
|
<tr>
|
||||||
Postcondition: <code>!locked()</code></td>
|
<td valign="top"><code>(&lk)->~L();</code></td>
|
||||||
</tr>
|
|
||||||
</table>
|
<td><code>if (locked()) unlock();</code></td>
|
||||||
<h3><a name="ScopedLock-concept"></a>ScopedLock Concept</h3>
|
</tr>
|
||||||
<p>A ScopedLock is a refinement of <a href="#Lock">Lock</a>. For a ScopedLock
|
|
||||||
type <code>L</code> and an object <code>lk</code> of that type, and an object
|
<tr>
|
||||||
<code>m</code> of a type meeting the <a href="mutex_concept.html#Mutex-concept">Mutex</a>
|
<td valign="top"><code>(&clk)->operator const
|
||||||
requirements, and an object <code>b</code> of type <code>bool</code>, the following
|
void*()</code></td>
|
||||||
expressions must be well-formed and have the indicated effects.</p>
|
|
||||||
<table summary="ScopedLock expressions" border="1" cellpadding="5">
|
<td>Returns type void*, non-zero if if the associated mutex has
|
||||||
<tr>
|
been locked by <code>clk</code>, otherwise 0.</td>
|
||||||
<td><b>Expression</b></td>
|
</tr>
|
||||||
<td><b>Effects</b></td>
|
|
||||||
</tr>
|
<tr>
|
||||||
<tr>
|
<td valign="top"><code>clk.locked()</code></td>
|
||||||
<td valign="top"><code>L lk(m);</code></td>
|
|
||||||
<td>Constructs an object <code>lk</code>, and associates mutex object <code>m</code>
|
<td>Returns a <code>bool</code>, <code>(&clk)->operator
|
||||||
with it, then calls <code>lock()</code></td>
|
const void*() != 0</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td valign="top"><code>L lk(m,b);</code></td>
|
<tr>
|
||||||
<td>Constructs an object <code>lk</code>, and associates mutex object <code>m</code>
|
<td valign="top"><code>lk.lock()</code></td>
|
||||||
with it, then if <code>b</code>, calls <code>lock()</code></td>
|
|
||||||
</tr>
|
<td>Throws lock_error if locked(). If the associated mutex is
|
||||||
</table>
|
already locked by some other thread, places the current thread
|
||||||
<h3><a name="ScopedTryLock-concept"></a>ScopedTryLock Concept</h3>
|
in the <a href="definitions.html#State">Blocked</a> state until
|
||||||
<p>A ScopedTryLock is a refinement of <a href="#Lock-concept">Lock</a>. For a
|
the associated mutex is unlocked, after which the current
|
||||||
ScopedTryLock type <code>L</code> and an object <code>lk</code> of that type,
|
thread is placed in the <a href="definitions.html#State">
|
||||||
and an object <code>m</code> of a type meeting the <a href="mutex_concept.html#TryMutex-concept">TryMutex</a>
|
Ready</a> state, eventually to be returned to the <a href=
|
||||||
requirements, and an object <code>b</code> of type <code>bool</code>, the following
|
"definitions.html#State">Running</a> state.<br>
|
||||||
expressions must be well-formed and have the indicated effects.</p>
|
Postcondition: locked()</td>
|
||||||
<table summary="ScopedTryLock expressions" border="1" cellpadding="5">
|
</tr>
|
||||||
<tr>
|
|
||||||
<td><b>Expression</b></td>
|
<tr>
|
||||||
<td><b>Effects</b></td>
|
<td valign="top"><code>lk.unlock()</code></td>
|
||||||
</tr>
|
|
||||||
<tr>
|
<td>If !locked(), throws lock_error, otherwise unlocks the
|
||||||
<td valign="top"><code>L lk(m);</code></td>
|
associated mutex.<br>
|
||||||
<td>Constructs an object <code>lk</code>, and associates mutex object <code>m</code>
|
Postcondition: !locked()</td>
|
||||||
with it, then calls <code>try_lock()</code></td>
|
</tr>
|
||||||
</tr>
|
</table>
|
||||||
<tr>
|
|
||||||
<td valign="top"><code>L lk(m,b);</code></td>
|
<h3><a name="ScopedLock">ScopedLock</a> Concept</h3>
|
||||||
<td>Constructs an object <code>lk</code>, and associates mutex object <code>m</code>
|
|
||||||
with it, then if <code>b</code>, calls <code> lock()</code></td>
|
<p>A ScopedLock must meet the <a href="#Lock">Lock</a> requirements.
|
||||||
</tr>
|
For a ScopedLock type <code>L</code> and an object <code>lk</code> of
|
||||||
<tr>
|
that type, and an object <code>m</code> of a type meeting the <a href=
|
||||||
<td valign="top"><code>lk.try_lock()</code></td>
|
"mutex_concept.html#Mutex">Mutex</a> requirements, and an object <code>
|
||||||
<td>If locked(), throws <code>lock_error</code>. Makes a non-blocking attempt
|
b</code> of type <code>bool</code>, the following expressions must be
|
||||||
to lock the associated mutex object, returning <code>true</code> if the
|
well-formed and have the indicated effects.</p>
|
||||||
lock attempt is successful, otherwise <code>false</code>. If the associated
|
|
||||||
mutex object is already locked by the same thread the behavior is dependent
|
<table summary="ScopedLock expressions" border="1" cellpadding="5">
|
||||||
on the <a href="mutex_concept.html#locking-strategies">locking strategy</a>
|
<tr>
|
||||||
of the associated mutex object.</td>
|
<td><b>Expression</b></td>
|
||||||
</tr>
|
|
||||||
</table>
|
<td><b>Effects</b></td>
|
||||||
<h3><a name="ScopedTimedLock-concept"></a>ScopedTimedLock Concept</h3>
|
</tr>
|
||||||
<p>A ScopedTimedLock is a refinement of <a href="#Lock">Lock</a>. For a ScopedTimedLock
|
|
||||||
type <code>L</code> and an object <code>lk</code> of that type, and an object
|
<tr>
|
||||||
<code>m</code> of a type meeting the <a href="mutex_concept.html#TimedMutex">TimedMutex</a>
|
<td valign="top"><code>L lk(m);</code></td>
|
||||||
requirements, and an object <code>b</code> of type <code>bool</code>, and an
|
|
||||||
object <code>t</code> of type <code><a href="xtime.html"> xtime</a></code>,
|
<td>Constructs an object <code>lk</code>, and associates mutex
|
||||||
the following expressions must be well-formed and have the indicated effects.</p>
|
<code>m</code> with it, then calls <code>lock()</code></td>
|
||||||
<table summary="ScopedTimedLock expressions" border="1" cellpadding=
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td valign="top"><code>L lk(m,b);</code></td>
|
||||||
|
|
||||||
|
<td>Constructs an object <code>lk</code>, and associates mutex
|
||||||
|
<code>m</code> with it, then if <code>b</code>, calls <code>
|
||||||
|
lock()</code></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<h3><a name="ScopedTryLock">ScopedTryLock</a> Concept</h3>
|
||||||
|
|
||||||
|
<p>A ScopedTryLock must meet the <a href="#Lock">Lock</a> requirements.
|
||||||
|
For a ScopedTryLock type <code>L</code> and an object <code>lk</code>
|
||||||
|
of that type, and an object <code>m</code> of a type meeting the <a
|
||||||
|
href="mutex_concept.html#TryMutex">TryMutex</a> requirements, and an
|
||||||
|
object <code>b</code> of type <code>bool</code>, the following
|
||||||
|
expressions must be well-formed and have the indicated effects.</p>
|
||||||
|
|
||||||
|
<table summary="ScopedTryLock expressions" border="1" cellpadding="5">
|
||||||
|
<tr>
|
||||||
|
<td><b>Expression</b></td>
|
||||||
|
|
||||||
|
<td><b>Effects</b></td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td valign="top"><code>L lk(m);</code></td>
|
||||||
|
|
||||||
|
<td>Constructs an object <code>lk</code>, and associates mutex
|
||||||
|
<code>m</code> with it, then calls <code>try_lock()</code></td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td valign="top"><code>L lk(m,b);</code></td>
|
||||||
|
|
||||||
|
<td>Constructs an object <code>lk</code>, and associates mutex
|
||||||
|
<code>m</code> with it, then if <code>b</code>, calls <code>
|
||||||
|
lock()</code></td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td valign="top"><code>lk.try_lock()</code></td>
|
||||||
|
|
||||||
|
<td>If locked(), throws <code>lock_error</code>. Makes a
|
||||||
|
non-blocking attempt to lock the associated mutex, returning
|
||||||
|
<code>true</code> if the lock attempt is successful, otherwise
|
||||||
|
<code>false</code>.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<h3><a name="ScopedTimedLock">ScopedTimedLock</a> Concept</h3>
|
||||||
|
|
||||||
|
<p>A ScopedTimedLock must meet the <a href="#Lock">Lock</a>
|
||||||
|
requirements. For a ScopedTimedLock type <code>L</code> and an object
|
||||||
|
<code>lk</code> of that type, and an object <code>m</code> of a type
|
||||||
|
meeting the <a href="mutex_concept.html#TimedMutex">TimedMutex</a>
|
||||||
|
requirements, and an object <code>b</code> of type <code>bool</code>,
|
||||||
|
and an object <code>t</code> of type <code><a href="xtime.html">
|
||||||
|
xtime</a></code>, the following expressions must be well-formed and
|
||||||
|
have the indicated effects.</p>
|
||||||
|
|
||||||
|
<table summary="ScopedTimedLock expressions" border="1" cellpadding=
|
||||||
"5">
|
"5">
|
||||||
<tr>
|
<tr>
|
||||||
<td><b>Expression</b></td>
|
<td><b>Expression</b></td>
|
||||||
<td><b>Effects</b></td>
|
|
||||||
</tr>
|
<td><b>Effects</b></td>
|
||||||
<tr>
|
</tr>
|
||||||
<td valign="top"><code>L lk(m,t);</code></td>
|
|
||||||
<td>Constructs an object <code>lk</code>, and associates mutex object <code>m</code>
|
<tr>
|
||||||
with it, then calls <code> timed_lock(t)</code></td>
|
<td valign="top"><code>L lk(m,t);</code></td>
|
||||||
</tr>
|
|
||||||
<tr>
|
<td>Constructs an object <code>lk</code>, and associates mutex
|
||||||
<td valign="top"><code>L lk(m,b);</code></td>
|
<code>m</code> with it, then calls <code>
|
||||||
<td>Constructs an object <code>lk</code>, and associates mutex object <code>m</code>
|
timed_lock(t)</code></td>
|
||||||
with it, then if <code>b</code>, calls <code> lock()</code></td>
|
</tr>
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td valign="top"><code>lk.timed_lock(t)</code></td>
|
<td valign="top"><code>L lk(m,b);</code></td>
|
||||||
<td>If locked(), throws lock_error. Makes a blocking attempt to lock the associated
|
|
||||||
mutex object, and returns <code>true</code> if successful within the specified
|
<td>Constructs an object <code>lk</code>, and associates mutex
|
||||||
time <code>t</code>, otherwise <code>false</code>. If the associated mutex
|
<code>m</code> with it, then if <code>b</code>, calls <code>
|
||||||
object is already locked by the same thread the behavior is dependent on
|
lock()</code></td>
|
||||||
the <a href="mutex_concept.html#locking-strategies">locking strategy</a>
|
</tr>
|
||||||
of the associated mutex object.</td>
|
|
||||||
</tr>
|
<tr>
|
||||||
</table>
|
<td valign="top"><code>lk.timed_lock(t)</code></td>
|
||||||
<hr>
|
|
||||||
<p>Revised
|
<td>If locked(), throws lock_error. Makes a blocking attempt to
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
lock the associated mutex, and returns <code>true</code> if
|
||||||
05 November, 2001
|
successful within the specified time <code>t</code>, otherwise
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
<code>false</code>.</td>
|
||||||
</p>
|
</tr>
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
</table>
|
||||||
All Rights Reserved.</i></p>
|
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
<h2><a name="Models">Models</a></h2>
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
<p><b>Boost.Threads</b> currently supplies three classes which model
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
lock concepts.</p>
|
||||||
makes no representations about the suitability of this software for any purpose.
|
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
<p>These classes are normally accessed via typedefs of the same name
|
||||||
</body>
|
supplied by a <a href="mutex_concept.html">mutex model</a>.</p>
|
||||||
|
|
||||||
|
<table summary="Lock concept classes" border="1" cellpadding="5">
|
||||||
|
<tr>
|
||||||
|
<td><b>Concept</b></td>
|
||||||
|
|
||||||
|
<td><b>Refines</b></td>
|
||||||
|
|
||||||
|
<td><b>Classes Modeling the Concept</b></td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td><a href="#ScopedLock">ScopedLock</a></td>
|
||||||
|
|
||||||
|
<td> </td>
|
||||||
|
|
||||||
|
<td><a href="scoped_lock.html">scoped_lock</a></td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td><a href="#ScopedTryLock">ScopedTryLock</a></td>
|
||||||
|
|
||||||
|
<td><a href="#ScopedLock">ScopedLock</a></td>
|
||||||
|
|
||||||
|
<td><a href="scoped_try_lock.html">scoped_try_lock</a> </td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td><a href="#ScopedTimedLock">ScopedTimedLock</a></td>
|
||||||
|
|
||||||
|
<td><a href="#ScopedLock">ScopedLock</a></td>
|
||||||
|
|
||||||
|
<td><a href="scoped_timed_lock.html">scoped_timed_lock</a></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|||||||
110
doc/lock_error.html
Normal file
110
doc/lock_error.html
Normal file
@@ -0,0 +1,110 @@
|
|||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content=
|
||||||
|
"text/html; charset=iso-8859-1">
|
||||||
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
|
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||||
|
|
||||||
|
<title>Boost.Threads, lock_error</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
|
width="100%">
|
||||||
|
<tr>
|
||||||
|
<td valign="top" width="300">
|
||||||
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
|
"277" height="86"></h3>
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td valign="top">
|
||||||
|
<h1 align="center">Boost.Threads</h1>
|
||||||
|
|
||||||
|
<h2 align="center">lock_error</h2>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
|
<a href="#Header">Header</a><br>
|
||||||
|
<a href="#Synopsis">Synopsis</a><br>
|
||||||
|
<a href="#Members">Members</a><br>
|
||||||
|
<a href="#Example">Example</a></p>
|
||||||
|
|
||||||
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
|
|
||||||
|
<p>The <tt>lock_error</tt> class defines an exception type thrown to
|
||||||
|
indicate a locking related error has been detected. Examples of such
|
||||||
|
errors include a lock operation which can be determined to result in a
|
||||||
|
deadlock, or unlock operations attempted by a thread that does not own
|
||||||
|
the lock.</p>
|
||||||
|
|
||||||
|
<h2><a name="Header">Header</a></h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/thread.hpp"><boost/thread/thread.hpp></a>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Synopsis">Synopsis</a></h2>
|
||||||
|
<pre>
|
||||||
|
namespace boost
|
||||||
|
|
||||||
|
class lock_error : public std::runtime_error
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
lock_error();
|
||||||
|
};
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Members">Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructor</h3>
|
||||||
|
<pre>
|
||||||
|
lock_error();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>Constructs a <tt>lock_error</tt> object.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><a name="Example">Example</a> Usage</h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/mutex.hpp"><boost/thread/mutex.hpp></a>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/thread.hpp"><boost/thread/thread.hpp></a>
|
||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
int main(int, char*[])
|
||||||
|
{
|
||||||
|
boost::mutex mutex;
|
||||||
|
boost::mutex::scoped_lock scoped_lock(mutex);
|
||||||
|
try
|
||||||
|
{
|
||||||
|
boost::mutex::scoped_lock deadlock(mutex);
|
||||||
|
std::cout << "lock succeeded" << std::endl;
|
||||||
|
}
|
||||||
|
catch (boost::lock_error& err)
|
||||||
|
{
|
||||||
|
std::cout << err.what() << " - deadlock occurred." << std::endl;
|
||||||
|
}
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>The output is:</p>
|
||||||
|
<pre>
|
||||||
|
thread lock error - deadlock occurred.
|
||||||
|
</pre>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
463
doc/mutex.html
463
doc/mutex.html
@@ -1,222 +1,298 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Type" content=
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
"text/html; charset=iso-8859-1">
|
||||||
<title>Boost.Threads - Header <boost/thread/mutex.hpp></title>
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
</head>
|
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||||
<body link="#0000ff" vlink="#800080">
|
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
<title>Boost.Threads, mutex</title>
|
||||||
"header">
|
</head>
|
||||||
<tr>
|
|
||||||
<td valign="top" width="300">
|
<body bgcolor="#ffffff" link="#0000ff" vlink="#800080">
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
</td>
|
width="100%">
|
||||||
<td valign="top">
|
<tr>
|
||||||
<h1 align="center">Boost.Threads</h1>
|
<td valign="top" width="300">
|
||||||
<h2 align="center">Header <<a href="../../../boost/thread/mutex.hpp">boost/thread/mutex.hpp</a>></h2>
|
<h3><img alt="C++ Boost" src="../../../c++boost.gif" width=
|
||||||
</td>
|
"277" height="86"></h3>
|
||||||
</tr>
|
</td>
|
||||||
</table>
|
|
||||||
<hr>
|
<td valign="top">
|
||||||
<h2>Contents</h2>
|
<h1 align="center">Boost.Threads</h1>
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#introduction">Introduction</a></dt>
|
<h2 align="center">mutex<br>
|
||||||
<dt><a href="#classes">Classes</a></dt>
|
try_mutex<br>
|
||||||
<dl class="page-index">
|
timed_mutex</h2>
|
||||||
<dt><a href="#class-mutex">Class <code>mutex</code></a></dt>
|
</td>
|
||||||
<dl class="page-index">
|
</tr>
|
||||||
<dt><a href="#class-mutex-synopsis">Class <code>mutex</code> synopsis</a></dt>
|
</table>
|
||||||
<dt><a href="#class-mutex-ctors">Class <code>mutex</code> constructors and
|
<hr>
|
||||||
destructor</a></dt>
|
|
||||||
</dl>
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
</dl>
|
<a href="#Header">Header</a><br>
|
||||||
<dl class="page-index">
|
<a href="#mutex Synopsis">Class mutex Synopsis</a><br>
|
||||||
<dt><a href="#class-try_mutex">Class <code>try_mutex</code></a></dt>
|
<a href="#mutex Members">Class mutex Members</a><br>
|
||||||
<dl class="page-index">
|
<a href="#try_mutex Synopsis">Class try_mutex Synopsis</a><br>
|
||||||
<dt><a href="#class-try_mutex-synopsis">Class <code>try_mutex</code> synopsis</a></dt>
|
<a href="#try_mutex Members">Class try_mutex Members</a><br>
|
||||||
<dt><a href="#class-try_mutex-ctors">Class <code>try_mutex</code> constructors
|
<a href="#timed_mutex Synopsis">Class timed_mutex Synopsis</a><br>
|
||||||
and destructor</a></dt>
|
<a href="#timed_mutex Members">Class timed_mutex Members</a><br>
|
||||||
</dl>
|
<a href="#Example">Example</a></p>
|
||||||
</dl>
|
|
||||||
<dl class="page-index">
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
<dt><a href="#class-timed_mutex">Class <code>timed_mutex</code></a></dt>
|
|
||||||
<dl class="page-index">
|
<p>The <tt><a href="#mutex Synopsis">mutex</a></tt>, <tt><a href=
|
||||||
<dt><a href="#class-timed_mutex-synopsis">Class <code>timed_mutex</code>
|
"#try_mutex Synopsis">try_mutex</a></tt> and <tt><a href=
|
||||||
synopsis</a></dt>
|
"#timed_mutex Synopsis">timed_mutex</a></tt> classes define full
|
||||||
<dt><a href="#class-timed_mutex-ctors">Class <code>timed_mutex</code> constructors
|
featured models of the <a href="mutex_concept.html#Mutex">Mutex</a>, <a
|
||||||
and destructor</a></dt>
|
href="mutex_concept.html#TryMutex">TryMutex</a>, and <a href=
|
||||||
</dl>
|
"mutex_concept.html#TimedMutex">TimedMutex</a> concepts. These types
|
||||||
</dl>
|
should be used to non-recursively synchronize access to shared
|
||||||
<dt><a href="#examples">Example(s)</a></dt>
|
resources. For recursive locking mechanics, see <a href=
|
||||||
</dl>
|
"recursive_mutex.html">recursive mutexes</a>.</p>
|
||||||
<hr>
|
|
||||||
<h2><a name="introduction"></a>Introduction</h2>
|
<p>Each class supplies one or more typedefs for lock types which model
|
||||||
<p>Include the header <<a href="../../../boost/thread/mutex.hpp">boost/thread/mutex.hpp</a>>
|
matching lock concepts. For the best possible performance you should
|
||||||
to define the <code><a href="#mutex Synopsis">mutex</a></code>, <code><a href=
|
use the mutex class that supports the minimum set of lock types that
|
||||||
"#try_mutex Synopsis">try_mutex</a></code> and <code><a href=
|
you need.</p>
|
||||||
"#timed_mutex Synopsis">timed_mutex</a></code> classes.</p>
|
|
||||||
<p>The <code><a href="#mutex Synopsis">mutex</a></code>, <code><a href=
|
<table summary="lock types" border="1" cellpadding="5">
|
||||||
"#try_mutex Synopsis">try_mutex</a></code> and <code><a href=
|
<tr>
|
||||||
"#timed_mutex Synopsis">timed_mutex</a></code> classes are models of <a href="mutex_concept.html#Mutex-concept">Mutex</a>,
|
<td><b>Mutex Class</b></td>
|
||||||
<a href="mutex_concept.html#TryMutex-concept">TryMutex</a>, and <a href="mutex_concept.html#TimedMutex-concept">TimedMutex</a>
|
|
||||||
respectively. These types should be used to non-recursively synchronize access
|
<td><b>Lock name</b></td>
|
||||||
to shared resources. For recursive locking mechanics, see the <a href="recursive_mutex.html">recursive
|
|
||||||
mutexes</a> supplied by <b>Boost.Threads</b>.</p>
|
<td><b>Implementation defined Lock Type</b></td>
|
||||||
<p>Each class supplies one or more typedefs for lock types which model matching
|
|
||||||
lock concepts. For the best possible performance you should use the mutex class
|
<td><b>Lock Concept</b></td>
|
||||||
that supports the minimum set of lock types that you need.</p>
|
</tr>
|
||||||
<table summary="lock types" border="1" cellpadding="5">
|
|
||||||
<tr>
|
<tr>
|
||||||
<td><b>Mutex Class</b></td>
|
<td valign="top"><a href="#mutex Synopsis"><code>
|
||||||
<td><b>Lock name</b></td>
|
mutex</code></a></td>
|
||||||
<td><b>Lock Concept</b></td>
|
|
||||||
</tr>
|
<td valign="middle"><code>scoped_lock</code></td>
|
||||||
<tr>
|
|
||||||
<td valign="top"><a href="#mutex Synopsis"><code> mutex</code></a></td>
|
<td valign="middle"><code><a href="scoped_lock.html">
|
||||||
<td valign="middle"><code>scoped_lock</code></td>
|
boost::</a></code><a href=
|
||||||
<td valign="middle"><a href="lock_concept.html#ScopedLock"> ScopedLock</a></td>
|
"scoped_lock.html"><code>detail::thread::scoped_lock<mutex></code></a></td>
|
||||||
</tr>
|
|
||||||
<tr>
|
<td valign="middle"><a href="lock_concept.html#ScopedLock">
|
||||||
<td valign="top"><code><a href="#try_mutex Synopsis"> try_mutex</a></code>
|
ScopedLock</a></td>
|
||||||
</td>
|
</tr>
|
||||||
<td valign="middle"><code>scoped_lock<br>
|
|
||||||
scoped_try_lock</code></td>
|
<tr>
|
||||||
<td valign="middle"><a href="lock_concept.html#ScopedLock"> ScopedLock</a><br>
|
<td valign="top"><tt><a href="#try_mutex Synopsis">
|
||||||
<a href="lock_concept.html#ScopedTryLock"> ScopedTryLock</a></td>
|
try_mutex</a></tt> </td>
|
||||||
</tr>
|
|
||||||
<tr>
|
<td valign="middle"><code>scoped_lock<br>
|
||||||
<td valign="top"><code><a href="#timed_mutex Synopsis"> timed_mutex</a></code>
|
scoped_try_lock</code></td>
|
||||||
</td>
|
|
||||||
<td valign="middle"><code>scoped_lock<br>
|
<td valign="middle"><code><a href="scoped_lock.html">
|
||||||
scoped_try_lock<br>
|
boost::</a></code><a href=
|
||||||
scoped_timed_lock</code></td>
|
"scoped_lock.html"><code>detail::thread::scoped_lock<try_mutex><br>
|
||||||
<td valign="middle"><a href="lock_concept.html#ScopedLock"> ScopedLock</a><br>
|
|
||||||
<a href="lock_concept.html#ScopedTryLock"> ScopedTryLock</a><br>
|
</code></a> <code><a href="scoped_try_lock.html">
|
||||||
<a href="lock_concept.html#ScopedTimedLock"> ScopedTimedLock</a></td>
|
boost::detail::thread::scoped_try_lock<try_mutex></a></code></td>
|
||||||
</tr>
|
|
||||||
</table>
|
<td valign="middle"><a href="lock_concept.html#ScopedLock">
|
||||||
<p>The <code>mutex</code>, <code>try_mutex</code> and <code>timed_mutex</code>
|
ScopedLock</a><br>
|
||||||
classes use an <code>Unspecified</code> <a href="mutex_concept.html#LockingStrategies">locking
|
<a href="lock_concept.html#ScopedTryLock">
|
||||||
strategy</a>, so attempts to recursively lock them or attempts to unlock them
|
ScopedTryLock</a></td>
|
||||||
by threads that don't own a lock on them result in <b>undefined behavior</b>.
|
</tr>
|
||||||
This strategy allows implementations to be as efficient as possible on any given
|
|
||||||
platform. It is, however, recommended that implementations include debugging
|
<tr>
|
||||||
support to detect misuse when <code>NDEBUG</code> is not defined.</p>
|
<td valign="top"><code><a href="#timed_mutex Synopsis">
|
||||||
<p>Like all the <b>Boost.Threads</b> <a href="mutex_concept.html">mutex models</a>,
|
timed_mutex</a></code> </td>
|
||||||
the <code>mutex</code>, <code>try_mutex</code> and <code> timed_mutex</code>
|
|
||||||
leave the <a href="mutex_concept.html#SchedulingPolicies">scheduling policy</a>
|
<td valign="middle"><code>scoped_lock<br>
|
||||||
as <code> Unspecified</code>. Programmers should make no assumptions about the
|
scoped_try_lock<br>
|
||||||
order in which waiting threads acquire a lock.</p>
|
scoped_timed_lock</code></td>
|
||||||
<h2><a name="classes"></a>Classes</h2>
|
|
||||||
<h3><a name="class-mutex"></a>Class <code>mutex</code></h3>
|
<td valign="middle"><code><a href="scoped_lock.html">
|
||||||
<p>The <code>mutex</code> class is a model of <a href="mutex_concept.html#Mutex-concept">Mutex</a>
|
boost::</a></code><a href=
|
||||||
and <a href="overview.html#non-copyable">NonCopyable</a>, and provides no additional
|
"scoped_lock.html"><code>detail::thread::scoped_lock<timed_mutex></code></a><br>
|
||||||
facilities beyond the requirements of these concepts.</p>
|
|
||||||
<h4><a name="class-mutex-synopsis"></a>Class <code>mutex</code> synopsis</h4>
|
<code><a href="scoped_try_lock.html">boost::</a></code><a
|
||||||
|
href=
|
||||||
|
"scoped_try_lock.html"><code>detail::thread::scoped_try_lock<timed_mutex></code></a><br>
|
||||||
|
|
||||||
|
<code><a href="scoped_timed_lock.html">boost::</a></code><a
|
||||||
|
href=
|
||||||
|
"scoped_timed_lock.html"><code>detail::thread::scoped_timed_lock<timed_mutex></code></a></td>
|
||||||
|
|
||||||
|
<td valign="middle"><a href="lock_concept.html#ScopedLock">
|
||||||
|
ScopedLock</a><br>
|
||||||
|
<a href="lock_concept.html#ScopedTryLock">
|
||||||
|
ScopedTryLock</a><br>
|
||||||
|
<a href="lock_concept.html#ScopedTimedLock">
|
||||||
|
ScopedTimedLock</a></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<p>The <tt>mutex</tt>, <tt>try_mutex</tt> and <tt>timed_mutex</tt>
|
||||||
|
classes use an <tt>Unspecified</tt> <a href=
|
||||||
|
"mutex_concept.html#LockingStrategies">locking strategy</a>, so
|
||||||
|
attempts to recursively lock them or attempts to unlock them by threads
|
||||||
|
that don't own a lock on them result in <b>undefined behavior</b>.
|
||||||
|
This strategy allows implementations to be as efficient as possible on
|
||||||
|
any given platform. It is, however, recommended that implementations
|
||||||
|
include debugging support to detect misuse when <tt>NDEBUG</tt> is not
|
||||||
|
defined.</p>
|
||||||
|
|
||||||
|
<p>Like all the <b>Boost.Threads</b> <a href="mutex_concept.html">mutex
|
||||||
|
models</a>, the <tt>mutex</tt>, <tt>try_mutex</tt> and <tt>
|
||||||
|
timed_mutex</tt> leave the <a href=
|
||||||
|
"mutex_concept.html#SchedulingPolicies">scheduling policy</a> as <tt>
|
||||||
|
Unspecified</tt>. Programmers should assume that threads waiting for a
|
||||||
|
lock on objects of these types acquire the lock in a random order, even
|
||||||
|
though the specific behavior for a given platform may be different.</p>
|
||||||
|
|
||||||
|
<h2><a name="Header">Header</a></h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/mutex.hpp"><boost/thread/mutex.hpp></a>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2>Class <a name="mutex Synopsis">mutex Synopsis</a></h2>
|
||||||
<pre>
|
<pre>
|
||||||
namespace boost
|
namespace boost
|
||||||
{
|
{
|
||||||
class mutex : private <a href="../../utility/utility.htm">boost::noncopyable</a> // Exposition only.
|
class mutex : private <a href=
|
||||||
// Class mutex meets the <a href="overview.html#non-copyable">NonCopyable</a> requirement.
|
"../../utility/utility.htm">boost::noncopyable</a> // Exposition only.
|
||||||
|
// Class mutex meets the <a href=
|
||||||
|
"overview.html#NonCopyable">NonCopyable</a> requirement.
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
typedef <i>[implementation defined; see <a href="#Introduction">Introduction</a>]</i> scoped_lock;
|
typedef <i>[implementation defined; see <a href=
|
||||||
|
"#Introduction">Introduction</a>]</i> scoped_lock;
|
||||||
|
|
||||||
mutex();
|
mutex();
|
||||||
~mutex();
|
~mutex();
|
||||||
};
|
};
|
||||||
};
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h4><a name="class-mutex-ctors"></a>Class <code>mutex</code> constructors and
|
|
||||||
destructor</h4>
|
<h2>Class <a name="mutex Members">mutex Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructor</h3>
|
||||||
<pre>
|
<pre>
|
||||||
mutex();
|
mutex();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Postconditions:</b> <code>*this</code> is in an unlocked state.</dt>
|
<p><b>Postconditions:</b> <code>*this</code> is in the unlocked
|
||||||
</dl>
|
state.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Destructor</h3>
|
||||||
<pre>
|
<pre>
|
||||||
~mutex();
|
~mutex();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> <code>*this</code> is in an unlocked sate.</dt>
|
<p><b>Requires:</b> <code>*this</code> is in the unlocked state.</p>
|
||||||
<dt><b>Danger:</b> Destruction of a locked mutex is a serious programming error
|
|
||||||
resulting in undefined behavior such as a program crash.</dt>
|
<p><b>Effects:</b> Destroys <code>*this</code>.</p>
|
||||||
</dl>
|
|
||||||
<h3><a name="class-try_mutex"></a>Class <code>try_mutex</code></h3>
|
<p><b>Dangers:</b> Destruction of a locked mutex is a serious
|
||||||
<p>The <code>try_mutex</code> class is a model of <a href="mutex_concept.html#TryMutex-concept">TryMutex</a>
|
programming error resulting in undefined behavior such as a program
|
||||||
and <a href="overview.html#non-copyable">NonCopyable</a>, and provides no additional
|
crash.</p>
|
||||||
facilities beyond the requirements of these concepts.</p>
|
<hr>
|
||||||
<h4><a name="class-try_mutex-synopsis"></a>Class <code>try_mutex</code> synopsis</h4>
|
|
||||||
|
<h2>Class <a name="try_mutex Synopsis">try_mutex Synopsis</a></h2>
|
||||||
<pre>
|
<pre>
|
||||||
namespace boost
|
namespace boost
|
||||||
{
|
{
|
||||||
class try_mutex : private <a href="../../utility/utility.htm">boost::noncopyable</a> // Exposition only.
|
class try_mutex : private boost::noncopyable // Exposition only.
|
||||||
// Class try_mutex meets the <a href="overview.html#non-copyable">NonCopyable</a> requirement.
|
// Class try_mutex meets the <a href=
|
||||||
|
"overview.html#NonCopyable">NonCopyable</a> requirement.
|
||||||
{
|
{
|
||||||
Public:
|
public:
|
||||||
typedef <i>[implementation defined; see <a href="#Introduction">Introduction</a>]</i> scoped_lock;
|
typedef <i>[implementation defined; see <a href=
|
||||||
typedef <i>[implementation defined; see <a href="#Introduction">Introduction</a>]</i> scoped_try_lock;
|
"#Introduction">Introduction</a>]</i> scoped_lock;
|
||||||
|
typedef <i>[implementation defined; see <a href=
|
||||||
|
"#Introduction">Introduction</a>]</i> scoped_try_lock;
|
||||||
|
|
||||||
try_mutex();
|
try_mutex();
|
||||||
~try_mutex();
|
~try_mutex();
|
||||||
};
|
};
|
||||||
};
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h4><a name="class-try_mutex-ctors"></a>Class <code>try_mutex</code> constructors
|
|
||||||
and destructor</h4>
|
<h2>Class <a name="try_mutex Members">try_mutex Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructor</h3>
|
||||||
<pre>
|
<pre>
|
||||||
try_mutex();
|
try_mutex();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Postconditions:</b> <code>*this</code> is in an unlocked state.</dt>
|
<p><b>Postconditions:</b> <code>*this</code> is in the unlocked
|
||||||
</dl>
|
state.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Destructor</h3>
|
||||||
<pre>
|
<pre>
|
||||||
~try_mutex();
|
~try_mutex();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> <code>*this</code> is in an unlocked sate.</dt>
|
<p><b>Requires:</b> <code>*this</code> is in the unlocked state.</p>
|
||||||
<dt><b>Danger:</b> Destruction of a locked mutex is a serious programming error
|
|
||||||
resulting in undefined behavior such as a program crash.</dt>
|
<p><b>Effects:</b> Destroys <code>*this</code>.</p>
|
||||||
</dl>
|
|
||||||
<h3><a name="class-timed_mutex"></a>Class <code>timed_mutex</code></h3>
|
<p><b>Dangers:</b> Destruction of a locked mutex is a serious
|
||||||
<p>The <code>timed_mutex</code> class is a model of <a href="mutex_concept.html#TimedMutex-concept">TimedMutex</a>
|
programming error resulting in undefined behavior such as a program
|
||||||
and <a href="overview.html#non-copyable">NonCopyable</a>, and provides no additional
|
crash.</p>
|
||||||
facilities beyond the requirements of these concepts.</p>
|
<hr>
|
||||||
<h4><a name="class-timed_mutex-synopsis"></a>Class <code>timed_mutex</code> synopsis</h4>
|
|
||||||
|
<h2>Class <a name="timed_mutex Synopsis">timed_mutex Synopsis</a></h2>
|
||||||
<pre>
|
<pre>
|
||||||
namespace boost
|
namespace boost
|
||||||
{
|
{
|
||||||
class timed_mutex : private <a href="../../utility/utility.htm">boost::noncopyable</a> // Exposition only.
|
class timed_mutex : private boost::noncopyable // Exposition only.
|
||||||
// Class timed_mutex meets the <a href="overview.html#non-copyable">NonCopyable</a> requirement.
|
// Class timed_mutex meets the <a href=
|
||||||
|
"overview.html#NonCopyable">NonCopyable</a> requirement.
|
||||||
{
|
{
|
||||||
Public:
|
public:
|
||||||
typedef <i>[implementation defined; see <a href="#Introduction">Introduction</a>]</i> scoped_lock;
|
typedef <i>[implementation defined; see <a href=
|
||||||
typedef <i>[implementation defined; see <a href="#Introduction">Introduction</a>]</i> scoped_try_lock;
|
"#Introduction">Introduction</a>]</i> scoped_lock;
|
||||||
typedef <i>[implementation defined; see <a href="#Introduction">Introduction</a>]</i> scoped_timed_lock;
|
typedef <i>[implementation defined; see <a href=
|
||||||
|
"#Introduction">Introduction</a>]</i> scoped_try_lock;
|
||||||
|
typedef <i>[implementation defined; see <a href=
|
||||||
|
"#Introduction">Introduction</a>]</i> scoped_timed_lock;
|
||||||
|
|
||||||
timed_mutex();
|
timed_mutex();
|
||||||
~timed_mutex();
|
~timed_mutex();
|
||||||
};
|
};
|
||||||
};
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h4><a name="class-timed_mutex-ctors"></a>Class <code>timed_mutex</code> constructors
|
|
||||||
and destructor</h4>
|
<h2>Class <a name="timed_mutex Members">timed_mutex Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructor</h3>
|
||||||
<pre>
|
<pre>
|
||||||
timed_mutex();
|
timed_mutex();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Postconditions:</b> <code>*this</code> is in an unlocked state.</dt>
|
<p><b>Postconditions:</b> <code>*this</code> is in the unlocked
|
||||||
</dl>
|
state.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Destructor</h3>
|
||||||
<pre>
|
<pre>
|
||||||
~timed_mutex();
|
~timed_mutex();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> <code>*this</code> is in an unlocked sate.</dt>
|
<p><b>Requires:</b> <code>*this</code> is in the unlocked state.</p>
|
||||||
<dt><b>Danger:</b> Destruction of a locked mutex is a serious programming error
|
|
||||||
resulting in undefined behavior such as a program crash.</dt>
|
<p><b>Effects:</b> Destroys <code>*this</code>.</p>
|
||||||
</dl>
|
|
||||||
<h2><a name="examples"></a>Example(s)</h2>
|
<p><b>Dangers:</b> Destruction of a locked mutex is a serious
|
||||||
|
programming error resulting in undefined behavior such as a program
|
||||||
|
crash.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><a name="Example">Example</a> Usage</h2>
|
||||||
<pre>
|
<pre>
|
||||||
#include <a href=
|
#include <a href=
|
||||||
"../../../boost/thread/mutex.hpp"><boost/thread/mutex.hpp></a>
|
"../../../boost/thread/mutex.hpp"><boost/thread/mutex.hpp></a>
|
||||||
@@ -244,7 +320,7 @@ private:
|
|||||||
|
|
||||||
counter c;
|
counter c;
|
||||||
|
|
||||||
void change_count()
|
void change_count(void*)
|
||||||
{
|
{
|
||||||
int i = c.increment();
|
int i = c.increment();
|
||||||
boost::mutex::scoped_lock scoped_lock(io_mutex);
|
boost::mutex::scoped_lock scoped_lock(io_mutex);
|
||||||
@@ -256,33 +332,28 @@ int main(int, char*[])
|
|||||||
const int num_threads = 4;
|
const int num_threads = 4;
|
||||||
boost::thread_group thrds;
|
boost::thread_group thrds;
|
||||||
for (int i=0; i < num_threads; ++i)
|
for (int i=0; i < num_threads; ++i)
|
||||||
thrds.create_thread(&change_count);
|
thrds.create_thread(&change_count, 0);
|
||||||
|
|
||||||
thrds.join_all();
|
thrds.join_all();
|
||||||
|
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<p>The output is:</p>
|
|
||||||
|
<p>The output is:</p>
|
||||||
<pre>
|
<pre>
|
||||||
count == 1
|
count == 1
|
||||||
count == 2
|
count == 2
|
||||||
count == 3
|
count == 3
|
||||||
count == 4
|
count == 4
|
||||||
</pre>
|
</pre>
|
||||||
<hr>
|
<hr>
|
||||||
<p>Revised
|
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
<p>Revised
|
||||||
05 November, 2001
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
|
||||||
</p>
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
All Rights Reserved.</i></p>
|
</body>
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
|
||||||
makes no representations about the suitability of this software for any purpose.
|
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|||||||
@@ -1,239 +1,337 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Type" content=
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
"text/html; charset=iso-8859-1">
|
||||||
<title>Boost.Threads - Mutex Concept</title>
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
</head>
|
|
||||||
<body link="#0000ff" vlink="#800080">
|
<title>Boost.Threads, Mutex Concept</title>
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
</head>
|
||||||
"header">
|
|
||||||
<tr>
|
<body bgcolor="#ffffff" link="#0000ff" vlink="#800080">
|
||||||
<td valign="top" width="300"> <a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a>
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
</td>
|
width="100%">
|
||||||
<td valign="top">
|
<tr>
|
||||||
<h1 align="center">Boost.Threads</h1>
|
<td valign="top" width="300">
|
||||||
<h2 align="center">Mutex Concept</h2>
|
<h3><img height="86" alt="C++ Boost" src=
|
||||||
</td>
|
"../../../c++boost.gif" width="277"></h3>
|
||||||
</tr>
|
</td>
|
||||||
</table>
|
|
||||||
<hr>
|
<td valign="top">
|
||||||
<dl class="page-index">
|
<h1 align="center">Boost.Threads</h1>
|
||||||
<dt><a href="#introduction">Introduction</a></dt>
|
|
||||||
<dt><a href="#locking-strategies">Locking Strategies</a></dt>
|
<h2 align="center">Mutex Concepts</h2>
|
||||||
<dl class="page-index">
|
</td>
|
||||||
<dt><a href="#locking-strategy-recursive">Recursive</a></dt>
|
</tr>
|
||||||
<dt><a href="#locking-strategy-checked">Checked</a></dt>
|
</table>
|
||||||
<dt><a href="#locking-strategy-unchecked">Unchecked</a></dt>
|
<hr>
|
||||||
<dt><a href="#locking-strategy-unspecified">Unspecified</a></dt>
|
|
||||||
</dl>
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
<dt><a href="#scheduling-policies">Scheduling Policies</a></dt>
|
<a href="#LockingStrategies">Locking Strategies</a><br>
|
||||||
<dl class="page-index">
|
<a href="#Recursive">Recursive</a><br>
|
||||||
<dt><a href="#scheduling-policy-FIFO">FIFO</a></dt>
|
<a href="#CheckedStrategy">Checked</a><br>
|
||||||
<dt><a href="#scheduling-policy-priority-driven">Priority Driven</a></dt>
|
<a href="#UncheckedStrategy">Unchecked</a><br>
|
||||||
<dt><a href="#scheduling-policy-unspecified">Unspecified</a></dt>
|
<a href="#UnspecifiedStrategy">
|
||||||
</dl>
|
Unspecified</a><br>
|
||||||
<dt><a href="#concept-requirements">Concept Requirements</a></dt>
|
<a href="#SchedulingPolicies">Scheduling Policies</a><br>
|
||||||
<dl class="page-index">
|
<a href="#FIFO">FIFO</a><br>
|
||||||
<dt><a href="#Mutex-concept">Mutex Concept</a></dt>
|
<a href="#Priority Driven">Priority
|
||||||
<dt><a href="#TryMutex-concept">TryMutex Concept</a></dt>
|
Driven</a><br>
|
||||||
<dt><a href="#TimedMutex-concept">TimedMutex Concept</a></dt>
|
<a href="#UndefinedScheduling">
|
||||||
</dl>
|
Undefined</a><br>
|
||||||
<dt><a href="#models">Models</a></dt>
|
<a href="#UnspecifiedScheduling">
|
||||||
</dl>
|
Unspecified</a><br>
|
||||||
<h2><a name="introduction"></a>Introduction</h2>
|
<a href="#Requirements">Concept Requirements</a><br>
|
||||||
<p>A mutex (short for mutual-exclusion) object is used to serializes access to
|
<a href="#Mutex">Mutex Concept</a><br>
|
||||||
a resource shared between multiple threads. The <a href="#Mutex">Mutex</a> concept,
|
<a href="#TryMutex">TryMutex Concept</a><br>
|
||||||
with <a href="#TryMutex">TryMutex</a> and <a href="#TimedMutex">TimedMutex</a>
|
<a href="#TimedMutex">TimedMutex
|
||||||
refinements, formalize the requirements. A model that implements Mutex and its
|
Concept</a><br>
|
||||||
refinements has two states: <b>locked</b> and <b>unlocked</b>. Before using
|
<a href="#Models">Models</a></p>
|
||||||
a shared resource, a thread locks a <b>Boost.Threads</b> mutex object (an object
|
|
||||||
whose type is a model of <a href="#Mutex-concept">Mutex</a> or one of it's
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
refinements), insuring <a href="definitions.html#thread-safe">thread-safe</a>
|
|
||||||
access to the shared resource. When use of the shared resource is complete,
|
<p>A mutex (short for mutual-exclusion) concept serializes access to a
|
||||||
the thread unlocks the mutex object, allowing another thread to acquire the
|
resource shared between multiple threads. The <a href="#Mutex">
|
||||||
lock and use the shared resource.</p>
|
Mutex</a> concept, with <a href="#TryMutex">TryMutex</a> and <a href=
|
||||||
<p>Traditional C thread APIs, like POSIX threads or the Windows thread APIs, expose
|
"#TimedMutex">TimedMutex</a> refinements, formalize the requirements. A
|
||||||
functions to lock and unlock a mutex object. This is dangerous since it's
|
model that implements Mutex and its refinements has two states: <b>
|
||||||
easy to forget to unlock a locked mutex. When the flow of control is complex,
|
locked</b> and <b>unlocked</b>. Before using a shared resource, a
|
||||||
with multiple return points, the likelihood of forgetting to unlock a mutex
|
thread locks a Boost.Threads mutex model object, insuring <a href=
|
||||||
object would become even greater. When exceptions are thrown, it becomes nearly
|
"definitions.html#Thread-safe">thread-safe</a> access to the shared
|
||||||
impossible to ensure that the mutex object is unlocked properly when using these
|
resource. When use of the shared resource is complete, the thread
|
||||||
traditional API's. The result is <a href="definitions.html#deadlock">deadlock</a>.</p>
|
unlocks the mutex model object, allowing another thread to acquire the
|
||||||
<p>Many C++ threading libraries use a pattern known as <i>Scoped Locking</i> <a href="bibliography.html#Schmidt-00">[Schmidt
|
lock and use the shared resource.</p>
|
||||||
00]</a> to free the programmer from the need to explicitly lock and unlock mutex
|
|
||||||
objects. With this pattern, a <a href="lock_concept.html">Lock</a> concept is
|
<p>Traditional C thread APIs, like Pthreads or the Windows thread APIs,
|
||||||
employed where the lock object's constructor locks the associated mutex
|
expose functions to lock and unlock a mutex model. This is dangerous
|
||||||
object and the destructor automatically does the unlocking. The <b>Boost.Threads</b>
|
since it's easy to forget to unlock a locked mutex. When the flow
|
||||||
library takes this pattern to the extreme in that Lock concepts are the only
|
of control is complex, with multiple return points, the likelihood of
|
||||||
way to lock and unlock a mutex object: lock and unlock functions are not exposed
|
forgetting to unlock a mutex model would become even greater. When
|
||||||
by any <b>Boost.Threads</b> mutex objects. This helps to ensure safe usage patterns,
|
exceptions are thrown, it becomes nearly impossible to ensure that the
|
||||||
especially when code throws exceptions.</p>
|
mutex is unlocked properly when using these traditional API's. The
|
||||||
<h2><a name="locking-strategies"></a>Locking Strategies</h2>
|
result is <a href="definitions.html#Deadlock">deadlock</a>.</p>
|
||||||
<p>Every mutex object follows one of several locking strategies. These strategies
|
|
||||||
define the semantics for the locking operation when the calling thread already
|
<p>Many C++ threading libraries use a pattern known as <i>Scoped
|
||||||
owns a lock on the mutex object.</p>
|
Locking</i> <a href="bibliography.html#Schmidt 00">[Schmidt 00]</a> to
|
||||||
<h3><a name="locking-strategy-recursive"></a>Recursive</h3>
|
free the programmer from the need to explicitly lock and unlock
|
||||||
<p>With a recursive locking strategy when a thread attempts to acquire a lock
|
mutexes. With this pattern, a <a href="lock_concept.html">lock
|
||||||
on the mutex object for which it already owns a lock, the operation is successful.
|
concept</a> is employed where the lock model's constructor locks
|
||||||
Note the distinction between a thread, which may have multiple locks outstanding
|
the associated mutex model and the destructor automatically does the
|
||||||
on a recursive mutex object, and a lock object, which even for a recursive mutex
|
unlocking. The <b>Boost.Threads</b> library takes this pattern to the
|
||||||
object cannot have any of its lock functions called multiple times without first
|
extreme in that lock concepts are the only way to lock and unlock a
|
||||||
calling unlock.</p>
|
mutex model: lock and unlock functions are not exposed by any <b>
|
||||||
<p>Internally a lock count is maintained and the owning thread must unlock the
|
Boost.Threads</b> mutex models. This helps to ensure safe usage
|
||||||
mutex model the same number of times that it's locked it before the mutex
|
patterns, especially when code throws exceptions.</p>
|
||||||
object's state returns to unlocked. Since mutex objects in <b>Boost.Threads</b>
|
|
||||||
expose locking functionality only through lock concepts, a thread will always
|
<h2><a name="LockingStrategies">Locking Strategies</a></h2>
|
||||||
unlock a mutex object the same number of times that it locked it. This helps
|
|
||||||
to eliminate a whole set of errors typically found in traditional C style thread
|
<p>Every mutex model follows one of several locking strategies. These
|
||||||
APIs.</p>
|
strategies define the semantics for the locking operation when the
|
||||||
<p>Classes <a href="recursive_mutex.html#class-recursive_mutex">recursive_mutex</a>,
|
calling thread already owns a lock on the mutex model.</p>
|
||||||
<a href="recursive_mutex.html#class-recursive_try_mutex">recursive_try_mutex</a>
|
|
||||||
and <a href="recursive_mutex.html#class-recursive_timed_mutex">recursive_timed_mutex</a>
|
<h3><a name="Recursive">Recursive</a></h3>
|
||||||
use this locking strategy.</p>
|
|
||||||
<h3><a name="locking-strategy-checked"></a>Checked</h3>
|
<p>With a recursive locking strategy when a thread attempts to acquire
|
||||||
<p>With a checked locking strategy when a thread attempts to acquire a lock on
|
a lock on the mutex model for which it already owns a lock, the
|
||||||
the mutex object for which the thread already owns a lock, the operation will
|
operation is successful. Note the distinction between a thread, which
|
||||||
fail with some sort of error indication. Further, attempts by a thread to unlock
|
may have multiple locks outstanding on a recursive mutex, and a lock
|
||||||
a mutex object that was not locked by the thread will also return some sort
|
object, which even for a recursive mutex cannot have its lock()
|
||||||
of error indication. In <b>Boost.Threads</b>, an exception of type <a href="exceptions.html#class-lock_error">
|
function called multiple times without first calling unlock().</p>
|
||||||
lock_error</a> would be thrown in these cases.</p>
|
|
||||||
<p><b>Boost.Threads</b> does not currently provide any mutex objects that use
|
<p>Internally a lock count is maintained and the owning thread must
|
||||||
this strategy.</p>
|
unlock the mutex model the same number of times that it's locked it
|
||||||
<h3><a name="locking-strategy-unchecked"></a>Unchecked</h3>
|
before the mutex model's state returns to unlocked. Since mutex
|
||||||
<p>With an unchecked locking strategy when a thread attempts to acquire a lock
|
models in <b>Boost.Threads</b> expose locking functionality only
|
||||||
on a mutex object for which the thread already owns a lock the operation will
|
through lock concepts, a thread will always unlock a mutex model the
|
||||||
<a href="definitions.html#definition-deadlock">deadlock</a>. In general this
|
same number of times that it locked it. This helps to eliminate a whole
|
||||||
locking strategy is less safe than a checked or recursive strategy, but it's
|
set of errors typically found in traditional C style thread APIs.</p>
|
||||||
also a faster strategy and so is employed by many libraries.</p>
|
|
||||||
<p><b>Boost.Threads</b> does not currently provide any mutex objects that use
|
<p>Classes <a href="recursive_mutex.html">recursive_mutex</a>, <a href=
|
||||||
this strategy.</p>
|
"recursive_mutex.html">recursive_try_mutex</a> and <a href=
|
||||||
<h3><a name="locking-strategy-unspecified"></a>Unspecified</h3>
|
"recursive_mutex.html">recursive_timed_mutex</a> use this locking
|
||||||
<p>With an unspecified locking strategy, when a thread attempts to acquire a lock
|
strategy.</p>
|
||||||
on a mutex object for which the thread already owns a lock the operation results
|
|
||||||
in <b>undefined behavior</b>.</p>
|
<h3><a name="CheckedStrategy">Checked</a></h3>
|
||||||
<p>In general a mutex object with an unspecified locking strategy is unsafe, and
|
|
||||||
it requires programmer discipline to use the mutex object properly. However,
|
<p>With a checked locking strategy when a thread attempts to acquire a
|
||||||
this strategy allows an implementation to be as fast as possible with no restrictions
|
lock on the mutex model for which the thread already owns a lock, the
|
||||||
on its implementation. This is especially true for portable implementations
|
operation will fail with some sort of error indication. Further,
|
||||||
that wrap the native threading support of a platform. For this reason, the classes
|
attempts by a thread to unlock a mutex that was not locked by the
|
||||||
<a href="mutex.html#class-mutex">mutex</a>, <a href="mutex.html#class-try_mutex">try_mutex</a>
|
thread will also return some sort of error indication. In <b>
|
||||||
and <a href="mutex.html#class-timed_mutex">timed_mutex</a> use this locking
|
Boost.Threads</b>, an exception of type <a href="lock_error.html">
|
||||||
strategy despite the lack of safety.</p>
|
lock_error</a> would be thrown in these cases.</p>
|
||||||
<h2><a name="scheduling-policies"></a>Scheduling Policies</h2>
|
|
||||||
<p>Every mutex object follows one of several scheduling policies. These policies
|
<p><b>Boost.Threads</b> does not currently provide any mutex models
|
||||||
define the semantics when the mutex object is unlocked and there is more than
|
that use this strategy.</p>
|
||||||
one thread waiting to acquire a lock. In other words, the policy defines which
|
|
||||||
waiting thread shall acquire the lock.</p>
|
<h3><a name="UncheckedStrategy">Unchecked</a></h3>
|
||||||
<h3><a name="scheduling-policy-FIFO"></a>FIFO</h3>
|
|
||||||
<p>With a FIFO scheduling policy, threads waiting for the lock will acquire it
|
<p>With an unchecked locking strategy when a thread attempts to acquire
|
||||||
in a first come first serve order (or First In First Out). This can help prevent
|
a lock on the mutex model for which the thread already owns a lock the
|
||||||
a high priority thread from starving lower priority threads that are also waiting
|
operation will <a href="definitions.html#Deadlock">deadlock</a>. In
|
||||||
on the mutex object's lock.</p>
|
general this locking strategy is less safe than a checked or recursive
|
||||||
<h3><a name="scheduling-policy-priority-driven"></a>Priority Driven</h3>
|
strategy, but it's also a faster strategy and so is employed by
|
||||||
<p>With a Priority Driven scheduling policy, the thread with the highest priority
|
many libraries.</p>
|
||||||
acquires the lock. Note that this means that low-priority threads may never
|
|
||||||
acquire the lock if the mutex object has high contention and there is always
|
<p><b>Boost.Threads</b> does not currently provide any mutex models
|
||||||
at least one high-priority thread waiting. This is known as thread starvation.
|
that use this strategy.</p>
|
||||||
When multiple threads of the same priority are waiting on the mutex object's
|
|
||||||
lock one of the other scheduling priorities will determine which thread shall
|
<h3><a name="UnspecifiedStrategy">Unspecified</a></h3>
|
||||||
acquire the lock.</p>
|
|
||||||
<h3><a name="scheduling-policy-unspecified"></a>Unspecified</h3>
|
<p>With an unspecified locking strategy, when a thread attempts to
|
||||||
<p>The mutex object does not specify a scheduling policy. In order to ensure portability,
|
acquire a lock on a mutex model for which the thread already owns a
|
||||||
all <b>Boost.Threads</b> mutex models use an unspecified scheduling policy.</p>
|
lock the operation results in <b>undefined behavior</b>. When a mutex
|
||||||
<h2><a name="concept-requirements"></a>Concept Requirements</h2>
|
model has an unspecified locking strategy the programmer must assume
|
||||||
<h3><a name="Mutex-concept"></a>Mutex Concept</h3>
|
that the mutex model instead uses an unchecked strategy.</p>
|
||||||
<p>A Mutex object has two states: locked and unlocked. Mutex object state can
|
|
||||||
only be determined by an object meeting the <a href="lock_concept.html#ScopedLock">ScopedLock</a>
|
<p>In general a mutex model with an unspecified locking strategy is
|
||||||
requirements and constructed for the Mutex object.</p>
|
unsafe, and it requires programmer discipline to use the mutex model
|
||||||
<p>A Mutex is <a href="../../utility/utility.htm#Class noncopyable">NonCopyable</a>.</p>
|
properly. However, this strategy allows an implementation to be as fast
|
||||||
<p>For a Mutex type M and an object m of that type, the following expressions
|
as possible with no restrictions on its implementation. This is
|
||||||
must be well-formed and have the indicated effects.</p>
|
especially true for portable implementations that wrap the native
|
||||||
<table summary="Mutex expressions" border="1" cellpadding="5">
|
threading support of a platform. For this reason, the classes <a href=
|
||||||
<tr>
|
"mutex.html">mutex</a>, <a href="mutex.html">try_mutex</a> and <a href=
|
||||||
<td><b>Expression</b></td>
|
"mutex.html">timed_mutex</a> use this locking strategy despite the lack
|
||||||
<td><b>Effects</b></td>
|
of safety.</p>
|
||||||
</tr>
|
|
||||||
<tr>
|
<h2><a name="SchedulingPolicies">Scheduling Policies</a></h2>
|
||||||
<td><code>M m;</code></td>
|
|
||||||
<td>Constructs a mutex object m. Post-condition: m is unlocked.</td>
|
<p>Every mutex model follows one of several scheduling policies. These
|
||||||
</tr>
|
policies define the semantics when the mutex model is unlocked and
|
||||||
<tr>
|
there is more than one thread waiting to acquire a lock. In other
|
||||||
<td><code>(&m)->~M();</code></td>
|
words, the policy defines which waiting thread shall acquire the
|
||||||
<td>Precondition: m is unlocked. Destroys a mutex object m.</td>
|
lock.</p>
|
||||||
</tr>
|
|
||||||
<tr>
|
<h3><a name="FIFO">FIFO</a></h3>
|
||||||
<td><code>M::scoped_lock</code></td>
|
|
||||||
<td>A model of <a href="lock_concept.html#ScopedLock">ScopedLock</a>.</td>
|
<p>With a FIFO scheduling policy, threads waiting for the lock will
|
||||||
</tr>
|
acquire it in a first come first serve order (or First In First Out).
|
||||||
</table>
|
This can help prevent a high priority thread from starving lower
|
||||||
<h3><a name="TryMutex-concept"></a>TryMutex Concept</h3>
|
priority threads that are also waiting on the mutex lock.</p>
|
||||||
<p>A TryMutex is a refinement of <a href="#Mutex-concept">Mutex</a>. For a TryMutex
|
|
||||||
type M and an object m of that type, the following expressions must be well-formed
|
<h3><a name="Priority Driven">Priority Driven</a></h3>
|
||||||
and have the indicated effects.</p>
|
|
||||||
<table summary="TryMutex expressions" border="1" cellpadding="5">
|
<p>With a Priority Driven scheduling policy, the thread with the
|
||||||
<tr>
|
highest priority acquires the lock. Note that this means that
|
||||||
<td><b>Expression</b></td>
|
low-priority threads may never acquire the lock if the mutex model has
|
||||||
<td><b>Effects</b></td>
|
high contention and there is always at least one high-priority thread
|
||||||
</tr>
|
waiting. This is known as thread starvation. When multiple threads of
|
||||||
<tr>
|
the same priority are waiting on the mutex lock one of the other
|
||||||
<td><code>M::scoped_try_lock</code></td>
|
scheduling priorities will determine which thread shall acquire the
|
||||||
<td>A model of <a href="lock_concept.html#ScopedTryLock">ScopedTryLock</a>.</td>
|
lock.</p>
|
||||||
</tr>
|
|
||||||
</table>
|
<h3><a name="UndefinedScheduling">Undefined</a></h3>
|
||||||
<h3><a name="TimedMutex-concept"></a>TimedMutex Concept</h3>
|
|
||||||
<p>A TimedMutex is a refinement of <a href="#TryMutex-concept">TryMutex</a>. For
|
<p>Threads acquire the lock in no particular order. Users should assume
|
||||||
a TimedMutex type M and an object m of that type, the following expressions
|
that low-priority threads may wait indefinitely, and that threads of
|
||||||
must be well-formed and have the indicated effects.</p>
|
the same priority acquire the lock in essentially random order.</p>
|
||||||
<table summary="TimedMutex expressions" border="1" cellpadding="5">
|
|
||||||
<tr>
|
<h3><a name="UnspecifiedScheduling">Unspecified</a></h3>
|
||||||
<td><b>Expression</b></td>
|
|
||||||
<td><b>Effects</b></td>
|
<p>The mutex model does not specify which scheduling policy is used.
|
||||||
</tr>
|
The programmer must assume that an undefined scheduling policy is used.
|
||||||
<tr>
|
In order to ensure portability, all <b>Boost.Threads</b> mutex models
|
||||||
<td><code>M::scoped_timed_lock</code></td>
|
use an unspecified scheduling policy.</p>
|
||||||
<td>A model of <a href="lock_concept.html#ScopedTimedLock">ScopedTimedLock</a>.</td>
|
|
||||||
</tr>
|
<h2>Concept <a name="Requirements">Requirements</a></h2>
|
||||||
</table>
|
|
||||||
<h2><a name="models"></a>Models</h2>
|
<h3><a name="Mutex">Mutex</a> Concept</h3>
|
||||||
<p><b>Boost.Threads</b> currently supplies six models of Mutex.</p>
|
|
||||||
<table summary="Mutex concept classes" border="1" cellpadding="5">
|
<p>A Mutex object has two states: locked and unlocked. Mutex object
|
||||||
<tr>
|
state can only be determined by an object meeting the <a href=
|
||||||
<td><b>Concept</b></td>
|
"lock_concept.html#ScopedLock">ScopedLock</a> requirements and
|
||||||
<td><b>Refines</b></td>
|
constructed for the Mutex object.</p>
|
||||||
<td><b>Models</b></td>
|
|
||||||
</tr>
|
<p>A Mutex is <a href="../../utility/utility.htm#Class noncopyable">
|
||||||
<tr>
|
noncopyable</a>.</p>
|
||||||
<td valign="top"><a href="#Mutex-concept">Mutex</a></td>
|
|
||||||
<td valign="top"> </td>
|
<p>For a Mutex type M and an object m of that type, the following
|
||||||
<td><a href="mutex.html">mutex</a><br>
|
expressions must be well-formed and have the indicated effects.</p>
|
||||||
<a href="recursive_mutex.html">recursive_mutex</a></td>
|
|
||||||
</tr>
|
<table summary="Mutex expressions" border="1" cellpadding="5">
|
||||||
<tr>
|
<tr>
|
||||||
<td valign="top"><a href="#TryMutex-concept">TryMutex</a></td>
|
<td><b>Expression</b></td>
|
||||||
<td valign="top"><a href="#Mutex-concept">Mutex</a></td>
|
|
||||||
<td><a href="mutex.html">try_mutex<br>
|
<td><b>Effects</b></td>
|
||||||
</a> <a href="recursive_mutex.html">recursive_try_mutex</a> </td>
|
</tr>
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td valign="top"><a href="#TimedMutex-concept">TimedMutex</a></td>
|
<td><code>M m;</code></td>
|
||||||
<td valign="top"><a href="#TryMutex-concept">TryMutex</a></td>
|
|
||||||
<td><a href="mutex.html">timed_mutex<br>
|
<td>Constructs a mutex object m. Post-condition: m is
|
||||||
</a> <a href="recursive_mutex.html"> recursive_timed_mutex</a></td>
|
unlocked.</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
|
||||||
<hr>
|
<tr>
|
||||||
<p>Revised
|
<td><code>(&m)->~M();</code></td>
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
|
||||||
05 November, 2001
|
<td>Precondition: m is unlocked. Destroys a mutex object
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
m.</td>
|
||||||
</p>
|
</tr>
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
|
||||||
All Rights Reserved.</i></p>
|
<tr>
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
<td><code>M::scoped_lock</code></td>
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
<td>A type meeting the <a href="lock_concept.html#ScopedLock">
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
ScopedLock</a> requirements.</td>
|
||||||
makes no representations about the suitability of this software for any purpose.
|
</tr>
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
</table>
|
||||||
</body>
|
|
||||||
|
<h3><a name="TryMutex">TryMutex</a> Concept</h3>
|
||||||
|
|
||||||
|
<p>A TryMutex must meet the <a href="#Mutex">Mutex</a> requirements. In
|
||||||
|
addition, for a TryMutex type M and an object m of that type, the
|
||||||
|
following expressions must be well-formed and have the indicated
|
||||||
|
effects.</p>
|
||||||
|
|
||||||
|
<table summary="TryMutex expressions" border="1" cellpadding="5">
|
||||||
|
<tr>
|
||||||
|
<td><b>Expression</b></td>
|
||||||
|
|
||||||
|
<td><b>Effects</b></td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td><code>M::scoped_try_lock</code></td>
|
||||||
|
|
||||||
|
<td>A type meeting the <a href=
|
||||||
|
"lock_concept.html#ScopedTryLock">ScopedTryLock</a>
|
||||||
|
requirements.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<h3><a name="TimedMutex">TimedMutex</a> Concept</h3>
|
||||||
|
|
||||||
|
<p>A TimedMutex must meet the <a href="#TryMutex">TryMutex</a>
|
||||||
|
requirements. In addition, for a TimedMutex type M and an object m of
|
||||||
|
that type, the following expressions must be well-formed and have the
|
||||||
|
indicated effects.</p>
|
||||||
|
|
||||||
|
<table summary="TimedMutex expressions" border="1" cellpadding="5">
|
||||||
|
<tr>
|
||||||
|
<td><b>Expression</b></td>
|
||||||
|
|
||||||
|
<td><b>Effects</b></td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td><code>M::scoped_timed_lock</code></td>
|
||||||
|
|
||||||
|
<td>A type meeting the <a href=
|
||||||
|
"lock_concept.html#ScopedTimedLock">ScopedTimedLock</a>
|
||||||
|
requirements.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<h2><a name="Models">Models</a></h2>
|
||||||
|
|
||||||
|
<p><b>Boost.Threads</b> currently supplies six classes which model
|
||||||
|
mutex concepts.</p>
|
||||||
|
|
||||||
|
<table summary="Mutex concept classes" border="1" cellpadding="5">
|
||||||
|
<tr>
|
||||||
|
<td><b>Concept</b></td>
|
||||||
|
|
||||||
|
<td><b>Refines</b></td>
|
||||||
|
|
||||||
|
<td><b>Classes Modeling the Concept</b></td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td valign="top"><a href="#Mutex">Mutex</a></td>
|
||||||
|
|
||||||
|
<td valign="top"> </td>
|
||||||
|
|
||||||
|
<td><a href="mutex.html">mutex</a><br>
|
||||||
|
<a href="recursive_mutex.html">recursive_mutex</a></td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td valign="top"><a href="#TryMutex">TryMutex</a></td>
|
||||||
|
|
||||||
|
<td valign="top"><a href="#Mutex">Mutex</a></td>
|
||||||
|
|
||||||
|
<td><a href="mutex.html">try_mutex<br>
|
||||||
|
</a> <a href="recursive_mutex.html">recursive_try_mutex</a>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td valign="top"><a href="#TimedMutex">TimedMutex</a></td>
|
||||||
|
|
||||||
|
<td valign="top"><a href="#TryMutex">TryMutex</a></td>
|
||||||
|
|
||||||
|
<td><a href="mutex.html">timed_mutex<br>
|
||||||
|
</a> <a href="recursive_mutex.html">
|
||||||
|
recursive_timed_mutex</a></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|||||||
116
doc/once.html
116
doc/once.html
@@ -1,116 +0,0 @@
|
|||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
|
||||||
<title>Boost.Threads - Header <boost/thread/once.hpp></title>
|
|
||||||
</head>
|
|
||||||
<body link="#0000ff" vlink="#800080">
|
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
|
||||||
"header">
|
|
||||||
<tr>
|
|
||||||
<td valign="top" width="300">
|
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
|
||||||
</td>
|
|
||||||
<td valign="top">
|
|
||||||
<h1 align="center">Boost.Threads</h1>
|
|
||||||
<h2 align="center">Header <<a href="../../../boost/thread/once.hpp">boost/thread/once.hpp</a>></h2>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<hr>
|
|
||||||
<h2>Contents</h2>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#introduction">Introduction</a></dt>
|
|
||||||
<dt><a href="#macros">Macros</a></dt>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#macro-BOOST_ONCE_INIT">BOOST_ONCE_INIT</a></dt>
|
|
||||||
</dl>
|
|
||||||
<dt><a href="#types">Types</a></dt>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#type-once_flag">once_flag</a></dt>
|
|
||||||
</dl>
|
|
||||||
<dt><a href="#functions">Functions</a></dt>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#function-call_once">call_once</a></dt>
|
|
||||||
</dl>
|
|
||||||
<dt><a href="#examples">Example(s)</a></dt>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<h2><a name="introduction"></a>Introduction</h2>
|
|
||||||
<p>Include the header <<a href="../../../boost/thread/once.hpp">boost/thread/once.hpp</a>>
|
|
||||||
to define the <code>call_once</code> function, <code>once_flag</code> type and
|
|
||||||
<code>BOOST_ONCE_INIT</code> constant.</p>
|
|
||||||
<p>The <code>call_once</code> function and <code>once_flag</code> type (statically
|
|
||||||
initialized to <code>BOOST_ONCE_INIT</code>) can be used to run a routine exactly
|
|
||||||
once. This can be used to initialize data in a <a href="definitions.html#Thread-safe">
|
|
||||||
thread-safe</a> manner.</p>
|
|
||||||
<h2><a name="macros"></a>Macros</h2>
|
|
||||||
<pre>
|
|
||||||
<a name="macro-BOOST_ONCE_INIT"></a>#define BOOST_ONCE_INIT <i>implementation defined</i>
|
|
||||||
</pre>
|
|
||||||
<p>This is a constant value used to initialize <code>once_flag</code> instances
|
|
||||||
to indicate that the logically associated routine has not been run yet.</p>
|
|
||||||
<h2><a name="types"></a>Types</h2>
|
|
||||||
<pre>
|
|
||||||
<a name="type-once_flag"></a>typedef <i>implementation defined</i> once_flag;
|
|
||||||
</pre>
|
|
||||||
<p>This implementation defined type is used as a flag to insure a routine is called
|
|
||||||
only once. Instances of this type should be statically initialized to <code>BOOST_ONCE_INIT</code>.</p>
|
|
||||||
<h2><a name="functions"></a>Functions</h2>
|
|
||||||
<pre>
|
|
||||||
<a name="function-call_once"></a>void call_once(void (*func)(), once_flag& flag);
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> The function <code>func</code> shall not throw exceptions.</dt>
|
|
||||||
<dt><b>Effects:</b> As if (in an atomic fashion):
|
|
||||||
<pre>
|
|
||||||
if (flag == BOOST_ONCE_INIT)
|
|
||||||
func();
|
|
||||||
</pre>
|
|
||||||
</dt>
|
|
||||||
<dt><b>Postconditions:</b> <code>flag != BOOST_ONCE_INIT</code></dt>
|
|
||||||
</dl>
|
|
||||||
<h2><a name="examples"></a>Example(s)</h2>
|
|
||||||
<pre>
|
|
||||||
#include <a href="../../../boost/thread/thread.hpp"><boost/thread/thread.hpp></a>
|
|
||||||
#include <a href="../../../boost/thread/tss.hpp"><boost/thread/once.hpp></a>
|
|
||||||
#include <cassert>
|
|
||||||
|
|
||||||
int value=0;
|
|
||||||
boost::once_flag once = BOOST_ONCE_INIT;
|
|
||||||
|
|
||||||
void init()
|
|
||||||
{
|
|
||||||
++value;
|
|
||||||
}
|
|
||||||
|
|
||||||
void thread_proc()
|
|
||||||
{
|
|
||||||
boost::call_once(&init, once);
|
|
||||||
}
|
|
||||||
|
|
||||||
int main(int argc, char* argv[])
|
|
||||||
{
|
|
||||||
boost::thread_group threads;
|
|
||||||
for (int i=0; i<5; ++i)
|
|
||||||
threads.create_thread(&thread_proc);
|
|
||||||
threads.join_all();
|
|
||||||
assert(value == 1);
|
|
||||||
}
|
|
||||||
</pre>
|
|
||||||
<hr>
|
|
||||||
<p>Revised
|
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
|
||||||
05 November, 2001
|
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
|
||||||
</p>
|
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
|
||||||
All Rights Reserved.</i></p>
|
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
|
||||||
makes no representations about the suitability of this software for any purpose.
|
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,173 +1,224 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Type" content=
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
"text/html; charset=windows-1252">
|
||||||
<title>Boost.Threads - Overview</title>
|
<meta name="GENERATOR" content="Microsoft FrontPage 4.0">
|
||||||
</head>
|
<meta name="ProgId" content="FrontPage.Editor.Document">
|
||||||
<body link="#0000ff" vlink="#800080">
|
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
<title>Boost.Threads Overview</title>
|
||||||
"header">
|
</head>
|
||||||
<tr>
|
|
||||||
<td valign="top" width="300">
|
<body>
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
</td>
|
width="100%">
|
||||||
<td valign="top">
|
<tr>
|
||||||
<h1 align="center">Boost.Threads</h1>
|
<td valign="top" width="300">
|
||||||
<h2 align="center">Overview</h2>
|
<h3><img height="86" alt="C++ Boost" src=
|
||||||
</td>
|
"../../../c++boost.gif" width="277"></h3>
|
||||||
</tr>
|
</td>
|
||||||
</table>
|
|
||||||
<hr>
|
<td valign="top">
|
||||||
<dl class="index">
|
<h1 align="center">Boost.Threads</h1>
|
||||||
<dt><a href="#introduction">Introduction</a></dt>
|
|
||||||
<dt><a href="#dangers">Dangers</a></dt>
|
<h2 align="center">Overview</h2>
|
||||||
<dl class="index">
|
</td>
|
||||||
<dt><a href="#testing-debugging">Testing and debugging considerations</a></dt>
|
</tr>
|
||||||
<dt><a href="#head-start">Getting a head start</a></dt>
|
</table>
|
||||||
</dl>
|
|
||||||
<dt><a href="#library">C++ Standard Library usage in multithreaded programs</a></dt>
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
<dl class="index">
|
<a href="#Dangers">Dangers</a><br>
|
||||||
<dt><a href="#runtime-libraries">Runtime libraries</a></dt>
|
<a href="#Library">C++ Standard Library usage</a><br>
|
||||||
<dt><a href="#non-thread-safe-functions">Potentially non-thread-safe functions</a></dt>
|
<a href="#Common">Common requirements</a></p>
|
||||||
</dl>
|
|
||||||
<dt><a href="#common-requirements">Common requirements for all Boost.Threads
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
components</a></dt>
|
|
||||||
<dl class="index">
|
<p>Boost.Threads allows C++ programs to execute as multiple,
|
||||||
<dt><a href="#exceptions">Exceptions</a></dt>
|
asynchronous, independent, threads-of-execution. Each thread has its
|
||||||
<dt><a href="#non-copyable">NonCopyable requirement</a></dt>
|
own machine state including program instruction counter and registers.
|
||||||
</dl>
|
Programs which execute as multiple threads are called multi-threaded
|
||||||
</dl>
|
programs to distinguish them from traditional single-threaded programs.
|
||||||
<h2><a name="introduction"></a>Introduction</h2>
|
<a href="definitions.html">Definitions</a> gives a more complete
|
||||||
<p>Boost.Threads allows C++ programs to execute as multiple, asynchronous, independent,
|
description of the multi-threading execution environment.</p>
|
||||||
threads-of-execution. Each thread has its own machine state including program
|
|
||||||
instruction counter and registers. Programs which execute as multiple threads
|
<p>Multi-threading provides several advantages:</p>
|
||||||
are called multithreaded programs to distinguish them from traditional single-threaded
|
|
||||||
programs. <a href="definitions.html">Definitions</a> gives a more complete description
|
<ul>
|
||||||
of the multithreading execution environment.</p>
|
<li>Programs which would otherwise block waiting for some external
|
||||||
<p>Multithreading provides several advantages:</p>
|
event can continue to respond if the blocking operation is placed
|
||||||
<ul>
|
in a separate thread. Multi-threading is usually an absolute
|
||||||
<li>Programs which would otherwise block waiting for some external event can
|
requirement for these programs.</li>
|
||||||
continue to respond if the blocking operation is placed in a separate thread.
|
</ul>
|
||||||
Multithreading is usually an absolute requirement for these programs.</li>
|
|
||||||
</ul>
|
<ul>
|
||||||
<ul>
|
<li>Well-designed multi-threaded programs may execute faster than
|
||||||
<li>Well-designed multithreaded programs may execute faster than single-threaded
|
single-threaded programs, particularly on multi-processor hardware.
|
||||||
programs, particularly on multiprocessor hardware. Note, however, that poorly-designed
|
Note, however, that poorly-designed multi-threaded programs are
|
||||||
multithreaded programs are often slower that single-threaded programs.</li>
|
often slower that single-threaded programs.</li>
|
||||||
</ul>
|
</ul>
|
||||||
<ul>
|
|
||||||
<li>Some program designs may be easier to formulate using a multithreaded approach.
|
<ul>
|
||||||
After all, the real world is asynchronous!</li>
|
<li>Some program designs may be easier to formulate using a
|
||||||
</ul>
|
multi-threaded approach. After all, the real world is
|
||||||
<h2><a name="dangers"></a>Dangers</h2>
|
asynchronous!</li>
|
||||||
<p>Beyond the errors which can occur in single-threaded programs, multithreaded
|
</ul>
|
||||||
programs are subject to additional errors:</p>
|
|
||||||
<ul>
|
<h2><a name="Dangers">Dangers</a></h2>
|
||||||
<li><a href="definitions.html#definition-race-condition">Race conditions</a>.</li>
|
|
||||||
<li><a href="definitions.html#definition-deadlock">Deadlock</a> (sometimes called
|
<p>Beyond the errors which can occur in single-threaded programs,
|
||||||
"deadly embrace")</li>
|
multi-threaded programs are subject to additional errors:</p>
|
||||||
<li><a href="definitions.html#definition-priority-failure">Priority failures</a>
|
|
||||||
(priority inversion, infinite overtaking, starvation, etc.)</li>
|
<ul>
|
||||||
</ul>
|
<li><a href="definitions.html#Race condition">Race
|
||||||
<p>Every multithreaded program must be designed carefully to avoid race conditions,
|
conditions</a>.</li>
|
||||||
priority failures and deadlock. These aren't rare or exotic failures - they
|
|
||||||
are virtually guaranteed to occur unless multithreaded code is designed to avoid
|
<li><a href="definitions.html#Deadlock">Deadlock</a> (sometimes
|
||||||
them. Priority failures are somewhat less common, but are nonetheless serious.</p>
|
called "deadly embrace")</li>
|
||||||
<p>The <a href="introduction.html">Boost.Threads design</a> attempts to minimize
|
|
||||||
these errors, but they will still occur unless the programmer proactively designs
|
<li><a href="definitions.html#Priority failure">Priority
|
||||||
to avoid them.</p>
|
failures</a> (priority inversion, infinite overtaking, starvation,
|
||||||
<h3><a name="testing-debugging"></a>Testing and debugging considerations</h3>
|
etc.)</li>
|
||||||
<p>Multithreaded programs are non-deterministic. In other words, the same program
|
</ul>
|
||||||
with the same input data may follow different execution paths each time it is
|
|
||||||
invoked. That can make testing and debugging a nightmare:</p>
|
<p>Every multi-threaded program must be designed carefully to avoid
|
||||||
<ul>
|
race conditions and deadlock. These aren't rare or exotic failures
|
||||||
<li>Failures are often not repeatable.</li>
|
- they are virtually guaranteed to occur unless multi-threaded code is
|
||||||
<li>Probe effect causes debuggers to produce very different results from non-debug
|
designed to avoid them. Priority failures are somewhat less common, but
|
||||||
uses.</li>
|
are none-the-less serious.</p>
|
||||||
<li>Debuggers require special support to show thread state.</li>
|
|
||||||
<li>Tests on a single processor system may give no indication of serious errors
|
<p>The <a href="introduction.html">Boost.Threads design</a> attempts to
|
||||||
which would appear on multiprocessor systems, and visa versa. Thus test cases
|
minimize these errors, but they will still occur unless the programmer
|
||||||
should include a varying number of processors.</li>
|
proactively designs to avoid them.</p>
|
||||||
<li>For programs which create a varying number of threads according to workload,
|
|
||||||
tests which don't span the full range of possibilities may miss serious
|
<h3>Testing and debugging considerations</h3>
|
||||||
errors.</li>
|
|
||||||
</ul>
|
<p>Multi-threaded programs are non-deterministic. In other words, the
|
||||||
<h3><a name="head-start"></a>Getting a head start</h3>
|
same program with the same input data may follow different execution
|
||||||
<p>Although it might appear that multithreaded programs are inherently unreliable,
|
paths each time it is invoked. That can make testing and debugging a
|
||||||
many reliable multithreaded programs do exist. Multithreading techniques are
|
nightmare:</p>
|
||||||
known which lead to reliable programs.</p>
|
|
||||||
<p>Design patterns for reliable multithreaded programs, including the important
|
<ul>
|
||||||
<i>monitor</i> pattern, are presented in <cite> Pattern-Oriented Software Architecture
|
<li>Failures are often not repeatable.</li>
|
||||||
Volume 2 - Patterns for Concurrent and Networked Objects</cite> [<a href=
|
|
||||||
"bibliography.html#Schmidt-00">Schmidt 00</a>]. Many important multithreading
|
<li>Probe effect causes debuggers to produce very different results
|
||||||
programming considerations (independent of threading library) are discussed
|
from non-debug uses.</li>
|
||||||
in <cite>Programming with POSIX Threads</cite> [<a href="bibliography.html#Butenhof-97">Butenhof
|
|
||||||
97</a>].</p>
|
<li>Debuggers require special support to show thread state.</li>
|
||||||
<p>Doing some reading before attempting multithreaded designs will give you a
|
|
||||||
head start toward reliable multithreaded programs.</p>
|
<li>Tests on a single processor system may give no indication of
|
||||||
<h2><a name="library"></a>C++ Standard Library usage in multithreaded programs</h2>
|
serious errors which would appear on multiprocessor systems, and
|
||||||
<h3><a name="runtime-libraries"></a>Runtime libraries</h3>
|
visa versa. Thus test cases should include a varying number of
|
||||||
<p><b>Warning:</b> Multithreaded programs such as those using <b> Boost.Threads</b>
|
processors.</li>
|
||||||
must link to <a href="definitions.html#Thread-safe"> thread-safe</a> versions
|
|
||||||
of all runtime libraries used by the program, including the runtime library
|
<li>For programs which create a varying number of threads according
|
||||||
for the C++ Standard Library. Otherwise <a href="definitions.html#Race condition">race
|
to workload, tests which don't span the full range of
|
||||||
conditions</a> will occur when multiple threads simultaneously execute runtime
|
possibilities may miss serious errors.</li>
|
||||||
library functions for <i>new</i>, <i>delete</i>, or other language features
|
</ul>
|
||||||
which imply shared state.</p>
|
|
||||||
<h3><a name="non-thread-safe-functions"></a>Potentially non-thread-safe functions</h3>
|
<h3>Getting a head start</h3>
|
||||||
<p>Certain C++ Standard Library functions inherited from C are particular problems
|
|
||||||
because they hold internal state between calls:</p>
|
<p>Although it might appear that multi-threaded programs are inherently
|
||||||
<ul>
|
unreliable, many reliable multi-threaded programs do exist.
|
||||||
<li>rand</li>
|
Multi-threading techniques are known which lead to reliable
|
||||||
<li>strtok</li>
|
programs.</p>
|
||||||
<li>asctime</li>
|
|
||||||
<li>ctime</li>
|
<p>Design patterns for reliable multi-threaded programs, including the
|
||||||
<li>gmtime</li>
|
important <i>monitor</i> pattern, are presented in <cite>
|
||||||
<li>localtime</li>
|
Pattern-Oriented Software Architecture Volume 2 - Patterns for
|
||||||
</ul>
|
Concurrent and Networked Objects</cite> [<a href=
|
||||||
<p>It is possible to write thread-safe implementations of these by using <a href="tss.html#class-thread_specific_ptr">thread-specific
|
"bibliography.html#Schmidt-00">Schmidt 00</a>]. Many important
|
||||||
storage</a>, and several C++ compiler vendors do just that. The technique is
|
multi-threading programming considerations (independent of threading
|
||||||
well-know and is explained in [<a href=
|
library) are discussed in <cite>Programming with POSIX Threads</cite>
|
||||||
"bibliography.html#Butenhof-97">Buttenhof 97</a>].</p>
|
[<a href="bibliography.html#Butenhof-97">Butenhof 97</a>].</p>
|
||||||
<p>But at least one vendor (HP-UX) does not provide thread-safe implementations
|
|
||||||
of the above functions in their otherwise thread-safe runtime library. Instead
|
<p>Doing some reading before attempting multi-threaded designs will give
|
||||||
they provide replacement functions with different names and arguments.</p>
|
you a head start toward reliable multi-threaded programs.</p>
|
||||||
<p><b>Recommendation:</b> For the most portable, yet thread-safe code, use Boost
|
|
||||||
replacements for the problem functions. See the <a href=
|
<h2><a name="Library">C++ Standard Library usage in multi-threaded
|
||||||
|
programs</a></h2>
|
||||||
|
|
||||||
|
<h3>Runtime libraries</h3>
|
||||||
|
|
||||||
|
<p><b>Warning:</b> Multi-threaded programs such as those using <b>
|
||||||
|
Boost.Threads</b> must link to <a href="definitions.html#Thread-safe">
|
||||||
|
thread-safe</a> versions of all runtime libraries used by the program,
|
||||||
|
including the runtime library for the C++ Standard Library. Otherwise
|
||||||
|
<a href="definitions.html#Race condition">race conditions</a> will
|
||||||
|
occur when multiple threads simultaneously execute runtime library
|
||||||
|
functions for <i>new</i>, <i>delete</i>, or other language features
|
||||||
|
which imply shared state.</p>
|
||||||
|
|
||||||
|
<h3>Potentially non-thread-safe functions</h3>
|
||||||
|
|
||||||
|
<p>Certain C++ Standard Library functions inherited from C are
|
||||||
|
particular problems because they hold internal state between calls:</p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>rand</li>
|
||||||
|
|
||||||
|
<li>strtok</li>
|
||||||
|
|
||||||
|
<li>asctime</li>
|
||||||
|
|
||||||
|
<li>ctime</li>
|
||||||
|
|
||||||
|
<li>gmtime</li>
|
||||||
|
|
||||||
|
<li>localtime</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<p>It is possible to write thread-safe implementations of these by
|
||||||
|
using <a href="thread_specific_ptr.html">thread-specific storage</a>,
|
||||||
|
and several C++ compiler vendors do just that. The technique is
|
||||||
|
well-know and is explained in [<a href=
|
||||||
|
"bibliography.html#Butenhof-97">Buttenhof-97</a>].</p>
|
||||||
|
|
||||||
|
<p>But at least one vendor (HP-UX) does not provide thread-safe
|
||||||
|
implementations of the above functions in their otherwise thread-safe
|
||||||
|
runtime library. Instead they provide replacement functions with
|
||||||
|
different names and arguments.</p>
|
||||||
|
|
||||||
|
<p><b>Recommendation:</b> For the most portable, yet thread-safe code,
|
||||||
|
use Boost replacements for the problem functions. See the <a href=
|
||||||
"../../random/index.html">Boost Random Number Library</a> and <a href=
|
"../../random/index.html">Boost Random Number Library</a> and <a href=
|
||||||
"../../tokenizer/index.htm">Boost Tokenizer Library</a>.</p>
|
"../../tokenizer/index.htm">Boost Tokenizer Library</a>.</p>
|
||||||
<h2><a name="common-gaurantees"></a>Common guarantees for all Boost.Threads components</h2>
|
|
||||||
<h3><a name="exceptions"></a>Exceptions</h3>
|
<h2><a name="Common">Common</a> requirements for all Boost.Threads
|
||||||
<p><b>Boost.Threads</b> destructors never throw exceptions. Unless otherwise specified,
|
components</h2>
|
||||||
other <b>Boost.Threads</b> functions that do not have an exception-specification
|
|
||||||
may throw implementation-defined exceptions.</p>
|
<h3>Exceptions</h3>
|
||||||
<p>In particular, <b>Boost.Threads</b> reports failure to allocate storage by
|
|
||||||
throwing an exception of type std::bad_alloc, or a class derived from std::bad_alloc,
|
<p><b>Boost.Threads</b> destructors never throw exceptions. Unless
|
||||||
failure to obtain thread resources other than memory by throwing an exception
|
otherwise specified, other <b>Boost.Threads</b> functions that do not
|
||||||
of type <a href="exceptions.html#class-thread_resource_error">boost::thread_resource_error</a>,
|
have an exception-specification may throw implementation-defined
|
||||||
and certain lock related failures by throwing an exception of type <a href="exceptions.html#class-lock_error">boost::lock_error</a></p>
|
exceptions.</p>
|
||||||
<p><b>Rationale:</b> Follows the C++ Standard Library practice of allowing all
|
|
||||||
functions except destructors or other specified functions to throw exceptions
|
<p>In particular, <b>Boost.Threads</b> reports failure to allocate
|
||||||
on errors.</p>
|
storage by throwing an exception of type std::bad_alloc, or a class
|
||||||
<h3><a name="non-copyable"></a>NonCopyable requirement</h3>
|
derived from std::bad_alloc, failure to obtain thread resources other
|
||||||
<p><b>Boost.Threads</b> classes documented as meeting the NonCopyable requirement
|
than memory by throwing an exception of type <a href=
|
||||||
disallow copy construction and copy assignment. For the sake of exposition,
|
"thread_resource_error.html">boost::thread_resource_error</a>, and
|
||||||
the synopsis of such classes show private derivation from <a href="../../utility/utility.htm">
|
certain lock related failures by throwing an exception of type <a href=
|
||||||
boost::noncopyable</a>. Users should not depend on this derivation, however,
|
"lock_error.html">boost::lock_error</a></p>
|
||||||
as implementations are free to meet the NonCopyable requirement in other ways.</p>
|
|
||||||
<hr>
|
<p><b>Rationale:</b> Follows the C++ Standard Library practice of
|
||||||
<p>Revised
|
allowing all functions except destructors or other specified functions
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
to throw exceptions on errors.</p>
|
||||||
05 November, 2001
|
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
<h3><a name="NonCopyable">NonCopyable</a> requirement</h3>
|
||||||
</p>
|
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
<p><b>Boost.Threads</b> classes documented as meeting the NonCopyable
|
||||||
All Rights Reserved.</i></p>
|
requirement disallow copy construction and copy assignment. For the
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
sake of exposition, the synopsis of such classes show private
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
derivation from <a href="../../utility/utility.htm">
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
boost::noncopyable</a>. Users should not depend on this derivation,
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
however, as implementations are free to meet the NonCopyable
|
||||||
makes no representations about the suitability of this software for any purpose.
|
requirement in other ways.</p>
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
<hr>
|
||||||
</body>
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p>© Copyright 2001 Beman Dawes</p>
|
||||||
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|||||||
@@ -1,174 +1,215 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Type" content=
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
"text/html; charset=iso-8859-1">
|
||||||
<title>Boost.Threads - Rationale</title>
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
</head>
|
|
||||||
<body link="#0000ff" vlink="#800080">
|
<title>Boost.Threads, rationale</title>
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
</head>
|
||||||
"header">
|
|
||||||
<tr>
|
<body bgcolor="#ffffff" link="#0000ff" vlink="#800080">
|
||||||
<td valign="top" width="300">
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
width="100%">
|
||||||
</td>
|
<tr>
|
||||||
<td valign="top">
|
<td valign="top" width="300">
|
||||||
<h1 align="center">Boost.Threads</h1>
|
<h3><img height="86" alt="C++ Boost" src=
|
||||||
<h2 align="center">Rationale</h2>
|
"../../../c++boost.gif" width="277"></h3>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
|
||||||
</table>
|
<td valign="top">
|
||||||
<hr>
|
<h1 align="center">Boost.Threads</h1>
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="#introduction">Introduction</a></dt>
|
<h2 align="center">Rationale</h2>
|
||||||
<dt><a href="#library">Rationale for the Creation of <b>Boost.Threads</b></a></dt>
|
</td>
|
||||||
<dt><a href="#primitives">Rationale for the Low Level Primitives Supported in
|
</tr>
|
||||||
<b>Boost.Threads</b></a></dt>
|
</table>
|
||||||
<dt><a href="#lock_objects">Rationale for the Lock Design</a></dt>
|
<hr>
|
||||||
<dt><a href="#non-copyable">Rationale for NonCopyable Thread Type</a></dt>
|
|
||||||
<dt><a href="#events">Rationale for not providing <i>Event Variables</i></a></dt>
|
<p>This page explains the rationale behind various design decisions in
|
||||||
</dl>
|
the <b>Boost.Threads</b> library. Having the rationale documented here
|
||||||
<h2><a name="introduction"></a>Introduction</h2>
|
should explain how we arrived at the current design as well as prevent
|
||||||
<p>This page explains the rationale behind various design decisions in the <b>Boost.Threads</b>
|
future rehashing of discussions and thought processes that have already
|
||||||
library. Having the rationale documented here should explain how we arrived
|
occurred. It can also give users a lot of insight into the design
|
||||||
at the current design as well as prevent future rehashing of discussions and
|
process required for this library.</p>
|
||||||
thought processes that have already occurred. It can also give users a lot of
|
|
||||||
insight into the design process required for this library.</p>
|
<h2><a name="library">Rationale for the Creation of
|
||||||
<h2><a name="library"></a>Rationale for the Creation of <b>Boost.Threads</b></h2>
|
Boost.Threads</a></h2>
|
||||||
<p>Processes often have a degree of "potential parallelism" and it can
|
|
||||||
often be more intuitive to design systems with this in mind. Further, these
|
<p>Processes often have a degree of "potential parallelism"
|
||||||
parallel processes can result in more responsive programs. The benefits for
|
and it can often be more intuitive to design systems with this in mind.
|
||||||
multithreaded programming are quite well known to most modern programmers, yet
|
Further, these parallel processes can result in more responsive
|
||||||
the C++ language doesn't directly support this concept.</p>
|
programs. The benefits for multi-threaded programming are quite well
|
||||||
<p>Many platforms support multithreaded programming despite the fact that the
|
known to most modern programmers, yet the C++ language doesn't
|
||||||
language doesn't support it. They do this through external libraries, which
|
directly support this concept.</p>
|
||||||
are, unfortunately, platform specific. POSIX has tried to address this problem
|
|
||||||
through the standardization of a "pthread" library. However, this
|
<p>Many platforms support multi-threaded programming despite the fact
|
||||||
is a standard only on POSIX platforms, so its portability is limited.</p>
|
that the language doesn't support it. They do this through external
|
||||||
<p>Another problem with POSIX and other platform specific thread libraries is
|
libraries, which are, unfortunately, platform specific. POSIX has tried
|
||||||
that they are almost universally C based libraries. This leaves several C++
|
to address this problem through the standardization of a
|
||||||
specific issues unresolved, such as what happens when an exception is thrown
|
"pthread" library. However, this is a standard only on POSIX
|
||||||
in a thread. Further, there are some C++ concepts, such as destructors, that
|
platforms, so its portability is limited.</p>
|
||||||
can make usage much easier than what's available in a C library.</p>
|
|
||||||
<p>What's truly needed is C++ language support for threads. However, the C++
|
<p>Another problem with POSIX and other platform specific thread
|
||||||
standards committee needs existing practice or a good proposal as a starting
|
libraries is that they are almost universally C based libraries. This
|
||||||
point for adding this to the standard.</p>
|
leaves several C++ specific issues unresolved, such as what happens
|
||||||
<p>The <b>Boost.Threads</b> library was developed to provide a C++ developer with
|
when an exception is thrown in a thread. Further, there are some C++
|
||||||
a portable interface for writing multithreaded programs on numerous platforms.
|
concepts, such as destructors, that can make usage much easier than
|
||||||
There's a hope that the library can be the basis for a more detailed proposal
|
what's available in a C library.</p>
|
||||||
for the C++ standards committee to consider for inclusion in the next C++ standard.</p>
|
|
||||||
<h2><a name="primitives"></a>Rationale for the Low Level Primitives Supported
|
<p>What's truly needed is C++ language support for threads.
|
||||||
in <b>Boost.Threads</b></h2>
|
However, the C++ standards committee needs existing practice or a good
|
||||||
<p>The <b>Boost.Threads</b> library supplies a set of low level primitives for
|
proposal as a starting point for adding this to the standard.</p>
|
||||||
writing multithreaded programs, such as mutexes and condition variables. In
|
|
||||||
fact, the first release of <b>Boost.Threads</b> supports only these low level
|
<p>The Boost.Threads library was developed to provide a C++ developer
|
||||||
primitives. However, computer science research has shown that use of these primitives
|
with a portable interface for writing multi-threaded programs on
|
||||||
is difficult since it's difficult to mathematically prove that a usage pattern
|
numerous platforms. There's a hope that the library can be the
|
||||||
is correct, meaning it doesn't result in race conditions or deadlocks. There
|
basis for a more detailed proposal for the C++ standards committee to
|
||||||
are several algebras (such as CSP, CCS and Join calculus) that have been developed
|
consider for inclusion in the next C++ standard.</p>
|
||||||
to help write provably correct parallel processes. In order to prove the correctness
|
|
||||||
these processes must be coded using higher level abstractions. So why does <b>Boost.Threads</b>
|
<h2><a name="primitives">Rationale for the Low Level Primitives
|
||||||
support the lower level concepts?</p>
|
Supported in Boost.Threads</a></h2>
|
||||||
<p>The reason is simple: the higher level concepts need to be implemented using
|
|
||||||
at least some of the lower level concepts. So having portable lower level concepts
|
<p>The Boost.Threads library supplies a set of low level primitives for
|
||||||
makes it easier to develop the higher level concepts and will allow researchers
|
writing multi-threaded programs, such as mutexes and condition variables.
|
||||||
to experiment with various techniques.</p>
|
In fact, the first release of Boost.Threads supports only these low level
|
||||||
<p>Beyond this theoretical application of higher level concepts, however, the
|
primitives. However, computer science research has shown that use of these
|
||||||
fact remains that many multithreaded programs are written using only the lower
|
primitives is difficult since there's no way to mathematically prove
|
||||||
level concepts, so they are useful in and of themselves, even if it's hard
|
that a usage pattern is correct, meaning it doesn't result in race
|
||||||
to prove that their usage is correct. Since many users will be familiar with
|
conditions or deadlocks. There are several algebras (such as CSP, CCS and
|
||||||
these lower level concepts but be unfamiliar with any of the higher level concepts
|
Join calculus) that have been developed to help write provably correct
|
||||||
there's also an argument for accessibility.</p>
|
parallel processes. In order to prove the correctness these processes must
|
||||||
<h2><a name="lock_objects"></a>Rationale for the Lock Design</h2>
|
be coded using higher level abstractions. So why does Boost.Threads support
|
||||||
<p>Programmers who are used to multithreaded programming issues will quickly note
|
the lower level concepts?</p>
|
||||||
that the Boost.Thread's design for mutex lock concepts is not <a href="definitions.html#Thread-safe">thread-safe</a>
|
|
||||||
(this is clearly documented as well). At first this may seem like a serious
|
<p>The reason is simple: the higher level concepts need to be
|
||||||
design flaw. Why have a multithreading primitive that's not thread-safe
|
implemented using at least some of the lower level concepts. So having
|
||||||
itself?</p>
|
portable lower level concepts makes it easier to develop the higher
|
||||||
<p>A lock object is not a synchronization primitive. A lock object's sole
|
level concepts and will allow researchers to experiment with various
|
||||||
responsibility is to ensure that a mutex is both locked and unlocked in a manner
|
techniques.</p>
|
||||||
that won't result in the common error of locking a mutex and then forgetting
|
|
||||||
to unlock it. This means that instances of a lock object are only going to be
|
<p>Beyond this theoretical application of higher level concepts,
|
||||||
created, at least in theory, within block scope and won't be shared between
|
however, the fact remains that many multi-threaded programs are written
|
||||||
threads. Only the mutex objects will be created outside of block scope and/or
|
using only the lower level concepts, so they are useful in and of
|
||||||
shared between threads. Though it's possible to create a lock object outside
|
themselves, even if it's hard to prove that their usage is correct.
|
||||||
of block scope and to share it between threads to do so would not be a typical
|
Since many users will be familiar with these lower level concepts but
|
||||||
usage (in fact, to do so would likely be an error). Nor are there any cases
|
be unfamiliar with any of the higher level concepts there's also an
|
||||||
when such usage would be required.</p>
|
argument for accessibility.</p>
|
||||||
<p>Lock objects must maintain some state information. In order to allow a program
|
|
||||||
to determine if a try_lock or timed_lock was successful the lock object must
|
<h2><a name="lock_objects">Rationale for the Lock Design</a></h2>
|
||||||
retain state indicating the success or failure of the call made in its constructor.
|
|
||||||
If a lock object were to have such state and remain thread-safe it would need
|
<p>Programmers who are used to multi-threaded programming issues will
|
||||||
to synchronize access to the state information which would result in roughly
|
quickly note that the Boost.Thread's design for mutex lock concepts
|
||||||
doubling the time of most operations. Worse, since checking the state can occur
|
is not <a href="definitions.html#Thread-safe">thread-safe</a> (this is
|
||||||
only by a call after construction we'd have a race condition if the lock
|
clearly documented as well). At first this may seem like a serious
|
||||||
object were shared between threads.</p>
|
design flaw. Why have a multi-threading primitive that's not
|
||||||
<p>So, to avoid the overhead of synchronizing access to the state information
|
thread-safe itself?</p>
|
||||||
and to avoid the race condition the <b>Boost.Threads</b> library simply does
|
|
||||||
nothing to make lock objects thread-safe. Instead, sharing a lock object between
|
<p>A lock object is not a synchronization primitive. A lock
|
||||||
threads results in undefined behavior. Since the only proper usage of lock objects
|
object's sole responsibility is to ensure that a mutex is both
|
||||||
is within block scope this isn't a problem, and so long as the lock object
|
locked and unlocked in a manner that won't result in the common
|
||||||
is properly used there's no danger of any multithreading issues.</p>
|
error of locking a mutex and then forgetting to unlock it. This means
|
||||||
<h2><a name="non-copyable"></a>Rationale for NonCopyable Thread Type</h2>
|
that instances of a lock object are only going to be created, at least
|
||||||
<p>Programmers who are used to C libraries for multithreaded programming are likely
|
in theory, within block scope and won't be shared between threads.
|
||||||
to wonder why <b>Boost.Threads</b> uses a noncopyable design for <a href="thread.html">boost::thread</a>.
|
Only the mutex objects will be created outside of block scope and/or
|
||||||
After all, the C thread types are copyable, and you often have a need for copying
|
shared between threads. Though it's possible to create a lock
|
||||||
them within user code. However, careful comparison of C designs to C++ designs
|
object outside of block scope and to share it between threads to do so
|
||||||
shows a flaw in this logic.</p>
|
would not be a typical usage. Nor are there any cases when such usage
|
||||||
<p>All C types are copyable. It is, in fact, not possible to make a noncopyable
|
would be required.</p>
|
||||||
type in C. For this reason types that represent system resources in C are often
|
|
||||||
designed to behave very similarly to a pointer to dynamic memory. There's
|
<p>Lock objects must maintain some state information. In order to allow
|
||||||
an API for acquiring the resource and an API for releasing the resources. For
|
a program to determine if a try_lock or timed_lock was successful the
|
||||||
memory we have pointers as the type and alloc/free for the acquisition and release
|
lock object must retain state indicating the success or failure of the
|
||||||
APIs. For files we have FILE* as the type and fopen/fclose for the acquisition
|
call made in its constructor. If a lock object were to have such state
|
||||||
and release APIs. You can freely copy instances of the types but must manually
|
and remain thread-safe it would need to synchronize access to the state
|
||||||
manage the lifetime of the actual resource through the acquisition and release
|
information which would result in roughly doubling the time of most
|
||||||
APIs.</p>
|
operations. Worse, since checking the state can occur only by a call
|
||||||
<p>C++ designs recognize that the acquisition and release APIs are error prone
|
after construction we'd have a race condition if the lock object
|
||||||
and try to eliminate possible errors by acquiring the resource in the constructor
|
were shared between threads.</p>
|
||||||
and releasing it in the destructor. The best example of such a design is the
|
|
||||||
std::iostream set of classes which can represent the same resource as the FILE*
|
<p>So, to avoid the overhead of synchronizing access to the state
|
||||||
type in C. A file is opened in the std::fstream's constructor and closed
|
information and to avoid the race condition the Boost.Threads library
|
||||||
in its destructor. However, if an iostream were copyable it could lead to a
|
simply does nothing to make lock objects thread-safe. Instead, sharing
|
||||||
file being closed twice, an obvious error, so the std::iostream types are noncopyable
|
a lock object between threads results in undefined behavior. Since the
|
||||||
by design. This is the same design used by boost::thread, which is a simple
|
only proper usage of lock objects is within block scope this isn't
|
||||||
and easy to understand design that's consistent with other C++ standard
|
a problem, and so long as the lock object is properly used there's
|
||||||
types.</p>
|
no danger of any multi-threading issues.</p>
|
||||||
<p>During the design of boost::thread it was pointed out that it would be possible
|
|
||||||
to allow it to be a copyable type if some form of "reference management"
|
<h2><a name="thread">Rationale for Non-copyable Thread Type</a></h2>
|
||||||
were used, such as ref-counting or ref-lists, and many argued for a boost::thread_ref
|
|
||||||
design instead. The reasoning was that copying "thread" objects was
|
<p>Programmers who are used to C libraries for multi-threaded
|
||||||
a typical need in the C libraries, and so presumably would be in the C++ libraries
|
programming are likely to wonder why Boost.Threads uses a non-copyable
|
||||||
as well. It was also thought that implementations could provide more efficient
|
design for <a href="thread.html">boost::thread</a>. After all, the C
|
||||||
reference management than wrappers (such as boost::shared_ptr) around a noncopyable
|
thread types are copyable, and you often have a need for copying them
|
||||||
thread concept. Analysis of whether or not these arguments would hold true doesn't
|
within user code. However, careful comparison of C designs to C++
|
||||||
appear to bear them out. To illustrate the analysis we'll first provide
|
designs shows a flaw in this logic.</p>
|
||||||
pseudo-code illustrating the six typical usage patterns of a thread object.</p>
|
|
||||||
<h3>1. Simple creation of a thread.</h3>
|
<p>All C types are copyable. It is, in fact, not possible to make a
|
||||||
|
non-copyable type in C. For this reason types that represent system
|
||||||
|
resources in C are often designed to behave very similarly to a pointer
|
||||||
|
to dynamic memory. There's an API for acquiring the resource and an
|
||||||
|
API for releasing the resources. For memory we have pointers as the
|
||||||
|
type and alloc/free for the acquisition and release APIs. For files we
|
||||||
|
have FILE* as the type and fopen/fclose for the acquisition and release
|
||||||
|
APIs. You can freely copy instances of the types but must manually
|
||||||
|
manage the lifetime of the actual resource through the acquisition and
|
||||||
|
release APIs.</p>
|
||||||
|
|
||||||
|
<p>C++ designs recognize that the acquisition and release APIs are
|
||||||
|
error prone and try to eliminate possible errors by acquiring the
|
||||||
|
resource in the constructor and releasing it in the destructor. The
|
||||||
|
best example of such a design is the std::iostream set of classes which
|
||||||
|
can represent the same resource as the FILE* type in C. A file is
|
||||||
|
opened in the std::fstream's constructor and closed in its
|
||||||
|
destructor. However, if an iostream were copyable it could lead to a
|
||||||
|
file being closed twice, an obvious error, so the std::iostream types
|
||||||
|
are noncopyable by design. This is the same design used by
|
||||||
|
boost::thread, which is a simple and easy to understand design
|
||||||
|
that's consistent with other C++ standard types.</p>
|
||||||
|
|
||||||
|
<p>During the design of boost::thread it was pointed out that it would
|
||||||
|
be possible to allow it to be a copyable type if some form of
|
||||||
|
"reference management" were used, such as ref-counting or
|
||||||
|
ref-lists, and many argued for a boost::thread_ref design instead. The
|
||||||
|
reasoning was that copying "thread" objects was a typical
|
||||||
|
need in the C libraries, and so presumably would be in the C++
|
||||||
|
libraries as well. It was also thought that implementations could
|
||||||
|
provide more efficient reference management then wrappers (such as
|
||||||
|
boost::shared_ptr) around a noncopyable thread concept. Analysis of
|
||||||
|
whether or not these arguments would hold true don't appear to bear
|
||||||
|
them out. To illustrate the analysis we'll first provide
|
||||||
|
pseudo-code illustrating the six typical usage patterns of a thread
|
||||||
|
object.</p>
|
||||||
|
|
||||||
|
<h3>1. Simple creation of a thread.</h3>
|
||||||
<pre>
|
<pre>
|
||||||
void foo()
|
void foo()
|
||||||
{
|
{
|
||||||
create_thread(&bar);
|
create_thread(&bar);
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h3>2. Creation of a thread that's later joined.</h3>
|
|
||||||
|
<h3>2. Creation of a thread that's later joined.</h3>
|
||||||
<pre>
|
<pre>
|
||||||
Void foo()
|
void foo()
|
||||||
{
|
{
|
||||||
thread = create_thread(&bar);
|
thread = create_thread(&bar);
|
||||||
join(thread);
|
join(thread);
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h3>3. Simple creation of several threads in a loop.</h3>
|
|
||||||
|
<h3>3. Simple creation of several threads in a loop.</h3>
|
||||||
<pre>
|
<pre>
|
||||||
Void foo()
|
void foo()
|
||||||
{
|
{
|
||||||
for (int i=0; i<NUM_THREADS; ++i)
|
for (int i=0; i<NUM_THREADS; ++i)
|
||||||
create_thread(&bar);
|
create_thread(&bar);
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h3>4. Creation of several threads in a loop which are later joined.</h3>
|
|
||||||
|
<h3>4. Creation of several threads in a loop which are later
|
||||||
|
joined.</h3>
|
||||||
<pre>
|
<pre>
|
||||||
Void foo()
|
void foo()
|
||||||
{
|
{
|
||||||
for (int i=0; i<NUM_THREADS; ++i)
|
for (int i=0; i<NUM_THREADS; ++i)
|
||||||
threads[i] = create_thread(&bar);
|
threads[i] = create_thread(&bar);
|
||||||
@@ -176,41 +217,54 @@ Void foo()
|
|||||||
threads[i].join();
|
threads[i].join();
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h3>5. Creation of a thread whose ownership is passed to another object/method.</h3>
|
|
||||||
|
<h3>5. Creation of a thread whose ownership is passed to another
|
||||||
|
object/method.</h3>
|
||||||
<pre>
|
<pre>
|
||||||
Void foo()
|
void foo()
|
||||||
{
|
{
|
||||||
thread = create_thread(&bar);
|
thread = create_thread(&bar);
|
||||||
manager.owns(thread);
|
manager.owns(thread);
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h3>6. Creation of a thread whose ownership is shared between multiple objects.</h3>
|
|
||||||
|
<h3>6. Creation of a thread whose ownership is shared between multiple
|
||||||
|
objects.</h3>
|
||||||
<pre>
|
<pre>
|
||||||
Void foo()
|
void foo()
|
||||||
{
|
{
|
||||||
thread = create_thread(&bar);
|
thread = create_thread(&bar);
|
||||||
manager1.add(thread);
|
manager1.add(thread);
|
||||||
manager2.add(thread);
|
manager2.add(thread);
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<p>Of these usage patterns there's only one that requires reference management
|
|
||||||
(number 6). Hopefully it's fairly obvious that this usage pattern simply
|
<p>Of these usage patterns there's only one that requires reference
|
||||||
won't occur as often as the other usage patterns. So there really isn't
|
management (number 6). Hopefully it's fairly obvious that this
|
||||||
a "typical need" for a thread concept, though there is some need.</p>
|
usage pattern simply won't occur as often as the other usage
|
||||||
<p>Since the need isn't typical we must use different criteria for deciding
|
patterns. So there really isn't a "typical need" for a
|
||||||
on either a thread_ref or thread design. Possible criteria include ease of use
|
thread concept, though there is some need.</p>
|
||||||
and performance. So let's analyze both of these carefully.</p>
|
|
||||||
<p>With ease of use we can look at existing experience. The standard C++ objects
|
<p>Since the need isn't typical we must use different criteria for
|
||||||
that represent a system resource, such as std::iostream, are noncopyable, so
|
deciding on either a thread_ref or thread design. Possible criteria
|
||||||
we know that C++ programmers must at least be experienced with this design.
|
include ease of use and performance. So let's analyze both of these
|
||||||
Most C++ developers are also used to smart pointers such as boost::shared_ptr,
|
carefully.</p>
|
||||||
so we know they can at least adapt to a thread_ref concept with little effort.
|
|
||||||
So existing experience isn't going to lead us to a choice.</p>
|
<p>With ease of use we can look at existing experience. The standard
|
||||||
<p>The other thing we can look at is how difficult it is to use both types for
|
C++ objects that represent a system resource, such as std::iostream,
|
||||||
the six usage patterns above. If we find it overly difficult to use a concept
|
are noncopyable, so we know that C++ programmers must at least be
|
||||||
for any of the usage patterns there would be a good argument for choosing the
|
experienced with this design. Most C++ developers are also used to
|
||||||
other design. So we'll code all six usage patterns using both designs.</p>
|
smart pointers such as boost::shared_ptr, so we know they can at least
|
||||||
<h3>1.</h3>
|
adapt to a thread_ref concept with little effort. So existing
|
||||||
|
experience isn't going to lead us to a choice.</p>
|
||||||
|
|
||||||
|
<p>The other thing we can look at is how difficult it is to use both
|
||||||
|
types for the six usage patterns above. If we find it overly difficult
|
||||||
|
to use a concept for any of the usage patterns there would be a good
|
||||||
|
argument for choosing the other design. So we'll code all six usage
|
||||||
|
patterns using both designs.</p>
|
||||||
|
|
||||||
|
<h3>1.</h3>
|
||||||
<pre>
|
<pre>
|
||||||
void foo()
|
void foo()
|
||||||
{
|
{
|
||||||
@@ -222,7 +276,8 @@ void foo()
|
|||||||
thread_ref thrd = create_thread(&bar);
|
thread_ref thrd = create_thread(&bar);
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h3>2.</h3>
|
|
||||||
|
<h3>2.</h3>
|
||||||
<pre>
|
<pre>
|
||||||
void foo()
|
void foo()
|
||||||
{
|
{
|
||||||
@@ -236,7 +291,8 @@ void foo()
|
|||||||
create_thread(&bar);thrd->join();
|
create_thread(&bar);thrd->join();
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h3>3.</h3>
|
|
||||||
|
<h3>3.</h3>
|
||||||
<pre>
|
<pre>
|
||||||
void foo()
|
void foo()
|
||||||
{
|
{
|
||||||
@@ -250,7 +306,8 @@ void foo()
|
|||||||
thread_ref thrd = create_thread(&bar);
|
thread_ref thrd = create_thread(&bar);
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h3>4.</h3>
|
|
||||||
|
<h3>4.</h3>
|
||||||
<pre>
|
<pre>
|
||||||
void foo()
|
void foo()
|
||||||
{
|
{
|
||||||
@@ -270,7 +327,8 @@ void foo()
|
|||||||
++i)threads[i]->join();
|
++i)threads[i]->join();
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h3>5.</h3>
|
|
||||||
|
<h3>5.</h3>
|
||||||
<pre>
|
<pre>
|
||||||
void foo()
|
void foo()
|
||||||
{
|
{
|
||||||
@@ -284,7 +342,8 @@ void foo()
|
|||||||
manager.owns(thrd);
|
manager.owns(thrd);
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h3>6.</h3>
|
|
||||||
|
<h3>6.</h3>
|
||||||
<pre>
|
<pre>
|
||||||
void foo()
|
void foo()
|
||||||
{
|
{
|
||||||
@@ -300,14 +359,16 @@ void foo()
|
|||||||
manager2.add(thrd);
|
manager2.add(thrd);
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<p>This shows the usage patterns being nearly identical in complexity for both
|
|
||||||
designs. The only actual added complexity occurs because of the use of operator
|
<p>This shows the usage patterns being nearly identical in complexity
|
||||||
new in (4), (5) and (6) and the use of std::auto_ptr and boost::shared_ptr in
|
for both designs. The only actual added complexity occurs because of
|
||||||
(4) and (6) respectively. However, that's not really much added complexity,
|
the use of operator new in (4), (5) and (6) and the use of
|
||||||
and C++ programmers are used to using these idioms any way. Some may dislike
|
std::auto_ptr and boost::shared_ptr in (4) and (6) respectively.
|
||||||
the presence of operator new in user code, but this can be eliminated by proper
|
However, that's not really much added complexity, and C++
|
||||||
design of higher level concepts, such as the boost::thread_group class that
|
programmers are used to using these idioms any way. Some may dislike
|
||||||
simplifies example (4) down to:</p>
|
the presence of operator new in user code, but this can be eliminated
|
||||||
|
by proper design of higher level concepts, such as the
|
||||||
|
boost::thread_group class that simplifies example (4) down to:</p>
|
||||||
<pre>
|
<pre>
|
||||||
void foo()
|
void foo()
|
||||||
{
|
{
|
||||||
@@ -317,83 +378,104 @@ void foo()
|
|||||||
threads.join_all();
|
threads.join_all();
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<p>So ease of use is really a wash and not much help in picking a design.</p>
|
|
||||||
<p>So what about performance? If you look at the above code examples we can analyze
|
<p>So ease of use is really a wash and not much help in picking a
|
||||||
the theoretical impact to performance that both designs have. For (1) we can
|
design.</p>
|
||||||
see that platforms that don't have a ref-counted native thread type (POSIX,
|
|
||||||
for instance) will be impacted by a thread_ref design. Even if the native thread
|
<p>So what about performance? If you look at the above code examples we
|
||||||
type is ref-counted there may be an impact if more state information has to
|
can analyze the theoretical impact to performance that both designs
|
||||||
be maintained for concepts foreign to the native API, such as clean up stacks
|
have. For (1) we can see that platforms that don't have a
|
||||||
for Win32 implementations. For (2) the performance impact will be identical
|
ref-counted native thread type (POSIX, for instance) will be impacted
|
||||||
to (1). The same for (3). For (4) things get a little more interesting and we
|
by a thread_ref design. Even if the native thread type is ref-counted
|
||||||
find that theoretically at least the thread_ref may perform faster since the
|
there may be an impact if more state information has to be maintained
|
||||||
thread design requires dynamic memory allocation/deallocation. However, in practice
|
for concepts foreign to the native API, such as clean up stacks for
|
||||||
there may be dynamic allocation for the thread_ref design as well, it will just
|
Win32 implementations. For (2) the performance impact will be identical
|
||||||
be hidden from the user. As long as the implementation has to do dynamic allocations
|
to (1). The same for (3). For (4) things get a little more interesting
|
||||||
the thread_ref loses again because of the reference management. For (5) we see
|
and we find that theoretically at least the thread_ref may perform
|
||||||
the same impact as we do for (4). For (6) we still have a possible impact to
|
faster since the thread design requires dynamic memory
|
||||||
the thread design because of dynamic allocation but thread_ref no longer suffers
|
allocation/deallocation. However, in practice there may be dynamic
|
||||||
because of its reference management, and in fact, theoretically at least, the
|
allocation for the thread_ref design as well, it will just be hidden
|
||||||
thread_ref may do a better job of managing the references. All of this indicates
|
from the user. As long as the implementation has to do dynamic
|
||||||
that thread wins for (1), (2) and (3), with (4) and (5) the winner depends on
|
allocations the thread_ref loses again because of the reference
|
||||||
the implementation and the platform but the thread design probably has a better
|
management. For (5) we see the same impact as we do for (4). For (6) we
|
||||||
chance, and with (6) it will again depend on the implementation and platform
|
still have a possible impact to the thread design because of dynamic
|
||||||
but this time we favor thread_ref slightly. Given all of this it's a narrow
|
allocation but thread_ref no longer suffers because of it's
|
||||||
margin, but the thread design prevails.</p>
|
reference management, and in fact, theoretically at least, the
|
||||||
<p>Given this analysis, and the fact that noncopyable objects for system resources
|
thread_ref may do a better job of managing the references. All of this
|
||||||
are the normal designs that C++ programmers are used to dealing with, the <b>Boost.Threads</b>
|
indicates that thread wins for (1), (2) and (3), with (4) and (5) the
|
||||||
library has gone with a noncopyable design.</p>
|
winner depends on the implementation and the platform but the thread
|
||||||
<h2><a name="events"></a>Rationale for not providing <i>Event Variables</i></h2>
|
design probably has a better chance, and with (6) it will again depend
|
||||||
<p><i>Event variables</i> are simply far too error-prone. <a href=
|
on the implementation and platform but this time we favor thread_ref
|
||||||
"condition.html">Condition variables</a> are a much safer alternative.</p>
|
slightly. Given all of this it's a narrow margin, but the thread
|
||||||
<p>[Note that Graphical User Interface <i>events</i> are a different concept,
|
design prevails.</p>
|
||||||
and are not what is being discussed here.]</p>
|
|
||||||
<p>Event variables were one of the first synchronization primitives. They are
|
<p>Given this analysis, and the fact that noncopyable objects for
|
||||||
still used today, for example, in the native Windows multithreading API.</p>
|
system resources are the normal designs that C++ programmers are used
|
||||||
<p>Yet both respected computer science researchers and experienced multithreading
|
to dealing with, the Boost.Threads library has gone with a noncopyable
|
||||||
practitioners believe event variables are so inherently error-prone that they
|
design.</p>
|
||||||
should never be used, and thus should not be part of a multithreading library.</p>
|
|
||||||
<p>Per Brinch Hansen <a href="bibliography.html#Brinch-Hansen-73"> [Brinch Hansen
|
<h2>Rationale for not providing <i><a name="Events">Event</a>
|
||||||
73]</a> analyzed event variables in some detail, pointing out [emphasis his]
|
Variables</i></h2>
|
||||||
that "<i>event operations force the programmer to be aware of the relative
|
|
||||||
speeds of the sending and receiving processes</i>". His summary:</p>
|
<p><i>Event variables</i> are simply far too error-prone. <a href=
|
||||||
<blockquote>
|
"condition.html">Condition variables</a> are a much safer
|
||||||
<p>We must therefore conclude that event variables of the previous type are
|
alternative.</p>
|
||||||
impractical for system design. <i>The effect of an interaction between two
|
|
||||||
processes must be independent of the speed at which it is carried out.</i></p>
|
<p>[Note that Graphical User Interface <i>events</i> are a different
|
||||||
</blockquote>
|
concept, and are not what is being discussed here.]</p>
|
||||||
<p>Experienced programmers using the Windows platform today report that event
|
|
||||||
variables are a continuing source of errors, even after previous bad experiences
|
<p>Event variables were one of the first synchronization primitives.
|
||||||
caused them to be very careful in their use of event variables. Overt problems
|
They are still used today, for example, in the native Windows
|
||||||
can be avoided, for example, by teaming the event variable with a mutex, but
|
multithreading API.</p>
|
||||||
that may just convert a <a href=
|
|
||||||
"definitions.html#Race condition">race condition</a> into another problem,
|
<p>Yet both respected computer science researchers and experienced
|
||||||
such as excessive resource use. One of the most distressing aspects of the experience
|
multithreading practitioners believe event variables are so inherently
|
||||||
reports is the claim that many defects are latent. That is, the programs appear
|
error-prone that they should never be used, and thus should not be part
|
||||||
to work correctly, but contain hidden timing dependencies which will cause them
|
of a multithreading library.</p>
|
||||||
to fail when environmental factors or usage patterns change, altering relative
|
|
||||||
thread timings.</p>
|
<p>Per Brinch Hansen <a href="bibliography.html#Brinch-Hansen-73">
|
||||||
<p>The decision to exclude event variables from <b>Boost.Threads</b> has been
|
[Brinch Hansen 73]</a> analyzed event variables in some detail,
|
||||||
surprising to some Windows programmers. They have written programs which work
|
pointing out [emphasis his] that "<i>event operations force the
|
||||||
using event variables, and wonder what the problem is. It seems similar to the
|
programmer to be aware of the relative speeds of the sending and
|
||||||
"goto considered harmful" controversy of 30 years ago. It isn't
|
receiving processes</i>". His summary:</p>
|
||||||
that events, like gotos, can't be made to work, but rather that virtually
|
|
||||||
all programs using alternatives will be easier to write, debug, read, maintain,
|
<blockquote>
|
||||||
and be less likely to contain latent defects.</p>
|
<p>We must therefore conclude that event variables of the previous
|
||||||
<p>[Rationale provided by Beman Dawes]</p>
|
type are impractical for system design. <i>The effect of an
|
||||||
<hr>
|
interaction between two processes must be independent of the speed
|
||||||
<p>Revised
|
at which it is carried out.</i></p>
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
</blockquote>
|
||||||
05 November, 2001
|
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
<p>Experienced programmers using the Windows platform today report that
|
||||||
</p>
|
event variables are a continuing source of errors, even after previous
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
bad experiences caused them to be very careful in their use of event
|
||||||
All Rights Reserved.</i></p>
|
variables. Overt problems can be avoided, for example, by teaming the
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
event variable with a mutex, but that may just convert a <a href=
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
"definitions.html#Race condition">race condition</a> into another
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
problem, such as excessive resource use. One of the most distressing
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
aspects of the experience reports is the claim that many defects are
|
||||||
makes no representations about the suitability of this software for any purpose.
|
latent. That is, the programs appear to work correctly, but contain
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
hidden timing dependencies which will cause them to fail when
|
||||||
</body>
|
environmental factors or usage patterns change, altering relative
|
||||||
|
thread timings.</p>
|
||||||
|
|
||||||
|
<p>The decision to exclude event variables from Boost.Threads has been
|
||||||
|
surprising to some Windows programmers. They have written programs
|
||||||
|
which work using event variables, and wonder what the problem is. It
|
||||||
|
seems similar to the "goto considered harmful" controversy of
|
||||||
|
30 years ago. It isn't that events, like gotos, can't be made
|
||||||
|
to work, but rather that virtually all programs using alternatives will
|
||||||
|
be easier to write, debug, read, maintain, and be less likely to
|
||||||
|
contain latent defects.</p>
|
||||||
|
|
||||||
|
<p>[Rationale provided by Beman Dawes]</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|||||||
@@ -1,226 +1,311 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Type" content=
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
"text/html; charset=iso-8859-1">
|
||||||
<title>Boost.Threads - Header <boost/thread/recursive_mutex.hpp></title>
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
</head>
|
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||||
<body link="#0000ff" vlink="#800080">
|
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
<title>Boost.Threads, recursive_mutex</title>
|
||||||
"header">
|
</head>
|
||||||
<tr>
|
|
||||||
<td valign="top" width="300">
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
<table summary="header" border="0" cellpadding="7" cellspacing="0" width="100%">
|
||||||
</td>
|
<tr>
|
||||||
<td valign="top">
|
<td valign="top" width="300">
|
||||||
<h1 align="center">Boost.Threads</h1>
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
<h2 align="center">Header <<a href="../../../boost/thread/recursive_mutex.hpp">boost/thread/recursive_mutex.hpp</a>></h2> </td>
|
"277" height="86"></h3>
|
||||||
</tr>
|
</td>
|
||||||
</table>
|
|
||||||
<hr>
|
<td valign="top">
|
||||||
<h2>Contents</h2>
|
<h1 align="center">Boost.Threads</h1>
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#introduction">Introduction</a></dt>
|
<h2 align="center">recursive_mutex<br>
|
||||||
<dt><a href="#classes">Classes</a></dt>
|
recursive_try_mutex<br>
|
||||||
<dl class="page-index">
|
recursive_timed_mutex</h2>
|
||||||
<dt><a href="#class-recursive_mutex">Class <code>recursive_mutex</code></a></dt>
|
</td>
|
||||||
<dl class="page-index">
|
</tr>
|
||||||
<dt><a href="#class-recursive_mutex-synopsis">Class <code>recursive_mutex</code>
|
</table>
|
||||||
synopsis</a></dt>
|
<hr>
|
||||||
<dt><a href="#class-recursive_mutex-ctors">Class <code>recursive_mutex</code>
|
|
||||||
constructors and destructor</a></dt>
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
</dl>
|
<a href="#Header">Header</a><br>
|
||||||
<dt><a href="#class-recursive_try_mutex">Class <code>recursive_try_mutex</code></a></dt>
|
<a href="#recursive_mutex Synopsis">Class recursive_mutex
|
||||||
<dl class="page-index">
|
Synopsis</a><br>
|
||||||
<dt><a href="#class-recursive_try_mutex-synopsis">Class <code>recursive_try_mutex</code>
|
<a href="#recursive_mutex Members">Class recursive_mutex
|
||||||
synopsis</a></dt>
|
Members</a><br>
|
||||||
<dt><a href="#class-recursive_try_mutex-ctors">Class <code>recursive_try_mutex</code>
|
<a href="#recursive_try_mutex Synopsis">Class recursive_try_mutex
|
||||||
constructors and destructor</a></dt>
|
Synopsis</a><br>
|
||||||
</dl>
|
<a href="#recursive_try_mutex Members">Class recursive_try_mutex
|
||||||
<dt><a href="#class-recursive_timed_mutex">Class <code>recursive_timed_mutex</code></a></dt>
|
Members</a><br>
|
||||||
<dl class="page-index">
|
<a href="#recursive_timed_mutex Synopsis">Class recursive_timed_mutex
|
||||||
<dt><a href="#class-recursive_timed_mutex-synopsis">Class <code>recursive_timed_mutex</code>
|
Synopsis</a><br>
|
||||||
synopsis</a></dt>
|
<a href="#recursive_timed_mutex Members">Class recursive_timed_mutex
|
||||||
<dt><a href="#class-recursive_timed_mutex-ctors">Class <code>recursive_timed_mutex</code>
|
Members</a><br>
|
||||||
constructors and destructor</a></dt>
|
<a href="#Example">Example</a></p>
|
||||||
</dl>
|
|
||||||
</dl>
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
<dt><a href="#examples">Example(s)</a></dt>
|
|
||||||
</dl>
|
<p>The <code>recursive_mutex</code>, <code>recursive_try_mutex</code>
|
||||||
<hr>
|
and <code>recursive_timed_mutex</code> classes define full featured
|
||||||
<h2><a name="introduction"></a>Introduction</h2>
|
models of the <a href="mutex_concept.html#Mutex">Mutex</a>, <a href=
|
||||||
<p>Include the header <<a href="../../../boost/thread/recursive_mutex.hpp">boost/thread/recursive_mutex.hpp</a>>
|
"mutex_concept.html#TryMutex">TryMutex</a> and <a href=
|
||||||
to define the <a href="#class-recursive_mutex">recursive_mutex</a>, <a href="#class-recursive_try_mutex">recursive_try_mutex</a>
|
"mutex_concept.html#TimedMutex">TimedMutex</a> concepts with recursive
|
||||||
and <a href="#class-recursive_timed_mutex">recursive_timed_mutex</a> classes.</p>
|
locking semantics. These types should be used to synchronize access to
|
||||||
<p>The <a href="#class-recursive_mutex">recursive_mutex</a>, <a href="#class-recursive_try_mutex">recursive_try_mutex</a>
|
shared resources when recursive locking by a single thread is likely to
|
||||||
and <a href="#class-recursive_timed_mutex">recursive_timed_mutex</a> classes
|
occur. A good example for this is when a class supplies "internal
|
||||||
are models of <a href="mutex_concept.html#Mutex-concept">Mutex</a>, <a href="mutex_concept.html#TryMutex-concept">TryMutex</a>,
|
synchronization" to ensure <a href="definitions.html#Thread-safe">
|
||||||
and <a href="mutex_concept.html#TimedMutex-concept">TimedMutex</a> respectively.
|
thread-safety</a> and a function of the class may have to call other
|
||||||
These types should be used to synchronize access to shared resources when recursive
|
functions of the class which also attempt to lock the mutex. For
|
||||||
locking by a single thread is likely to occur. A good example for this is when
|
recursive locking mechanics, see <a href="mutex.html">mutexes</a>.</p>
|
||||||
a class supplies "internal synchronization" to ensure <a href="definitions.html#Thread-safe">
|
|
||||||
thread-safety</a> and a function of the class may have to call other functions
|
<p>Each class supplies one or more typedefs for lock types which model
|
||||||
of the class which also attempt to lock the mutex. For recursive locking mechanics,
|
matching lock concepts. For the best possible performance you should
|
||||||
see <a href="mutex.html">mutexes</a>.</p>
|
use the mutex class that supports the minimum set of lock types that
|
||||||
<p>Each class supplies one or more typedefs for lock types which model matching
|
you need.</p>
|
||||||
lock concepts. For the best possible performance you should use the mutex class
|
|
||||||
that supports the minimum set of lock types that you need.</p>
|
<table summary="lock types" border="1" cellpadding="5">
|
||||||
<table summary="lock types" border="1" cellpadding="5">
|
<tr>
|
||||||
<tr>
|
<td><b>Mutex Class</b></td>
|
||||||
<td><b>Mutex Class</b></td>
|
|
||||||
<td><b>Lock name</b></td>
|
<td><b>Lock name</b></td>
|
||||||
<td><b>Lock Concept</b></td>
|
|
||||||
</tr>
|
<td><b>Implementation defined Lock Type</b></td>
|
||||||
<tr>
|
|
||||||
<td valign="top"><a href="#recursive_mutex Synopsis"><code> recursive_mutex</code></a></td>
|
<td><b>Lock Concept</b></td>
|
||||||
<td valign="middle"><code>scoped_lock</code></td>
|
</tr>
|
||||||
<td valign="middle"><a href="lock_concept.html#ScopedLock"> ScopedLock</a></td>
|
|
||||||
</tr>
|
<tr>
|
||||||
<tr>
|
<td valign="top"><a href="#recursive_mutex Synopsis"><code>
|
||||||
<td valign="top"><code><a href="#recursive_try_mutex Synopsis"> recursive_try_mutex</a></code></td>
|
recursive_mutex</code></a></td>
|
||||||
<td valign="middle"><code>scoped_lock<br>
|
|
||||||
scoped_try_lock</code></td>
|
<td valign="middle"><code>scoped_lock</code></td>
|
||||||
<td valign="middle"><a href="lock_concept.html#ScopedLock"> ScopedLock</a><br>
|
|
||||||
<a href="lock_concept.html#ScopedTryLock"> ScopedTryLock</a></td>
|
<td valign="middle"><a href="scoped_lock.html"><code>
|
||||||
</tr>
|
detail::thread::scoped_lock<recursive_mutex></code></a></td>
|
||||||
<tr>
|
|
||||||
<td valign="top"><code><a href=
|
<td valign="middle"><a href="lock_concept.html#ScopedLock">
|
||||||
"#recursive_timed_mutex Synopsis"> recursive_timed_mutex</a></code>
|
ScopedLock</a></td>
|
||||||
</td>
|
</tr>
|
||||||
<td valign="middle"><code>scoped_lock<br>
|
|
||||||
scoped_try_lock<br>
|
<tr>
|
||||||
scoped_timed_lock</code></td>
|
<td valign="top"><code><a href="#recursive_try_mutex Synopsis">
|
||||||
<td valign="middle"><a href="lock_concept.html#ScopedLock"> ScopedLock</a><br>
|
recursive_try_mutex</a></code></td>
|
||||||
<a href="lock_concept.html#ScopedTryLock"> ScopedTryLock</a><br>
|
|
||||||
<a href="lock_concept.html#ScopedTimedLock"> ScopedTimedLock</a></td>
|
<td valign="middle"><code>scoped_lock<br>
|
||||||
</tr>
|
scoped_try_lock</code></td>
|
||||||
</table>
|
|
||||||
<p>The <code>recursive_mutex</code>, <code>recursive_try_mutex</code> and <code>recursive_timed_mutex</code>
|
<td valign="middle"><a href="scoped_lock.html"><code>
|
||||||
employ a <code>Recursive</code> <a href="mutex_concept.html#LockingStrategies">locking
|
detail::thread::scoped_lock<recursive_try_mutex><br>
|
||||||
strategy</a>, so attempts to recursively lock them succeed and an internal "lock
|
</code></a> <code><a href="scoped_try_lock.html">
|
||||||
count" is maintained. Attempts to unlock them by a thread that does not
|
detail::thread::scoped_try_lock<recursive_try_mutex></a></code></td>
|
||||||
own a lock on them will result in <b>undefined behavior</b>.</p>
|
|
||||||
<p>The <code>recursive_mutex</code>, <code>recursive_try_mutex</code> and <code>recursive_timed_mutex</code>
|
<td valign="middle"><a href="lock_concept.html#ScopedLock">
|
||||||
leave the <a href=
|
ScopedLock</a><br>
|
||||||
"mutex_concept.html#SchedulingPolicies">scheduling policy</a> as <code>
|
<a href="lock_concept.html#ScopedTryLock">
|
||||||
Unspecified</code>. Programmers should assume that threads waiting for a lock
|
ScopedTryLock</a></td>
|
||||||
on objects of these types acquire the lock in a random order, even though the
|
</tr>
|
||||||
specific behavior for a given platform may be different.</p>
|
|
||||||
<h2><a name="classes"></a>Classes</h2>
|
<tr>
|
||||||
<h3><a name="class-recursive_mutex"></a>Class <code>recursive_mutex</code></h3>
|
<td valign="top"><code><a href=
|
||||||
<p>The <code>recursive_mutex</code> class is a model of <a href="mutex_concept.html#Mutex-concept">Mutex</a>
|
"#recursive_timed_mutex Synopsis">
|
||||||
and <a href="overview.html#non-copyable">NonCopyable</a>, and provides no additional
|
recursive_timed_mutex</a></code> </td>
|
||||||
facilities beyond the requirements of these concepts.</p>
|
|
||||||
<h4><a name="class-recursive_mutex-synopsis"></a>Class <code>recursive_mutex</code>
|
<td valign="middle"><code>scoped_lock<br>
|
||||||
synopsis</h4>
|
scoped_try_lock<br>
|
||||||
|
scoped_timed_lock</code></td>
|
||||||
|
|
||||||
|
<td valign="middle"><a href="scoped_lock.html"><code>
|
||||||
|
detail::thread::scoped_lock<recursive_timed_mutex></code></a><br>
|
||||||
|
|
||||||
|
<a href="scoped_try_lock.html"><code>
|
||||||
|
detail::thread::scoped_try_lock<recursive_timed_mutex></code></a><br>
|
||||||
|
|
||||||
|
<a href="scoped_timed_lock.html"><code>
|
||||||
|
detail::thread::scoped_timed_lock<recursive_timed_mutex></code></a></td>
|
||||||
|
|
||||||
|
<td valign="middle"><a href="lock_concept.html#ScopedLock">
|
||||||
|
ScopedLock</a><br>
|
||||||
|
<a href="lock_concept.html#ScopedTryLock">
|
||||||
|
ScopedTryLock</a><br>
|
||||||
|
<a href="lock_concept.html#ScopedTimedLock">
|
||||||
|
ScopedTimedLock</a></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<p>The <code>recursive_mutex</code>, <code>recursive_try_mutex</code>
|
||||||
|
and <code>recursive_timed_mutex</code> employ a <code>Recursive</code>
|
||||||
|
<a href="mutex_concept.html#LockingStrategies">locking strategy</a>, so
|
||||||
|
attempts to recursively lock them succeed and an internal "lock
|
||||||
|
count" is maintained. Attempts to unlock them by a thread that
|
||||||
|
does not own a lock on them will result in a <a href="lock_error.html">
|
||||||
|
lock_error</a> exception being thrown.</p>
|
||||||
|
|
||||||
|
<p>The <code>recursive_mutex</code>, <code>recursive_try_mutex</code>
|
||||||
|
and <code>recursive_timed_mutex</code> leave the <a href=
|
||||||
|
"mutex_concept.html#SchedulingPolicies">scheduling policy</a> as <code>
|
||||||
|
Unspecified</code>. Programmers should assume that threads waiting for
|
||||||
|
a lock on objects of these types acquire the lock in a random order,
|
||||||
|
even though the specific behavior for a given platform may be
|
||||||
|
different.</p>
|
||||||
|
|
||||||
|
<h2><a name="Header">Header</a></h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/recursive_mutex.hpp"><boost/thread/recursive_mutex.hpp></a>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2>Class <a name="recursive_mutex Synopsis">recursive_mutex
|
||||||
|
Synopsis</a></h2>
|
||||||
|
<hr>
|
||||||
<pre>
|
<pre>
|
||||||
namespace boost
|
namespace boost
|
||||||
{
|
{
|
||||||
class recursive_mutex : private boost::noncopyable // Exposition only.
|
class recursive_mutex : private <a href=
|
||||||
// Class recursive_mutex meets the NonCopyable requirement.
|
"../../utility/utility.htm">boost::noncopyable</a> // Exposition only.
|
||||||
|
// Class recursive_mutex meets the <a href=
|
||||||
|
"overview.html#NonCopyable">NonCopyable</a> requirement.
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
typedef <i>[implementation defined; see <a href=
|
||||||
|
"#Introduction">Introduction</a>]</i> scoped_lock;
|
||||||
|
|
||||||
|
recursive_mutex();
|
||||||
|
~recursive_mutex();
|
||||||
|
};
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2>Class <a name="recursive_mutex Members">recursive_mutex
|
||||||
|
Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructor</h3>
|
||||||
|
<pre>
|
||||||
|
recursive_mutex();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Postconditions:</b> <code>*this</code> is in the unlocked
|
||||||
|
state.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Destructor</h3>
|
||||||
|
<pre>
|
||||||
|
~recursive_mutex();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Requires:</b> <code>*this</code> is in the unlocked state.</p>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Destroys <code>*this</code>.</p>
|
||||||
|
|
||||||
|
<p><b>Dangers:</b> Destruction of a locked mutex is a serious
|
||||||
|
programming error resulting in undefined behavior such as a program
|
||||||
|
crash..</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2>Class <a name="recursive_try_mutex Synopsis">recursive_try_mutex
|
||||||
|
Synopsis</a></h2>
|
||||||
|
<pre>
|
||||||
|
namespace boost
|
||||||
|
{
|
||||||
|
class recursive_try_mutex : private boost::noncopyable // Exposition only.
|
||||||
|
// Class recursive_try_mutex meets the <a href=
|
||||||
|
"overview.html#NonCopyable">NonCopyable</a> requirement.
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
typedef [implementation defined; see Introduction] scoped_lock;
|
typedef <i>[implementation defined; see <a href=
|
||||||
|
"#Introduction">Introduction</a>]</i> scoped_lock;
|
||||||
recursive_mutex();
|
typedef <i>[implementation defined; see <a href=
|
||||||
~recursive_mutex();
|
"#Introduction">Introduction</a>]</i> scoped_try_lock;
|
||||||
|
|
||||||
|
recursive_try_mutex();
|
||||||
|
~recursive_try_mutex();
|
||||||
};
|
};
|
||||||
};
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h4><a name="class-recursive_mutex-ctors"></a>Class <code>recursive_mutex</code>
|
|
||||||
constructors and destructor</h4>
|
<h2>Class <a name="recursive_try_mutex Members">recursive_try_mutex
|
||||||
|
Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructor</h3>
|
||||||
<pre>
|
<pre>
|
||||||
recursive_mutex();
|
recursive_try_mutex();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Postconditions:</b> <code>*this</code> is in an unlocked state.</dt>
|
<p><b>Postconditions:</b> <code>*this</code> is in the unlocked
|
||||||
</dl>
|
state.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Destructor</h3>
|
||||||
<pre>
|
<pre>
|
||||||
~recursive_mutex();
|
~recursive_try_mutex();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> <code>*this</code> is in an unlocked sate.</dt>
|
<p><b>Requires:</b> <code>*this</code> is in the unlocked state.</p>
|
||||||
<dt><b>Danger:</b> Destruction of a locked mutex is a serious programming error
|
|
||||||
resulting in undefined behavior such as a program crash.</dt>
|
<p><b>Effects:</b> Destroys <code>*this</code>.</p>
|
||||||
</dl>
|
|
||||||
<h3><a name="class-recursive_try_mutex"></a>Class <code>recursive_try_mutex</code></h3>
|
<p><b>Dangers:</b> Destruction of a locked mutex is a serious
|
||||||
<p>The <code>recursive_try_mutex</code> class is a model of <a href="mutex_concept.html#TryMutex-concept">TryMutex</a>
|
programming error resulting in undefined behavior such as a program
|
||||||
and <a href="overview.html#non-copyable">NonCopyable</a>, and provides no additional
|
crash..</p>
|
||||||
facilities beyond the requirements of these concepts.</p>
|
<hr>
|
||||||
<h4><a name="class-recursive_try_mutex-synopsis"></a>Class <code>recursive_try_mutex</code>
|
|
||||||
synopsis</h4>
|
<h2>Class <a name="recursive_timed_mutex Synopsis">
|
||||||
<pre>
|
recursive_timed_mutex Synopsis</a></h2>
|
||||||
namespace boost
|
|
||||||
{
|
|
||||||
class recursive_mutex : private boost::noncopyable // Exposition only.
|
|
||||||
// Class recursive_mutex meets the NonCopyable requirement.
|
|
||||||
{
|
|
||||||
Public:
|
|
||||||
typedef [implementation defined; see Introduction] scoped_lock;
|
|
||||||
typedef [implementation defined; see Introduction] scoped_try_lock;
|
|
||||||
|
|
||||||
recursive_try_mutex();
|
|
||||||
~recursive_try_mutex();
|
|
||||||
};
|
|
||||||
};
|
|
||||||
</pre>
|
|
||||||
<h4><a name="class-recursive_try_mutex-ctors"></a>Class <code>recursive_try_mutex</code>
|
|
||||||
constructors and destructor</h4>
|
|
||||||
<pre>
|
|
||||||
recursive_try_mutex();
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Postconditions:</b> <code>*this</code> is in an unlocked state.</dt>
|
|
||||||
</dl>
|
|
||||||
<pre>
|
|
||||||
~recursive_try_mutex();
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> <code>*this</code> is in an unlocked sate.</dt>
|
|
||||||
<dt><b>Danger:</b> Destruction of a locked mutex is a serious programming error
|
|
||||||
resulting in undefined behavior such as a program crash.</dt>
|
|
||||||
</dl>
|
|
||||||
<h3><a name="class-recursive_timed_mutex"></a>Class <code>recursive_timed_mutex</code></h3>
|
|
||||||
<p>The <code>recursive_timed_mutex</code> class is a model of <a href="mutex_concept.html#TimedMutex-concept">TimedMutex</a>
|
|
||||||
and <a href="overview.html#non-copyable">NonCopyable</a>, and provides no additional
|
|
||||||
facilities beyond the requirements of these concepts.</p>
|
|
||||||
<h4><a name="class-recursive_timed_mutex-synopsis"></a>Class <code>recursive_timed_mutex</code>
|
|
||||||
synopsis</h4>
|
|
||||||
<pre>
|
<pre>
|
||||||
namespace boost
|
namespace boost
|
||||||
{
|
{
|
||||||
class recursive_timed_mutex : private boost::noncopyable // Exposition only.
|
class recursive_timed_mutex : private boost::noncopyable // Exposition only.
|
||||||
// Class recursive_mutex meets the NonCopyable requirement.
|
// Class recursive_timed_mutex meets the <a href=
|
||||||
|
"overview.html#NonCopyable">NonCopyable</a> requirement.
|
||||||
{
|
{
|
||||||
Public:
|
public:
|
||||||
typedef [implementation defined; see Introduction] scoped_lock;
|
typedef <i>[implementation defined; see <a href=
|
||||||
typedef [implementation defined; see Introduction] scoped_try_lock;
|
"#Introduction">Introduction</a>]</i> scoped_lock;
|
||||||
typedef [implementation defined; see Introduction] scoped_timed_lock;
|
typedef <i>[implementation defined; see <a href=
|
||||||
|
"#Introduction">Introduction</a>]</i> scoped_try_lock;
|
||||||
recursive_timed_mutex();
|
typedef <i>[implementation defined; see <a href=
|
||||||
~recursive_timed_mutex();
|
"#Introduction">Introduction</a>]</i> scoped_timed_lock;
|
||||||
|
|
||||||
|
recursive_timed_mutex();
|
||||||
|
~recursive_timed_mutex();
|
||||||
};
|
};
|
||||||
};
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<h4><a name="class-recursive_timed_mutex-ctors"></a>Class <code>recursive_timed_mutex</code>
|
|
||||||
constructors and destructor</h4>
|
<h2>Class <a name="recursive_timed_mutex Members">recursive_timed_mutex
|
||||||
|
Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructor</h3>
|
||||||
<pre>
|
<pre>
|
||||||
recursive_timed_mutex();
|
recursive_timed_mutex();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Postconditions:</b> <code>*this</code> is in an unlocked state.</dt>
|
<p><b>Postconditions:</b> <code>*this</code> is in the unlocked
|
||||||
</dl>
|
state.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Destructor</h3>
|
||||||
<pre>
|
<pre>
|
||||||
~recursive_timed_mutex();
|
~recursive_timed_mutex();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> <code>*this</code> is in an unlocked sate.</dt>
|
<p><b>Requires:</b> <code>*this</code> is in the unlocked state.</p>
|
||||||
<dt><b>Danger:</b> Destruction of a locked mutex is a serious programming error
|
|
||||||
resulting in undefined behavior such as a program crash.</dt>
|
<p><b>Effects:</b> Destroys <code>*this</code>.</p>
|
||||||
</dl>
|
|
||||||
<h2><a name="examples"></a>Example(s)</h2>
|
<p><b>Dangers:</b> Destruction of a locked mutex is a serious
|
||||||
|
programming error resulting in undefined behavior such as a program
|
||||||
|
crash..</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><a name="Example">Example</a> Usage</h2>
|
||||||
<pre>
|
<pre>
|
||||||
#include <a href="../../../boost/thread/recursive_mutex.hpp"><boost/thread/recursive_mutex.hpp></a>
|
#include <a href=
|
||||||
#include <a href="../../../boost/thread/thread.hpp"><boost/thread/thread.hpp></a>
|
"../../../boost/thread/recursive_mutex.hpp"><boost/thread/recursive_mutex.hpp></a>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/thread.hpp"><boost/thread/thread.hpp></a>
|
||||||
#include <iostream>
|
#include <iostream>
|
||||||
|
|
||||||
class counter
|
class counter
|
||||||
@@ -263,26 +348,21 @@ int main(int, char*[])
|
|||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<p>The output is:</p>
|
|
||||||
|
<p>The output is:</p>
|
||||||
<pre>
|
<pre>
|
||||||
count == 1
|
count == 1
|
||||||
count == 2
|
count == 2
|
||||||
count == 3
|
count == 3
|
||||||
count == 4
|
count == 4
|
||||||
</pre>
|
</pre>
|
||||||
<hr>
|
<hr>
|
||||||
<p>Revised
|
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
<p>Revised
|
||||||
05 November, 2001
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
|
||||||
</p>
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
All Rights Reserved.</i></p>
|
</body>
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
|
||||||
makes no representations about the suitability of this software for any purpose.
|
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|||||||
134
doc/removed_atomic_t.html
Normal file
134
doc/removed_atomic_t.html
Normal file
@@ -0,0 +1,134 @@
|
|||||||
|
<html>
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||||||
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
|
<title>Boost.Threads, atomic_t</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
|
|
||||||
|
<table border="0" cellpadding="7" cellspacing="0" width="100%">
|
||||||
|
<tr>
|
||||||
|
<td valign="top" width="300">
|
||||||
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width="277" height="86"></h3>
|
||||||
|
</td>
|
||||||
|
<td valign="top">
|
||||||
|
<h1 align="center">Boost.Threads</h1>
|
||||||
|
<h2 align="center">atomic_t</h2>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2>Header</h2>
|
||||||
|
|
||||||
|
<p>The <tt>atomic_t</tt> class defines an "atomic integer" type. This class should be used
|
||||||
|
to perform thread safe operations on an integral type with out the overhead of locks. Only
|
||||||
|
a limited set of integer operations are available with an <tt>atomic_t</tt> instance.</p>
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
#include <boost/thread/atomic.hpp>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2>Public Interface</h2>
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
class atomic_t
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
typedef <b>implementation defined</b> value_type;
|
||||||
|
|
||||||
|
explicit atomic_t(value_type val=0);
|
||||||
|
};
|
||||||
|
|
||||||
|
atomic_t::value_type read(const atomic_t& x);
|
||||||
|
atomic_t::value_type increment(atomic_t& x);
|
||||||
|
atomic_t::value_type decrement(atomic_t& x);
|
||||||
|
atomic_t::value_type swap(atomic_t& x, atomic_t::value_type y);
|
||||||
|
atomic_t::value_type compare_swap(atomic_t& x, atomic_t::value_type y, atomic_t::value_type z);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h3>Constructor</h3>
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
atomic_t(atomic_t::value_type val=0);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>Constructs an <tt>atomic_t</tt> and sets its value to <tt>val</tt>.</p>
|
||||||
|
|
||||||
|
<h3>read</h3>
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
atomic_t::value_type read(const atomic_t& x);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>Gets the current value of <tt>x</tt>.</p>
|
||||||
|
|
||||||
|
<h3>increment</h3>
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
atomic_t::value_type increment(atomic_t& x);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>Increments <tt>x</tt> and returns a value <tt>< 0</tt> if the result is less than 0,
|
||||||
|
<tt>> 0</tt> if the result is greater than 0 and <tt>== 0</tt> if the result is equal to
|
||||||
|
0.</p>
|
||||||
|
|
||||||
|
<h3>decrement</h3>
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
atomic_t::value_type decrement(atomic_t& x);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>Decrements <tt>x</tt> and returns a value <tt>< 0</tt> if the result is less than 0,
|
||||||
|
<tt>> 0</tt> if the result is greater than 0 and <tt>== 0</tt> if the result is equal to
|
||||||
|
0.</p>
|
||||||
|
|
||||||
|
<h3>swap</h3>
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
atomic_t::value_type swap(atomic_t& x, atomic_t::value_type y);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>Assigns the value of <tt>y</tt> to <tt>x</tt> and returns the value of <tt>x</tt> prior
|
||||||
|
to the swap.</p>
|
||||||
|
|
||||||
|
<h3>compare_swap</h3>
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
atomic_t::value_type compare_swap(atomic_t& x, atomic_t::value_type y, atomic_t::value_type z);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>Compares the value of <tt>z</tt> to the value of <tt>x</tt> and if equal sets the value of
|
||||||
|
<tt>x</tt> to the value of <tt>y</tt> and returns the value of <tt>x</tt> prior to the swap.</p>
|
||||||
|
|
||||||
|
<h2>Example Usage</h2>
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
#include <boost/thread/atomic.hpp>
|
||||||
|
#include <boost/test/test_tools.hpp>
|
||||||
|
|
||||||
|
int test_main(int, char*[])
|
||||||
|
{
|
||||||
|
boost::atomic_t a;
|
||||||
|
BOOST_TEST_VERIFY(boost::read(a) == 0);
|
||||||
|
BOOST_TEST_VERIFY(boost::increment(a) > 0);
|
||||||
|
BOOST_TEST_VERIFY(boost::decrement(a) == 0);
|
||||||
|
BOOST_TEST_VERIFY(boost::swap(a, 1) == 0);
|
||||||
|
BOOST_TEST_VERIFY(boost::swap(a, 2, 0) == 1);
|
||||||
|
BOOST_TEST_VERIFY(boost::read(a) == 1);
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">William E. Kempf</a>
|
||||||
|
2001 all rights reserved.</i></p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
227
doc/scoped_lock.html
Normal file
227
doc/scoped_lock.html
Normal file
@@ -0,0 +1,227 @@
|
|||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content=
|
||||||
|
"text/html; charset=iso-8859-1">
|
||||||
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
|
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||||
|
|
||||||
|
<title>Boost.Threads, scoped_lock</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
|
width="100%">
|
||||||
|
<tr>
|
||||||
|
<td valign="top" width="300">
|
||||||
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
|
"277" height="86"></h3>
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td valign="top">
|
||||||
|
<h1 align="center">Boost.Threads</h1>
|
||||||
|
|
||||||
|
<h2 align="center">scoped_lock</h2>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
|
<a href="#Header">Header</a><br>
|
||||||
|
<a href="#Synopsis">Synopsis</a><br>
|
||||||
|
<a href="#Members">Members</a><br>
|
||||||
|
<a href="#Example">Example</a></p>
|
||||||
|
|
||||||
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
|
|
||||||
|
<p>This class template defines a generic lock type which meets the <a
|
||||||
|
href="lock_concept.html#ScopedLock">ScopedLock</a> requirements. The <a
|
||||||
|
href="mutex.html">mutex</a>, <a href="mutex.html">try_mutex</a>, <a
|
||||||
|
href="mutex.html">timed_mutex</a>, <a href="recursive_mutex.html">
|
||||||
|
recursive_mutex</a>, <a href="recursive_mutex.html">
|
||||||
|
recursive_try_mutex</a> and <a href="recursive_mutex.html">
|
||||||
|
recursive_timed_mutex</a> classes all use this template to define their
|
||||||
|
<code>scoped_lock</code> types.</p>
|
||||||
|
|
||||||
|
<p>Like all the <b>Boost.Threads</b> <a href="lock_concept.html">lock
|
||||||
|
models</a>, <code>scoped_lock</code> objects are meant to be
|
||||||
|
short-lived. Objects of the class are not <a href=
|
||||||
|
"definitions.html#thread-safe">thread-safe</a>, and so should not be
|
||||||
|
shared between threads.</p>
|
||||||
|
|
||||||
|
<p>Class <code>scoped_lock</code> follows the "resource
|
||||||
|
acquisition is initialization" idiom <a href=
|
||||||
|
"bibliography.html#Stroustrup-00">[Stroustrup 00 14.4.1]</a> and is a
|
||||||
|
realization of the "Scoped Locking Pattern" <a href=
|
||||||
|
"bibliography.html#Schmidt-00">[Schmidt-00]</a>. Thus the usage is to
|
||||||
|
let the constructor do the locking, and then let the destructor do the
|
||||||
|
unlocking automatically at the end of the enclosing scope. The lock()
|
||||||
|
and unlock() members are usually not explicitly called, but are
|
||||||
|
provided to allow for complex overlapping locks of multiple
|
||||||
|
mutexes.</p>
|
||||||
|
|
||||||
|
<p>The type used to instantiate the class must meet the <a href=
|
||||||
|
"mutex_concept.html#Mutex">Mutex</a> requirements.</p>
|
||||||
|
|
||||||
|
<p>Although this class is an implementation detail, it is publicly
|
||||||
|
documented here because of its importance.</p>
|
||||||
|
|
||||||
|
<h2><a name="Header">Header</a></h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/detail/lock.hpp"><boost/thread/detail/lock.hpp></a>
|
||||||
|
<i>This header is usually not included directly by programmers
|
||||||
|
because it is supplied by <a href=
|
||||||
|
"../../../boost/thread/mutex.hpp"><boost/thread/mutex.hpp></a> or
|
||||||
|
<a href=
|
||||||
|
"../../../boost/thread/recursive_mutex.hpp"><boost/thread/recursive_mutex.hpp></a></i>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Synopsis">Synopsis</a></h2>
|
||||||
|
<pre>
|
||||||
|
namespace boost { namespace detail { namespace thread {
|
||||||
|
template <typename Mutex>
|
||||||
|
class scoped_lock : private <a href=
|
||||||
|
"../../utility/utility.htm#Class noncopyable">boost::noncopyable</a> // Exposition only.
|
||||||
|
// Class scoped_lock meets the <a href=
|
||||||
|
"overview.html#NonCopyable">NonCopyable</a> requirement.
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
typedef Mutex mutex_type;
|
||||||
|
|
||||||
|
explicit scoped_lock(Mutex& mx, bool initially_locked=true);
|
||||||
|
~scoped_lock();
|
||||||
|
|
||||||
|
void lock();
|
||||||
|
void unlock();
|
||||||
|
|
||||||
|
operator const void*() const;
|
||||||
|
bool locked() const;
|
||||||
|
};
|
||||||
|
} // namespace thread
|
||||||
|
} // namespace detail
|
||||||
|
} // namespace boost
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Members">Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructor</h3>
|
||||||
|
<pre>
|
||||||
|
explicit scoped_lock(Mutex& mx, bool initially_locked=true);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Associates mutex <code>mx</code> with <code>
|
||||||
|
*this</code>. If <code>initially_locked</code> is <code>true,</code>
|
||||||
|
calls <code>lock()</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Destructor</h3>
|
||||||
|
<pre>
|
||||||
|
~scoped_lock();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> If <code>locked()</code>, calls <code>
|
||||||
|
unlock()</code>. Destroys <code>*this</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>lock</h3>
|
||||||
|
<pre>
|
||||||
|
void lock();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> If the associated mutex is already locked by another
|
||||||
|
lock in the current thread, the effects depend on the locking strategy
|
||||||
|
of the associated mutex, as shown in the following table:</p>
|
||||||
|
|
||||||
|
<table summary="lock effects" border="1" cellpadding="5">
|
||||||
|
<tr>
|
||||||
|
<td><i><a href="mutex_concept.html#LockingStrategies">Locking
|
||||||
|
Strategy</a><br>
|
||||||
|
of associated mutex</i></td>
|
||||||
|
|
||||||
|
<td><i>Effect if associated mutex is already locked by the
|
||||||
|
current thread</i></td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>Recursive</td>
|
||||||
|
|
||||||
|
<td>As if an additional lock were added to the mutex.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>Checked</td>
|
||||||
|
|
||||||
|
<td>Throws <a href="lock_error.html">lock_error</a>.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>Unchecked</td>
|
||||||
|
|
||||||
|
<td>Undefined behavior [<a href="bibliography.html#ISO">ISO</a>
|
||||||
|
1.3.12] (but typically, <a href="definitions.html#Deadlock">
|
||||||
|
deadlock</a>.)</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<p>If the associated mutex is already locked by some other thread,
|
||||||
|
places the current thread in the <a href="definitions.html#State">
|
||||||
|
Blocked</a> state until the associated mutex is unlocked, after which
|
||||||
|
the current thread is placed in the <a href="definitions.html#State">
|
||||||
|
Ready</a> state, eventually to be returned to the <a href=
|
||||||
|
"definitions.html#State">Running</a> state.</p>
|
||||||
|
|
||||||
|
<p><b>Postcondition:</b> locked()</p>
|
||||||
|
|
||||||
|
<p><b>Throws:</b> <a href="lock_error.html">lock_error</a> if <code>
|
||||||
|
locked()</code> or as indicated in <b>Effects</b>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>unlock</h3>
|
||||||
|
<pre>
|
||||||
|
void unlock();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Unlocks the associated mutex.</p>
|
||||||
|
|
||||||
|
<p><b>Throws:</b> <a href="lock_error.html">lock_error</a> if <code>
|
||||||
|
!locked()</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>const void* Conversion</h3>
|
||||||
|
<pre>
|
||||||
|
operator const void*() const;
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> If the associated mutex is currently locked, a value
|
||||||
|
convertible to <code>true</code>, else a value convertible to <code>
|
||||||
|
false</code>.</p>
|
||||||
|
|
||||||
|
<p><b>Rationale:</b> A <code>const void*</code> conversion is
|
||||||
|
considered safer than a conversion to <code>bool</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>locked</h3>
|
||||||
|
<pre>
|
||||||
|
bool locked() const;
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> <code>this->operator const void*() !=
|
||||||
|
0</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><a name="Example">Example</a> Usage</h2>
|
||||||
|
|
||||||
|
<p>See the example given in the documentation for the <a href=
|
||||||
|
"mutex.html">mutex</a> class.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
267
doc/scoped_timed_lock.html
Normal file
267
doc/scoped_timed_lock.html
Normal file
@@ -0,0 +1,267 @@
|
|||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content=
|
||||||
|
"text/html; charset=iso-8859-1">
|
||||||
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
|
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||||
|
|
||||||
|
<title>Boost.Threads, scoped_timed_lock</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
|
width="100%">
|
||||||
|
<tr>
|
||||||
|
<td valign="top" width="300">
|
||||||
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
|
"277" height="86"></h3>
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td valign="top">
|
||||||
|
<h1 align="center">Boost.Threads</h1>
|
||||||
|
|
||||||
|
<h2 align="center">scoped_timed_lock</h2>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
|
<a href="#Header">Header</a><br>
|
||||||
|
<a href="#Synopsis">Synopsis</a><br>
|
||||||
|
<a href="#Members">Members</a><br>
|
||||||
|
<a href="#Example">Example</a></p>
|
||||||
|
|
||||||
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
|
|
||||||
|
<p>This class template defines a generic lock type which meets the <a
|
||||||
|
href="lock_concept.html#ScopedTimedLock">ScopedTimedLock</a>
|
||||||
|
requirements. The <a href="mutex.html">timed_mutex</a> and <a href=
|
||||||
|
"recursive_mutex.html">recursive_timed_mutex</a> classes use this
|
||||||
|
template to define their <code>scoped_timed_lock</code> types.</p>
|
||||||
|
|
||||||
|
<p>Like all the <b>Boost.Threads</b> <a href="lock_concept.html">lock
|
||||||
|
models</a>, <code>scoped_timed_lock</code> objects are meant to be
|
||||||
|
short-lived. Objects of the class are not <a href=
|
||||||
|
"definitions.html#thread-safe">thread-safe</a>, and so should not be
|
||||||
|
shared between threads.</p>
|
||||||
|
|
||||||
|
<p>Class <code>scoped_timed_lock</code> follows the "resource
|
||||||
|
acquisition is initialization" idiom <a href=
|
||||||
|
"bibliography.html#Stroustrup-00">[Stroustrup 00 14.4.1]</a> and is a
|
||||||
|
realization of the "Scoped Locking Pattern" <a href=
|
||||||
|
"bibliography.html#Schmidt-00">[Schmidt-00]</a>. Thus the usage is to
|
||||||
|
let the constructor do the locking, and then let the destructor do the
|
||||||
|
unlocking automatically at the end of the enclosing scope. The lock()
|
||||||
|
and unlock() members are usually not explicitly called, but are
|
||||||
|
provided to allow for complex overlapping locks of multiple
|
||||||
|
mutexes.</p>
|
||||||
|
|
||||||
|
<p>The type used to instantiate the class must meet the <a href=
|
||||||
|
"mutex_concept.html#TimedMutex">TimedMutex</a> requirements.</p>
|
||||||
|
|
||||||
|
<p>Although this class is an implementation detail, it is publicly
|
||||||
|
documented here because of its importance.</p>
|
||||||
|
|
||||||
|
<h2><a name="Header">Header</a></h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/detail/lock.hpp"><boost/thread/detail/lock.hpp></a>
|
||||||
|
<i>This header is usually not included directly by programmers
|
||||||
|
because it is supplied by <a href=
|
||||||
|
"../../../boost/thread/mutex.hpp"><boost/thread/mutex.hpp></a> or
|
||||||
|
<a href=
|
||||||
|
"../../../boost/thread/recursive_mutex.hpp"><boost/thread/recursive_mutex.hpp></a></i>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Synopsis">Synopsis</a></h2>
|
||||||
|
<pre>
|
||||||
|
namespace boost { namespace detail { namespace thread {
|
||||||
|
template <typename TimedMutex>
|
||||||
|
class scoped_timed_lock : private <a href=
|
||||||
|
"../../utility/utility.htm#Class noncopyable">boost::noncopyable</a> // Exposition only.
|
||||||
|
// Class scoped_timed_lock meets the <a href=
|
||||||
|
"overview.html#NonCopyable">NonCopyable</a> requirement.
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
typedef TimedMutex mutex_type;
|
||||||
|
|
||||||
|
scoped_timed_lock(TimedMutex& mx, const boost::xtime& xt);
|
||||||
|
scoped_timed_lock(TimedMutex& mx, bool initially_locked);
|
||||||
|
~scoped_timed_lock();
|
||||||
|
|
||||||
|
void lock();
|
||||||
|
bool timed_lock(const xtime& xt);
|
||||||
|
void unlock();
|
||||||
|
|
||||||
|
operator const void*() const;
|
||||||
|
};
|
||||||
|
} // namespace thread
|
||||||
|
} // namesapce detail
|
||||||
|
} // namespace boost
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Members">Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructor</h3>
|
||||||
|
<pre>
|
||||||
|
scoped_timed_lock(TimedMutex& mx, const <a href=
|
||||||
|
"xtime.html">xtime</a>& xt);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Associates mutex <code>mx</code> with <code>
|
||||||
|
*this</code>. Calls <code>timed_lock</code>( <code>xt</code>)</p>
|
||||||
|
<hr>
|
||||||
|
<pre>
|
||||||
|
scoped_timed_lock(TimedMutex& mx, bool initially_locked);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Associates mutex <code>mx</code> with <code>
|
||||||
|
*this</code>. If <code>initially_locked</code> is <code>true</code>,
|
||||||
|
calls <code>lock()</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Destructor</h3>
|
||||||
|
<pre>
|
||||||
|
~scoped_timed_lock();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> If <code>locked()</code>, calls <code>
|
||||||
|
unlock()</code>. Destroys <code>*this</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>lock</h3>
|
||||||
|
<pre>
|
||||||
|
void lock();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> If the associated mutex is already locked by another
|
||||||
|
lock in the current thread, the effects depend on the locking strategy
|
||||||
|
of the associated mutex, as shown in the following table:</p>
|
||||||
|
|
||||||
|
<table summary="lock effects" border="1" cellpadding="5">
|
||||||
|
<tr>
|
||||||
|
<td><i><a href="mutex_concept.html#LockingStrategies">Locking
|
||||||
|
Strategy</a><br>
|
||||||
|
of associated mutex</i></td>
|
||||||
|
|
||||||
|
<td><i>Effect if associated mutex is already locked by the
|
||||||
|
current thread</i></td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>Recursive</td>
|
||||||
|
|
||||||
|
<td>As if an additional lock were added to the mutex.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>Checked</td>
|
||||||
|
|
||||||
|
<td>Throws <a href="lock_error.html">lock_error</a>.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>Unchecked</td>
|
||||||
|
|
||||||
|
<td>Undefined behavior [<a href="bibliography.html#ISO">ISO</a>
|
||||||
|
1.3.12] (but typically, <a href="definitions.html#Deadlock">
|
||||||
|
deadlock</a>.)</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<p>If the associated mutex is already locked by some other thread,
|
||||||
|
places the current thread in the <a href="definitions.html#State">
|
||||||
|
Blocked</a> state until the associated mutex is unlocked, after which
|
||||||
|
the current thread is placed in the <a href="definitions.html#State">
|
||||||
|
Ready</a> state, eventually to be returned to the <a href=
|
||||||
|
"definitions.html#State">Running</a> state. Places the associated mutex
|
||||||
|
in the locked state.</p>
|
||||||
|
|
||||||
|
<p><b>Throws:</b> <a href="lock_error.html">lock_error</a> if <code>
|
||||||
|
locked()</code> or as indicated in <b>Effects</b>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>timed_lock</h3>
|
||||||
|
<pre>
|
||||||
|
bool timed_lock(const <a href="xtime.html">xtime</a>& xt);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Same as <code>lock()</code>, except that if xt is
|
||||||
|
reached, places the current thread in the <a href=
|
||||||
|
"definitions.html#State">Ready</a> state without further ado.</p>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> <code>locked()</code>.</p>
|
||||||
|
|
||||||
|
<p><b>Throws:</b> <a href="lock_error.html">lock_error</a> if <code>
|
||||||
|
locked()</code> or as indicated in <b>Effects</b>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>unlock</h3>
|
||||||
|
<pre>
|
||||||
|
void unlock();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Unlocks the associated mutex.</p>
|
||||||
|
|
||||||
|
<p><b>Throws:</b> <a href="lock_error.html">lock_error</a> if <code>
|
||||||
|
!locked()</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>const void* Conversion</h3>
|
||||||
|
<pre>
|
||||||
|
operator const void*() const;
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> If the associated mutex is currently locked, a value
|
||||||
|
convertible to <code>true</code>, else a value convertible to <code>
|
||||||
|
false</code>.</p>
|
||||||
|
|
||||||
|
<p><b>Rationale:</b> A <code>const void*</code> conversion is
|
||||||
|
considered safer than a conversion to <code>bool</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>locked</h3>
|
||||||
|
<pre>
|
||||||
|
bool locked() const;
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> <code>this->operator const void*() !=
|
||||||
|
0</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><a name="Example">Example</a> Usage</h2>
|
||||||
|
<pre>
|
||||||
|
#include <boost/thread/mutex.hpp>
|
||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
int main(int, char*[])
|
||||||
|
{
|
||||||
|
boost::timed_mutex mutex;
|
||||||
|
boost::xtime xt;
|
||||||
|
boost::get_xtime(&xt, boost::TIME_UTC);
|
||||||
|
xt.sec += 1;
|
||||||
|
boost::mutex::scoped_timed_lock scope_timed_lock(mutex, xt);
|
||||||
|
if (scope_timed_lock.locked())
|
||||||
|
std::cout << "locked" << std::endl;
|
||||||
|
else
|
||||||
|
std::cout << "unlocked" << std::endl;
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>The output is:</p>
|
||||||
|
<pre>
|
||||||
|
locked
|
||||||
|
</pre>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%B %d, %Y" startspan -->November 05, 2001<!--webbot bot="Timestamp" endspan i-checksum="39585" --></p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
305
doc/scoped_try_lock.html
Normal file
305
doc/scoped_try_lock.html
Normal file
@@ -0,0 +1,305 @@
|
|||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content=
|
||||||
|
"text/html; charset=iso-8859-1">
|
||||||
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
|
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||||
|
|
||||||
|
<title>Boost.Threads, scoped_try_lock</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
|
width="100%">
|
||||||
|
<tr>
|
||||||
|
<td valign="top" width="300">
|
||||||
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
|
"277" height="86"></h3>
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td valign="top">
|
||||||
|
<h1 align="center">Boost.Threads</h1>
|
||||||
|
|
||||||
|
<h2 align="center">scoped_try_lock</h2>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
|
<a href="#Header">Header</a><br>
|
||||||
|
<a href="#Synopsis">Synopsis</a><br>
|
||||||
|
<a href="#Members">Members</a><br>
|
||||||
|
<a href="#Example">Example</a></p>
|
||||||
|
|
||||||
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
|
|
||||||
|
<p>This class template defines a generic lock type which meets the <a
|
||||||
|
href="lock_concept.html#ScopedTryLock">ScopedTryLock</a> requirements.
|
||||||
|
The <a href="mutex.html">try_mutex</a>, <a href="mutex.html">
|
||||||
|
timed_mutex</a>, <a href="recursive_mutex.html">recursive_try_mutex</a>
|
||||||
|
and <a href="recursive_mutex.html">recursive_timed_mutex</a> classes
|
||||||
|
use this template to define their <code>scoped_try_lock</code>
|
||||||
|
types.</p>
|
||||||
|
|
||||||
|
<p>Like all the <b>Boost.Threads</b> <a href="lock_concept.html">lock
|
||||||
|
models</a>, <code>scoped_try_lock</code> objects are meant to be
|
||||||
|
short-lived. Objects of the class are not <a href=
|
||||||
|
"definitions.html#thread-safe">thread-safe</a>, and so should not be
|
||||||
|
shared between threads.</p>
|
||||||
|
|
||||||
|
<p>Class <code>scoped_try_lock</code> follows the "resource
|
||||||
|
acquisition is initialization" idiom <a href=
|
||||||
|
"bibliography.html#Stroustrup-00">[Stroustrup 00 14.4.1]</a> and is a
|
||||||
|
realization of the "Scoped Locking Pattern" <a href=
|
||||||
|
"bibliography.html#Schmidt-00">[Schmidt-00]</a>. Thus the usage is to
|
||||||
|
let the constructor do the locking, and then let the destructor do the
|
||||||
|
unlocking automatically at the end of the enclosing scope. The lock()
|
||||||
|
and unlock() members are usually not explicitly called, but are
|
||||||
|
provided to allow for complex overlapping locks of multiple
|
||||||
|
mutexes.</p>
|
||||||
|
|
||||||
|
<p>Although this class is an implementation detail, it is publicly
|
||||||
|
documented here because of its importance.</p>
|
||||||
|
|
||||||
|
<p>The type used to instantiate the class must meet the <a href=
|
||||||
|
"mutex_concept.html#TryMutex">TryMutex</a> requirements.</p>
|
||||||
|
|
||||||
|
<h2><a name="Header">Header</a></h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/detail/lock.hpp"><boost/thread/detail/lock.hpp></a>
|
||||||
|
<i>This header is usually not included directly by programmers
|
||||||
|
because it is supplied by <a href=
|
||||||
|
"../../../boost/thread/mutex.hpp"><boost/thread/mutex.hpp></a> or
|
||||||
|
<a href=
|
||||||
|
"../../../boost/thread/recursive_mutex.hpp"><boost/thread/recursive_mutex.hpp></a></i>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Synopsis">Synopsis</a></h2>
|
||||||
|
<pre>
|
||||||
|
namespace boost { namespace detail { namespace thread {
|
||||||
|
template <typename TryMutex>
|
||||||
|
class scoped_try_lock : private <a href=
|
||||||
|
"../../utility/utility.htm#Class noncopyable">boost::noncopyable</a> // Exposition only.
|
||||||
|
// Class scoped_try_lock meets the <a href=
|
||||||
|
"overview.html#NonCopyable">NonCopyable</a> requirement.
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
typedef TryMutex mutex_type;
|
||||||
|
|
||||||
|
explicit scoped_try_lock(TryMutex& mx);
|
||||||
|
scoped_try_lock(TryMutex& mx, bool initially_locked);
|
||||||
|
~scoped_try_lock();
|
||||||
|
|
||||||
|
void lock();
|
||||||
|
bool try_lock();
|
||||||
|
void unlock();
|
||||||
|
|
||||||
|
operator const void*() const;
|
||||||
|
};
|
||||||
|
} // namespace thread
|
||||||
|
} // namespace detail
|
||||||
|
} // namespace boost
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Members">Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructors</h3>
|
||||||
|
<pre>
|
||||||
|
explicit scoped_try_lock(TryMutex& mx);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Associates mutex <code>mx</code> with <code>
|
||||||
|
*this</code>. Calls <code>try_lock()</code>.</p>
|
||||||
|
<hr>
|
||||||
|
<pre>
|
||||||
|
scoped_try_lock(TryMutex& mx, bool initially_locked);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Associates mutex <code>mx</code> with <code>
|
||||||
|
*this</code>. If <code>initially_locked</code> is <code>true,</code>
|
||||||
|
calls <code>lock()</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Destructor</h3>
|
||||||
|
<pre>
|
||||||
|
~scoped_try_lock();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> If <code>locked()</code>, calls <code>
|
||||||
|
unlock()</code>. Destroys <code>*this</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>lock</h3>
|
||||||
|
<pre>
|
||||||
|
void lock();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> If the associated mutex is already locked by another
|
||||||
|
lock in the current thread, the effects depend on the locking strategy
|
||||||
|
of the associated mutex, as shown in the following table:</p>
|
||||||
|
|
||||||
|
<table summary="lock effects" border="1" cellpadding="5" height="147">
|
||||||
|
<tr>
|
||||||
|
<td height="34"><i><a href=
|
||||||
|
"mutex_concept.html#LockingStrategies">Locking Strategy</a><br>
|
||||||
|
of associated mutex</i></td>
|
||||||
|
|
||||||
|
<td height="34"><i>Effect if associated mutex is already locked
|
||||||
|
by the current thread</i></td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td height="19">Recursive</td>
|
||||||
|
|
||||||
|
<td height="19">As if an additional lock were added to the
|
||||||
|
mutex.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td height="19">Checked</td>
|
||||||
|
|
||||||
|
<td height="19">Throws <a href="lock_error.html">
|
||||||
|
lock_error</a>.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td height="19">Unchecked</td>
|
||||||
|
|
||||||
|
<td height="19">Undefined behavior [<a href=
|
||||||
|
"bibliography.html#ISO">ISO</a> 1.3.12] (but typically, <a
|
||||||
|
href="definitions.html#Deadlock">deadlock</a>.)</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<p>If the associated mutex is already locked by some other thread,
|
||||||
|
places the current thread in the <a href="definitions.html#State">
|
||||||
|
Blocked</a> state until the associated mutex is unlocked, after which
|
||||||
|
the current thread is placed in the <a href="definitions.html#State">
|
||||||
|
Ready</a> state, eventually to be returned to the <a href=
|
||||||
|
"definitions.html#State">Running</a> state. Places the associated mutex
|
||||||
|
in the locked state.</p>
|
||||||
|
|
||||||
|
<p><b>Throws:</b> <a href="lock_error.html">lock_error</a> if <code>
|
||||||
|
locked()</code> or as indicated in <b>Effects</b>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>try_lock</h3>
|
||||||
|
<pre>
|
||||||
|
bool try_lock();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> If the associated mutex is already locked by another
|
||||||
|
lock in the current thread, the effects depend on the locking strategy
|
||||||
|
of the associated mutex, as shown in the following table:</p>
|
||||||
|
|
||||||
|
<table summary="try_lock effects" border="1" cellpadding="5" height=
|
||||||
|
"147">
|
||||||
|
<tr>
|
||||||
|
<td height="34"><i><a href=
|
||||||
|
"mutex_concept.html#LockingStrategies">Locking Strategy</a><br>
|
||||||
|
of associated mutex</i></td>
|
||||||
|
|
||||||
|
<td height="34"><i>Effect if associated mutex is already locked
|
||||||
|
by the current thread</i></td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td height="19">Recursive</td>
|
||||||
|
|
||||||
|
<td height="19">As if an additional lock were added to the
|
||||||
|
mutex.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td height="19">Checked</td>
|
||||||
|
|
||||||
|
<td height="19">Throws <a href="lock_error.html">
|
||||||
|
lock_error</a>.</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td height="19">Unspecified</td>
|
||||||
|
|
||||||
|
<td height="19">Undefined behavior [<a href=
|
||||||
|
"bibliography.html#ISO">ISO</a> 1.3.12] (but typically, <a
|
||||||
|
href="definitions.html#Deadlock">deadlock</a>.)</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<p>If the associated mutex is not already locked by some other thread,
|
||||||
|
locks the associated mutex and returns true, else returns false.</p>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> See effects.</p>
|
||||||
|
|
||||||
|
<p><b>Throws:</b> <a href="lock_error.html">lock_error</a> if <code>
|
||||||
|
locked()</code> or as indicated in <b>Effects</b>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>unlock</h3>
|
||||||
|
<pre>
|
||||||
|
void unlock();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Unlocks the associated mutex.</p>
|
||||||
|
|
||||||
|
<p><b>Throws:</b> <a href="lock_error.html">lock_error</a> if <code>
|
||||||
|
!locked()</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>const void* Conversion</h3>
|
||||||
|
<pre>
|
||||||
|
operator const void*() const;
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> If the associated mutex is currently locked, a value
|
||||||
|
convertible to <code>true</code>, else a value convertible to <code>
|
||||||
|
false</code>.</p>
|
||||||
|
|
||||||
|
<p><b>Rationale:</b> A <code>const void*</code> conversion is
|
||||||
|
considered safer than a conversion to <code>bool</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>locked</h3>
|
||||||
|
<pre>
|
||||||
|
bool locked() const;
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> <code>this->operator const void*() !=
|
||||||
|
0</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><a name="Example">Example</a> Usage</h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/mutex.hpp"><boost/thread/mutex.hpp></a>
|
||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
int main(int, char*[])
|
||||||
|
{
|
||||||
|
boost::mutex mutex;
|
||||||
|
boost::mutex::try_lock lock(mutex);
|
||||||
|
if (lock)
|
||||||
|
std::cout << "locked" << std::endl;
|
||||||
|
else
|
||||||
|
std::cout << "unlocked" << std::endl;
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>The output is:</p>
|
||||||
|
<pre>
|
||||||
|
locked
|
||||||
|
</pre>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
4
doc/styles.css
Normal file
4
doc/styles.css
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
PRE
|
||||||
|
{
|
||||||
|
BACKGROUND-COLOR: lightcyan
|
||||||
|
}
|
||||||
497
doc/thread.html
497
doc/thread.html
@@ -1,96 +1,92 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Type" content=
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
"text/html; charset=iso-8859-1">
|
||||||
<title>Boost.Threads - <boost/thread.hpp></title>
|
<meta name="keywords" content=
|
||||||
</head>
|
"threads, Boost.Threads, thread library, C++">
|
||||||
<body link="#0000ff" vlink="#800080">
|
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
|
||||||
"header">
|
<title>Boost.Threads, thread</title>
|
||||||
<tr>
|
</head>
|
||||||
<td valign="top" width="300">
|
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
<body bgcolor="#ffffff" link="#0000ff" vlink="#800080">
|
||||||
</td>
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
<td valign="top">
|
width="100%">
|
||||||
<h1 align="center">Boost.Threads</h1>
|
<tr>
|
||||||
<h2 align="center">Header <<a href="../../../boost/thread/thread.hpp">boost/thread.hpp</a>></h2>
|
<td valign="top" width="300">
|
||||||
</td>
|
<h3><img height="86" alt="C++ Boost" src=
|
||||||
</tr>
|
"../../../c++boost.gif" width="277"></h3>
|
||||||
</table>
|
</td>
|
||||||
<hr>
|
|
||||||
<h2>Contents</h2>
|
<td valign="top">
|
||||||
<dl class="page-index">
|
<h1 align="center">Boost.Threads</h1>
|
||||||
<dt><a href="#introduction">Introduction</a></dt>
|
|
||||||
<dt><a href="#classes">Classes</a></dt>
|
<h2 align="center">Class thread</h2>
|
||||||
<dl class="page-index">
|
</td>
|
||||||
<dt><a href="#class-thread">Class <code>thread</code></a></dt>
|
</tr>
|
||||||
<dl class="page-index">
|
</table>
|
||||||
<dt><a href="#class-thread-synopsis">Class <code>thread</code> synopsis</a></dt>
|
<hr>
|
||||||
<dt><a href="#class-thread-ctors">Class <code>thread</code> constructors
|
|
||||||
and destructor</a></dt>
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
<dt><a href="#class-thread-comparisons">Class <code>thread</code> comparison
|
<a href="#Header">Header</a><br>
|
||||||
functions</a></dt>
|
<a href="#Synopsis">Synopsis</a><br>
|
||||||
<dt><a href="#class-thread-modifiers">Class <code>thread</code> modifier
|
<a href="#Members">Members</a><br>
|
||||||
functions</a></dt>
|
<a href="#Example">Example</a></p>
|
||||||
<dt><a href="#class-thread-statics">Class <code>thread</code> static functions</a></dt>
|
|
||||||
</dl>
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
<dt><a href="#class-thread_group">Class <code>thread_group</code></a></dt>
|
|
||||||
<dl class="page-index">
|
<p>The <code>thread</code> class represents threads of execution, and
|
||||||
<dt><a href="#class-thread_group-synopsis">Class <code>thread_group</code>
|
provides the functionality to create and manage threads within the <b>
|
||||||
synopsis</a></dt>
|
Boost.Threads</b> library. See <a href="definitions.html">
|
||||||
<dt><a href="#class-thread_group-ctors">Class <code>thread_group</code>
|
Definitions</a> for a precise description of "thread of
|
||||||
constructors and destructor</a></dt>
|
execution", and for definitions of threading related terms and of
|
||||||
<dt><a href="#class-thread_group-modifiers">Class <code>thread_group</code>
|
thread states such as "blocked".</p>
|
||||||
modifier functions</a></dt>
|
|
||||||
</dl>
|
<p>A thread of execution has an initial function. For the program's
|
||||||
</dl>
|
initial thread, the initial function is <code>main()</code>. For other
|
||||||
<dt><a href="#examples">Example(s)</a></dt>
|
threads, the initial function is <code>operator()</code> of the
|
||||||
<dl class="page-index">
|
function object passed to the class <code>thread</code>
|
||||||
<dt><a href="#example-thread">Simple usage of <code>boost::thread</code></a></dt>
|
constructor.</p>
|
||||||
<dt><a href="#example-thread_group">Simple usage of <code>boost::thread_group</code></a></dt>
|
|
||||||
</dl>
|
<p>A thread of execution is said to be "finished" or
|
||||||
</dl>
|
"finished execution" when its initial function returns or is
|
||||||
<hr>
|
terminated. This includes completion of all thread cleanup handlers,
|
||||||
<h2><a name="introduction"></a>Introduction</h2>
|
and completion of the normal C++ function return behaviors, such as
|
||||||
<p>The header <<a href="../../../boost/thread/thread.hpp">boost/thread.hpp</a>>
|
destruction of automatic storage (stack) objects and releasing any
|
||||||
defines the classes <a href="#class-thread">thread</a> and <a href="#class-thread_group">thread_group</a>
|
associated implementation resources.</p>
|
||||||
which are used to create, observe and manage threads and groups of threads.</p>
|
|
||||||
<h2><a name="classes"></a>Classes</h2>
|
<p>A thread object has an associated state which is either
|
||||||
<h3><a name="class-thread"></a>Class <code>thread</code></h3>
|
"joinable" or "non-joinable".</p>
|
||||||
<p>The <code>thread</code> class represents threads of execution, and provides
|
|
||||||
the functionality to create and manage threads within the <b> Boost.Threads</b>
|
<p>Except as described below, the policy used by an implementation of
|
||||||
library. See <a href="definitions.html"> Definitions</a> for a precise description
|
<b>Boost.Threads</b> to schedule transitions between thread states is
|
||||||
of "thread of execution", and for definitions of threading related
|
unspecified.</p>
|
||||||
terms and of thread states such as "blocked".</p>
|
|
||||||
<p>A thread of execution has an initial function. For the program's initial
|
<p><b>Note:</b> Just as the lifetime of a file may be different from
|
||||||
thread, the initial function is <code>main()</code>. For other threads, the
|
the lifetime of an iostream object which represents the file, the
|
||||||
initial function is <code>operator()</code> of the function object passed to
|
lifetime of a thread of execution may be different from the <code>
|
||||||
the class <code>thread</code> constructor.</p>
|
thread</code> object which represents the thread of execution. In
|
||||||
<p>A thread of execution is said to be "finished" or "finished
|
particular, after a call to <code>join()</code>, the thread of
|
||||||
execution" when its initial function returns or is terminated. This includes
|
execution will no longer exist even though the <code>thread</code>
|
||||||
completion of all thread cleanup handlers, and completion of the normal C++
|
object continues to exist until the end of its normal lifetime. The
|
||||||
function return behaviors, such as destruction of automatic storage (stack)
|
converse is also possible; if a <code>thread</code> object is destroyed
|
||||||
objects and releasing any associated implementation resources.</p>
|
without <code>join()</code> having first been called, the thread of
|
||||||
<p>A thread object has an associated state which is either "joinable"
|
execution continues until its initial function completes.</p>
|
||||||
or "non-joinable".</p>
|
|
||||||
<p>Except as described below, the policy used by an implementation of <b>Boost.Threads</b>
|
<h2><a name="Header">Header</a></h2>
|
||||||
to schedule transitions between thread states is unspecified.</p>
|
<pre>
|
||||||
<p><b>Note:</b> Just as the lifetime of a file may be different from the lifetime
|
#include <a href=
|
||||||
of an iostream object which represents the file, the lifetime of a thread of
|
"../../../boost/thread/thread.hpp"><boost/thread/thread.hpp></a>
|
||||||
execution may be different from the <code> thread</code> object which represents
|
</pre>
|
||||||
the thread of execution. In particular, after a call to <code>join()</code>,
|
|
||||||
the thread of execution will no longer exist even though the <code>thread</code>
|
<h2><a name="Synopsis">Synopsis</a></h2>
|
||||||
object continues to exist until the end of its normal lifetime. The converse
|
|
||||||
is also possible; if a <code>thread</code> object is destroyed without <code>join()</code>
|
|
||||||
having first been called, the thread of execution continues until its initial
|
|
||||||
function completes.</p>
|
|
||||||
<h4><a name="class-thread-synopsis"></a>Class <code>thread</code> synopsis</h4>
|
|
||||||
<pre>
|
<pre>
|
||||||
namespace boost {
|
namespace boost {
|
||||||
|
|
||||||
class thread : <a href=
|
class thread : <a href=
|
||||||
"../../utility/utility.htm#Class noncopyable">boost::noncopyable</a> // Exposition only.
|
"../../utility/utility.htm#noncopyable">boost::noncopyable</a> // Exposition only.
|
||||||
// Class thread meets the <a href=
|
// Class thread meets the <a href=
|
||||||
"overview.html#non-copyable">NonCopyable</a> requirement.
|
"overview.html#NonCopyable">NonCopyable</a> requirement.
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
thread();
|
thread();
|
||||||
@@ -105,185 +101,119 @@ public:
|
|||||||
static void sleep(const xtime& xt);
|
static void sleep(const xtime& xt);
|
||||||
static void yield();
|
static void yield();
|
||||||
};
|
};
|
||||||
} // namespace boost
|
|
||||||
</pre>
|
|
||||||
<h4><a name="class-thread-ctors"></a>Class <code>thread</code> constructors and
|
|
||||||
destructor</h4>
|
|
||||||
<pre>
|
|
||||||
thread();
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> Constructs a <code>thread</code> object representing the
|
|
||||||
current thread of execution.</dt>
|
|
||||||
<dt><b>Postconditions:</b> <code>*this</code> is non-joinable.</dt>
|
|
||||||
<dt><b>Danger:</b> <code>*this</code> is valid only within the current thread.</dt>
|
|
||||||
</dl>
|
|
||||||
<pre>
|
|
||||||
thread(const <a href="../../function/index.html">boost::function0</a><void>& threadfunc);
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> Starts a new thread of execution and constructs a <code>thread</code>
|
|
||||||
object representing it. Copies <code> threadfunc</code> (which in turn copies
|
|
||||||
the function object wrapped by <code>threadfunc</code>) to an internal location
|
|
||||||
which persists for the lifetime of the new thread of execution. Calls <code>operator()</code>
|
|
||||||
on the copy of the <code>threadfunc</code> function object in the new thread
|
|
||||||
of execution.</dt>
|
|
||||||
<dt><b>Postconditions:</b> <code>*this</code> is joinable.</dt>
|
|
||||||
<dt><b>Throws:</b> <code>boost::thread_resource_error</code> if a new thread
|
|
||||||
of execution cannot be started.</dt>
|
|
||||||
</dl>
|
|
||||||
<pre>
|
|
||||||
~Thread();
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> Destroys <code>*this</code>. The actual thread of execution
|
|
||||||
may continue to execute after the <code>thread</code> object has been destroyed.</dt>
|
|
||||||
<dt><b>Note:</b> If <code>*this</code> is joinable the actual thread of execution
|
|
||||||
becomes "detached". Any resources used by the thread will be reclaimed
|
|
||||||
when the thread of execution completes. To ensure such a thread of execution
|
|
||||||
runs to completion before the <code> thread</code> object is destroyed, call
|
|
||||||
<code>join()</code>.</dt>
|
|
||||||
</dl>
|
|
||||||
<h4><a name="class-thread-comparisons"></a>Class <code>thread</code> comparison
|
|
||||||
functions</h4>
|
|
||||||
<pre>
|
|
||||||
bool operator==(const thread& rhs) const;
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> The thread is non-terminated or <code>*this</code> is joinable.</dt>
|
|
||||||
<dt><b>Returns:</b> <code>true</code> if <code>*this</code> and <code> rhs</code>
|
|
||||||
represent the same thread of execution.</dt>
|
|
||||||
</dl>
|
|
||||||
<pre>
|
|
||||||
bool operator!=(const thread& rhs) const;
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> The thread is non-terminated or <code>*this</code> is joinable.</dt>
|
|
||||||
<dt><b>Returns:</b> <code>!(*this==rhs)</code>.</dt>
|
|
||||||
</dl>
|
|
||||||
<h4><a name="class-thread-modifiers"></a>Class <code>thread</code> modifier functions</h4>
|
|
||||||
<pre>
|
|
||||||
void join();
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> <code>*this</code> is joinable.</dt>
|
|
||||||
<dt><b>Effects:</b> The current thread of execution blocks until the initial
|
|
||||||
function of the thread of execution represented by <code> *this</code> finishes
|
|
||||||
and all resources are reclaimed.</dt>
|
|
||||||
<dt><b>Postconditions:</b> <code>*this</code> is non-joinable.</dt>
|
|
||||||
<dt><b>Notes:</b> If <code>*this == thread()</code> the result is implementation
|
|
||||||
defined. If the implementation doesn't detect this the result will be
|
|
||||||
<a href="definitions.html#Deadlock"> deadlock</a>.</dt>
|
|
||||||
</dl>
|
|
||||||
<h4><a name="class-thread-statics"></a>Class <code>thread</code> static functions</h4>
|
|
||||||
<pre>
|
|
||||||
static void sleep(const <a href="xtime.html">xtime</a>& XT);
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> The current thread of execution blocks until <code> XT</code>
|
|
||||||
is reached.</dt>
|
|
||||||
</dl>
|
|
||||||
<pre>
|
|
||||||
static void yield();
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> The current thread of execution is placed in the "ready"
|
|
||||||
state.</dt>
|
|
||||||
<dt><b>Notes:</b> Allow the current thread to give up the rest of its time slice
|
|
||||||
(or other scheduling quota) to another thread. Particularly useful in non-preemptive
|
|
||||||
implementations.</dt>
|
|
||||||
</dl>
|
|
||||||
<h3><a name="class-thread_group"></a>Class <code>thread_group</code></h3>
|
|
||||||
<p>The <tt>thread_group</tt> class provides a container for easy grouping of threads
|
|
||||||
to simplify several common thread creation and management idioms.</p>
|
|
||||||
<p>All <tt>thread_group</tt> member functions are <a href=
|
|
||||||
"definitions.html#thread-safe">thread-safe</a>, except destruction.</p>
|
|
||||||
<h4><a name="class-thread_group-synopsis"></a>Class <code>thread_group</code>
|
|
||||||
synopsis</h4>
|
|
||||||
<pre>
|
|
||||||
namespace boost {
|
|
||||||
class thread_group : <a href=
|
|
||||||
"../../utility/utility.htm#Class noncopyable">boost::noncopyable</a>
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
thread_group();
|
|
||||||
~thread_group();
|
|
||||||
|
|
||||||
thread* create_thread(const boost::function0<void>& threadfunc);
|
|
||||||
void add_thread(thread* thrd);
|
|
||||||
void remove_thread(thread* thrd);
|
|
||||||
void join_all();
|
|
||||||
};
|
|
||||||
} // namespace boost
|
} // namespace boost
|
||||||
</pre>
|
</pre>
|
||||||
<h4><a name="class-thread_group-ctors"></a>Class <code>thread_group</code> constructors
|
|
||||||
and destructor</h4>
|
<h2><a name="Members">Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructors</h3>
|
||||||
<pre>
|
<pre>
|
||||||
thread_group();
|
thread();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> Constructs an empty <code>thread_group</code> container.</dt>
|
<p><b>Effects:</b> Constructs a <code>thread</code> object representing
|
||||||
</dl>
|
the current thread of execution.</p>
|
||||||
|
|
||||||
|
<p><b>Postcondition:</b> <code>*this</code> is non-joinable.</p>
|
||||||
|
|
||||||
|
<p><b>Danger:</b> <code>*this</code> is valid only within the current
|
||||||
|
thread.</p>
|
||||||
<pre>
|
<pre>
|
||||||
~thread_group();
|
thread(const <a href=
|
||||||
|
"../../function/index.html">boost::function0</a><void>& threadfunc);
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> Destroys each contained thread object. Destroys <code>*this</code>.</dt>
|
<p><b>Effects:</b> Starts a new thread of execution and constructs a
|
||||||
<dt><b>Notes:</b> Behavior is undefined if another thread references *this during
|
<code>thread</code> object representing it. Copies <code>
|
||||||
the execution of the destructor.</dt>
|
threadfunc</code> (which in turn copies the function object wrapped by
|
||||||
</dl>
|
<code>threadfunc</code>) to an internal location which persists for the
|
||||||
<h4><a name="class-thread_group-modifiers"></a>Class <code>thread_group</code>
|
lifetime of the new thread of execution. Calls <code>operator()</code>
|
||||||
modifier functions</h4>
|
on the copy of the <code>threadfunc</code> function object in the new
|
||||||
|
thread of execution.</p>
|
||||||
|
|
||||||
|
<p><b>Postcondition:</b> <code>*this</code> is joinable.</p>
|
||||||
|
|
||||||
|
<p><b>Throws:</b> <code>boost::thread_resource_error</code> if a new
|
||||||
|
thread of execution cannot be started.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Destructor</h3>
|
||||||
<pre>
|
<pre>
|
||||||
thread* create_thread(const boost::function0<void>& threadfunc);
|
~thread();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> Creates a new <tt>thread</tt> object that executes <tt>threadfunc</tt>
|
<p><b>Effects:</b> Destroys <code>*this</code>. The actual thread of
|
||||||
and adds it to the <tt>thread_group</tt> container object's list of managed
|
execution may continue to execute after the <code>thread</code> object
|
||||||
<tt>thread</tt> objects.</dt>
|
has been destroyed.</p>
|
||||||
<dt><b>Returns:</b> Pointer to the newly created thread.</dt>
|
|
||||||
</dl>
|
<p><b>Notes:</b> If <code>*this</code> is joinable the actual thread of
|
||||||
|
execution becomes "detached". Any resources used by the
|
||||||
|
thread will be reclaimed when the thread of execution completes. To
|
||||||
|
ensure such a thread of execution runs to completion before the <code>
|
||||||
|
thread</code> object is destroyed, call <code>join()</code>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Comparison Operators</h3>
|
||||||
<pre>
|
<pre>
|
||||||
void add_thread(thread* thrd);
|
bool operator==(const thread& rhs);
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> Adds <tt>thrd</tt> to the <tt>thread_group</tt> object's
|
<p><b>Requires:</b> The thread is non-terminated or <code>*this</code>
|
||||||
list of managed <tt>thread</tt> objects. The <tt>thrd</tt> object must have
|
is joinable.</p>
|
||||||
been allocated via operator new and will be deleted when the group is destroyed.</dt>
|
|
||||||
</dl>
|
<p><b>Returns:</b> <code>true</code> if <code>*this</code> and <code>
|
||||||
|
rhs</code> represent the same thread of execution.</p>
|
||||||
<pre>
|
<pre>
|
||||||
Void remove_thread(thread* thrd);
|
bool operator!=(const thread& rhs);
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> Removes <code>*this</code>'s list of managed <tt>thread</tt>
|
<p><b>Returns:</b> <code>!(*this==rhs)</code>.</p>
|
||||||
objects.</dt>
|
<hr>
|
||||||
<dt><b>Throws:</b> ? if <tt>thrd</tt> is not it <code>*this</code>'s list
|
|
||||||
of managed <tt>thread</tt> objects.</dt>
|
<h3>join</h3>
|
||||||
</dl>
|
|
||||||
<pre>
|
<pre>
|
||||||
Void join_all();
|
void join();
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> Calls <code>join()</code> on each of the managed <tt>thread</tt>
|
<p><b>Requires:</b> <code>*this</code> is joinable.</p>
|
||||||
objects.</dt>
|
|
||||||
</dl>
|
<p><b>Effects:</b> The current thread of execution blocks until the
|
||||||
<h2><a name="functions"></a>Functions</h2>
|
initial function of the thread of execution represented by <code>
|
||||||
|
*this</code> finishes and all resources are reclaimed.</p>
|
||||||
|
|
||||||
|
<p><b>Postcondition:</b> <code>*this</code> is non-joinable.</p>
|
||||||
|
|
||||||
|
<p><b>Note:</b> If <code>*this == thread()</code> the result is
|
||||||
|
implementation defined. If the implementation doesn't detect this
|
||||||
|
the result will be <a href="definitions.html#Deadlock">
|
||||||
|
deadlock</a>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>sleep</h3>
|
||||||
<pre>
|
<pre>
|
||||||
<a name="function-spec"></a>{{function}}
|
static void sleep(const <a href="xtime.html">xtime</a>& xt);
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> {{text}}</dt>
|
<p><b>Effects:</b> The current thread of execution blocks until <code>
|
||||||
<dt><b>Effects:</b> {{text}}</dt>
|
xt</code> is reached.</p>
|
||||||
<dt><b>Postconditions:</b> {{text}}</dt>
|
<hr>
|
||||||
<dt><b>Returns:</b> {{text}}</dt>
|
|
||||||
<dt><b>Throws:</b> {{text}}</dt>
|
<h3>yield</h3>
|
||||||
<dt><b>Complexity:</b> {{text}}</dt>
|
<pre>
|
||||||
<dt><b>Rationale:</b> {{text}}</dt>
|
static void yield();
|
||||||
</dl>
|
</pre>
|
||||||
<h2><a name="objects"></a>Objects</h2>
|
|
||||||
<p><a name="object-spec"></a>{{Object specifications}}</p>
|
<p><b>Effects:</b> The current thread of execution is placed in the
|
||||||
<h2><a name="examples"></a>Example(s)</h2>
|
"ready" state.</p>
|
||||||
<h3><a name="example-thread"></a>Simple usage of <code>boost::thread</code></h3>
|
|
||||||
|
<p><b>Notes:</b> Allow the current thread to give up the rest of its
|
||||||
|
time slice (or other scheduling quota) to another thread. Particularly
|
||||||
|
useful in non-preemptive implementations.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><a name="Example">Example Usage</a></h2>
|
||||||
<pre>
|
<pre>
|
||||||
#include <boost/thread/thread.hpp>
|
#include <boost/thread/thread.hpp>
|
||||||
#include <iostream>
|
#include <iostream>
|
||||||
@@ -293,11 +223,11 @@ struct thread_alarm
|
|||||||
thread_alarm(int secs) : m_secs(secs) { }
|
thread_alarm(int secs) : m_secs(secs) { }
|
||||||
void operator()()
|
void operator()()
|
||||||
{
|
{
|
||||||
boost::xtime XT;
|
boost::xtime xt;
|
||||||
boost::xtime_get(&XT, boost::TIME_UTC);
|
boost::xtime_get(&xt, boost::TIME_UTC);
|
||||||
xt.sec += m_secs;
|
xt.sec += m_secs;
|
||||||
|
|
||||||
boost::thread::sleep(XT);
|
boost::thread::sleep(xt);
|
||||||
|
|
||||||
std::cout << "alarm sounded..." << std::endl;
|
std::cout << "alarm sounded..." << std::endl;
|
||||||
}
|
}
|
||||||
@@ -309,64 +239,23 @@ int main(int argc, char* argv[])
|
|||||||
{
|
{
|
||||||
int secs = 5;
|
int secs = 5;
|
||||||
std::cout << "setting alarm for 5 seconds..." << std::endl;
|
std::cout << "setting alarm for 5 seconds..." << std::endl;
|
||||||
thread_alarm alarm(secs);
|
boost::thread thrd(thread_alarm(secs));
|
||||||
boost::thread thrd(alarm);
|
|
||||||
thrd.join();
|
thrd.join();
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<p>The output is:</p>
|
|
||||||
|
<p>The output is:</p>
|
||||||
<pre>
|
<pre>
|
||||||
setting alarm for 5 seconds...
|
setting alarm for 5 seconds...
|
||||||
alarm sounded...
|
alarm sounded...
|
||||||
</pre>
|
</pre>
|
||||||
<h3><a name="example-thread_group"></a>Simple usage of <code>boost::thread_group</code></h3>
|
<hr>
|
||||||
<pre>
|
|
||||||
#include <boost/thread/thread.hpp>
|
|
||||||
#include <iostream>
|
|
||||||
|
|
||||||
int count = 0;
|
<p>Revised
|
||||||
boost::mutex mutex;
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
void increment_count()
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
{
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
boost::mutex::lock lock(mutex);
|
</body>
|
||||||
std::cout << "count = " << ++count << std::endl;
|
|
||||||
}
|
|
||||||
|
|
||||||
int main(int argc, char* argv[])
|
|
||||||
{
|
|
||||||
boost::thread_group threads;
|
|
||||||
for (int i = 0; i < 10; ++i)
|
|
||||||
threads.create_thread(&increment_count);
|
|
||||||
threads.join_all();
|
|
||||||
}
|
|
||||||
</pre>
|
|
||||||
<p>The output is:</p>
|
|
||||||
<pre>
|
|
||||||
count = 1
|
|
||||||
count = 2
|
|
||||||
count = 3
|
|
||||||
count = 4
|
|
||||||
count = 5
|
|
||||||
count = 6
|
|
||||||
count = 7
|
|
||||||
count = 8
|
|
||||||
count = 9
|
|
||||||
count = 10
|
|
||||||
</pre>
|
|
||||||
<hr>
|
|
||||||
<p>Revised
|
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
|
||||||
05 November, 2001
|
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
|
||||||
</p>
|
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
|
||||||
All Rights Reserved.</i></p>
|
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
|
||||||
makes no representations about the suitability of this software for any purpose.
|
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|||||||
182
doc/thread_group.html
Normal file
182
doc/thread_group.html
Normal file
@@ -0,0 +1,182 @@
|
|||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content=
|
||||||
|
"text/html; charset=iso-8859-1">
|
||||||
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
|
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||||
|
|
||||||
|
<title>Boost.Threads, thread_group</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
|
width="100%">
|
||||||
|
<tr>
|
||||||
|
<td valign="top" width="300">
|
||||||
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
|
"277" height="86"></h3>
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td valign="top">
|
||||||
|
<h1 align="center">Boost.Threads</h1>
|
||||||
|
|
||||||
|
<h2 align="center">thread_group</h2>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
|
<a href="#Header">Header</a><br>
|
||||||
|
<a href="#Synopsis">Synopsis</a><br>
|
||||||
|
<a href="#Members">Members</a><br>
|
||||||
|
<a href="#Example">Example</a></p>
|
||||||
|
|
||||||
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
|
|
||||||
|
<p>The <tt>thread_group</tt> class provides a container for easy
|
||||||
|
grouping of threads to simplify several common thread creation and
|
||||||
|
management idioms.</p>
|
||||||
|
|
||||||
|
<p>All <tt>thread_group</tt> member functions are <a href=
|
||||||
|
"definitions.html#thread-safe">thread-safe</a>, except destruction.</p>
|
||||||
|
|
||||||
|
<h2><a name="Header">Header</a></h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/thread.hpp"><boost/thread/thread.hpp></a>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Synopsis">Synopsis</a></h2>
|
||||||
|
<pre>
|
||||||
|
namespace boost
|
||||||
|
{
|
||||||
|
class thread_group : <a href=
|
||||||
|
"../../utility/utility.htm#noncopyable">boost::noncopyable</a>
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
thread_group();
|
||||||
|
~thread_group();
|
||||||
|
|
||||||
|
thread* create_thread(const boost::function0<void>& threadfunc);
|
||||||
|
void add_thread(thread* thrd);
|
||||||
|
void remove_thread(thread* thrd);
|
||||||
|
void join_all();
|
||||||
|
};
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Members">Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructor</h3>
|
||||||
|
<pre>
|
||||||
|
thread_group();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Constructs an empty <tt>thread_group</tt>
|
||||||
|
container.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Destructor</h3>
|
||||||
|
<pre>
|
||||||
|
~thread_group();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Destroys each contained thread object. Destroys
|
||||||
|
<code>*this</code>.</p>
|
||||||
|
|
||||||
|
<p><b>Notes:</b> Behavior is undefined if another thread references
|
||||||
|
*this during the execution of the destructor.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>create_thread</h3>
|
||||||
|
<pre>
|
||||||
|
thread* create_thread(const boost::function0<void>& threadfunc);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Creates a new <tt>thread</tt> object that executes
|
||||||
|
<tt>threadfunc</tt> and adds it to the <tt>thread_group</tt> container
|
||||||
|
object's list of managed <tt>thread</tt> objects.</p>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> Pointer to the newly created thread.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>add_thread</h3>
|
||||||
|
<pre>
|
||||||
|
void add_thread(thread* thrd);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Adds <tt>thrd</tt> to the <tt>thread_group</tt>
|
||||||
|
object's list of managed <tt>thread</tt> objects. The <tt>thrd</tt>
|
||||||
|
object must have been allocated via operator new and will be deleted
|
||||||
|
when the group is destroyed.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>remove_thread</h3>
|
||||||
|
<pre>
|
||||||
|
void remove_thread(thread* thrd);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Removes <code>*this</code>'s list of managed
|
||||||
|
<tt>thread</tt> objects.</p>
|
||||||
|
|
||||||
|
<p><b>Throws:</b> ? if <tt>thrd</tt> is not it <code>*this</code>'s
|
||||||
|
list of managed <tt>thread</tt> objects.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>join_all</h3>
|
||||||
|
<pre>
|
||||||
|
void join_all();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> Calls <code>join()</code> on each of the managed
|
||||||
|
<tt>thread</tt> objects.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><a name="Example">Example</a> Usage</h2>
|
||||||
|
<pre>
|
||||||
|
#include <boost/thread/thread.hpp>
|
||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
int count = 0;
|
||||||
|
boost::mutex mutex;
|
||||||
|
|
||||||
|
void increment_count()
|
||||||
|
{
|
||||||
|
boost::mutex::lock lock(mutex);
|
||||||
|
std::cout << "count = " << ++count << std::endl;
|
||||||
|
}
|
||||||
|
|
||||||
|
int main(int argc, char* argv[])
|
||||||
|
{
|
||||||
|
boost::thread_group threads;
|
||||||
|
for (int i = 0; i < 10; ++i)
|
||||||
|
threads.create_thread(&increment_count);
|
||||||
|
threads.join_all();
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>The output is:</p>
|
||||||
|
<pre>
|
||||||
|
count = 1
|
||||||
|
count = 2
|
||||||
|
count = 3
|
||||||
|
count = 4
|
||||||
|
count = 5
|
||||||
|
count = 6
|
||||||
|
count = 7
|
||||||
|
count = 8
|
||||||
|
count = 9
|
||||||
|
count = 10
|
||||||
|
</pre>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
78
doc/thread_resource_error.html
Normal file
78
doc/thread_resource_error.html
Normal file
@@ -0,0 +1,78 @@
|
|||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content=
|
||||||
|
"text/html; charset=iso-8859-1">
|
||||||
|
<meta name="keywords" content="threads, BTL, thread library, C++">
|
||||||
|
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||||
|
|
||||||
|
<title>Boost.Threads, thread_resource_error</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
|
<table summary="header" border="0" cellpadding="7" cellspacing="0" width="100%">
|
||||||
|
<tr>
|
||||||
|
<td valign="top" width="300">
|
||||||
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
|
"277" height="86"></h3>
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td valign="top">
|
||||||
|
<h1 align="center">Boost.Threads</h1>
|
||||||
|
|
||||||
|
<h2 align="center">thread_resource_error</h2>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
|
<a href="#Header">Header</a><br>
|
||||||
|
<a href="#Synopsis">Synopsis</a><br>
|
||||||
|
<a href="#Members">Members</a><br>
|
||||||
|
<a href="#Example">Example</a></p>
|
||||||
|
|
||||||
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
|
|
||||||
|
<p>The <code>thread_resource_error</code> class defines an exception
|
||||||
|
type that is thrown by constructors in the <b>Boost.Threads</b> library
|
||||||
|
when thread related resources can not be acquired. This does not
|
||||||
|
include memory allocation failures which instead throw
|
||||||
|
std::bad_alloc.</p>
|
||||||
|
|
||||||
|
<h2><a name="Header">Header</a></h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/thread.hpp"><boost/thread/exceptions.hpp></a>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Synopsis">Synopsis</a></h2>
|
||||||
|
<pre>
|
||||||
|
namespace boost
|
||||||
|
{
|
||||||
|
class thread_resource_error : public std::runtime_error
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
thread_resource_error();
|
||||||
|
};
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Members">Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructor</h3>
|
||||||
|
<pre>
|
||||||
|
thread_resource_error();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>Constructs a <code>thread_resource_error</code> object.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
223
doc/thread_specific_ptr.html
Normal file
223
doc/thread_specific_ptr.html
Normal file
@@ -0,0 +1,223 @@
|
|||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content=
|
||||||
|
"text/html; charset=iso-8859-1">
|
||||||
|
<meta name="keywords" content=
|
||||||
|
"threads, Boost.Threads, thread library, C++">
|
||||||
|
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||||
|
|
||||||
|
<title>Boost.Threads, thread_specific_ptr</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
|
width="100%">
|
||||||
|
<tr>
|
||||||
|
<td valign="top" width="300">
|
||||||
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
|
"277" height="86"></h3>
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td valign="top">
|
||||||
|
<h1 align="center">Boost.Threads</h1>
|
||||||
|
|
||||||
|
<h2 align="center">thread_specific_ptr</h2>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
|
<a href="#Header">Header</a><br>
|
||||||
|
<a href="#Synopsis">Synopsis</a><br>
|
||||||
|
<a href="#Members">Members</a><br>
|
||||||
|
<a href="#Example">Example</a></p>
|
||||||
|
|
||||||
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
|
|
||||||
|
<p>The <code>thread_specific_ptr</code> class defines an interface for
|
||||||
|
using thread specific storage. Thread specific storage is data
|
||||||
|
associated with individual threads and is often used to make operations
|
||||||
|
<a href="definitions.html#Thread-safe">thread-safe</a> that rely on
|
||||||
|
global data.</p>
|
||||||
|
|
||||||
|
<p>Template <code>thread_specific_ptr</code> stores a pointer to an
|
||||||
|
object obtained via <code>new</code> on a thread-by-thread basis and
|
||||||
|
calls delete on the contained pointer when the thread terminates. Each
|
||||||
|
thread initially stores the null pointer in each <code>
|
||||||
|
thread_specific_ptr</code> instance.</p>
|
||||||
|
|
||||||
|
<p>The template <code>thread_specific_ptr</code> is useful in the
|
||||||
|
following cases:</p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>An interface was original written assuming a single thread of
|
||||||
|
control and is being ported to a multi-threaded environment.</li>
|
||||||
|
|
||||||
|
<li>Each thread of control invokes sequences of methods that share
|
||||||
|
data that must be logically accessed through a globally visible
|
||||||
|
access point, but are physically unique for each thread, instead of
|
||||||
|
being explicitly passed.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2><a name="Header">Header</a></h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/tss.hpp"><boost/thread/tss.hpp></a>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Synopsis">Synopsis</a></h2>
|
||||||
|
<pre>
|
||||||
|
namespace boost {
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
class thread_specific_ptr : private boost::noncopyable // Exposition only.
|
||||||
|
// Class thread_specific_ptr meets the <a href=
|
||||||
|
"overview.html#NonCopyable">NonCopyable</a> requirement.
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
thread_specific_ptr();
|
||||||
|
~thread_specific_ptr();
|
||||||
|
|
||||||
|
T* get() const;
|
||||||
|
T* operator->() const;
|
||||||
|
T& operator*() const;
|
||||||
|
T* release();
|
||||||
|
void reset(T* p=0);
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace boost
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Members">Members</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Constructor</h3>
|
||||||
|
<pre>
|
||||||
|
thread_specific_ptr();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Postconditions:</b> A thread specific storage has been reserved
|
||||||
|
for use by *this in all threads, with each thread initially storing a
|
||||||
|
null pointer.</p>
|
||||||
|
|
||||||
|
<p><b>Requires:</b> The expression <code>delete get()</code> is well
|
||||||
|
formed.</p>
|
||||||
|
|
||||||
|
<p><b>Throws:</b> <code>boost::thread_resource_error</code> if the
|
||||||
|
necessary resources can not be obtained.</p>
|
||||||
|
|
||||||
|
<p><b>Notes:</b> There is an implementation specific limit to the
|
||||||
|
number of thread specific storage objects that can be created, and this
|
||||||
|
limit may be small.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Destructor</h3>
|
||||||
|
<pre>
|
||||||
|
~thread_specific_ptr();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Notes:</b> Does not destroy any data that may be stored in any
|
||||||
|
thread's thread specific storage. For this reason you should not
|
||||||
|
destroy a <code>thread_specific_ptr</code> object until you are certain
|
||||||
|
there are no threads running that have made use of its thread specific
|
||||||
|
storage.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>get</h3>
|
||||||
|
<pre>
|
||||||
|
T* get() const;
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> The object stored in thread specific storage for the
|
||||||
|
current thread for *this.</p>
|
||||||
|
|
||||||
|
<p><b>Notes:</b> Each thread initially returns 0.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Smart Pointer Operations</h3>
|
||||||
|
<pre>
|
||||||
|
T* operator->() const;
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> <code>get()</code></p>
|
||||||
|
<pre>
|
||||||
|
T& operator*() const;
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> <code>get()</code></p>
|
||||||
|
|
||||||
|
<p><b>Requires:</b> <code>get() != 0</code></p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Release</h3>
|
||||||
|
<pre>
|
||||||
|
T* release();
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> <code>get()</code></p>
|
||||||
|
|
||||||
|
<p><b>Postcondition:</b> *this holds the null pointer for the current
|
||||||
|
thread.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>Reset</h3>
|
||||||
|
<pre>
|
||||||
|
void reset(T* p=0);
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Effects:</b> If <code>get()!= p</code> then <code>delete
|
||||||
|
get()</code>.</p>
|
||||||
|
|
||||||
|
<p><b>Postconditions:</b> <code>*this</code> holds the pointer <code>
|
||||||
|
p</code> for the current thread.</p>
|
||||||
|
|
||||||
|
<p><b>Notes:</b> The pointer will be deleted when the thread
|
||||||
|
terminates.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><a name="Example">Example Usage</a></h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/thread.hpp"><boost/thread/thread.hpp></a>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/tss.hpp"><boost/thread/tss.hpp></a>
|
||||||
|
#include <cassert>
|
||||||
|
|
||||||
|
boost::thread_specific_ptr<int> value;
|
||||||
|
|
||||||
|
void increment()
|
||||||
|
{
|
||||||
|
int* p = value.get();
|
||||||
|
++*p;
|
||||||
|
}
|
||||||
|
|
||||||
|
void thread_proc()
|
||||||
|
{
|
||||||
|
value.reset(new int(0)); // initialize the thread's storage
|
||||||
|
for (int i=0; i<10; ++i)
|
||||||
|
{
|
||||||
|
increment();
|
||||||
|
int* p = value.get();
|
||||||
|
assert(*p == i+1);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
int main(int argc, char* argv[])
|
||||||
|
{
|
||||||
|
boost::thread_group threads;
|
||||||
|
for (int i=0; i<5; ++i)
|
||||||
|
threads.create_thread(&thread_proc);
|
||||||
|
threads.join_all();
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<p>Revised
|
||||||
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
|
|
||||||
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
200
doc/tss.html
200
doc/tss.html
@@ -1,200 +0,0 @@
|
|||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
|
||||||
<title>Boost.Threads - Header <boost/thread/tss.hpp></title>
|
|
||||||
</head>
|
|
||||||
<body link="#0000ff" vlink="#800080">
|
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
|
||||||
"header">
|
|
||||||
<tr>
|
|
||||||
<td valign="top" width="300">
|
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
|
||||||
</td>
|
|
||||||
<td valign="top">
|
|
||||||
<h1 align="center">Boost.Threads</h1>
|
|
||||||
<h2 align="center">Header <<a href="../../../boost/thread/tss.hpp">boost/thread/tss.hpp</a>></h2>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<hr>
|
|
||||||
<h2>Contents</h2>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#introduction">Introduction</a></dt>
|
|
||||||
<dt><a href="#classes">Classes</a></dt>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#class-thread_specific_ptr">Class <code>thread_specific_ptr</code></a></dt>
|
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#class-thread_specific_ptr-synopsis">Class <code>thread_specific_ptr</code>
|
|
||||||
synopsis</a></dt>
|
|
||||||
<dt><a href="#class-thread_specific_ptr-ctors">Class <code>thread_specific_ptr</code>
|
|
||||||
constructors and destructor</a></dt>
|
|
||||||
<dt><a href="#class-thread_specific_ptr-modifiers">Class <code>thread_specific_ptr</code>
|
|
||||||
modifier functions</a></dt>
|
|
||||||
<dt><a href="#class-thread_specific_ptr-observers">Class <code>thread_specific_ptr</code>
|
|
||||||
observer functions</a></dt>
|
|
||||||
</dl>
|
|
||||||
</dl>
|
|
||||||
<dt><a href="#examples">Example(s)</a></dt>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<h2><a name="introduction"></a>Introduction</h2>
|
|
||||||
<p>The header <<a href="../../../boost/thread/tss.hpp">boost/thread/tss.hpp</a>>
|
|
||||||
defines the class <a href="#class-thread_specific_ptr">thread_specific_ptr</a>
|
|
||||||
which is used to manage data associated with specific thread instances.</p>
|
|
||||||
<h2><a name="classes"></a>Classes</h2>
|
|
||||||
<h3><a name="class-thread_specific_ptr"></a>Class <code>thread_specific_ptr</code></h3>
|
|
||||||
<p>The <code>thread_specific_ptr</code> class defines an interface for using thread
|
|
||||||
specific storage. Thread specific storage is data associated with individual
|
|
||||||
threads and is often used to make operations <a href="definitions.html#Thread-safe">thread-safe</a>
|
|
||||||
that rely on global data.</p>
|
|
||||||
<p>Template <code>thread_specific_ptr</code> stores a pointer to an object obtained
|
|
||||||
via <code>new</code> on a thread-by-thread basis and calls delete on the contained
|
|
||||||
pointer when the thread terminates. Each thread initially stores the null pointer
|
|
||||||
in each <code> thread_specific_ptr</code> instance.</p>
|
|
||||||
<p>The template <code>thread_specific_ptr</code> is useful in the following cases:</p>
|
|
||||||
<ul>
|
|
||||||
<li>An interface was originally written assuming a single thread of control
|
|
||||||
and is being ported to a multithreaded environment.</li>
|
|
||||||
<li>Each thread of control invokes sequences of methods that share data that
|
|
||||||
must be logically accessed through a globally visible access point, but are
|
|
||||||
physically unique for each thread, instead of being explicitly passed.</li>
|
|
||||||
</ul>
|
|
||||||
<h4><a name="class-thread_specific_ptr-synopsis"></a>Class <code>thread_specific_ptr</code>
|
|
||||||
synopsis</h4>
|
|
||||||
<pre>
|
|
||||||
namespace boost
|
|
||||||
{
|
|
||||||
template <typename T>
|
|
||||||
class thread_specific_ptr : private boost::noncopyable // Exposition only.
|
|
||||||
// Class thread_specific_ptr meets the <a href="overview.html#non-copyable">NonCopyable</a> requirement.
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
thread_specific_ptr();
|
|
||||||
~thread_specific_ptr();
|
|
||||||
|
|
||||||
T* get() const;
|
|
||||||
T* operator->() const;
|
|
||||||
T& operator*() const;
|
|
||||||
T* release();
|
|
||||||
void reset(T* p=0);
|
|
||||||
};
|
|
||||||
};
|
|
||||||
</pre>
|
|
||||||
<h4><a name="class-thread_specific_ptr-ctors"></a>Class <code>thread_specific_ptr</code>
|
|
||||||
constructors and destructor</h4>
|
|
||||||
<pre>
|
|
||||||
thread_specific_ptr();
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> The expression <code>delete get()</code> is well formed.</dt>
|
|
||||||
<dt><b>Postconditions:</b> A thread specific storage has been reserved for use
|
|
||||||
by <code>*this</code> in all threads, with each thread initially storing a
|
|
||||||
null pointer.</dt>
|
|
||||||
<dt><b>Throws:</b> <code>boost::thread_resource_error</code> if the necessary
|
|
||||||
resources can not be obtained.</dt>
|
|
||||||
<dt><b>Note:</b> There is an implementation specific limit to the number of
|
|
||||||
thread specific storage objects that can be created, and this limit may be
|
|
||||||
small.</dt>
|
|
||||||
</dl>
|
|
||||||
<pre>
|
|
||||||
~thread_specific_ptr();
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Note:</b> Does not destroy any data that may be stored in any thread's
|
|
||||||
thread specific storage. For this reason you should not destroy a <code>thread_specific_ptr</code>
|
|
||||||
object until you are certain there are no threads running that have made use
|
|
||||||
of its thread specific storage.</dt>
|
|
||||||
</dl>
|
|
||||||
<h4><a name="class-thread_specific_ptr-modifiers"></a>Class <code>thread_specific_ptr</code>
|
|
||||||
modifier functions</h4>
|
|
||||||
<pre>
|
|
||||||
T* release();
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Postconditions:</b> <code>*this</code> holds the null pointer for the
|
|
||||||
current thread.</dt>
|
|
||||||
<dt><b>Returns:</b> <code>this->get()</code> prior to the call.</dt>
|
|
||||||
</dl>
|
|
||||||
<pre>
|
|
||||||
void reset(T* p=0);
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Effects:</b> If <code>this->get()!= p</code> then <code>delete this->get()</code>.
|
|
||||||
</dt>
|
|
||||||
<dt><b>Postconditions:</b> <code>*this</code> holds the pointer <code> p</code>
|
|
||||||
for the current thread.</dt>
|
|
||||||
<dt><b>Note:</b> The pointer will be deleted when the thread terminates.</dt>
|
|
||||||
</dl>
|
|
||||||
<h4><a name="class-thread_specific_ptr-observers"></a>Class <code>thread_specific_ptr</code>
|
|
||||||
observer functions</h4>
|
|
||||||
<pre>
|
|
||||||
T* get() const;
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Returns:</b> The object stored in thread specific storage for the current
|
|
||||||
thread for <code>*this</code>.</dt>
|
|
||||||
<dt><b>Note:</b> Each thread initially returns 0.</dt>
|
|
||||||
</dl>
|
|
||||||
<pre>
|
|
||||||
T* operator->() const;
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Returns:</b> <code>this-<get()</code>.</dt>
|
|
||||||
</dl>
|
|
||||||
<pre>
|
|
||||||
T& operator*() const;
|
|
||||||
</pre>
|
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Requires:</b> <code>this-<get() != 0</code></dt>
|
|
||||||
<dt><b>Returns:</b> <code>this-<get()</code>.</dt>
|
|
||||||
</dl>
|
|
||||||
<h2><a name="examples"></a>Example(s)</h2>
|
|
||||||
<pre>
|
|
||||||
#include <a href="../../../boost/thread/thread.hpp"><boost/thread/thread.hpp></a>
|
|
||||||
#include <a href="../../../boost/thread/tss.hpp"><boost/thread/tss.hpp></a>
|
|
||||||
#include <cassert>
|
|
||||||
|
|
||||||
boost::thread_specific_ptr<int> value;
|
|
||||||
|
|
||||||
void increment()
|
|
||||||
{
|
|
||||||
int* p = value.get();
|
|
||||||
++*p;
|
|
||||||
}
|
|
||||||
|
|
||||||
void thread_proc()
|
|
||||||
{
|
|
||||||
value.reset(new int(0)); // initialize the thread's storage
|
|
||||||
for (int i=0; i<10; ++i)
|
|
||||||
{
|
|
||||||
increment();
|
|
||||||
int* p = value.get();
|
|
||||||
assert(*p == i+1);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
int main(int argc, char* argv[])
|
|
||||||
{
|
|
||||||
boost::thread_group threads;
|
|
||||||
for (int i=0; i<5; ++i)
|
|
||||||
threads.create_thread(&thread_proc);
|
|
||||||
threads.join_all();
|
|
||||||
}
|
|
||||||
</pre>
|
|
||||||
<hr>
|
|
||||||
<p>Revised
|
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
|
||||||
05 November, 2001
|
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
|
||||||
</p>
|
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
|
||||||
All Rights Reserved.</i></p>
|
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
|
||||||
makes no representations about the suitability of this software for any purpose.
|
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
236
doc/xtime.html
236
doc/xtime.html
@@ -1,121 +1,147 @@
|
|||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
<meta http-equiv="Content-Type" content=
|
||||||
<link rel="stylesheet" type="text/css" href="../../../boost.css">
|
"text/html; charset=iso-8859-1">
|
||||||
<title>Boost.Threads - Header <boost/thread/xtime.hpp></title>
|
<meta name="keywords" content=
|
||||||
</head>
|
"threads, Boost.Threads, thread library, C++">
|
||||||
<body link="#0000ff" vlink="#800080">
|
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||||
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
|
||||||
"header">
|
<title>Boost.Threads, xtime</title>
|
||||||
<tr>
|
</head>
|
||||||
<td valign="top" width="300">
|
|
||||||
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../c++boost.gif" border="0"></a></h3>
|
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||||
</td>
|
<table summary="header" border="0" cellpadding="7" cellspacing="0"
|
||||||
<td valign="top">
|
width="100%">
|
||||||
<h1 align="center">Boost.Threads</h1>
|
<tr>
|
||||||
<h2 align="center">Header <<a href="../../../boost/thread/xtime.hpp">boost/thread/xtime.hpp</a>></h2>
|
<td valign="top" width="300">
|
||||||
</td>
|
<h3><img src="../../../c++boost.gif" alt="C++ Boost" width=
|
||||||
</tr>
|
"277" height="86"></h3>
|
||||||
</table>
|
</td>
|
||||||
<hr>
|
|
||||||
<h2>Contents</h2>
|
<td valign="top">
|
||||||
<dl class="page-index">
|
<h1 align="center">Boost.Threads</h1>
|
||||||
<dt><a href="#introduction">Introduction</a></dt>
|
|
||||||
<dt><a href="#values">Values</a></dt>
|
<h2 align="center">xtime</h2>
|
||||||
<dl class="page-index">
|
</td>
|
||||||
<dt><a href="#value-spec">TIME_UTC</a></dt>
|
</tr>
|
||||||
</dl>
|
</table>
|
||||||
<dt><a href="#classes">Classes</a></dt>
|
<hr>
|
||||||
<dl class="page-index">
|
|
||||||
<dt><a href="#class-spec">Struct <code>xtime</code></a></dt>
|
<p><a href="#Introduction">Introduction</a><br>
|
||||||
<dl class="page-index">
|
<a href="#Header">Header</a><br>
|
||||||
<dt><a href="#class-xtime-synopsis">Struct <code>xtime</code> synopsis</a></dt>
|
<a href="#Synopsis">Synopsis</a><br>
|
||||||
</dl>
|
<a href="#Reference">Reference</a><br>
|
||||||
</dl>
|
<a href="#Example">Example</a></p>
|
||||||
<dt><a href="#functions">Functions</a></dt>
|
|
||||||
<dl class="page-index">
|
<h2><a name="Introduction">Introduction</a></h2>
|
||||||
<dt><a href="#function-xtime_get"><code>xtime_get</code></a></dt>
|
|
||||||
</dl>
|
<p>The <code>xtime</code> type is used to represent a point on some
|
||||||
<dt><a href="#examples">Example(s)</a></dt>
|
time scale or a duration in time. This type may be proposed for the C
|
||||||
</dl>
|
standard by Markus Kuhn. <b>Boost.Threads</b> provides only a very
|
||||||
<hr>
|
minimal implementation of this proposal and it's expected that a
|
||||||
<h2><a name="introduction"></a>Introduction</h2>
|
full implementation will be provided in Boost as a separate library, at
|
||||||
<p>The header <<a href="../../../boost/thread/xtime.hpp">boost/thread/xtime.hpp</a>>
|
which time <b>Boost.Threads</b> will deprecate its implementation.</p>
|
||||||
defines functions and data types used to perform high-resolution time operations.
|
|
||||||
This is a temporary solution that will be replaced by a more robust time library
|
<h2><a name="Header">Header</a></h2>
|
||||||
once available in Boost.</p>
|
<pre>
|
||||||
<h2><a name="values"></a>Values</h2>
|
#include <a href=
|
||||||
<pre><a name="value-spec"></a>
|
"../../../boost/thread/xtime.hpp"><boost/thread/xtime.hpp></a>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<h2><a name="Synopsis">Synopsis</a></h2>
|
||||||
|
<pre>
|
||||||
|
namespace boost {
|
||||||
|
|
||||||
enum
|
enum
|
||||||
{
|
{
|
||||||
TIME_UTC
|
TIME_UTC=1,
|
||||||
}
|
|
||||||
</pre>
|
|
||||||
<p>The clock type for Coordinated Universal Time (UTC). The epoch for this clock
|
|
||||||
type is 1970-01-01 00:00:00. This is the only clock type supported by <b>Boost.Threads</b>.</p>
|
|
||||||
<h2><a name="classes"></a>Classes</h2>
|
|
||||||
<h3><a name="class-xtime"></a>Struct <code>xtime</code></h3>
|
|
||||||
<p>The <code>xtime</code> type is used to represent a point on some time scale
|
|
||||||
or a duration in time. This type may be proposed for the C standard by Markus
|
|
||||||
Kuhn. <b>Boost.Threads</b> provides only a very minimal implementation of this
|
|
||||||
proposal and it's expected that a full implementation (or some other time
|
|
||||||
library) will be provided in Boost as a separate library, at which time <b>Boost.Threads</b>
|
|
||||||
will deprecate its implementation.</p>
|
|
||||||
<h4><a name="class-xtime-synopsis"></a>Struct <code>xtime</code> synopsis</h4>
|
|
||||||
<pre>
|
|
||||||
namespace boost
|
|
||||||
{
|
|
||||||
struct xtime
|
|
||||||
{
|
|
||||||
#if defined(BOOST_NO_INT64_T)
|
|
||||||
int_fast32_t sec;
|
|
||||||
#else
|
|
||||||
int_fast64_t sec;
|
|
||||||
#endif
|
|
||||||
int_fast32_t nsec;
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
|
|
||||||
|
struct xtime
|
||||||
|
{
|
||||||
|
#if defined(BOOST_NO_INT64_T)
|
||||||
|
int_fast32_t sec;
|
||||||
|
#else
|
||||||
|
int_fast64_t sec;
|
||||||
|
#endif
|
||||||
|
int_fast32_t nsec;
|
||||||
|
};
|
||||||
|
|
||||||
|
int xtime_get(struct xtime* xtp, int clock_type);
|
||||||
|
|
||||||
|
} // namespace boost
|
||||||
</pre>
|
</pre>
|
||||||
<h2><a name="functions"></a>Functions</h2>
|
|
||||||
|
<h2><a name="Reference">Reference</a></h2>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>TIME_UTC</h3>
|
||||||
|
|
||||||
|
<p>The clock type for Coordinated Universal Time (UTC). The epoch for
|
||||||
|
this clock type is 1970-01-01 00:00:00. This is the only clock type
|
||||||
|
supported by <b>Boost.Threads</b>.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h3>xtime</h3>
|
||||||
<pre>
|
<pre>
|
||||||
<a name="function-xtime_get"></a>int xtime_get(struct xtime* xtp, int clock_type);
|
struct xtime
|
||||||
|
{
|
||||||
|
#if defined(BOOST_NO_INT64_T)
|
||||||
|
int_fast32_t sec;
|
||||||
|
#else
|
||||||
|
int_fast64_t sec;
|
||||||
|
#endif
|
||||||
|
int_fast32_t nsec;
|
||||||
|
};
|
||||||
</pre>
|
</pre>
|
||||||
<dl class="function-semantics">
|
|
||||||
<dt><b>Postconditions:</b> <code>xtp</code> represents the current point in
|
<p><b>sec</b> represents the whole seconds that have passed since the
|
||||||
time as a duration since the epoch specified by the <code> clock_type</code>.</dt>
|
epoch.</p>
|
||||||
<dt><b>Returns:</b> <code>clock_type</code> if successful, otherwise 0.</dt>
|
|
||||||
<dt><b>Note:</b> The resolution is implementation specific. For many implementations
|
<p><b>nsec</b> represents the nanoseconds since <code>sec.</code></p>
|
||||||
the best resolution of time is far more than one nanosecond, and even when
|
<hr>
|
||||||
the resolution is reasonably good, the latency of a call to <code>xtime_get()</code>
|
|
||||||
may be significant. For maximum portability, avoid durations of less than
|
<h3>xtime_get</h3>
|
||||||
one second.</dt>
|
|
||||||
</dl>
|
|
||||||
<h2><a name="examples"></a>Example(s)</h2>
|
|
||||||
<pre>
|
<pre>
|
||||||
#include <a href="../../../boost/thread/thread.hpp"><boost/thread/thread.hpp></a>
|
int xtime_get(struct xtime* xtp, int clock_type);
|
||||||
#include <a href="../../../boost/thread/tss.hpp"><boost/thread/xtime.hpp></a>
|
</pre>
|
||||||
|
|
||||||
|
<p><b>Postcondition:</b> <code>xtp</code> represents the current point
|
||||||
|
in time as a duration since the epoch specified by the <code>
|
||||||
|
clock_type</code>.</p>
|
||||||
|
|
||||||
|
<p><b>Returns:</b> <code>clock_type</code> if successful, otherwise
|
||||||
|
0.</p>
|
||||||
|
|
||||||
|
<p><b>Notes:</b> The resolution is implementation specific. For many
|
||||||
|
implementations the best resolution of time is far more than one
|
||||||
|
nanosecond, and even when the resolution is reasonably good, the
|
||||||
|
latency of a call to <code>xtime_get()</code> may be significant. For
|
||||||
|
maximum portability, avoid durations of less than one second.</p>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2><a name="Example">Example Usage</a></h2>
|
||||||
|
<pre>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/thread.hpp"><boost/thread/thread.hpp></a>
|
||||||
|
#include <a href=
|
||||||
|
"../../../boost/thread/tss.hpp"><boost/thread/xtime.hpp></a>
|
||||||
|
|
||||||
int main(int argc, char* argv[])
|
int main(int argc, char* argv[])
|
||||||
{
|
{
|
||||||
boost::xtime xt;
|
boost::xtime xt;
|
||||||
boost::xtime_get(&XT, boost::TIME_UTC);
|
boost::xtime_get(&xt, boost::TIME_UTC);
|
||||||
xt.sec += 1;
|
xt.sec += 1;
|
||||||
boost::thread::sleep(XT); // Sleep for 1 second
|
boost::thread::sleep(xt); // Sleep for 1 second
|
||||||
}
|
}
|
||||||
</pre>
|
</pre>
|
||||||
<hr>
|
<hr>
|
||||||
<p>Revised
|
|
||||||
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
<p>Revised
|
||||||
05 November, 2001
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->05 November, 2001<!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
|
||||||
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
|
||||||
</p>
|
<p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">
|
||||||
<p><i>© Copyright <a href="mailto:wekempf@cox.net">William E. Kempf</a> 2001-2002.
|
William E. Kempf</a> 2001 all rights reserved.</i></p>
|
||||||
All Rights Reserved.</i></p>
|
</body>
|
||||||
<p>Permission to use, copy, modify, distribute and sell this software and its
|
|
||||||
documentation for any purpose is hereby granted without fee, provided that the
|
|
||||||
above copyright notice appear in all copies and that both that copyright notice
|
|
||||||
and this permission notice appear in supporting documentation. William E. Kempf
|
|
||||||
makes no representations about the suitability of this software for any purpose.
|
|
||||||
It is provided "as is" without express or implied warranty.</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|||||||
@@ -1,2 +0,0 @@
|
|||||||
bin
|
|
||||||
*.pdb
|
|
||||||
@@ -9,60 +9,58 @@
|
|||||||
# 1. monitor, an example program.
|
# 1. monitor, an example program.
|
||||||
# 2. starvephil, an example program.
|
# 2. starvephil, an example program.
|
||||||
# 3. tennis, an example program.
|
# 3. tennis, an example program.
|
||||||
# Additional configuration variables used:
|
|
||||||
# 1. PTW32 may be used on Win32 platforms to specify that the pthreads-win32
|
|
||||||
# library should be used instead of "native" threads. This feature is
|
|
||||||
# mostly used for testing and it's generally recommended you use the
|
|
||||||
# native threading libraries instead. PTW32 should be set to be a list
|
|
||||||
# of two strings, the first specifying the installation path of the
|
|
||||||
# pthreads-win32 library and the second specifying which library
|
|
||||||
# variant to link against (see the pthreads-win32 documentation).
|
|
||||||
# Example: jam -sPTW32="c:\pthreads-win32 pthreadVCE.lib"
|
|
||||||
|
|
||||||
# Declare the location of this subproject relative to the root.
|
# declare the location of this subproject relative to the root
|
||||||
subproject libs/thread/example ;
|
subproject libs/thread/example ;
|
||||||
|
|
||||||
# Include threads.jam for Boost.Threads global build information.
|
# Do some OS-specific setup
|
||||||
# This greatly simplifies the Jam code needed to configure the build
|
if $(NT)
|
||||||
# for the various Win32 build types.
|
{
|
||||||
SEARCH on <module@>threads.jam = $(BOOST_ROOT)/libs/thread/build ;
|
BOOST_THREADMON_LIB = <lib>../build/libboost_threadmon ;
|
||||||
include <module@>threads.jam ;
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
BOOST_THREADMON_LIB = ;
|
||||||
|
}
|
||||||
|
|
||||||
#######################
|
#######################
|
||||||
# Declare the Boost.Threads example program monitor.
|
|
||||||
|
|
||||||
exe monitor
|
#
|
||||||
: monitor/monitor.cpp
|
# Declare the Boost.Threads monitor example program.
|
||||||
<lib>../build/boost_thread
|
#
|
||||||
$(threadmon)
|
|
||||||
: <sysinclude>$(BOOST_ROOT)
|
exe monitor : monitor/monitor.cpp
|
||||||
$(pthreads-win32)
|
<lib>../build/libboost_thread
|
||||||
<threading>multi
|
$(BOOST_THREADMON_LIB)
|
||||||
: debug release <runtime-link>static/dynamic
|
# requirements
|
||||||
;
|
: <include>$(BOOST_ROOT)
|
||||||
|
<threading>multi
|
||||||
|
: debug release ;
|
||||||
|
|
||||||
#######################
|
#######################
|
||||||
# Declare the Boost.Threads example program starvephil.
|
|
||||||
|
|
||||||
exe starvephil
|
#
|
||||||
: starvephil/starvephil.cpp
|
# Declare the Boost.Threads starvephil example program.
|
||||||
<lib>../build/boost_thread
|
#
|
||||||
$(threadmon)
|
|
||||||
: <sysinclude>$(BOOST_ROOT)
|
exe starvephil : starvephil/starvephil.cpp
|
||||||
$(pthreads-win32)
|
<lib>../build/libboost_thread
|
||||||
<threading>multi
|
$(BOOST_THREADMON_LIB)
|
||||||
: debug release <runtime-link>static/dynamic
|
# requirements
|
||||||
;
|
: <include>$(BOOST_ROOT)
|
||||||
|
<threading>multi
|
||||||
|
: debug release ;
|
||||||
|
|
||||||
#######################
|
#######################
|
||||||
# Declare the Boost.Threads example program tennis.
|
|
||||||
|
|
||||||
exe tennis
|
#
|
||||||
: tennis/tennis.cpp
|
# Declare the Boost.Threads tennis example program.
|
||||||
<lib>../build/boost_thread
|
#
|
||||||
$(threadmon)
|
|
||||||
: <sysinclude>$(BOOST_ROOT)
|
exe tennis : tennis/tennis.cpp
|
||||||
$(pthreads-win32)
|
<lib>../build/libboost_thread
|
||||||
<threading>multi
|
$(BOOST_THREADMON_LIB)
|
||||||
: debug release <runtime-link>static/dynamic
|
# requirements
|
||||||
;
|
: <include>$(BOOST_ROOT)
|
||||||
|
<threading>multi
|
||||||
|
: debug release ;
|
||||||
|
|||||||
@@ -1 +0,0 @@
|
|||||||
/*
|
|
||||||
@@ -8,19 +8,19 @@
|
|||||||
namespace {
|
namespace {
|
||||||
const int ITERS = 100;
|
const int ITERS = 100;
|
||||||
boost::mutex io_mutex;
|
boost::mutex io_mutex;
|
||||||
}
|
};
|
||||||
|
|
||||||
template <typename M>
|
template <typename M>
|
||||||
class buffer_t
|
class buffer_t
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
typedef typename M::scoped_lock scoped_lock;
|
typedef typename M::scoped_lock scoped_lock;
|
||||||
|
|
||||||
buffer_t(int n)
|
buffer_t(int n)
|
||||||
: p(0), c(0), full(0), buf(n)
|
: p(0), c(0), full(0), buf(n)
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|
||||||
void send(int m)
|
void send(int m)
|
||||||
{
|
{
|
||||||
scoped_lock lk(mutex);
|
scoped_lock lk(mutex);
|
||||||
@@ -29,7 +29,7 @@ public:
|
|||||||
buf[p] = m;
|
buf[p] = m;
|
||||||
p = (p+1) % buf.size();
|
p = (p+1) % buf.size();
|
||||||
++full;
|
++full;
|
||||||
cond.notify_one();
|
cond.notify_all();
|
||||||
}
|
}
|
||||||
int receive()
|
int receive()
|
||||||
{
|
{
|
||||||
@@ -39,40 +39,41 @@ public:
|
|||||||
int i = buf[c];
|
int i = buf[c];
|
||||||
c = (c+1) % buf.size();
|
c = (c+1) % buf.size();
|
||||||
--full;
|
--full;
|
||||||
cond.notify_one();
|
cond.notify_all();
|
||||||
return i;
|
return i;
|
||||||
}
|
}
|
||||||
|
|
||||||
static buffer_t& get_buffer()
|
static buffer_t& get_buffer()
|
||||||
{
|
{
|
||||||
static buffer_t buf(2);
|
static buffer_t buf(2);
|
||||||
return buf;
|
return buf;
|
||||||
}
|
}
|
||||||
|
|
||||||
static void do_sender_thread()
|
static void do_sender_thread()
|
||||||
{
|
{
|
||||||
for (int n = 0; n < ITERS; ++n)
|
for (int n = 0; n < ITERS; ++n)
|
||||||
{
|
{
|
||||||
|
get_buffer().send(n);
|
||||||
{
|
{
|
||||||
boost::mutex::scoped_lock lock(io_mutex);
|
boost::mutex::scoped_lock lock(io_mutex);
|
||||||
std::cout << "sending: " << n << std::endl;
|
std::cout << "sent: " << n << std::endl;
|
||||||
}
|
}
|
||||||
get_buffer().send(n);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
static void do_receiver_thread()
|
static void do_receiver_thread()
|
||||||
{
|
{
|
||||||
for (int x=0; x < (ITERS/2); ++x)
|
int n;
|
||||||
|
do
|
||||||
{
|
{
|
||||||
int n = get_buffer().receive();
|
n = get_buffer().receive();
|
||||||
{
|
{
|
||||||
boost::mutex::scoped_lock lock(io_mutex);
|
boost::mutex::scoped_lock lock(io_mutex);
|
||||||
std::cout << "received: " << n << std::endl;
|
std::cout << "received: " << n << std::endl;
|
||||||
}
|
}
|
||||||
}
|
} while (n < ITERS - 1);
|
||||||
}
|
}
|
||||||
|
|
||||||
private:
|
private:
|
||||||
M mutex;
|
M mutex;
|
||||||
boost::condition cond;
|
boost::condition cond;
|
||||||
@@ -85,12 +86,10 @@ void do_test(M* dummy=0)
|
|||||||
{
|
{
|
||||||
typedef buffer_t<M> buffer_type;
|
typedef buffer_t<M> buffer_type;
|
||||||
buffer_type::get_buffer();
|
buffer_type::get_buffer();
|
||||||
boost::thread thrd1(&buffer_type::do_receiver_thread);
|
boost::thread thrd1(&buffer_type::do_sender_thread);
|
||||||
boost::thread thrd2(&buffer_type::do_receiver_thread);
|
boost::thread thrd2(&buffer_type::do_receiver_thread);
|
||||||
boost::thread thrd3(&buffer_type::do_sender_thread);
|
|
||||||
thrd1.join();
|
thrd1.join();
|
||||||
thrd2.join();
|
thrd2.join();
|
||||||
thrd3.join();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void test_buffer()
|
void test_buffer()
|
||||||
|
|||||||
Binary file not shown.
@@ -1 +0,0 @@
|
|||||||
/*
|
|
||||||
@@ -7,124 +7,124 @@
|
|||||||
|
|
||||||
namespace
|
namespace
|
||||||
{
|
{
|
||||||
boost::mutex iomx;
|
boost::mutex iomx;
|
||||||
}
|
};
|
||||||
|
|
||||||
class canteen
|
class canteen
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
canteen() : m_chickens(0) { }
|
canteen() : m_chickens(0) { }
|
||||||
|
|
||||||
void get(int id)
|
void get(int id)
|
||||||
{
|
{
|
||||||
boost::mutex::scoped_lock lock(m_mutex);
|
boost::mutex::scoped_lock lock(m_mutex);
|
||||||
while (m_chickens == 0)
|
while (m_chickens == 0)
|
||||||
{
|
{
|
||||||
{
|
{
|
||||||
boost::mutex::scoped_lock lock(iomx);
|
boost::mutex::scoped_lock lock(iomx);
|
||||||
std::cout << "(" << clock() << ") Phil" << id <<
|
std::cout << "(" << clock() << ") Phil" << id <<
|
||||||
": wot, no chickens? I'll WAIT ..." << std::endl;
|
": wot, no chickens? I'll WAIT ..." << std::endl;
|
||||||
}
|
}
|
||||||
m_condition.wait(lock);
|
m_condition.wait(lock);
|
||||||
}
|
}
|
||||||
{
|
{
|
||||||
boost::mutex::scoped_lock lock(iomx);
|
boost::mutex::scoped_lock lock(iomx);
|
||||||
std::cout << "(" << clock() << ") Phil" << id <<
|
std::cout << "(" << clock() << ") Phil" << id <<
|
||||||
": those chickens look good ... one please ..." << std::endl;
|
": those chickens look good ... one please ..." << std::endl;
|
||||||
}
|
}
|
||||||
m_chickens--;
|
m_chickens--;
|
||||||
}
|
}
|
||||||
void put(int value)
|
void put(int value)
|
||||||
{
|
{
|
||||||
boost::mutex::scoped_lock lock(m_mutex);
|
boost::mutex::scoped_lock lock(m_mutex);
|
||||||
{
|
{
|
||||||
boost::mutex::scoped_lock lock(iomx);
|
boost::mutex::scoped_lock lock(iomx);
|
||||||
std::cout << "(" << clock() <<
|
std::cout << "(" << clock() <<
|
||||||
") Chef: ouch ... make room ... this dish is very hot ..." << std::endl;
|
") Chef: ouch ... make room ... this dish is very hot ..." << std::endl;
|
||||||
}
|
}
|
||||||
boost::xtime xt;
|
boost::xtime xt;
|
||||||
boost::xtime_get(&xt, boost::TIME_UTC);
|
boost::xtime_get(&xt, boost::TIME_UTC);
|
||||||
xt.sec += 3;
|
xt.sec += 3;
|
||||||
boost::thread::sleep(xt);
|
boost::thread::sleep(xt);
|
||||||
m_chickens += value;
|
m_chickens += value;
|
||||||
{
|
{
|
||||||
boost::mutex::scoped_lock lock(iomx);
|
boost::mutex::scoped_lock lock(iomx);
|
||||||
std::cout << "(" << clock() <<
|
std::cout << "(" << clock() <<
|
||||||
") Chef: more chickens ... " << m_chickens <<
|
") Chef: more chickens ... " << m_chickens <<
|
||||||
" now available ... NOTIFYING ..." << std::endl;
|
" now available ... NOTIFYING ..." << std::endl;
|
||||||
}
|
}
|
||||||
m_condition.notify_all();
|
m_condition.notify_all();
|
||||||
}
|
}
|
||||||
|
|
||||||
private:
|
private:
|
||||||
boost::mutex m_mutex;
|
boost::mutex m_mutex;
|
||||||
boost::condition m_condition;
|
boost::condition m_condition;
|
||||||
int m_chickens;
|
int m_chickens;
|
||||||
};
|
};
|
||||||
|
|
||||||
canteen g_canteen;
|
canteen g_canteen;
|
||||||
|
|
||||||
void chef()
|
void chef()
|
||||||
{
|
{
|
||||||
const int chickens = 4;
|
const int chickens = 4;
|
||||||
{
|
{
|
||||||
boost::mutex::scoped_lock lock(iomx);
|
boost::mutex::scoped_lock lock(iomx);
|
||||||
std::cout << "(" << clock() << ") Chef: starting ..." << std::endl;
|
std::cout << "(" << clock() << ") Chef: starting ..." << std::endl;
|
||||||
}
|
}
|
||||||
for (;;)
|
for (;;)
|
||||||
{
|
{
|
||||||
{
|
{
|
||||||
boost::mutex::scoped_lock lock(iomx);
|
boost::mutex::scoped_lock lock(iomx);
|
||||||
std::cout << "(" << clock() << ") Chef: cooking ..." << std::endl;
|
std::cout << "(" << clock() << ") Chef: cooking ..." << std::endl;
|
||||||
}
|
}
|
||||||
boost::xtime xt;
|
boost::xtime xt;
|
||||||
boost::xtime_get(&xt, boost::TIME_UTC);
|
boost::xtime_get(&xt, boost::TIME_UTC);
|
||||||
xt.sec += 2;
|
xt.sec += 2;
|
||||||
boost::thread::sleep(xt);
|
boost::thread::sleep(xt);
|
||||||
{
|
{
|
||||||
boost::mutex::scoped_lock lock(iomx);
|
boost::mutex::scoped_lock lock(iomx);
|
||||||
std::cout << "(" << clock() << ") Chef: " << chickens
|
std::cout << "(" << clock() << ") Chef: " << chickens
|
||||||
<< " chickens, ready-to-go ..." << std::endl;
|
<< " chickens, ready-to-go ..." << std::endl;
|
||||||
}
|
}
|
||||||
g_canteen.put(chickens);
|
g_canteen.put(chickens);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
struct phil
|
struct phil
|
||||||
{
|
{
|
||||||
phil(int id) : m_id(id) { }
|
phil(int id) : m_id(id) { }
|
||||||
void run() {
|
void run() {
|
||||||
{
|
{
|
||||||
boost::mutex::scoped_lock lock(iomx);
|
boost::mutex::scoped_lock lock(iomx);
|
||||||
std::cout << "(" << clock() << ") Phil" << m_id << ": starting ..." << std::endl;
|
std::cout << "(" << clock() << ") Phil" << m_id << ": starting ..." << std::endl;
|
||||||
}
|
}
|
||||||
for (;;)
|
for (;;)
|
||||||
{
|
{
|
||||||
if (m_id > 0)
|
if (m_id > 0)
|
||||||
{
|
{
|
||||||
boost::xtime xt;
|
boost::xtime xt;
|
||||||
boost::xtime_get(&xt, boost::TIME_UTC);
|
boost::xtime_get(&xt, boost::TIME_UTC);
|
||||||
xt.sec += 3;
|
xt.sec += 3;
|
||||||
boost::thread::sleep(xt);
|
boost::thread::sleep(xt);
|
||||||
}
|
}
|
||||||
{
|
{
|
||||||
boost::mutex::scoped_lock lock(iomx);
|
boost::mutex::scoped_lock lock(iomx);
|
||||||
std::cout << "(" << clock() << ") Phil" << m_id
|
std::cout << "(" << clock() << ") Phil" << m_id
|
||||||
<< ": gotta eat ..." << std::endl;
|
<< ": gotta eat ..." << std::endl;
|
||||||
}
|
}
|
||||||
g_canteen.get(m_id);
|
g_canteen.get(m_id);
|
||||||
{
|
{
|
||||||
boost::mutex::scoped_lock lock(iomx);
|
boost::mutex::scoped_lock lock(iomx);
|
||||||
std::cout << "(" << clock() << ") Phil" << m_id
|
std::cout << "(" << clock() << ") Phil" << m_id
|
||||||
<< ": mmm ... that's good ..." << std::endl;
|
<< ": mmm ... that's good ..." << std::endl;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
static void do_thread(void* param) {
|
static void do_thread(void* param) {
|
||||||
static_cast<phil*>(param)->run();
|
static_cast<phil*>(param)->run();
|
||||||
}
|
}
|
||||||
|
|
||||||
int m_id;
|
int m_id;
|
||||||
};
|
};
|
||||||
|
|
||||||
struct thread_adapt
|
struct thread_adapt
|
||||||
|
|||||||
Binary file not shown.
@@ -1 +0,0 @@
|
|||||||
/*
|
|
||||||
@@ -5,8 +5,8 @@
|
|||||||
#include <iostream>
|
#include <iostream>
|
||||||
|
|
||||||
#if defined(BOOST_HAS_WINTHREADS)
|
#if defined(BOOST_HAS_WINTHREADS)
|
||||||
# include <windows.h>
|
# include <windows.h>
|
||||||
# include <process.h>
|
# include <process.h>
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
enum game_state
|
enum game_state
|
||||||
|
|||||||
Binary file not shown.
@@ -23,8 +23,6 @@
|
|||||||
|
|
||||||
#if defined(BOOST_HAS_PTHREADS)
|
#if defined(BOOST_HAS_PTHREADS)
|
||||||
# include <pthread.h>
|
# include <pthread.h>
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
# include "scoped_critical_region.hpp"
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
namespace boost {
|
namespace boost {
|
||||||
@@ -87,17 +85,17 @@ private:
|
|||||||
template <typename M>
|
template <typename M>
|
||||||
void do_wait(M& mutex)
|
void do_wait(M& mutex)
|
||||||
{
|
{
|
||||||
#if (defined(BOOST_HAS_WINTHREADS) || defined(BOOST_HAS_MPTASKS))
|
#if defined(BOOST_HAS_WINTHREADS)
|
||||||
enter_wait();
|
enter_wait();
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
typedef typename detail::thread::lock_ops<M> lock_ops;
|
typedef typename detail::thread::lock_ops<M> lock_ops;
|
||||||
typename lock_ops::lock_state state;
|
lock_ops::lock_state state;
|
||||||
lock_ops::unlock(mutex, state);
|
lock_ops::unlock(mutex, state);
|
||||||
|
|
||||||
#if defined(BOOST_HAS_PTHREADS)
|
#if defined(BOOST_HAS_PTHREADS)
|
||||||
do_wait(state.pmutex);
|
do_wait(state.pmutex);
|
||||||
#elif (defined(BOOST_HAS_WINTHREADS) || defined(BOOST_HAS_MPTASKS))
|
#elif defined(BOOST_HAS_WINTHREADS)
|
||||||
do_wait();
|
do_wait();
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
@@ -107,19 +105,19 @@ private:
|
|||||||
template <typename M>
|
template <typename M>
|
||||||
bool do_timed_wait(M& mutex, const xtime& xt)
|
bool do_timed_wait(M& mutex, const xtime& xt)
|
||||||
{
|
{
|
||||||
#if (defined(BOOST_HAS_WINTHREADS) || defined(BOOST_HAS_MPTASKS))
|
#if defined(BOOST_HAS_WINTHREADS)
|
||||||
enter_wait();
|
enter_wait();
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
typedef typename detail::thread::lock_ops<M> lock_ops;
|
typedef typename detail::thread::lock_ops<M> lock_ops;
|
||||||
typename lock_ops::lock_state state;
|
lock_ops::lock_state state;
|
||||||
lock_ops::unlock(mutex, state);
|
lock_ops::unlock(mutex, state);
|
||||||
|
|
||||||
bool ret = false;
|
bool ret = false;
|
||||||
|
|
||||||
#if defined(BOOST_HAS_PTHREADS)
|
#if defined(BOOST_HAS_PTHREADS)
|
||||||
ret = do_timed_wait(xt, state.pmutex);
|
ret = do_timed_wait(xt, state.pmutex);
|
||||||
#elif (defined(BOOST_HAS_WINTHREADS) || defined(BOOST_HAS_MPTASKS))
|
#elif defined(BOOST_HAS_WINTHREADS)
|
||||||
ret = do_timed_wait(xt);
|
ret = do_timed_wait(xt);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
@@ -128,7 +126,7 @@ private:
|
|||||||
return ret;
|
return ret;
|
||||||
}
|
}
|
||||||
|
|
||||||
#if (defined(BOOST_HAS_WINTHREADS) || defined(BOOST_HAS_MPTASKS))
|
#if defined(BOOST_HAS_WINTHREADS)
|
||||||
void enter_wait();
|
void enter_wait();
|
||||||
void do_wait();
|
void do_wait();
|
||||||
bool do_timed_wait(const xtime& xt);
|
bool do_timed_wait(const xtime& xt);
|
||||||
@@ -147,15 +145,6 @@ private:
|
|||||||
// m_waiting to be removed from the m_queue
|
// m_waiting to be removed from the m_queue
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
pthread_cond_t m_condition;
|
pthread_cond_t m_condition;
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
MPSemaphoreID m_gate;
|
|
||||||
MPSemaphoreID m_queue;
|
|
||||||
threads::mac::detail::scoped_critical_region m_mutex;
|
|
||||||
threads::mac::detail::scoped_critical_region m_mutex_mutex;
|
|
||||||
unsigned m_gone; // # threads that timed out and never made it to the m_queue
|
|
||||||
unsigned long m_blocked; // # threads m_blocked m_waiting for the condition
|
|
||||||
unsigned m_waiting; // # threads m_waiting no longer m_waiting for the condition but still
|
|
||||||
// m_waiting to be removed from the m_queue
|
|
||||||
#endif
|
#endif
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
100
include/boost/thread/config.hpp
Normal file
100
include/boost/thread/config.hpp
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
// Copyright (C) 2001
|
||||||
|
// William E. Kempf
|
||||||
|
//
|
||||||
|
// Permission to use, copy, modify, distribute and sell this software
|
||||||
|
// and its documentation for any purpose is hereby granted without fee,
|
||||||
|
// provided that the above copyright notice appear in all copies and
|
||||||
|
// that both that copyright notice and this permission notice appear
|
||||||
|
// in supporting documentation. William E. Kempf makes no representations
|
||||||
|
// about the suitability of this software for any purpose.
|
||||||
|
// It is provided "as is" without express or implied warranty.
|
||||||
|
|
||||||
|
// This file is used to configure Boost.Threads during development
|
||||||
|
// in order to decouple dependency on any Boost release. Once
|
||||||
|
// accepted into Boost these contents will be moved to <boost/config>
|
||||||
|
// or some other appropriate build configuration and all
|
||||||
|
// #include <boost/thread/config.hpp> statements will be changed
|
||||||
|
// accordingly.
|
||||||
|
|
||||||
|
#ifndef BOOST_THREAD_CONFIG_WEK070601_HPP
|
||||||
|
#define BOOST_THREAD_CONFIG_WEK070601_HPP
|
||||||
|
|
||||||
|
#include <boost/config.hpp>
|
||||||
|
|
||||||
|
#error "Included <boost/thread/config.hpp>"
|
||||||
|
|
||||||
|
/*// Define if threading support is enabled for the toolset.
|
||||||
|
#undef BOOST_HAS_THREADS
|
||||||
|
|
||||||
|
// Define if threading should be implemented in terms of Win32 threads.
|
||||||
|
#undef BOOST_HAS_WINTHREADS
|
||||||
|
|
||||||
|
// Define if threading should be implemented in terms of POSIX threads.
|
||||||
|
#undef BOOST_HAS_PTHREADS
|
||||||
|
|
||||||
|
// Define if BOOST_HAS_PTHREADS and pthread_delay_np() exists.
|
||||||
|
#undef BOOST_HAS_PTHREAD_DELAY_NP
|
||||||
|
|
||||||
|
// Define if BOOST_HAS_PTHREADS and not BOOST_HAS_PTHREAD_DELAY_NP
|
||||||
|
// but nanosleep can be used instead.
|
||||||
|
#undef BOOST_HAS_NANOSLEEP
|
||||||
|
|
||||||
|
// Define if BOOST_HAS_PTHREADS and pthread_yield() exists.
|
||||||
|
#undef BOOST_HAS_PTHREAD_YIELD
|
||||||
|
|
||||||
|
// Define if BOOST_HAS_PTHREADS and not BOOST_HAS_PTHREAD_YIELD and
|
||||||
|
// sched_yield() exists.
|
||||||
|
#undef BOOST_HAS_SCHED_YIELD
|
||||||
|
|
||||||
|
// Define if gettimeofday() exists.
|
||||||
|
#undef BOOST_HAS_GETTIMEOFDAY
|
||||||
|
|
||||||
|
// Define if not BOOST_HAS_GETTIMEOFDAY and clock_gettime() exists.
|
||||||
|
#undef BOOST_HAS_CLOCK_GETTIME
|
||||||
|
|
||||||
|
// Define if not BOOST_HAS_GETTIMEOFDAY and not BOOST_HAS_CLOCK_GETTIME and
|
||||||
|
// GetSystemTimeAsFileTime() can be called with an FTIME structure.
|
||||||
|
#undef BOOST_HAS_FTIME
|
||||||
|
|
||||||
|
// Define if pthread_mutexattr_settype and pthread_mutexattr_gettype exist.
|
||||||
|
#undef BOOST_HAS_PTHREAD_MUTEXATTR_SETTYPE
|
||||||
|
|
||||||
|
// Here we'll set up known compiler options.
|
||||||
|
|
||||||
|
#if defined(BOOST_MSVC)
|
||||||
|
# if defined(_MT)
|
||||||
|
# define BOOST_HAS_THREADS
|
||||||
|
# endif
|
||||||
|
# define BOOST_HAS_WINTHREADS // comment out this to test pthreads-win32.
|
||||||
|
# if !defined(BOOST_HAS_WINTHREADS)
|
||||||
|
# define BOOST_HAS_PTHREADS
|
||||||
|
# define BOOST_HAS_PTHREAD_MUTEXATTR_SETTYPE
|
||||||
|
# define PtW32NoCatchWarn
|
||||||
|
# pragma comment(lib, "pthreadVCE.lib")
|
||||||
|
# endif
|
||||||
|
# define BOOST_HAS_FTIME
|
||||||
|
// pdm: this is for linux - is there a better #define to #if on?
|
||||||
|
// wek: not sure how else to do this, but GNU CC on Win32 should probably
|
||||||
|
// use BOOST_HAS_WINTHREADS, and I expect there will be other
|
||||||
|
// platform specific variations for this compiler toolset. Need
|
||||||
|
// to decide how to handle this.
|
||||||
|
#elif defined( __GNUC__ )
|
||||||
|
# define BOOST_HAS_THREADS
|
||||||
|
# define BOOST_HAS_PTHREADS
|
||||||
|
# define BOOST_HAS_NANOSLEEP
|
||||||
|
# define BOOST_HAS_GETTIMEOFDAY
|
||||||
|
// pdm: From the pthread.h header, one of these macros
|
||||||
|
// must be defined for this stuff to exist.
|
||||||
|
// wek: This seems like a harmless enough method to determine these
|
||||||
|
// switches, but one should note that some implementations may not
|
||||||
|
// use these. Notably, pthreads-win32 doesn't define either
|
||||||
|
// __USE_UNIX98 or __USE_GNU.
|
||||||
|
# if defined( __USE_UNIX98 )
|
||||||
|
# define BOOST_HAS_PTHREAD_MUTEXATTR_SETTYPE
|
||||||
|
# elif defined( __USE_GNU )
|
||||||
|
# define BOOST_HAS_PTHREAD_MUTEXATTR_SETTYPE
|
||||||
|
# define BOOST_HAS_PTHREAD_YIELD
|
||||||
|
# endif
|
||||||
|
#endif*/
|
||||||
|
|
||||||
|
#endif // BOOST_THREAD_CONFIG_WEK070601_HPP
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_FORCE_CAST_MJM012402_HPP
|
|
||||||
#define BOOST_FORCE_CAST_MJM012402_HPP
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
namespace thread {
|
|
||||||
|
|
||||||
|
|
||||||
// force_cast will convert anything to anything.
|
|
||||||
|
|
||||||
// general case
|
|
||||||
template<class Return_Type, class Argument_Type>
|
|
||||||
inline Return_Type &force_cast(Argument_Type &rSrc)
|
|
||||||
{ return(*reinterpret_cast<Return_Type *>(&rSrc)); }
|
|
||||||
|
|
||||||
// specialization for const
|
|
||||||
template<class Return_Type, class Argument_Type>
|
|
||||||
inline const Return_Type &force_cast(const Argument_Type &rSrc)
|
|
||||||
{ return(*reinterpret_cast<const Return_Type *>(&rSrc)); }
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace thread
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BOOST_FORCE_CAST_MJM012402_HPP
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_SINGLETON_MJM012402_HPP
|
|
||||||
#define BOOST_SINGLETON_MJM012402_HPP
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
namespace thread {
|
|
||||||
|
|
||||||
// class singleton has the same goal as all singletons: create one instance of a
|
|
||||||
// class on demand, then dish it out as requested.
|
|
||||||
|
|
||||||
template<class T>
|
|
||||||
class singleton: private T
|
|
||||||
{
|
|
||||||
private:
|
|
||||||
singleton();
|
|
||||||
~singleton();
|
|
||||||
|
|
||||||
public:
|
|
||||||
static T &instance();
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
template<class T>
|
|
||||||
inline singleton<T>::singleton()
|
|
||||||
{ /* no-op */ }
|
|
||||||
|
|
||||||
template<class T>
|
|
||||||
inline singleton<T>::~singleton()
|
|
||||||
{ /* no-op */ }
|
|
||||||
|
|
||||||
|
|
||||||
template<class T>
|
|
||||||
/*static*/ T &singleton<T>::instance()
|
|
||||||
{
|
|
||||||
// function-local static to force this to work correctly at static initialization
|
|
||||||
// time.
|
|
||||||
static singleton<T> s_oT;
|
|
||||||
return(s_oT);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace thread
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BOOST_SINGLETON_MJM012402_HPP
|
|
||||||
@@ -22,7 +22,7 @@
|
|||||||
|
|
||||||
namespace boost {
|
namespace boost {
|
||||||
|
|
||||||
class lock_error : public std::logic_error
|
class lock_error : public std::runtime_error
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
lock_error();
|
lock_error();
|
||||||
|
|||||||
@@ -24,10 +24,6 @@
|
|||||||
# include <pthread.h>
|
# include <pthread.h>
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#if defined(BOOST_HAS_MPTASKS)
|
|
||||||
# include "scoped_critical_region.hpp"
|
|
||||||
#endif
|
|
||||||
|
|
||||||
namespace boost {
|
namespace boost {
|
||||||
|
|
||||||
struct xtime;
|
struct xtime;
|
||||||
@@ -50,10 +46,6 @@ private:
|
|||||||
{
|
{
|
||||||
pthread_mutex_t* pmutex;
|
pthread_mutex_t* pmutex;
|
||||||
};
|
};
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
struct cv_state
|
|
||||||
{
|
|
||||||
};
|
|
||||||
#endif
|
#endif
|
||||||
void do_lock();
|
void do_lock();
|
||||||
void do_unlock();
|
void do_unlock();
|
||||||
@@ -64,9 +56,6 @@ private:
|
|||||||
void* m_mutex;
|
void* m_mutex;
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
pthread_mutex_t m_mutex;
|
pthread_mutex_t m_mutex;
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
threads::mac::detail::scoped_critical_region m_mutex;
|
|
||||||
threads::mac::detail::scoped_critical_region m_mutex_mutex;
|
|
||||||
#endif
|
#endif
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -89,10 +78,6 @@ private:
|
|||||||
{
|
{
|
||||||
pthread_mutex_t* pmutex;
|
pthread_mutex_t* pmutex;
|
||||||
};
|
};
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
struct cv_state
|
|
||||||
{
|
|
||||||
};
|
|
||||||
#endif
|
#endif
|
||||||
void do_lock();
|
void do_lock();
|
||||||
bool do_trylock();
|
bool do_trylock();
|
||||||
@@ -104,9 +89,6 @@ private:
|
|||||||
void* m_mutex;
|
void* m_mutex;
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
pthread_mutex_t m_mutex;
|
pthread_mutex_t m_mutex;
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
threads::mac::detail::scoped_critical_region m_mutex;
|
|
||||||
threads::mac::detail::scoped_critical_region m_mutex_mutex;
|
|
||||||
#endif
|
#endif
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -130,10 +112,6 @@ private:
|
|||||||
{
|
{
|
||||||
pthread_mutex_t* pmutex;
|
pthread_mutex_t* pmutex;
|
||||||
};
|
};
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
struct cv_state
|
|
||||||
{
|
|
||||||
};
|
|
||||||
#endif
|
#endif
|
||||||
void do_lock();
|
void do_lock();
|
||||||
bool do_trylock();
|
bool do_trylock();
|
||||||
@@ -148,9 +126,6 @@ private:
|
|||||||
pthread_mutex_t m_mutex;
|
pthread_mutex_t m_mutex;
|
||||||
pthread_cond_t m_condition;
|
pthread_cond_t m_condition;
|
||||||
bool m_locked;
|
bool m_locked;
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
threads::mac::detail::scoped_critical_region m_mutex;
|
|
||||||
threads::mac::detail::scoped_critical_region m_mutex_mutex;
|
|
||||||
#endif
|
#endif
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ namespace boost {
|
|||||||
typedef pthread_once_t once_flag;
|
typedef pthread_once_t once_flag;
|
||||||
#define BOOST_ONCE_INIT PTHREAD_ONCE_INIT
|
#define BOOST_ONCE_INIT PTHREAD_ONCE_INIT
|
||||||
|
|
||||||
#elif (defined(BOOST_HAS_WINTHREADS) || defined(BOOST_HAS_MPTASKS))
|
#elif defined(BOOST_HAS_WINTHREADS)
|
||||||
|
|
||||||
typedef bool once_flag;
|
typedef bool once_flag;
|
||||||
#define BOOST_ONCE_INIT false
|
#define BOOST_ONCE_INIT false
|
||||||
|
|||||||
@@ -22,8 +22,6 @@
|
|||||||
|
|
||||||
#if defined(BOOST_HAS_PTHREADS)
|
#if defined(BOOST_HAS_PTHREADS)
|
||||||
# include <pthread.h>
|
# include <pthread.h>
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
# include "scoped_critical_region.hpp"
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
namespace boost {
|
namespace boost {
|
||||||
@@ -41,7 +39,7 @@ public:
|
|||||||
~recursive_mutex();
|
~recursive_mutex();
|
||||||
|
|
||||||
private:
|
private:
|
||||||
#if (defined(BOOST_HAS_WINTHREADS) || defined(BOOST_HAS_MPTASKS))
|
#if defined(BOOST_HAS_WINTHREADS)
|
||||||
typedef std::size_t cv_state;
|
typedef std::size_t cv_state;
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
struct cv_state
|
struct cv_state
|
||||||
@@ -66,10 +64,6 @@ private:
|
|||||||
pthread_t m_thread_id;
|
pthread_t m_thread_id;
|
||||||
bool m_valid_id;
|
bool m_valid_id;
|
||||||
# endif
|
# endif
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
threads::mac::detail::scoped_critical_region m_mutex;
|
|
||||||
threads::mac::detail::scoped_critical_region m_mutex_mutex;
|
|
||||||
std::size_t m_count;
|
|
||||||
#endif
|
#endif
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -85,7 +79,7 @@ public:
|
|||||||
~recursive_try_mutex();
|
~recursive_try_mutex();
|
||||||
|
|
||||||
private:
|
private:
|
||||||
#if (defined(BOOST_HAS_WINTHREADS) || defined(BOOST_HAS_MPTASKS))
|
#if defined(BOOST_HAS_WINTHREADS)
|
||||||
typedef std::size_t cv_state;
|
typedef std::size_t cv_state;
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
struct cv_state
|
struct cv_state
|
||||||
@@ -111,10 +105,6 @@ private:
|
|||||||
pthread_t m_thread_id;
|
pthread_t m_thread_id;
|
||||||
bool m_valid_id;
|
bool m_valid_id;
|
||||||
# endif
|
# endif
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
threads::mac::detail::scoped_critical_region m_mutex;
|
|
||||||
threads::mac::detail::scoped_critical_region m_mutex_mutex;
|
|
||||||
std::size_t m_count;
|
|
||||||
#endif
|
#endif
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -131,7 +121,7 @@ public:
|
|||||||
~recursive_timed_mutex();
|
~recursive_timed_mutex();
|
||||||
|
|
||||||
private:
|
private:
|
||||||
#if (defined(BOOST_HAS_WINTHREADS) || defined(BOOST_HAS_MPTASKS))
|
#if defined(BOOST_HAS_WINTHREADS)
|
||||||
typedef std::size_t cv_state;
|
typedef std::size_t cv_state;
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
struct cv_state
|
struct cv_state
|
||||||
@@ -156,10 +146,6 @@ private:
|
|||||||
pthread_t m_thread_id;
|
pthread_t m_thread_id;
|
||||||
bool m_valid_id;
|
bool m_valid_id;
|
||||||
unsigned m_count;
|
unsigned m_count;
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
threads::mac::detail::scoped_critical_region m_mutex;
|
|
||||||
threads::mac::detail::scoped_critical_region m_mutex_mutex;
|
|
||||||
std::size_t m_count;
|
|
||||||
#endif
|
#endif
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -26,8 +26,6 @@
|
|||||||
#if defined(BOOST_HAS_PTHREADS)
|
#if defined(BOOST_HAS_PTHREADS)
|
||||||
# include <pthread.h>
|
# include <pthread.h>
|
||||||
# include <boost/thread/condition.hpp>
|
# include <boost/thread/condition.hpp>
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
# include <Multiprocessing.h>
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
namespace boost {
|
namespace boost {
|
||||||
@@ -56,9 +54,6 @@ private:
|
|||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
private:
|
private:
|
||||||
pthread_t m_thread;
|
pthread_t m_thread;
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
MPQueueID m_pJoinQueueID;
|
|
||||||
MPTaskID m_pTaskID;
|
|
||||||
#endif
|
#endif
|
||||||
bool m_joinable;
|
bool m_joinable;
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -21,8 +21,6 @@
|
|||||||
|
|
||||||
#if defined(BOOST_HAS_PTHREADS)
|
#if defined(BOOST_HAS_PTHREADS)
|
||||||
# include <pthread.h>
|
# include <pthread.h>
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
# include <Multiprocessing.h>
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
namespace boost {
|
namespace boost {
|
||||||
@@ -43,15 +41,8 @@ namespace boost {
|
|||||||
void (*m_cleanup)(void*);
|
void (*m_cleanup)(void*);
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
pthread_key_t m_key;
|
pthread_key_t m_key;
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
TaskStorageIndex m_key;
|
|
||||||
void (*m_cleanup)(void*);
|
|
||||||
#endif
|
#endif
|
||||||
};
|
};
|
||||||
|
|
||||||
#if defined(BOOST_HAS_MPTASKS)
|
|
||||||
void thread_cleanup();
|
|
||||||
#endif
|
|
||||||
}
|
}
|
||||||
|
|
||||||
template <typename T>
|
template <typename T>
|
||||||
|
|||||||
@@ -40,13 +40,6 @@ struct xtime
|
|||||||
};
|
};
|
||||||
|
|
||||||
int xtime_get(struct xtime* xtp, int clock_type);
|
int xtime_get(struct xtime* xtp, int clock_type);
|
||||||
inline int xtime_cmp(const xtime& xt1, const xtime& xt2)
|
|
||||||
{
|
|
||||||
int res = (int)(xt1.sec - xt2.sec);
|
|
||||||
if (res == 0)
|
|
||||||
res = (int)(xt1.nsec - xt2.nsec);
|
|
||||||
return res;
|
|
||||||
}
|
|
||||||
|
|
||||||
} // namespace boost
|
} // namespace boost
|
||||||
|
|
||||||
|
|||||||
@@ -18,16 +18,10 @@
|
|||||||
#include "timeconv.inl"
|
#include "timeconv.inl"
|
||||||
|
|
||||||
#if defined(BOOST_HAS_WINTHREADS)
|
#if defined(BOOST_HAS_WINTHREADS)
|
||||||
# ifndef NOMINMAX
|
# define NOMINMAX
|
||||||
# define NOMINMAX
|
|
||||||
# endif
|
|
||||||
# include <windows.h>
|
# include <windows.h>
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
# include <errno.h>
|
# include <errno.h>
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
# include <MacErrors.h>
|
|
||||||
# include "mac/init.hpp"
|
|
||||||
# include "mac/safe.hpp"
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
namespace boost {
|
namespace boost {
|
||||||
@@ -93,7 +87,6 @@ void condition::notify_one()
|
|||||||
|
|
||||||
++m_waiting;
|
++m_waiting;
|
||||||
--m_blocked;
|
--m_blocked;
|
||||||
signals = 1;
|
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
@@ -114,15 +107,15 @@ void condition::notify_one()
|
|||||||
res = ReleaseSemaphore(reinterpret_cast<HANDLE>(m_gate), 1, 0);
|
res = ReleaseSemaphore(reinterpret_cast<HANDLE>(m_gate), 1, 0);
|
||||||
assert(res);
|
assert(res);
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
res = ReleaseMutex(reinterpret_cast<HANDLE>(m_mutex));
|
res = ReleaseMutex(reinterpret_cast<HANDLE>(m_mutex));
|
||||||
assert(res);
|
|
||||||
|
|
||||||
if (signals)
|
|
||||||
{
|
|
||||||
res = ReleaseSemaphore(reinterpret_cast<HANDLE>(m_queue), signals, 0);
|
|
||||||
assert(res);
|
assert(res);
|
||||||
|
|
||||||
|
if (signals)
|
||||||
|
{
|
||||||
|
res = ReleaseSemaphore(reinterpret_cast<HANDLE>(m_queue), signals, 0);
|
||||||
|
assert(res);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -244,7 +237,7 @@ void condition::do_wait()
|
|||||||
|
|
||||||
bool condition::do_timed_wait(const xtime& xt)
|
bool condition::do_timed_wait(const xtime& xt)
|
||||||
{
|
{
|
||||||
int milliseconds;
|
unsigned milliseconds;
|
||||||
to_duration(xt, milliseconds);
|
to_duration(xt, milliseconds);
|
||||||
|
|
||||||
unsigned int res = 0;
|
unsigned int res = 0;
|
||||||
@@ -358,285 +351,6 @@ bool condition::do_timed_wait(const xtime& xt, pthread_mutex_t* pmutex)
|
|||||||
|
|
||||||
return res != ETIMEDOUT;
|
return res != ETIMEDOUT;
|
||||||
}
|
}
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
|
|
||||||
using threads::mac::detail::safe_enter_critical_region;
|
|
||||||
using threads::mac::detail::safe_wait_on_semaphore;
|
|
||||||
|
|
||||||
condition::condition()
|
|
||||||
: m_gone(0), m_blocked(0), m_waiting(0)
|
|
||||||
{
|
|
||||||
threads::mac::detail::thread_init();
|
|
||||||
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
|
|
||||||
lStatus = MPCreateSemaphore(1, 1, &m_gate);
|
|
||||||
if(lStatus == noErr)
|
|
||||||
lStatus = MPCreateSemaphore(ULONG_MAX, 0, &m_queue);
|
|
||||||
|
|
||||||
if(lStatus != noErr || !m_gate || !m_queue)
|
|
||||||
{
|
|
||||||
if (m_gate)
|
|
||||||
{
|
|
||||||
lStatus = MPDeleteSemaphore(m_gate);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
if (m_queue)
|
|
||||||
{
|
|
||||||
lStatus = MPDeleteSemaphore(m_queue);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
throw thread_resource_error();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
condition::~condition()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPDeleteSemaphore(m_gate);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
lStatus = MPDeleteSemaphore(m_queue);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
void condition::notify_one()
|
|
||||||
{
|
|
||||||
unsigned signals = 0;
|
|
||||||
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, kDurationForever, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
|
|
||||||
if (m_waiting != 0) // the m_gate is already closed
|
|
||||||
{
|
|
||||||
if (m_blocked == 0)
|
|
||||||
{
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
++m_waiting;
|
|
||||||
--m_blocked;
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
lStatus = safe_wait_on_semaphore(m_gate, kDurationForever);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
if (m_blocked > m_gone)
|
|
||||||
{
|
|
||||||
if (m_gone != 0)
|
|
||||||
{
|
|
||||||
m_blocked -= m_gone;
|
|
||||||
m_gone = 0;
|
|
||||||
}
|
|
||||||
signals = m_waiting = 1;
|
|
||||||
--m_blocked;
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
lStatus = MPSignalSemaphore(m_gate);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
|
|
||||||
while (signals)
|
|
||||||
{
|
|
||||||
lStatus = MPSignalSemaphore(m_queue);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
--signals;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void condition::notify_all()
|
|
||||||
{
|
|
||||||
unsigned signals = 0;
|
|
||||||
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, kDurationForever, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
|
|
||||||
if (m_waiting != 0) // the m_gate is already closed
|
|
||||||
{
|
|
||||||
if (m_blocked == 0)
|
|
||||||
{
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
m_waiting += (signals = m_blocked);
|
|
||||||
m_blocked = 0;
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
lStatus = safe_wait_on_semaphore(m_gate, kDurationForever);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
if (m_blocked > m_gone)
|
|
||||||
{
|
|
||||||
if (m_gone != 0)
|
|
||||||
{
|
|
||||||
m_blocked -= m_gone;
|
|
||||||
m_gone = 0;
|
|
||||||
}
|
|
||||||
signals = m_waiting = m_blocked;
|
|
||||||
m_blocked = 0;
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
lStatus = MPSignalSemaphore(m_gate);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
|
|
||||||
while (signals)
|
|
||||||
{
|
|
||||||
lStatus = MPSignalSemaphore(m_queue);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
--signals;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void condition::enter_wait()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_wait_on_semaphore(m_gate, kDurationForever);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
++m_blocked;
|
|
||||||
lStatus = MPSignalSemaphore(m_gate);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
void condition::do_wait()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_wait_on_semaphore(m_queue, kDurationForever);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
|
|
||||||
unsigned was_waiting=0;
|
|
||||||
unsigned was_gone=0;
|
|
||||||
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, kDurationForever, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
was_waiting = m_waiting;
|
|
||||||
was_gone = m_gone;
|
|
||||||
if (was_waiting != 0)
|
|
||||||
{
|
|
||||||
if (--m_waiting == 0)
|
|
||||||
{
|
|
||||||
if (m_blocked != 0)
|
|
||||||
{
|
|
||||||
lStatus = MPSignalSemaphore(m_gate); // open m_gate
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
was_waiting = 0;
|
|
||||||
}
|
|
||||||
else if (m_gone != 0)
|
|
||||||
m_gone = 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else if (++m_gone == (std::numeric_limits<unsigned>::max() / 2))
|
|
||||||
{
|
|
||||||
// timeout occured, normalize the m_gone count
|
|
||||||
// this may occur if many calls to wait with a timeout are made and
|
|
||||||
// no call to notify_* is made
|
|
||||||
lStatus = safe_wait_on_semaphore(m_gate, kDurationForever);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
m_blocked -= m_gone;
|
|
||||||
lStatus = MPSignalSemaphore(m_gate);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
m_gone = 0;
|
|
||||||
}
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
|
|
||||||
if (was_waiting == 1)
|
|
||||||
{
|
|
||||||
for (/**/ ; was_gone; --was_gone)
|
|
||||||
{
|
|
||||||
// better now than spurious later
|
|
||||||
lStatus = safe_wait_on_semaphore(m_queue, kDurationForever);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
lStatus = MPSignalSemaphore(m_gate);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
bool condition::do_timed_wait(const xtime& xt)
|
|
||||||
{
|
|
||||||
int milliseconds;
|
|
||||||
to_duration(xt, milliseconds);
|
|
||||||
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_wait_on_semaphore(m_queue, milliseconds);
|
|
||||||
assert(lStatus == noErr || lStatus == kMPTimeoutErr);
|
|
||||||
|
|
||||||
bool ret = (lStatus == noErr);
|
|
||||||
|
|
||||||
unsigned was_waiting=0;
|
|
||||||
unsigned was_gone=0;
|
|
||||||
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, kDurationForever, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
was_waiting = m_waiting;
|
|
||||||
was_gone = m_gone;
|
|
||||||
if (was_waiting != 0)
|
|
||||||
{
|
|
||||||
if (!ret) // timeout
|
|
||||||
{
|
|
||||||
if (m_blocked != 0)
|
|
||||||
--m_blocked;
|
|
||||||
else
|
|
||||||
++m_gone; // count spurious wakeups
|
|
||||||
}
|
|
||||||
if (--m_waiting == 0)
|
|
||||||
{
|
|
||||||
if (m_blocked != 0)
|
|
||||||
{
|
|
||||||
lStatus = MPSignalSemaphore(m_gate); // open m_gate
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
was_waiting = 0;
|
|
||||||
}
|
|
||||||
else if (m_gone != 0)
|
|
||||||
m_gone = 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else if (++m_gone == (std::numeric_limits<unsigned>::max() / 2))
|
|
||||||
{
|
|
||||||
// timeout occured, normalize the m_gone count
|
|
||||||
// this may occur if many calls to wait with a timeout are made and
|
|
||||||
// no call to notify_* is made
|
|
||||||
lStatus = safe_wait_on_semaphore(m_gate, kDurationForever);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
m_blocked -= m_gone;
|
|
||||||
lStatus = MPSignalSemaphore(m_gate);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
m_gone = 0;
|
|
||||||
}
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
|
|
||||||
if (was_waiting == 1)
|
|
||||||
{
|
|
||||||
for (/**/ ; was_gone; --was_gone)
|
|
||||||
{
|
|
||||||
// better now than spurious later
|
|
||||||
lStatus = safe_wait_on_semaphore(m_queue, kDurationForever);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
lStatus = MPSignalSemaphore(m_gate);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
return ret;
|
|
||||||
}
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
} // namespace boost
|
} // namespace boost
|
||||||
|
|||||||
@@ -14,7 +14,7 @@
|
|||||||
|
|
||||||
namespace boost {
|
namespace boost {
|
||||||
|
|
||||||
lock_error::lock_error() : std::logic_error("thread lock error")
|
lock_error::lock_error() : std::runtime_error("thread lock error")
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,14 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#define TARGET_CARBON 1
|
|
||||||
@@ -1,72 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#include "delivery_man.hpp"
|
|
||||||
|
|
||||||
#include "os.hpp"
|
|
||||||
#include "execution_context.hpp"
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
delivery_man::delivery_man():
|
|
||||||
m_pPackage(NULL),
|
|
||||||
m_pSemaphore(kInvalidID),
|
|
||||||
m_bPackageWaiting(false)
|
|
||||||
{
|
|
||||||
assert(at_st());
|
|
||||||
|
|
||||||
OSStatus lStatus = MPCreateSemaphore(1UL, 0UL, &m_pSemaphore);
|
|
||||||
// TODO - throw on error here
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
delivery_man::~delivery_man()
|
|
||||||
{
|
|
||||||
assert(m_bPackageWaiting == false);
|
|
||||||
|
|
||||||
OSStatus lStatus = MPDeleteSemaphore(m_pSemaphore);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
void delivery_man::accept_deliveries()
|
|
||||||
{
|
|
||||||
if(m_bPackageWaiting)
|
|
||||||
{
|
|
||||||
assert(m_pPackage != NULL);
|
|
||||||
m_pPackage->accept();
|
|
||||||
m_pPackage = NULL;
|
|
||||||
m_bPackageWaiting = false;
|
|
||||||
|
|
||||||
// signal to the thread making the call that we're done
|
|
||||||
OSStatus lStatus = MPSignalSemaphore(m_pSemaphore);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
@@ -1,90 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_DELIVERY_MAN_MJM012402_HPP
|
|
||||||
#define BOOST_DELIVERY_MAN_MJM012402_HPP
|
|
||||||
|
|
||||||
|
|
||||||
#include <boost/function.hpp>
|
|
||||||
#include <boost/utility.hpp>
|
|
||||||
|
|
||||||
#include <boost/thread/mutex.hpp>
|
|
||||||
|
|
||||||
#include "package.hpp"
|
|
||||||
|
|
||||||
#include <Multiprocessing.h>
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
// class delivery_man is intended to move boost::function objects from MP tasks to
|
|
||||||
// other execution contexts (such as deferred task time or system task time).
|
|
||||||
|
|
||||||
class delivery_man: private noncopyable
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
delivery_man();
|
|
||||||
~delivery_man();
|
|
||||||
|
|
||||||
public:
|
|
||||||
template<class R>
|
|
||||||
R deliver(function<R> &rFunctor);
|
|
||||||
|
|
||||||
void accept_deliveries();
|
|
||||||
|
|
||||||
private:
|
|
||||||
base_package *m_pPackage;
|
|
||||||
mutex m_oMutex;
|
|
||||||
MPSemaphoreID m_pSemaphore;
|
|
||||||
bool m_bPackageWaiting;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
template<class R>
|
|
||||||
R delivery_man::deliver(function<R> &rFunctor)
|
|
||||||
{
|
|
||||||
assert(at_mp());
|
|
||||||
|
|
||||||
// lock our mutex
|
|
||||||
mutex::scoped_lock oLock(m_oMutex);
|
|
||||||
|
|
||||||
// create a package and save it
|
|
||||||
package<R> oPackage(rFunctor);
|
|
||||||
m_pPackage = &oPackage;
|
|
||||||
m_bPackageWaiting = true;
|
|
||||||
|
|
||||||
// wait on the semaphore
|
|
||||||
OSStatus lStatus = MPWaitOnSemaphore(m_pSemaphore, kDurationForever);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
|
|
||||||
return(oPackage.return_value());
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BOOST_DELIVERY_MAN_MJM012402_HPP
|
|
||||||
@@ -1,99 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#include "dt_scheduler.hpp"
|
|
||||||
|
|
||||||
#include "ot_context.hpp"
|
|
||||||
|
|
||||||
|
|
||||||
#include <boost/thread/detail/singleton.hpp>
|
|
||||||
|
|
||||||
#include <OpenTransportProtocol.h>
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
const OTTimeout k_ulTimerTaskDelay = 1UL;
|
|
||||||
|
|
||||||
|
|
||||||
dt_scheduler::dt_scheduler():
|
|
||||||
m_bReschedule(false),
|
|
||||||
m_uppTask(NULL),
|
|
||||||
m_lTask(0UL)
|
|
||||||
{
|
|
||||||
using ::boost::detail::thread::singleton;
|
|
||||||
|
|
||||||
ot_context &rContext(singleton<ot_context>::instance());
|
|
||||||
|
|
||||||
m_uppTask = NewOTProcessUPP(task_entry);
|
|
||||||
m_lTask = OTCreateTimerTaskInContext(m_uppTask, this, rContext.get_context());
|
|
||||||
}
|
|
||||||
|
|
||||||
dt_scheduler::~dt_scheduler()
|
|
||||||
{
|
|
||||||
OTDestroyTimerTask(m_lTask);
|
|
||||||
m_lTask = 0UL;
|
|
||||||
DisposeOTProcessUPP(m_uppTask);
|
|
||||||
m_uppTask = NULL;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
void dt_scheduler::start_polling()
|
|
||||||
{
|
|
||||||
m_bReschedule = true;
|
|
||||||
schedule_task();
|
|
||||||
}
|
|
||||||
|
|
||||||
void dt_scheduler::stop_polling()
|
|
||||||
{
|
|
||||||
m_bReschedule = false;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
void dt_scheduler::schedule_task()
|
|
||||||
{
|
|
||||||
if(m_bReschedule)
|
|
||||||
{
|
|
||||||
OTScheduleTimerTask(m_lTask, k_ulTimerTaskDelay);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/*static*/ pascal void dt_scheduler::task_entry(void *pRefCon)
|
|
||||||
{
|
|
||||||
dt_scheduler *pThis = reinterpret_cast<dt_scheduler *>(pRefCon);
|
|
||||||
assert(pThis != NULL);
|
|
||||||
pThis->task();
|
|
||||||
}
|
|
||||||
|
|
||||||
void dt_scheduler::task()
|
|
||||||
{
|
|
||||||
periodic_function();
|
|
||||||
schedule_task();
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_DT_SCHEDULER_MJM012402_HPP
|
|
||||||
#define BOOST_DT_SCHEDULER_MJM012402_HPP
|
|
||||||
|
|
||||||
|
|
||||||
#include "periodical.hpp"
|
|
||||||
|
|
||||||
#include <OpenTransport.h>
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
// class dt_scheduler calls its pure-virtual periodic_function method periodically at
|
|
||||||
// deferred task time. This is generally 1kHz under Mac OS 9.
|
|
||||||
|
|
||||||
class dt_scheduler
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
dt_scheduler();
|
|
||||||
virtual ~dt_scheduler();
|
|
||||||
|
|
||||||
protected:
|
|
||||||
void start_polling();
|
|
||||||
void stop_polling();
|
|
||||||
|
|
||||||
private:
|
|
||||||
virtual void periodic_function() = 0;
|
|
||||||
|
|
||||||
private:
|
|
||||||
void schedule_task();
|
|
||||||
static pascal void task_entry(void *pRefCon);
|
|
||||||
void task();
|
|
||||||
|
|
||||||
private:
|
|
||||||
bool m_bReschedule;
|
|
||||||
OTProcessUPP m_uppTask;
|
|
||||||
long m_lTask;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BOOST_DT_SCHEDULER_MJM012402_HPP
|
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#include <Debugging.h>
|
|
||||||
#include <Multiprocessing.h>
|
|
||||||
|
|
||||||
#include "execution_context.hpp"
|
|
||||||
#include "init.hpp"
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
|
|
||||||
execution_context_t execution_context()
|
|
||||||
{
|
|
||||||
// make sure that MP services are available the first time through
|
|
||||||
static bool bIgnored = detail::thread_init();
|
|
||||||
|
|
||||||
// first check if we're an MP task
|
|
||||||
if(MPTaskIsPreemptive(kInvalidID))
|
|
||||||
{
|
|
||||||
return(k_eExecutionContextMPTask);
|
|
||||||
}
|
|
||||||
|
|
||||||
#if TARGET_CARBON
|
|
||||||
// Carbon has TaskLevel
|
|
||||||
UInt32 ulLevel = TaskLevel();
|
|
||||||
|
|
||||||
if(ulLevel == 0UL)
|
|
||||||
{
|
|
||||||
return(k_eExecutionContextSystemTask);
|
|
||||||
}
|
|
||||||
|
|
||||||
if(ulLevel & kInDeferredTaskMask)
|
|
||||||
{
|
|
||||||
return(k_eExecutionContextDeferredTask);
|
|
||||||
}
|
|
||||||
|
|
||||||
return(k_eExecutionContextOther);
|
|
||||||
#else
|
|
||||||
// this can be implemented using TaskLevel if you don't mind linking against
|
|
||||||
// DebugLib (and therefore breaking Mac OS 8.6 support), or CurrentExecutionLevel.
|
|
||||||
# error execution_context unimplimented
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_EXECUTION_CONTEXT_MJM012402_HPP
|
|
||||||
#define BOOST_EXECUTION_CONTEXT_MJM012402_HPP
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
|
|
||||||
// utility functions for figuring out what context your code is executing in.
|
|
||||||
// Bear in mind that at_mp and in_blue are the only functions guarenteed by
|
|
||||||
// Apple to work. There is simply no way of being sure that you will not get
|
|
||||||
// false readings about task level at interrupt time in blue.
|
|
||||||
|
|
||||||
typedef enum {
|
|
||||||
k_eExecutionContextSystemTask,
|
|
||||||
k_eExecutionContextDeferredTask,
|
|
||||||
k_eExecutionContextMPTask,
|
|
||||||
k_eExecutionContextOther
|
|
||||||
} execution_context_t;
|
|
||||||
|
|
||||||
execution_context_t execution_context();
|
|
||||||
|
|
||||||
inline bool at_st()
|
|
||||||
{ return(execution_context() == k_eExecutionContextSystemTask); }
|
|
||||||
|
|
||||||
inline bool at_mp()
|
|
||||||
{ return(execution_context() == k_eExecutionContextMPTask); }
|
|
||||||
inline bool in_blue()
|
|
||||||
{ return(!at_mp()); }
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
#endif // BOOST_EXECUTION_CONTEXT_MJM012402_HPP
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#include "init.hpp"
|
|
||||||
|
|
||||||
#include "remote_call_manager.hpp"
|
|
||||||
|
|
||||||
|
|
||||||
#include <boost/thread/detail/singleton.hpp>
|
|
||||||
|
|
||||||
#include <Multiprocessing.h>
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
namespace {
|
|
||||||
|
|
||||||
// force these to get called by the end of static initialization time.
|
|
||||||
static bool g_bInitialized = (thread_init() && create_singletons());
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
bool thread_init()
|
|
||||||
{
|
|
||||||
static bool bResult = MPLibraryIsLoaded();
|
|
||||||
|
|
||||||
return(bResult);
|
|
||||||
}
|
|
||||||
|
|
||||||
bool create_singletons()
|
|
||||||
{
|
|
||||||
using ::boost::detail::thread::singleton;
|
|
||||||
|
|
||||||
singleton<remote_call_manager>::instance();
|
|
||||||
|
|
||||||
return(true);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_INIT_MJM012402_HPP
|
|
||||||
#define BOOST_INIT_MJM012402_HPP
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
bool thread_init();
|
|
||||||
bool create_singletons();
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BOOST_INIT_MJM012402_HPP
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#include <cassert>
|
|
||||||
#include <cstdio>
|
|
||||||
|
|
||||||
#include <MacTypes.h>
|
|
||||||
|
|
||||||
#include "remote_calls.hpp"
|
|
||||||
|
|
||||||
// this function will be called when an assertion fails. We redirect the assertion
|
|
||||||
// to DebugStr (MacsBug under Mac OS 1.x-9.x, Console under Mac OS X).
|
|
||||||
void __assertion_failed(char const *pszAssertion, char const *pszFile, int nLine)
|
|
||||||
{
|
|
||||||
using std::snprintf;
|
|
||||||
unsigned char strlDebug[sizeof(Str255) + 1];
|
|
||||||
char *pszDebug = reinterpret_cast<char *>(&strlDebug[1]);
|
|
||||||
strlDebug[0] = snprintf(pszDebug, sizeof(Str255), "assertion failed: \"%s\", %s, line %d", pszAssertion, pszFile, nLine);
|
|
||||||
boost::threads::mac::dt_remote_call(DebugStr, static_cast<ConstStringPtr>(strlDebug));
|
|
||||||
}
|
|
||||||
@@ -1,134 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
//
|
|
||||||
// includes
|
|
||||||
//
|
|
||||||
|
|
||||||
#include <abort_exit.h>
|
|
||||||
#include <console.h>
|
|
||||||
#include <console_io.h>
|
|
||||||
#include <misc_io.h>
|
|
||||||
#include <SIOUX.h>
|
|
||||||
|
|
||||||
#include "remote_calls.hpp"
|
|
||||||
|
|
||||||
|
|
||||||
//
|
|
||||||
// using declarations
|
|
||||||
//
|
|
||||||
|
|
||||||
using std::__file_handle;
|
|
||||||
using std::__idle_proc;
|
|
||||||
using std::__io_error;
|
|
||||||
using std::__no_io_error;
|
|
||||||
using std::size_t;
|
|
||||||
|
|
||||||
using boost::threads::mac::st_remote_call;
|
|
||||||
|
|
||||||
|
|
||||||
//
|
|
||||||
// prototypes
|
|
||||||
//
|
|
||||||
|
|
||||||
static bool check_console();
|
|
||||||
static int do_read_console(__file_handle ulHandle, unsigned char *pBuffer, size_t *pCount, __idle_proc pfnIdleProc);
|
|
||||||
static int do_write_console(__file_handle ulHandle, unsigned char *pBuffer, size_t *pCount, __idle_proc pfnIdleProc);
|
|
||||||
|
|
||||||
|
|
||||||
//
|
|
||||||
// MSL function replacements
|
|
||||||
//
|
|
||||||
|
|
||||||
// these two functions are called by cin and cout, respectively, as well as by (all?)
|
|
||||||
// other functions in MSL that do console I/O. All that they do is as the remote
|
|
||||||
// call manager to ensure that their guts are called at system task time.
|
|
||||||
int __read_console(__file_handle handle, unsigned char * buffer, size_t * count, __idle_proc idle_proc)
|
|
||||||
{
|
|
||||||
return(st_remote_call(do_read_console, handle, buffer, count, idle_proc));
|
|
||||||
}
|
|
||||||
|
|
||||||
int __write_console(__file_handle handle, unsigned char * buffer, size_t * count, __idle_proc idle_proc)
|
|
||||||
{
|
|
||||||
return(st_remote_call(do_write_console, handle, buffer, count, idle_proc));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
//
|
|
||||||
// implementations
|
|
||||||
//
|
|
||||||
|
|
||||||
static bool check_console()
|
|
||||||
{
|
|
||||||
static bool s_bHaveConsole(false);
|
|
||||||
static bool s_bWontHaveConsole(false);
|
|
||||||
|
|
||||||
if(s_bHaveConsole)
|
|
||||||
{
|
|
||||||
return(true);
|
|
||||||
}
|
|
||||||
|
|
||||||
if(s_bWontHaveConsole == false)
|
|
||||||
{
|
|
||||||
__stdio_atexit();
|
|
||||||
|
|
||||||
if(InstallConsole(0) != 0)
|
|
||||||
{
|
|
||||||
s_bWontHaveConsole = true;
|
|
||||||
return(false);
|
|
||||||
}
|
|
||||||
__console_exit = RemoveConsole;
|
|
||||||
s_bHaveConsole = true;
|
|
||||||
return(true);
|
|
||||||
}
|
|
||||||
|
|
||||||
return(false);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
int do_read_console(__file_handle /*ulHandle*/, unsigned char *pBuffer, size_t *pCount, __idle_proc /*pfnIdleProc*/)
|
|
||||||
{
|
|
||||||
assert(pCount != NULL);
|
|
||||||
assert(pBuffer != NULL || *pCount == 0UL);
|
|
||||||
|
|
||||||
if(check_console() == false)
|
|
||||||
{
|
|
||||||
return(__io_error);
|
|
||||||
}
|
|
||||||
std::fflush(stdout);
|
|
||||||
long lCount = ReadCharsFromConsole(reinterpret_cast<char *>(pBuffer), static_cast<long>(*pCount));
|
|
||||||
*pCount = static_cast<size_t>(lCount);
|
|
||||||
if(lCount == -1L)
|
|
||||||
{
|
|
||||||
return(__io_error);
|
|
||||||
}
|
|
||||||
|
|
||||||
return(__no_io_error);
|
|
||||||
}
|
|
||||||
|
|
||||||
int do_write_console(__file_handle /*ulHandle*/, unsigned char *pBuffer, size_t *pCount, __idle_proc /*pfnIdleProc*/)
|
|
||||||
{
|
|
||||||
if(check_console() == false)
|
|
||||||
{
|
|
||||||
return(__io_error);
|
|
||||||
}
|
|
||||||
|
|
||||||
long lCount = WriteCharsToConsole(reinterpret_cast<char *>(pBuffer), static_cast<long>(*pCount));
|
|
||||||
*pCount = static_cast<size_t>(lCount);
|
|
||||||
if(lCount == -1L)
|
|
||||||
{
|
|
||||||
return(__io_error);
|
|
||||||
}
|
|
||||||
|
|
||||||
return(__no_io_error);
|
|
||||||
}
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
//
|
|
||||||
// includes
|
|
||||||
//
|
|
||||||
|
|
||||||
#include <cstdlib>
|
|
||||||
|
|
||||||
#include <Multiprocessing.h>
|
|
||||||
|
|
||||||
|
|
||||||
//
|
|
||||||
// using declarations
|
|
||||||
//
|
|
||||||
|
|
||||||
using std::size_t;
|
|
||||||
|
|
||||||
|
|
||||||
extern "C" {
|
|
||||||
|
|
||||||
//
|
|
||||||
// prototypes
|
|
||||||
//
|
|
||||||
|
|
||||||
void *malloc(size_t ulSize);
|
|
||||||
void free(void *pBlock);
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
//
|
|
||||||
// MSL function replacements
|
|
||||||
//
|
|
||||||
|
|
||||||
// all allocation/deallocation currently goes through MPAllocateAligned/MPFree. This
|
|
||||||
// solution is sub-optimal at best, but will have to do for now.
|
|
||||||
void *malloc(size_t ulSize)
|
|
||||||
{
|
|
||||||
static bool bIgnored = MPLibraryIsLoaded();
|
|
||||||
return(MPAllocateAligned(ulSize, kMPAllocateDefaultAligned, 0UL));
|
|
||||||
}
|
|
||||||
|
|
||||||
void free(void *pBlock)
|
|
||||||
{
|
|
||||||
if(pBlock == NULL) return;
|
|
||||||
MPFree(pBlock);
|
|
||||||
}
|
|
||||||
@@ -1,105 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
//
|
|
||||||
// includes
|
|
||||||
//
|
|
||||||
|
|
||||||
#include <new>
|
|
||||||
|
|
||||||
#include <Multiprocessing.h>
|
|
||||||
|
|
||||||
|
|
||||||
//
|
|
||||||
// using declarations
|
|
||||||
//
|
|
||||||
|
|
||||||
using std::size_t;
|
|
||||||
using std::bad_alloc;
|
|
||||||
using std::nothrow_t;
|
|
||||||
using std::nothrow;
|
|
||||||
|
|
||||||
|
|
||||||
//
|
|
||||||
// local utility functions
|
|
||||||
//
|
|
||||||
|
|
||||||
// all allocation/deallocation currently goes through MPAllocateAligned/MPFree. This
|
|
||||||
// solution is sub-optimal at best, but will have to do for now.
|
|
||||||
inline static void *allocate(size_t ulSize, const nothrow_t &)
|
|
||||||
{
|
|
||||||
static bool bIgnored = MPLibraryIsLoaded();
|
|
||||||
return(MPAllocateAligned(ulSize, kMPAllocateDefaultAligned, 0UL));
|
|
||||||
}
|
|
||||||
|
|
||||||
inline static void *allocate(size_t ulSize)
|
|
||||||
{
|
|
||||||
void *pBlock = allocate(ulSize, nothrow);
|
|
||||||
if(pBlock == NULL)
|
|
||||||
throw(bad_alloc());
|
|
||||||
return(pBlock);
|
|
||||||
}
|
|
||||||
|
|
||||||
inline static void deallocate(void *pBlock)
|
|
||||||
{
|
|
||||||
if(pBlock == NULL) return;
|
|
||||||
MPFree(pBlock);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
//
|
|
||||||
// global operators
|
|
||||||
//
|
|
||||||
|
|
||||||
void *operator new(size_t ulSize)
|
|
||||||
{
|
|
||||||
return(allocate(ulSize));
|
|
||||||
}
|
|
||||||
|
|
||||||
void *operator new[](size_t ulSize)
|
|
||||||
{
|
|
||||||
return(allocate(ulSize));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
void *operator new(size_t ulSize, const nothrow_t &rNoThrow)
|
|
||||||
{
|
|
||||||
return(allocate(ulSize, rNoThrow));
|
|
||||||
}
|
|
||||||
|
|
||||||
void *operator new[](size_t ulSize, const nothrow_t &rNoThrow)
|
|
||||||
{
|
|
||||||
return(allocate(ulSize, rNoThrow));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
void operator delete(void *pBlock)
|
|
||||||
{
|
|
||||||
deallocate(pBlock);
|
|
||||||
}
|
|
||||||
|
|
||||||
void operator delete[](void *pBlock)
|
|
||||||
{
|
|
||||||
deallocate(pBlock);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
void operator delete(void *pBlock, const nothrow_t &)
|
|
||||||
{
|
|
||||||
deallocate(pBlock);
|
|
||||||
}
|
|
||||||
|
|
||||||
void operator delete[](void *pBlock, const nothrow_t &)
|
|
||||||
{
|
|
||||||
deallocate(pBlock);
|
|
||||||
}
|
|
||||||
@@ -1,156 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#include <cassert>
|
|
||||||
// we include timesize.mac.h to get whether or not __TIMESIZE_DOUBLE__ is
|
|
||||||
// defined. This is not safe, given that __TIMESIZE_DOUBLE__ affects MSL
|
|
||||||
// at MSL's compile time, not ours, so be forgiving if you have changed it
|
|
||||||
// since you have built MSL.
|
|
||||||
#include <timesize.mac.h>
|
|
||||||
#include <time.h>
|
|
||||||
|
|
||||||
#include <boost/thread/detail/force_cast.hpp>
|
|
||||||
#include <boost/thread/xtime.hpp>
|
|
||||||
|
|
||||||
#include "execution_context.hpp"
|
|
||||||
|
|
||||||
#include <DriverServices.h>
|
|
||||||
|
|
||||||
|
|
||||||
extern "C"
|
|
||||||
{
|
|
||||||
clock_t __get_clock();
|
|
||||||
time_t __get_time();
|
|
||||||
int __to_gm_time(time_t *pTime);
|
|
||||||
int __is_dst();
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
static inline uint64_t get_nanoseconds()
|
|
||||||
{
|
|
||||||
using boost::detail::thread::force_cast;
|
|
||||||
return(force_cast<uint64_t>(AbsoluteToNanoseconds(UpTime())));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
#ifdef __TIMESIZE_DOUBLE__
|
|
||||||
|
|
||||||
// return number of microseconds since startup as a double
|
|
||||||
clock_t __get_clock()
|
|
||||||
{
|
|
||||||
static const double k_dNanosecondsPerMicrosecond(1000.0);
|
|
||||||
|
|
||||||
return(get_nanoseconds() / k_dNanosecondsPerMicrosecond);
|
|
||||||
}
|
|
||||||
|
|
||||||
#else
|
|
||||||
|
|
||||||
// return number of ticks (60th of a second) since startup as a long
|
|
||||||
clock_t __get_clock()
|
|
||||||
{
|
|
||||||
static const uint64_t k_ullTicksPerSecond(60ULL);
|
|
||||||
static const uint64_t k_ullNanosecondsPerSecond(1000ULL * 1000ULL * 1000ULL);
|
|
||||||
static const uint64_t k_ullNanosecondsPerTick(k_ullNanosecondsPerSecond / k_ullTicksPerSecond);
|
|
||||||
|
|
||||||
return(get_nanoseconds() / k_ullNanosecondsPerTick);
|
|
||||||
}
|
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
||||||
// return number of seconds elapsed since Jan 1, 1970
|
|
||||||
time_t __get_time()
|
|
||||||
{
|
|
||||||
boost::xtime sTime;
|
|
||||||
int nType = boost::xtime_get(&sTime, boost::TIME_UTC);
|
|
||||||
assert(nType == boost::TIME_UTC);
|
|
||||||
return(static_cast<time_t>(sTime.sec));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
static inline MachineLocation &read_location()
|
|
||||||
{
|
|
||||||
static MachineLocation s_sLocation;
|
|
||||||
assert(boost::threads::mac::at_st());
|
|
||||||
ReadLocation(&s_sLocation);
|
|
||||||
return(s_sLocation);
|
|
||||||
}
|
|
||||||
|
|
||||||
static inline MachineLocation &get_location()
|
|
||||||
{
|
|
||||||
static MachineLocation &s_rLocation(read_location());
|
|
||||||
return(s_rLocation);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// force the machine location to be cached at static initlialization
|
|
||||||
static MachineLocation &g_rIgnored(get_location());
|
|
||||||
|
|
||||||
static inline long calculate_delta()
|
|
||||||
{
|
|
||||||
MachineLocation &rLocation(get_location());
|
|
||||||
|
|
||||||
// gmtDelta is a 24-bit, signed integer. We need to strip out the lower 24 bits,
|
|
||||||
// then sign-extend what we have.
|
|
||||||
long lDelta = rLocation.u.gmtDelta & 0x00ffffffL;
|
|
||||||
if((lDelta & 0x00800000L) != 0L)
|
|
||||||
{
|
|
||||||
lDelta |= 0xFF000000;
|
|
||||||
}
|
|
||||||
return(lDelta);
|
|
||||||
}
|
|
||||||
|
|
||||||
static inline bool check_if_location_is_broken()
|
|
||||||
{
|
|
||||||
MachineLocation &rLocation(get_location());
|
|
||||||
if(rLocation.latitude == 0 && rLocation.longitude == 0 && rLocation.u.gmtDelta == 0)
|
|
||||||
return(true);
|
|
||||||
return(false);
|
|
||||||
}
|
|
||||||
|
|
||||||
static inline bool location_is_broken()
|
|
||||||
{
|
|
||||||
static bool s_bLocationIsBroken(check_if_location_is_broken());
|
|
||||||
return(s_bLocationIsBroken);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// translate time to GMT
|
|
||||||
int __to_gm_time(time_t *pTime)
|
|
||||||
{
|
|
||||||
if(location_is_broken())
|
|
||||||
{
|
|
||||||
return(0);
|
|
||||||
}
|
|
||||||
|
|
||||||
static long s_lDelta(calculate_delta());
|
|
||||||
*pTime -= s_lDelta;
|
|
||||||
return(1);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
static inline bool is_daylight_savings_time()
|
|
||||||
{
|
|
||||||
MachineLocation &rLocation(get_location());
|
|
||||||
return(rLocation.u.dlsDelta != 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
// check if we're in daylight savings time
|
|
||||||
int __is_dst()
|
|
||||||
{
|
|
||||||
if(location_is_broken())
|
|
||||||
{
|
|
||||||
return(-1);
|
|
||||||
}
|
|
||||||
static bool bIsDaylightSavingsTime(is_daylight_savings_time());
|
|
||||||
return(static_cast<int>(bIsDaylightSavingsTime));
|
|
||||||
}
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#include "os.hpp"
|
|
||||||
|
|
||||||
|
|
||||||
#include <cassert>
|
|
||||||
|
|
||||||
#include <Gestalt.h>
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace os {
|
|
||||||
|
|
||||||
|
|
||||||
// read the OS version from Gestalt
|
|
||||||
static inline long get_version()
|
|
||||||
{
|
|
||||||
long lVersion;
|
|
||||||
OSErr nErr = Gestalt(gestaltSystemVersion, &lVersion);
|
|
||||||
assert(nErr == noErr);
|
|
||||||
return(lVersion);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// check if we're running under Mac OS X and cache that information
|
|
||||||
bool x()
|
|
||||||
{
|
|
||||||
static bool bX = (version() >= 0x1000);
|
|
||||||
return(bX);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// read the OS version and cache it
|
|
||||||
long version()
|
|
||||||
{
|
|
||||||
static long lVersion = get_version();
|
|
||||||
return(lVersion);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace os
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_OS_MJM012402_HPP
|
|
||||||
#define BOOST_OS_MJM012402_HPP
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace os {
|
|
||||||
|
|
||||||
|
|
||||||
// functions to determine the OS environment. With namespaces, you get a cute call:
|
|
||||||
// mac::os::x
|
|
||||||
|
|
||||||
bool x();
|
|
||||||
long version();
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace os
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BOOST_OS_MJM012402_HPP
|
|
||||||
@@ -1,52 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#include "ot_context.hpp"
|
|
||||||
|
|
||||||
#include "execution_context.hpp"
|
|
||||||
|
|
||||||
|
|
||||||
#include <cassert>
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
ot_context::ot_context()
|
|
||||||
{
|
|
||||||
assert(at_st());
|
|
||||||
|
|
||||||
OSStatus lStatus = InitOpenTransportInContext(0UL, &m_pContext);
|
|
||||||
// TODO - throw on error
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
ot_context::~ot_context()
|
|
||||||
{
|
|
||||||
CloseOpenTransportInContext(m_pContext);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_OT_CONTEXT_MJM012402_HPP
|
|
||||||
#define BOOST_OT_CONTEXT_MJM012402_HPP
|
|
||||||
|
|
||||||
|
|
||||||
#include <OpenTransport.h>
|
|
||||||
|
|
||||||
#include <boost/utility.hpp>
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
// class ot_context is intended to be used only as a singleton. All that this class
|
|
||||||
// does is ask OpenTransport to create him an OTClientContextPtr, and then doles
|
|
||||||
// this out to anyone who wants it. ot_context should only be instantiated at
|
|
||||||
// system task time.
|
|
||||||
|
|
||||||
class ot_context: private noncopyable
|
|
||||||
{
|
|
||||||
protected:
|
|
||||||
ot_context();
|
|
||||||
~ot_context();
|
|
||||||
|
|
||||||
public:
|
|
||||||
OTClientContextPtr get_context();
|
|
||||||
|
|
||||||
private:
|
|
||||||
OTClientContextPtr m_pContext;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
inline OTClientContextPtr ot_context::get_context()
|
|
||||||
{ return(m_pContext); }
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BOOST_OT_CONTEXT_MJM012402_HPP
|
|
||||||
@@ -1,82 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_PACKAGE_MJM012402_HPP
|
|
||||||
#define BOOST_PACKAGE_MJM012402_HPP
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
class base_package: private noncopyable
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
virtual void accept() = 0;
|
|
||||||
};
|
|
||||||
|
|
||||||
template<class R>
|
|
||||||
class package: public base_package
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
inline package(function<R> &rFunctor):
|
|
||||||
m_rFunctor(rFunctor)
|
|
||||||
{ /* no-op */ }
|
|
||||||
inline ~package()
|
|
||||||
{ /* no-op */ }
|
|
||||||
|
|
||||||
virtual void accept()
|
|
||||||
{ m_oR = m_rFunctor(); }
|
|
||||||
inline R return_value()
|
|
||||||
{ return(m_oR); }
|
|
||||||
|
|
||||||
private:
|
|
||||||
function<R> &m_rFunctor;
|
|
||||||
R m_oR;
|
|
||||||
};
|
|
||||||
|
|
||||||
template<>
|
|
||||||
class package<void>: public base_package
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
inline package(function<void> &rFunctor):
|
|
||||||
m_rFunctor(rFunctor)
|
|
||||||
{ /* no-op */ }
|
|
||||||
inline ~package()
|
|
||||||
{ /* no-op */ }
|
|
||||||
|
|
||||||
virtual void accept()
|
|
||||||
{ m_rFunctor(); }
|
|
||||||
inline void return_value()
|
|
||||||
{ return; }
|
|
||||||
|
|
||||||
private:
|
|
||||||
function<void> &m_rFunctor;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BOOST_PACKAGE_MJM012402_HPP
|
|
||||||
@@ -1,103 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_PERIODICAL_MJM012402_HPP
|
|
||||||
#define BOOST_PERIODICAL_MJM012402_HPP
|
|
||||||
|
|
||||||
|
|
||||||
#include <boost/function.hpp>
|
|
||||||
#include <boost/utility.hpp>
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
// class periodical inherits from its template parameter, which should follow the
|
|
||||||
// pattern set by classes dt_scheduler and st_scheduler. periodical knows how to
|
|
||||||
// call a boost::function, where the xx_scheduler classes only know to to call a
|
|
||||||
// member periodically.
|
|
||||||
|
|
||||||
template<class Scheduler>
|
|
||||||
class periodical: private noncopyable, private Scheduler
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
periodical(function<void> &rFunction);
|
|
||||||
~periodical();
|
|
||||||
|
|
||||||
public:
|
|
||||||
void start();
|
|
||||||
void stop();
|
|
||||||
|
|
||||||
protected:
|
|
||||||
virtual void periodic_function();
|
|
||||||
|
|
||||||
private:
|
|
||||||
function<void> m_oFunction;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
template<class Scheduler>
|
|
||||||
periodical<Scheduler>::periodical(function<void> &rFunction):
|
|
||||||
m_oFunction(rFunction)
|
|
||||||
{
|
|
||||||
// no-op
|
|
||||||
}
|
|
||||||
|
|
||||||
template<class Scheduler>
|
|
||||||
periodical<Scheduler>::~periodical()
|
|
||||||
{
|
|
||||||
stop();
|
|
||||||
}
|
|
||||||
|
|
||||||
template<class Scheduler>
|
|
||||||
void periodical<Scheduler>::start()
|
|
||||||
{
|
|
||||||
start_polling();
|
|
||||||
}
|
|
||||||
|
|
||||||
template<class Scheduler>
|
|
||||||
void periodical<Scheduler>::stop()
|
|
||||||
{
|
|
||||||
stop_polling();
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
template<class Scheduler>
|
|
||||||
inline void periodical<Scheduler>::periodic_function()
|
|
||||||
{
|
|
||||||
try
|
|
||||||
{
|
|
||||||
m_oFunction();
|
|
||||||
}
|
|
||||||
catch(...)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BOOST_PERIODICAL_MJM012402_HPP
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#define NDEBUG
|
|
||||||
#define TARGET_CARBON 1
|
|
||||||
@@ -1,54 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#include "remote_call_manager.hpp"
|
|
||||||
|
|
||||||
#include <boost/bind.hpp>
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
using detail::delivery_man;
|
|
||||||
|
|
||||||
|
|
||||||
remote_call_manager::remote_call_manager():
|
|
||||||
m_oDTDeliveryMan(),
|
|
||||||
m_oSTDeliveryMan(),
|
|
||||||
m_oDTFunction(bind(&delivery_man::accept_deliveries, &m_oDTDeliveryMan)),
|
|
||||||
m_oSTFunction(bind(&delivery_man::accept_deliveries, &m_oSTDeliveryMan)),
|
|
||||||
m_oDTPeriodical(m_oDTFunction),
|
|
||||||
m_oSTPeriodical(m_oSTFunction)
|
|
||||||
{
|
|
||||||
m_oDTPeriodical.start();
|
|
||||||
m_oSTPeriodical.start();
|
|
||||||
}
|
|
||||||
|
|
||||||
remote_call_manager::~remote_call_manager()
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
@@ -1,108 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_REMOTE_CALL_MANAGER_MJM012402_HPP
|
|
||||||
#define BOOST_REMOTE_CALL_MANAGER_MJM012402_HPP
|
|
||||||
|
|
||||||
|
|
||||||
#include <boost/utility.hpp>
|
|
||||||
|
|
||||||
#include "delivery_man.hpp"
|
|
||||||
#include "dt_scheduler.hpp"
|
|
||||||
#include "periodical.hpp"
|
|
||||||
#include "execution_context.hpp"
|
|
||||||
#include "st_scheduler.hpp"
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
// class remote_call_manager is used by the remote call functions (dt_remote_call and
|
|
||||||
// st_remote_call) to execute functions in non-MP contexts.
|
|
||||||
|
|
||||||
class remote_call_manager: private noncopyable
|
|
||||||
{
|
|
||||||
protected:
|
|
||||||
remote_call_manager();
|
|
||||||
~remote_call_manager();
|
|
||||||
|
|
||||||
public:
|
|
||||||
template<class R>
|
|
||||||
R execute_at_dt(function<R> &rFunctor);
|
|
||||||
template<class R>
|
|
||||||
R execute_at_st(function<R> &rFunctor);
|
|
||||||
|
|
||||||
private:
|
|
||||||
template<class R>
|
|
||||||
static R execute_now(function<R> &rFunctor);
|
|
||||||
|
|
||||||
private:
|
|
||||||
delivery_man m_oDTDeliveryMan;
|
|
||||||
delivery_man m_oSTDeliveryMan;
|
|
||||||
function<void> m_oDTFunction;
|
|
||||||
function<void> m_oSTFunction;
|
|
||||||
periodical<dt_scheduler> m_oDTPeriodical;
|
|
||||||
periodical<st_scheduler> m_oSTPeriodical;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
template<class R>
|
|
||||||
/*static*/ inline R remote_call_manager::execute_now(function<R> &rFunctor)
|
|
||||||
{
|
|
||||||
return(rFunctor());
|
|
||||||
}
|
|
||||||
template<>
|
|
||||||
/*static*/ inline void remote_call_manager::execute_now<void>(function<void> &rFunctor)
|
|
||||||
{
|
|
||||||
rFunctor();
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
template<class R>
|
|
||||||
inline R remote_call_manager::execute_at_dt(function<R> &rFunctor)
|
|
||||||
{
|
|
||||||
if(at_mp())
|
|
||||||
{
|
|
||||||
return(m_oDTDeliveryMan.deliver(rFunctor));
|
|
||||||
}
|
|
||||||
return(execute_now(rFunctor));
|
|
||||||
}
|
|
||||||
|
|
||||||
template<class R>
|
|
||||||
inline R remote_call_manager::execute_at_st(function<R> &rFunctor)
|
|
||||||
{
|
|
||||||
if(at_mp())
|
|
||||||
{
|
|
||||||
return(m_oSTDeliveryMan.deliver(rFunctor));
|
|
||||||
}
|
|
||||||
assert(at_st());
|
|
||||||
return(execute_now(rFunctor));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BOOST_REMOTE_CALL_MANAGER_MJM012402_HPP
|
|
||||||
@@ -1,163 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_REMOTE_CALLS_MJM012402_HPP
|
|
||||||
#define BOOST_REMOTE_CALLS_MJM012402_HPP
|
|
||||||
|
|
||||||
|
|
||||||
#include <boost/bind.hpp>
|
|
||||||
|
|
||||||
#include "remote_call_manager.hpp"
|
|
||||||
#include <boost/thread/detail/singleton.hpp>
|
|
||||||
|
|
||||||
|
|
||||||
// this file contains macros to generate functions with the signatures:
|
|
||||||
// ReturnType st_remote_call([pascal] ReturnType (*pfnFunction)(
|
|
||||||
// [Argument1Type[, Argument2Type[...]]])
|
|
||||||
// [, Argument1Type oArgument1[, Argument2Type oArgument2[...]]])
|
|
||||||
// and
|
|
||||||
// ReturnType dt_remote_call([pascal] ReturnType (*pfnFunction)(
|
|
||||||
// [Argument1Type[, Argument2Type[...]]])
|
|
||||||
// [, Argument1Type oArgument1[, Argument2Type oArgument2[...]]])
|
|
||||||
// in other words, identical to the function pointer versions of boost::bind, but
|
|
||||||
// with the return type returned. The purpose of these functions is to be able to
|
|
||||||
// request that a function be called at system task time or deferred task time, then
|
|
||||||
// sleep until it is called, and finally get back its return value.
|
|
||||||
|
|
||||||
#define BOOST_REMOTE_CALL_CLASS_LIST_0
|
|
||||||
#define BOOST_REMOTE_CALL_CLASS_LIST_1 BOOST_REMOTE_CALL_CLASS_LIST_0, class A1
|
|
||||||
#define BOOST_REMOTE_CALL_CLASS_LIST_2 BOOST_REMOTE_CALL_CLASS_LIST_1, class A2
|
|
||||||
#define BOOST_REMOTE_CALL_CLASS_LIST_3 BOOST_REMOTE_CALL_CLASS_LIST_2, class A3
|
|
||||||
#define BOOST_REMOTE_CALL_CLASS_LIST_4 BOOST_REMOTE_CALL_CLASS_LIST_3, class A4
|
|
||||||
#define BOOST_REMOTE_CALL_CLASS_LIST_5 BOOST_REMOTE_CALL_CLASS_LIST_4, class A5
|
|
||||||
#define BOOST_REMOTE_CALL_CLASS_LIST_6 BOOST_REMOTE_CALL_CLASS_LIST_5, class A6
|
|
||||||
#define BOOST_REMOTE_CALL_CLASS_LIST_7 BOOST_REMOTE_CALL_CLASS_LIST_6, class A7
|
|
||||||
#define BOOST_REMOTE_CALL_CLASS_LIST_8 BOOST_REMOTE_CALL_CLASS_LIST_7, class A8
|
|
||||||
#define BOOST_REMOTE_CALL_CLASS_LIST_9 BOOST_REMOTE_CALL_CLASS_LIST_8, class A9
|
|
||||||
|
|
||||||
|
|
||||||
#define BOOST_REMOTE_CALL_ARGUMENT_LIST_0
|
|
||||||
#define BOOST_REMOTE_CALL_ARGUMENT_LIST_1 BOOST_REMOTE_CALL_ARGUMENT_LIST_0 A1 oA1
|
|
||||||
#define BOOST_REMOTE_CALL_ARGUMENT_LIST_2 BOOST_REMOTE_CALL_ARGUMENT_LIST_1, A2 oA2
|
|
||||||
#define BOOST_REMOTE_CALL_ARGUMENT_LIST_3 BOOST_REMOTE_CALL_ARGUMENT_LIST_2, A3 oA3
|
|
||||||
#define BOOST_REMOTE_CALL_ARGUMENT_LIST_4 BOOST_REMOTE_CALL_ARGUMENT_LIST_3, A4 oA4
|
|
||||||
#define BOOST_REMOTE_CALL_ARGUMENT_LIST_5 BOOST_REMOTE_CALL_ARGUMENT_LIST_4, A5 oA5
|
|
||||||
#define BOOST_REMOTE_CALL_ARGUMENT_LIST_6 BOOST_REMOTE_CALL_ARGUMENT_LIST_5, A6 oA6
|
|
||||||
#define BOOST_REMOTE_CALL_ARGUMENT_LIST_7 BOOST_REMOTE_CALL_ARGUMENT_LIST_6, A7 oA7
|
|
||||||
#define BOOST_REMOTE_CALL_ARGUMENT_LIST_8 BOOST_REMOTE_CALL_ARGUMENT_LIST_7, A8 oA8
|
|
||||||
#define BOOST_REMOTE_CALL_ARGUMENT_LIST_9 BOOST_REMOTE_CALL_ARGUMENT_LIST_8, A9 oA9
|
|
||||||
|
|
||||||
|
|
||||||
#define BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_0
|
|
||||||
#define BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_1 BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_0, oA1
|
|
||||||
#define BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_2 BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_1, oA2
|
|
||||||
#define BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_3 BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_2, oA3
|
|
||||||
#define BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_4 BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_3, oA4
|
|
||||||
#define BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_5 BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_4, oA5
|
|
||||||
#define BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_6 BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_5, oA6
|
|
||||||
#define BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_7 BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_6, oA7
|
|
||||||
#define BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_8 BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_7, oA8
|
|
||||||
#define BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_9 BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_8, oA9
|
|
||||||
|
|
||||||
|
|
||||||
#define BOOST_REMOTE_CALL_COMMA_0
|
|
||||||
#define BOOST_REMOTE_CALL_COMMA_1 ,
|
|
||||||
#define BOOST_REMOTE_CALL_COMMA_2 ,
|
|
||||||
#define BOOST_REMOTE_CALL_COMMA_3 ,
|
|
||||||
#define BOOST_REMOTE_CALL_COMMA_4 ,
|
|
||||||
#define BOOST_REMOTE_CALL_COMMA_5 ,
|
|
||||||
#define BOOST_REMOTE_CALL_COMMA_6 ,
|
|
||||||
#define BOOST_REMOTE_CALL_COMMA_7 ,
|
|
||||||
#define BOOST_REMOTE_CALL_COMMA_8 ,
|
|
||||||
#define BOOST_REMOTE_CALL_COMMA_9 ,
|
|
||||||
|
|
||||||
|
|
||||||
// this is the macro that ties it all together. From here, we generate all forms of
|
|
||||||
// dt_remote_call and st_remote_call.
|
|
||||||
|
|
||||||
#define BOOST_REMOTE_CALL(context, stack, n) \
|
|
||||||
template<class R BOOST_REMOTE_CALL_CLASS_LIST_ ## n> \
|
|
||||||
inline R context ## _remote_call(stack R (*pfnF)( \
|
|
||||||
BOOST_REMOTE_CALL_ARGUMENT_LIST_ ## n) \
|
|
||||||
BOOST_REMOTE_CALL_COMMA_ ## n \
|
|
||||||
BOOST_REMOTE_CALL_ARGUMENT_LIST_ ## n) \
|
|
||||||
{ \
|
|
||||||
using ::boost::detail::thread::singleton; \
|
|
||||||
using detail::remote_call_manager; \
|
|
||||||
function<R> oFunc(bind(pfnF BOOST_REMOTE_CALL_FUNCTION_ARGUMENT_LIST_ ## n)); \
|
|
||||||
remote_call_manager &rManager(singleton<remote_call_manager>::instance()); \
|
|
||||||
return(rManager.execute_at_ ## context(oFunc)); \
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
|
|
||||||
BOOST_REMOTE_CALL(st, , 0)
|
|
||||||
BOOST_REMOTE_CALL(st, , 1)
|
|
||||||
BOOST_REMOTE_CALL(st, , 2)
|
|
||||||
BOOST_REMOTE_CALL(st, , 3)
|
|
||||||
BOOST_REMOTE_CALL(st, , 4)
|
|
||||||
BOOST_REMOTE_CALL(st, , 5)
|
|
||||||
BOOST_REMOTE_CALL(st, , 6)
|
|
||||||
BOOST_REMOTE_CALL(st, , 7)
|
|
||||||
BOOST_REMOTE_CALL(st, , 8)
|
|
||||||
BOOST_REMOTE_CALL(st, , 9)
|
|
||||||
|
|
||||||
BOOST_REMOTE_CALL(dt, , 0)
|
|
||||||
BOOST_REMOTE_CALL(dt, , 1)
|
|
||||||
BOOST_REMOTE_CALL(dt, , 2)
|
|
||||||
BOOST_REMOTE_CALL(dt, , 3)
|
|
||||||
BOOST_REMOTE_CALL(dt, , 4)
|
|
||||||
BOOST_REMOTE_CALL(dt, , 5)
|
|
||||||
BOOST_REMOTE_CALL(dt, , 6)
|
|
||||||
BOOST_REMOTE_CALL(dt, , 7)
|
|
||||||
BOOST_REMOTE_CALL(dt, , 8)
|
|
||||||
BOOST_REMOTE_CALL(dt, , 9)
|
|
||||||
|
|
||||||
|
|
||||||
BOOST_REMOTE_CALL(st, pascal, 0)
|
|
||||||
BOOST_REMOTE_CALL(st, pascal, 1)
|
|
||||||
BOOST_REMOTE_CALL(st, pascal, 2)
|
|
||||||
BOOST_REMOTE_CALL(st, pascal, 3)
|
|
||||||
BOOST_REMOTE_CALL(st, pascal, 4)
|
|
||||||
BOOST_REMOTE_CALL(st, pascal, 5)
|
|
||||||
BOOST_REMOTE_CALL(st, pascal, 6)
|
|
||||||
BOOST_REMOTE_CALL(st, pascal, 7)
|
|
||||||
BOOST_REMOTE_CALL(st, pascal, 8)
|
|
||||||
BOOST_REMOTE_CALL(st, pascal, 9)
|
|
||||||
|
|
||||||
BOOST_REMOTE_CALL(dt, pascal, 0)
|
|
||||||
BOOST_REMOTE_CALL(dt, pascal, 1)
|
|
||||||
BOOST_REMOTE_CALL(dt, pascal, 2)
|
|
||||||
BOOST_REMOTE_CALL(dt, pascal, 3)
|
|
||||||
BOOST_REMOTE_CALL(dt, pascal, 4)
|
|
||||||
BOOST_REMOTE_CALL(dt, pascal, 5)
|
|
||||||
BOOST_REMOTE_CALL(dt, pascal, 6)
|
|
||||||
BOOST_REMOTE_CALL(dt, pascal, 7)
|
|
||||||
BOOST_REMOTE_CALL(dt, pascal, 8)
|
|
||||||
BOOST_REMOTE_CALL(dt, pascal, 9)
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BOOST_REMOTE_CALLS_MJM012402_HPP
|
|
||||||
216
src/mac/safe.cpp
216
src/mac/safe.cpp
@@ -1,216 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#include <DriverServices.h>
|
|
||||||
#include <Events.h>
|
|
||||||
#include <Multiprocessing.h>
|
|
||||||
#include <Threads.h>
|
|
||||||
|
|
||||||
#include <boost/bind.hpp>
|
|
||||||
#include <boost/function.hpp>
|
|
||||||
|
|
||||||
#include <boost/thread/detail/force_cast.hpp>
|
|
||||||
#include <limits>
|
|
||||||
#include "execution_context.hpp"
|
|
||||||
|
|
||||||
|
|
||||||
using boost::detail::thread::force_cast;
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
static OSStatus safe_wait(function<OSStatus, Duration> &rFunction, Duration lDuration);
|
|
||||||
|
|
||||||
|
|
||||||
// we call WNE to allow tasks that own the resource the blue is waiting on system
|
|
||||||
// task time, in case they are blocked on an ST remote call (or a memory allocation
|
|
||||||
// for that matter).
|
|
||||||
static void idle()
|
|
||||||
{
|
|
||||||
if(at_st())
|
|
||||||
{
|
|
||||||
EventRecord sEvent;
|
|
||||||
bool bEvent = WaitNextEvent(0U, &sEvent, 0UL, NULL);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
OSStatus safe_wait_on_semaphore(MPSemaphoreID pSemaphoreID, Duration lDuration)
|
|
||||||
{
|
|
||||||
function<OSStatus, Duration> oWaitOnSemaphore;
|
|
||||||
oWaitOnSemaphore = bind(MPWaitOnSemaphore, pSemaphoreID, _1);
|
|
||||||
return(safe_wait(oWaitOnSemaphore, lDuration));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
OSStatus safe_enter_critical_region(MPCriticalRegionID pCriticalRegionID, Duration lDuration, MPCriticalRegionID pCriticalRegionCriticalRegionID/* = kInvalidID*/)
|
|
||||||
{
|
|
||||||
if(pCriticalRegionCriticalRegionID != kInvalidID)
|
|
||||||
{
|
|
||||||
if(at_mp())
|
|
||||||
{
|
|
||||||
// enter the critical region's critical region
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
AbsoluteTime sExpiration;
|
|
||||||
if(lDuration != kDurationImmediate && lDuration != kDurationForever)
|
|
||||||
{
|
|
||||||
sExpiration = AddDurationToAbsolute(lDuration, UpTime());
|
|
||||||
}
|
|
||||||
lStatus = MPEnterCriticalRegion(pCriticalRegionCriticalRegionID, lDuration);
|
|
||||||
assert(lStatus == noErr || lStatus == kMPTimeoutErr);
|
|
||||||
if(lStatus == noErr)
|
|
||||||
{
|
|
||||||
// calculate a new duration
|
|
||||||
if(lDuration != kDurationImmediate && lDuration != kDurationForever)
|
|
||||||
{
|
|
||||||
// check if we have any time left
|
|
||||||
AbsoluteTime sUpTime(UpTime());
|
|
||||||
if(force_cast<uint64_t>(sExpiration) > force_cast<uint64_t>(sUpTime))
|
|
||||||
{
|
|
||||||
// reset our duration to our remaining time
|
|
||||||
lDuration = AbsoluteDeltaToDuration(sExpiration, sUpTime);
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
// no time left
|
|
||||||
lDuration = kDurationImmediate;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// if we entered the critical region, exit it again
|
|
||||||
lStatus = MPExitCriticalRegion(pCriticalRegionCriticalRegionID);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
// otherwise, give up
|
|
||||||
return(lStatus);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
// if we're at system task time, try to enter the critical region's critical
|
|
||||||
// region until we succeed. MP tasks will block on this until we let it go.
|
|
||||||
OSStatus lStatus;
|
|
||||||
do
|
|
||||||
{
|
|
||||||
lStatus = MPEnterCriticalRegion(pCriticalRegionCriticalRegionID, kDurationImmediate);
|
|
||||||
} while(lStatus == kMPTimeoutErr);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// try to enter the critical region
|
|
||||||
function<OSStatus, Duration> oEnterCriticalRegion;
|
|
||||||
oEnterCriticalRegion = bind(MPEnterCriticalRegion, pCriticalRegionID, _1);
|
|
||||||
OSStatus lStatus = safe_wait(oEnterCriticalRegion, lDuration);
|
|
||||||
|
|
||||||
// if we entered the critical region's critical region to get the critical region,
|
|
||||||
// exit the critical region's critical region.
|
|
||||||
if(pCriticalRegionCriticalRegionID != kInvalidID && at_mp() == false)
|
|
||||||
{
|
|
||||||
lStatus = MPExitCriticalRegion(pCriticalRegionCriticalRegionID);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
return(lStatus);
|
|
||||||
}
|
|
||||||
|
|
||||||
OSStatus safe_wait_on_queue(MPQueueID pQueueID, void **pParam1, void **pParam2, void **pParam3, Duration lDuration)
|
|
||||||
{
|
|
||||||
function<OSStatus, Duration> oWaitOnQueue;
|
|
||||||
oWaitOnQueue = bind(MPWaitOnQueue, pQueueID, pParam1, pParam2, pParam3, _1);
|
|
||||||
return(safe_wait(oWaitOnQueue, lDuration));
|
|
||||||
}
|
|
||||||
|
|
||||||
OSStatus safe_delay_until(AbsoluteTime *pWakeUpTime)
|
|
||||||
{
|
|
||||||
if(execution_context() == k_eExecutionContextMPTask)
|
|
||||||
{
|
|
||||||
return(MPDelayUntil(pWakeUpTime));
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
uint64_t ullWakeUpTime = force_cast<uint64_t>(*pWakeUpTime);
|
|
||||||
|
|
||||||
while(force_cast<uint64_t>(UpTime()) < ullWakeUpTime)
|
|
||||||
{
|
|
||||||
idle();
|
|
||||||
}
|
|
||||||
|
|
||||||
return(noErr);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
OSStatus safe_wait(function<OSStatus, Duration> &rFunction, Duration lDuration)
|
|
||||||
{
|
|
||||||
if(execution_context() == k_eExecutionContextMPTask)
|
|
||||||
{
|
|
||||||
return(rFunction(lDuration));
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
uint64_t ullExpiration = 0ULL;
|
|
||||||
|
|
||||||
// get the expiration time in UpTime units
|
|
||||||
if(lDuration == kDurationForever)
|
|
||||||
{
|
|
||||||
ullExpiration = ::std::numeric_limits<uint64_t>::max();
|
|
||||||
}
|
|
||||||
else if(lDuration == kDurationImmediate)
|
|
||||||
{
|
|
||||||
ullExpiration = force_cast<uint64_t>(UpTime());
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
AbsoluteTime sExpiration = AddDurationToAbsolute(lDuration, UpTime());
|
|
||||||
ullExpiration = force_cast<uint64_t>(sExpiration);
|
|
||||||
}
|
|
||||||
|
|
||||||
OSStatus lStatus;
|
|
||||||
bool bExpired = false;
|
|
||||||
|
|
||||||
do
|
|
||||||
{
|
|
||||||
lStatus = rFunction(kDurationImmediate);
|
|
||||||
// mm - "if" #if 0'd out to allow task time to threads blocked on I/O
|
|
||||||
#if 0
|
|
||||||
if(lStatus == kMPTimeoutErr)
|
|
||||||
#endif
|
|
||||||
{
|
|
||||||
idle();
|
|
||||||
}
|
|
||||||
if(lDuration != kDurationForever)
|
|
||||||
{
|
|
||||||
bExpired = (force_cast<uint64_t>(UpTime()) < ullExpiration);
|
|
||||||
}
|
|
||||||
} while(lStatus == kMPTimeoutErr && bExpired == false);
|
|
||||||
|
|
||||||
return(lStatus);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
@@ -1,47 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_SAFE_MJM012402_HPP
|
|
||||||
#define BOOST_SAFE_MJM012402_HPP
|
|
||||||
|
|
||||||
|
|
||||||
#include <Multiprocessing.h>
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
// these functions are used to wain in an execution context-independent manor. All of these
|
|
||||||
// functions are both MP- and ST-safe.
|
|
||||||
|
|
||||||
OSStatus safe_wait_on_semaphore(MPSemaphoreID pSemaphoreID, Duration lDuration);
|
|
||||||
OSStatus safe_enter_critical_region(MPCriticalRegionID pCriticalRegionID, Duration lDuration, MPCriticalRegionID pCriticalRegionCriticalRegionID = kInvalidID);
|
|
||||||
OSStatus safe_wait_on_queue(MPQueueID pQueueID, void **pParam1, void **pParam2, void **pParam3, Duration lDuration);
|
|
||||||
OSStatus safe_delay_until(AbsoluteTime *pWakeUpTime);
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
#endif // BOOST_SAFE_MJM012402_HPP
|
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#include "scoped_critical_region.hpp"
|
|
||||||
|
|
||||||
#include "init.hpp"
|
|
||||||
|
|
||||||
|
|
||||||
#include <cassert>
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
scoped_critical_region::scoped_critical_region():
|
|
||||||
m_pCriticalRegionID(kInvalidID)
|
|
||||||
{
|
|
||||||
static bool bIgnored = thread_init();
|
|
||||||
OSStatus lStatus = MPCreateCriticalRegion(&m_pCriticalRegionID);
|
|
||||||
if(lStatus != noErr || m_pCriticalRegionID == kInvalidID)
|
|
||||||
throw(thread_resource_error());
|
|
||||||
}
|
|
||||||
|
|
||||||
scoped_critical_region::~scoped_critical_region()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = MPDeleteCriticalRegion(m_pCriticalRegionID);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_SCOPED_CRITICAL_REGION_MJM012402_HPP
|
|
||||||
#define BOOST_SCOPED_CRITICAL_REGION_MJM012402_HPP
|
|
||||||
|
|
||||||
|
|
||||||
#include <boost/thread/exceptions.hpp>
|
|
||||||
|
|
||||||
#include <Multiprocessing.h>
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
// class scoped_critical_region probably needs a new name. Although the current name
|
|
||||||
// is accurate, it can be read to mean that a critical region is entered for the
|
|
||||||
// current scope. In reality, a critical region is _created_ for the current scope.
|
|
||||||
// This class is intended as a replacement for MPCriticalRegionID that will
|
|
||||||
// automatically create and dispose of itself.
|
|
||||||
|
|
||||||
class scoped_critical_region
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
scoped_critical_region();
|
|
||||||
~scoped_critical_region();
|
|
||||||
|
|
||||||
public:
|
|
||||||
operator const MPCriticalRegionID &() const;
|
|
||||||
const MPCriticalRegionID &get() const;
|
|
||||||
|
|
||||||
private:
|
|
||||||
MPCriticalRegionID m_pCriticalRegionID;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
// these are inlined for speed.
|
|
||||||
inline scoped_critical_region::operator const MPCriticalRegionID &() const
|
|
||||||
{ return(m_pCriticalRegionID); }
|
|
||||||
inline const MPCriticalRegionID &scoped_critical_region::get() const
|
|
||||||
{ return(m_pCriticalRegionID); }
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BOOST_SCOPED_CRITICAL_REGION_MJM012402_HPP
|
|
||||||
@@ -1,91 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#include "st_scheduler.hpp"
|
|
||||||
|
|
||||||
#include <cassert>
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
#if TARGET_CARBON
|
|
||||||
|
|
||||||
st_scheduler::st_scheduler():
|
|
||||||
m_uppTask(NULL),
|
|
||||||
m_pTimer(NULL)
|
|
||||||
{
|
|
||||||
m_uppTask = NewEventLoopTimerUPP(task_entry);
|
|
||||||
// TODO - throw on error
|
|
||||||
assert(m_uppTask != NULL);
|
|
||||||
}
|
|
||||||
|
|
||||||
st_scheduler::~st_scheduler()
|
|
||||||
{
|
|
||||||
DisposeEventLoopTimerUPP(m_uppTask);
|
|
||||||
m_uppTask = NULL;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
void st_scheduler::start_polling()
|
|
||||||
{
|
|
||||||
assert(m_pTimer == NULL);
|
|
||||||
OSStatus lStatus = InstallEventLoopTimer(GetMainEventLoop(),
|
|
||||||
0 * kEventDurationSecond,
|
|
||||||
kEventDurationMillisecond,
|
|
||||||
m_uppTask,
|
|
||||||
this,
|
|
||||||
&m_pTimer);
|
|
||||||
// TODO - throw on error
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
void st_scheduler::stop_polling()
|
|
||||||
{
|
|
||||||
assert(m_pTimer != NULL);
|
|
||||||
OSStatus lStatus = RemoveEventLoopTimer(m_pTimer);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
m_pTimer = NULL;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/*static*/ pascal void st_scheduler::task_entry(EventLoopTimerRef /*pTimer*/, void *pRefCon)
|
|
||||||
{
|
|
||||||
st_scheduler *pThis = reinterpret_cast<st_scheduler *>(pRefCon);
|
|
||||||
assert(pThis != NULL);
|
|
||||||
pThis->task();
|
|
||||||
}
|
|
||||||
|
|
||||||
void st_scheduler::task()
|
|
||||||
{
|
|
||||||
periodic_function();
|
|
||||||
}
|
|
||||||
|
|
||||||
#else
|
|
||||||
# error st_scheduler unimplemented!
|
|
||||||
#endif
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
@@ -1,73 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_ST_SCHEDULER_MJM012402_HPP
|
|
||||||
#define BOOST_ST_SCHEDULER_MJM012402_HPP
|
|
||||||
|
|
||||||
|
|
||||||
#include <CarbonEvents.h>
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
// class st_scheduler calls its pure-virtual periodic_function method periodically at
|
|
||||||
// system task time. This is generally 40Hz under Mac OS 9.
|
|
||||||
|
|
||||||
class st_scheduler
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
st_scheduler();
|
|
||||||
virtual ~st_scheduler();
|
|
||||||
|
|
||||||
protected:
|
|
||||||
void start_polling();
|
|
||||||
void stop_polling();
|
|
||||||
|
|
||||||
private:
|
|
||||||
virtual void periodic_function() = 0;
|
|
||||||
|
|
||||||
#if TARGET_CARBON
|
|
||||||
// use event loop timers under Carbon
|
|
||||||
private:
|
|
||||||
static pascal void task_entry(EventLoopTimerRef pTimer, void *pRefCon);
|
|
||||||
void task();
|
|
||||||
|
|
||||||
private:
|
|
||||||
EventLoopTimerUPP m_uppTask;
|
|
||||||
EventLoopTimerRef m_pTimer;
|
|
||||||
#else
|
|
||||||
// this can be implemented using OT system tasks. This would be mostly a copy-and-
|
|
||||||
// paste of the dt_scheduler code, replacing DeferredTask with SystemTask and DT
|
|
||||||
// with ST.
|
|
||||||
# error st_scheduler unimplemented!
|
|
||||||
#endif
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BOOST_ST_SCHEDULER_MJM012402_HPP
|
|
||||||
@@ -1,62 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#include "thread_cleanup.hpp"
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
namespace {
|
|
||||||
|
|
||||||
TaskStorageIndex g_ulIndex(0UL);
|
|
||||||
|
|
||||||
} // anonymous namespace
|
|
||||||
|
|
||||||
|
|
||||||
void do_thread_startup()
|
|
||||||
{
|
|
||||||
if(g_ulIndex == 0UL)
|
|
||||||
{
|
|
||||||
OSStatus lStatus = MPAllocateTaskStorageIndex(&g_ulIndex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
set_thread_cleanup_task(NULL);
|
|
||||||
}
|
|
||||||
|
|
||||||
void do_thread_cleanup()
|
|
||||||
{
|
|
||||||
void (*pfnTask)() = MPGetTaskValue(g_ulIndex)
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
void set_thread_cleanup_task(void (*pfnTask)())
|
|
||||||
{
|
|
||||||
lStatus = MPSetTaskValue(g_ulIndex, reinterpret_cast<TaskStorageValue>(pfnTask));
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
// Copyright (C) 2001
|
|
||||||
// Mac Murrett
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, distribute and sell this software
|
|
||||||
// and its documentation for any purpose is hereby granted without fee,
|
|
||||||
// provided that the above copyright notice appear in all copies and
|
|
||||||
// that both that copyright notice and this permission notice appear
|
|
||||||
// in supporting documentation. Mac Murrett makes no representations
|
|
||||||
// about the suitability of this software for any purpose. It is
|
|
||||||
// provided "as is" without express or implied warranty.
|
|
||||||
//
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
|
||||||
|
|
||||||
#ifndef BOOST_THREAD_CLEANUP_MJM012402_HPP
|
|
||||||
#define BOOST_THREAD_CLEANUP_MJM012402_HPP
|
|
||||||
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace threads {
|
|
||||||
|
|
||||||
namespace mac {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
void do_thread_startup();
|
|
||||||
void do_thread_cleanup();
|
|
||||||
|
|
||||||
void set_thread_cleanup_task();
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace mac
|
|
||||||
|
|
||||||
} // namespace threads
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
|
|
||||||
#endif // BOOST_THREAD_CLEANUP_MJM012402_HPP
|
|
||||||
135
src/mutex.cpp
135
src/mutex.cpp
@@ -24,11 +24,6 @@
|
|||||||
# include <time.h>
|
# include <time.h>
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
# include <errno.h>
|
# include <errno.h>
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
# include <MacErrors.h>
|
|
||||||
|
|
||||||
# include "mac/init.hpp"
|
|
||||||
# include "mac/safe.hpp"
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
namespace boost {
|
namespace boost {
|
||||||
@@ -145,7 +140,7 @@ bool timed_mutex::do_trylock()
|
|||||||
|
|
||||||
bool timed_mutex::do_timedlock(const xtime& xt)
|
bool timed_mutex::do_timedlock(const xtime& xt)
|
||||||
{
|
{
|
||||||
int milliseconds;
|
unsigned milliseconds;
|
||||||
to_duration(xt, milliseconds);
|
to_duration(xt, milliseconds);
|
||||||
|
|
||||||
unsigned int res = WaitForSingleObject(reinterpret_cast<HANDLE>(m_mutex), milliseconds);
|
unsigned int res = WaitForSingleObject(reinterpret_cast<HANDLE>(m_mutex), milliseconds);
|
||||||
@@ -399,134 +394,6 @@ void timed_mutex::do_unlock(cv_state& state)
|
|||||||
|
|
||||||
state.pmutex = &m_mutex;
|
state.pmutex = &m_mutex;
|
||||||
}
|
}
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
|
|
||||||
using threads::mac::detail::safe_enter_critical_region;
|
|
||||||
|
|
||||||
mutex::mutex()
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
mutex::~mutex()
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
void mutex::do_lock()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, kDurationForever, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
void mutex::do_unlock()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
void mutex::do_lock(cv_state& /*state*/)
|
|
||||||
{
|
|
||||||
do_lock();
|
|
||||||
}
|
|
||||||
|
|
||||||
void mutex::do_unlock(cv_state& /*state*/)
|
|
||||||
{
|
|
||||||
do_unlock();
|
|
||||||
}
|
|
||||||
|
|
||||||
try_mutex::try_mutex()
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
try_mutex::~try_mutex()
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
void try_mutex::do_lock()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, kDurationForever, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
bool try_mutex::do_trylock()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPEnterCriticalRegion(m_mutex, kDurationImmediate);
|
|
||||||
assert(lStatus == noErr || lStatus == kMPTimeoutErr);
|
|
||||||
return lStatus == noErr;
|
|
||||||
}
|
|
||||||
|
|
||||||
void try_mutex::do_unlock()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
void try_mutex::do_lock(cv_state& /*state*/)
|
|
||||||
{
|
|
||||||
do_lock();
|
|
||||||
}
|
|
||||||
|
|
||||||
void try_mutex::do_unlock(cv_state& /*state*/)
|
|
||||||
{
|
|
||||||
do_unlock();
|
|
||||||
}
|
|
||||||
|
|
||||||
timed_mutex::timed_mutex()
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
timed_mutex::~timed_mutex()
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
void timed_mutex::do_lock()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, kDurationForever, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
bool timed_mutex::do_trylock()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPEnterCriticalRegion(m_mutex, kDurationImmediate);
|
|
||||||
assert(lStatus == noErr || lStatus == kMPTimeoutErr);
|
|
||||||
return(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
bool timed_mutex::do_timedlock(const xtime& xt)
|
|
||||||
{
|
|
||||||
int microseconds;
|
|
||||||
to_microduration(xt, microseconds);
|
|
||||||
Duration lDuration = kDurationMicrosecond * microseconds;
|
|
||||||
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, lDuration, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr || lStatus == kMPTimeoutErr);
|
|
||||||
|
|
||||||
return(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
void timed_mutex::do_unlock()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
void timed_mutex::do_lock(cv_state& /*state*/)
|
|
||||||
{
|
|
||||||
do_lock();
|
|
||||||
}
|
|
||||||
|
|
||||||
void timed_mutex::do_unlock(cv_state& /*state*/)
|
|
||||||
{
|
|
||||||
do_unlock();
|
|
||||||
}
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
} // namespace boost
|
} // namespace boost
|
||||||
|
|||||||
23
src/once.cpp
23
src/once.cpp
@@ -28,8 +28,6 @@
|
|||||||
# else
|
# else
|
||||||
# include <sstream>
|
# include <sstream>
|
||||||
# endif
|
# endif
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
# include <Multiprocessing.h>
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef BOOST_NO_STDC_NAMESPACE
|
#ifdef BOOST_NO_STDC_NAMESPACE
|
||||||
@@ -57,19 +55,6 @@ static void do_once()
|
|||||||
(**cb)();
|
(**cb)();
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
void *remote_call_proxy(void *pData)
|
|
||||||
{
|
|
||||||
std::pair<void (*)(), boost::once_flag *> &rData(*reinterpret_cast<std::pair<void (*)(), boost::once_flag *> *>(pData));
|
|
||||||
|
|
||||||
if(*rData.second == false)
|
|
||||||
{
|
|
||||||
rData.first();
|
|
||||||
*rData.second = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
return(NULL);
|
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
@@ -122,14 +107,6 @@ void call_once(void (*func)(), once_flag& flag)
|
|||||||
pthread_once(&once, &key_init);
|
pthread_once(&once, &key_init);
|
||||||
pthread_setspecific(key, &func);
|
pthread_setspecific(key, &func);
|
||||||
pthread_once(&flag, do_once);
|
pthread_once(&flag, do_once);
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
if(flag == false)
|
|
||||||
{
|
|
||||||
// all we do here is make a remote call to blue, as blue is not reentrant.
|
|
||||||
std::pair<void (*)(), once_flag *> sData(func, &flag);
|
|
||||||
MPRemoteCall(remote_call_proxy, &sData, kMPOwningProcessRemoteContext);
|
|
||||||
assert(flag == true);
|
|
||||||
}
|
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -22,9 +22,6 @@
|
|||||||
# include <time.h>
|
# include <time.h>
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
# include <errno.h>
|
# include <errno.h>
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
# include <MacErrors.h>
|
|
||||||
# include "safe.hpp"
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
namespace boost {
|
namespace boost {
|
||||||
@@ -195,7 +192,7 @@ bool recursive_timed_mutex::do_trylock()
|
|||||||
|
|
||||||
bool recursive_timed_mutex::do_timedlock(const xtime& xt)
|
bool recursive_timed_mutex::do_timedlock(const xtime& xt)
|
||||||
{
|
{
|
||||||
int milliseconds;
|
unsigned milliseconds;
|
||||||
to_duration(xt, milliseconds);
|
to_duration(xt, milliseconds);
|
||||||
|
|
||||||
unsigned int res = 0;
|
unsigned int res = 0;
|
||||||
@@ -769,221 +766,6 @@ void recursive_timed_mutex::do_unlock(cv_state& state)
|
|||||||
state.pmutex = &m_mutex;
|
state.pmutex = &m_mutex;
|
||||||
state.count = m_count;
|
state.count = m_count;
|
||||||
}
|
}
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
|
|
||||||
using threads::mac::detail::safe_enter_critical_region;
|
|
||||||
|
|
||||||
|
|
||||||
recursive_mutex::recursive_mutex()
|
|
||||||
: m_count(0)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
recursive_mutex::~recursive_mutex()
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
void recursive_mutex::do_lock()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, kDurationForever, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
|
|
||||||
if (++m_count > 1)
|
|
||||||
{
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void recursive_mutex::do_unlock()
|
|
||||||
{
|
|
||||||
if (--m_count == 0)
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void recursive_mutex::do_lock(cv_state& state)
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, kDurationForever, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
|
|
||||||
m_count = state;
|
|
||||||
}
|
|
||||||
|
|
||||||
void recursive_mutex::do_unlock(cv_state& state)
|
|
||||||
{
|
|
||||||
state = m_count;
|
|
||||||
m_count = 0;
|
|
||||||
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
recursive_try_mutex::recursive_try_mutex()
|
|
||||||
: m_count(0)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
recursive_try_mutex::~recursive_try_mutex()
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
void recursive_try_mutex::do_lock()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, kDurationForever, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
|
|
||||||
if (++m_count > 1)
|
|
||||||
{
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
bool recursive_try_mutex::do_trylock()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPEnterCriticalRegion(m_mutex, kDurationImmediate);
|
|
||||||
assert(lStatus == noErr || lStatus == kMPTimeoutErr);
|
|
||||||
|
|
||||||
if (lStatus == noErr)
|
|
||||||
{
|
|
||||||
if (++m_count > 1)
|
|
||||||
{
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
void recursive_try_mutex::do_unlock()
|
|
||||||
{
|
|
||||||
if (--m_count == 0)
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void recursive_try_mutex::do_lock(cv_state& state)
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, kDurationForever, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
|
|
||||||
m_count = state;
|
|
||||||
}
|
|
||||||
|
|
||||||
void recursive_try_mutex::do_unlock(cv_state& state)
|
|
||||||
{
|
|
||||||
state = m_count;
|
|
||||||
m_count = 0;
|
|
||||||
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
recursive_timed_mutex::recursive_timed_mutex()
|
|
||||||
: m_count(0)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
recursive_timed_mutex::~recursive_timed_mutex()
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
void recursive_timed_mutex::do_lock()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, kDurationForever, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
|
|
||||||
if (++m_count > 1)
|
|
||||||
{
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
bool recursive_timed_mutex::do_trylock()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPEnterCriticalRegion(m_mutex, kDurationImmediate);
|
|
||||||
assert(lStatus == noErr || lStatus == kMPTimeoutErr);
|
|
||||||
|
|
||||||
if (lStatus == noErr)
|
|
||||||
{
|
|
||||||
if (++m_count > 1)
|
|
||||||
{
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool recursive_timed_mutex::do_timedlock(const xtime& xt)
|
|
||||||
{
|
|
||||||
int microseconds;
|
|
||||||
to_microduration(xt, microseconds);
|
|
||||||
Duration lDuration = kDurationMicrosecond * microseconds;
|
|
||||||
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, lDuration, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr || lStatus == kMPTimeoutErr);
|
|
||||||
|
|
||||||
if (lStatus == noErr)
|
|
||||||
{
|
|
||||||
if (++m_count > 1)
|
|
||||||
{
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
void recursive_timed_mutex::do_unlock()
|
|
||||||
{
|
|
||||||
if (--m_count == 0)
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void recursive_timed_mutex::do_lock(cv_state& state)
|
|
||||||
{
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = safe_enter_critical_region(m_mutex, kDurationForever, m_mutex_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
|
|
||||||
m_count = state;
|
|
||||||
}
|
|
||||||
|
|
||||||
void recursive_timed_mutex::do_unlock(cv_state& state)
|
|
||||||
{
|
|
||||||
state = m_count;
|
|
||||||
m_count = 0;
|
|
||||||
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPExitCriticalRegion(m_mutex);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
} // namespace boost
|
} // namespace boost
|
||||||
|
|||||||
@@ -17,12 +17,6 @@
|
|||||||
#if defined(BOOST_HAS_WINTHREADS)
|
#if defined(BOOST_HAS_WINTHREADS)
|
||||||
# include <windows.h>
|
# include <windows.h>
|
||||||
# include <process.h>
|
# include <process.h>
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
# include <DriverServices.h>
|
|
||||||
|
|
||||||
# include "init.hpp"
|
|
||||||
# include "safe.hpp"
|
|
||||||
# include <boost/thread/tss.hpp>
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#include "timeconv.inl"
|
#include "timeconv.inl"
|
||||||
@@ -59,8 +53,6 @@ extern "C" {
|
|||||||
unsigned __stdcall thread_proxy(void* param)
|
unsigned __stdcall thread_proxy(void* param)
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
static void* thread_proxy(void* param)
|
static void* thread_proxy(void* param)
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
static OSStatus thread_proxy(void* param)
|
|
||||||
#endif
|
#endif
|
||||||
{
|
{
|
||||||
try
|
try
|
||||||
@@ -73,9 +65,6 @@ static OSStatus thread_proxy(void* param)
|
|||||||
catch (...)
|
catch (...)
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
#if defined(BOOST_HAS_MPTASKS)
|
|
||||||
::boost::detail::thread_cleanup();
|
|
||||||
#endif
|
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -91,11 +80,6 @@ thread::thread()
|
|||||||
m_id = GetCurrentThreadId();
|
m_id = GetCurrentThreadId();
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
m_thread = pthread_self();
|
m_thread = pthread_self();
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
threads::mac::detail::thread_init();
|
|
||||||
threads::mac::detail::create_singletons();
|
|
||||||
m_pTaskID = MPCurrentTaskID();
|
|
||||||
m_pJoinQueueID = kInvalidID;
|
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -112,25 +96,6 @@ thread::thread(const function0<void>& threadfunc)
|
|||||||
res = pthread_create(&m_thread, 0, &thread_proxy, ¶m);
|
res = pthread_create(&m_thread, 0, &thread_proxy, ¶m);
|
||||||
if (res != 0)
|
if (res != 0)
|
||||||
throw thread_resource_error();
|
throw thread_resource_error();
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
threads::mac::detail::thread_init();
|
|
||||||
threads::mac::detail::create_singletons();
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
|
|
||||||
m_pJoinQueueID = kInvalidID;
|
|
||||||
m_pTaskID = kInvalidID;
|
|
||||||
|
|
||||||
lStatus = MPCreateQueue(&m_pJoinQueueID);
|
|
||||||
if(lStatus != noErr) throw thread_resource_error();
|
|
||||||
|
|
||||||
lStatus = MPCreateTask(&thread_proxy, ¶m, 0UL, m_pJoinQueueID, NULL, NULL,
|
|
||||||
0UL, &m_pTaskID);
|
|
||||||
if(lStatus != noErr)
|
|
||||||
{
|
|
||||||
lStatus = MPDeleteQueue(m_pJoinQueueID);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
throw thread_resource_error();
|
|
||||||
}
|
|
||||||
#endif
|
#endif
|
||||||
param.wait();
|
param.wait();
|
||||||
}
|
}
|
||||||
@@ -145,10 +110,6 @@ thread::~thread()
|
|||||||
assert(res);
|
assert(res);
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
pthread_detach(m_thread);
|
pthread_detach(m_thread);
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
assert(m_pJoinQueueID != kInvalidID);
|
|
||||||
OSStatus lStatus = MPDeleteQueue(m_pJoinQueueID);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -159,8 +120,6 @@ bool thread::operator==(const thread& other) const
|
|||||||
return other.m_id == m_id;
|
return other.m_id == m_id;
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
return pthread_equal(m_thread, other.m_thread) != 0;
|
return pthread_equal(m_thread, other.m_thread) != 0;
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
return other.m_pTaskID == m_pTaskID;
|
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -180,9 +139,6 @@ void thread::join()
|
|||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
res = pthread_join(m_thread, 0);
|
res = pthread_join(m_thread, 0);
|
||||||
assert(res == 0);
|
assert(res == 0);
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
OSStatus lStatus = threads::mac::detail::safe_wait_on_queue(m_pJoinQueueID, NULL, NULL, NULL, kDurationForever);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
#endif
|
#endif
|
||||||
// This isn't a race condition since any race that could occur would
|
// This isn't a race condition since any race that could occur would
|
||||||
// have us in undefined behavior territory any way.
|
// have us in undefined behavior territory any way.
|
||||||
@@ -191,44 +147,31 @@ void thread::join()
|
|||||||
|
|
||||||
void thread::sleep(const xtime& xt)
|
void thread::sleep(const xtime& xt)
|
||||||
{
|
{
|
||||||
for (;;)
|
|
||||||
{
|
|
||||||
#if defined(BOOST_HAS_WINTHREADS)
|
#if defined(BOOST_HAS_WINTHREADS)
|
||||||
int milliseconds;
|
unsigned milliseconds;
|
||||||
to_duration(xt, milliseconds);
|
to_duration(xt, milliseconds);
|
||||||
Sleep(milliseconds);
|
Sleep(milliseconds);
|
||||||
xtime xt2;
|
|
||||||
xtime_get(&xt2, TIME_UTC);
|
|
||||||
#elif defined(BOOST_HAS_PTHREADS)
|
#elif defined(BOOST_HAS_PTHREADS)
|
||||||
# if defined(BOOST_HAS_PTHREAD_DELAY_NP)
|
# if defined(BOOST_HAS_PTHREAD_DELAY_NP)
|
||||||
timespec ts;
|
timespec ts;
|
||||||
to_timespec_duration(xt, ts);
|
to_timespec(xt, ts);
|
||||||
int res = 0;
|
int res = 0;
|
||||||
res = pthread_delay_np(&ts);
|
res = pthread_delay_np(&ts);
|
||||||
assert(res == 0);
|
assert(res == 0);
|
||||||
# elif defined(BOOST_HAS_NANOSLEEP)
|
# elif defined(BOOST_HAS_NANOSLEEP)
|
||||||
timespec ts;
|
timespec ts;
|
||||||
to_timespec_duration(xt, ts);
|
to_timespec_duration(xt, ts);
|
||||||
|
|
||||||
// nanosleep takes a timespec that is an offset, not
|
// nanosleep takes a timespec that is an offset, not
|
||||||
// an absolute time.
|
// an absolute time.
|
||||||
nanosleep(&ts, 0);
|
nanosleep(&ts, 0);
|
||||||
# else
|
# else
|
||||||
mutex mx;
|
mutex mx;
|
||||||
mutex::scoped_lock lock(mx);
|
mutex::scoped_lock lock(mx);
|
||||||
condition cond;
|
condition cond;
|
||||||
cond.timed_wait(lock, xt);
|
cond.timed_wait(lock, xt);
|
||||||
# endif
|
# endif
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
int microseconds;
|
|
||||||
to_microduration(xt, microseconds);
|
|
||||||
Duration lMicroseconds(kDurationMicrosecond * microseconds);
|
|
||||||
AbsoluteTime sWakeTime(DurationToAbsolute(lMicroseconds));
|
|
||||||
threads::mac::detail::safe_delay_until(&sWakeTime);
|
|
||||||
#endif
|
#endif
|
||||||
if (xtime_cmp(xt, xt2) >= 0)
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void thread::yield()
|
void thread::yield()
|
||||||
@@ -249,8 +192,6 @@ void thread::yield()
|
|||||||
xtime_get(&xt, TIME_UTC);
|
xtime_get(&xt, TIME_UTC);
|
||||||
sleep(xt);
|
sleep(xt);
|
||||||
# endif
|
# endif
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
MPYield();
|
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -32,8 +32,7 @@ namespace
|
|||||||
#define DllMain DllEntryPoint
|
#define DllMain DllEntryPoint
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
extern "C"
|
BOOL APIENTRY DllMain(HANDLE module, DWORD reason, LPVOID)
|
||||||
BOOL WINAPI DllMain(HANDLE module, DWORD reason, LPVOID)
|
|
||||||
{
|
{
|
||||||
switch (reason)
|
switch (reason)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -10,14 +10,11 @@
|
|||||||
// It is provided "as is" without express or implied warranty.
|
// It is provided "as is" without express or implied warranty.
|
||||||
|
|
||||||
namespace {
|
namespace {
|
||||||
const int MILLISECONDS_PER_SECOND = 1000;
|
const unsigned MILLISECONDS_PER_SECOND = 1000;
|
||||||
const int NANOSECONDS_PER_SECOND = 1000000000;
|
const unsigned NANOSECONDS_PER_SECOND = 1000000000;
|
||||||
const int NANOSECONDS_PER_MILLISECOND = 1000000;
|
const unsigned NANOSECONDS_PER_MILLISECOND = 1000000;
|
||||||
|
|
||||||
const int MICROSECONDS_PER_SECOND = 1000000;
|
inline void to_time(unsigned milliseconds, boost::xtime& xt)
|
||||||
const int NANOSECONDS_PER_MICROSECOND = 1000;
|
|
||||||
|
|
||||||
inline void to_time(int milliseconds, boost::xtime& xt)
|
|
||||||
{
|
{
|
||||||
int res = 0;
|
int res = 0;
|
||||||
res = boost::xtime_get(&xt, boost::TIME_UTC);
|
res = boost::xtime_get(&xt, boost::TIME_UTC);
|
||||||
@@ -38,14 +35,14 @@ namespace {
|
|||||||
{
|
{
|
||||||
ts.tv_sec = static_cast<int>(xt.sec);
|
ts.tv_sec = static_cast<int>(xt.sec);
|
||||||
ts.tv_nsec = static_cast<int>(xt.nsec);
|
ts.tv_nsec = static_cast<int>(xt.nsec);
|
||||||
if(ts.tv_nsec > static_cast<const int>(NANOSECONDS_PER_SECOND))
|
if(ts.tv_nsec > NANOSECONDS_PER_SECOND)
|
||||||
{
|
{
|
||||||
ts.tv_sec += ts.tv_nsec / NANOSECONDS_PER_SECOND;
|
ts.tv_sec += ts.tv_nsec / NANOSECONDS_PER_SECOND;
|
||||||
ts.tv_nsec %= NANOSECONDS_PER_SECOND;
|
ts.tv_nsec %= NANOSECONDS_PER_SECOND;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
inline void to_time(int milliseconds, timespec& ts)
|
inline void to_time(unsigned milliseconds, timespec& ts)
|
||||||
{
|
{
|
||||||
boost::xtime xt;
|
boost::xtime xt;
|
||||||
to_time(milliseconds, xt);
|
to_time(milliseconds, xt);
|
||||||
@@ -74,7 +71,7 @@ namespace {
|
|||||||
ts.tv_sec -= 1;
|
ts.tv_sec -= 1;
|
||||||
ts.tv_nsec += NANOSECONDS_PER_SECOND;
|
ts.tv_nsec += NANOSECONDS_PER_SECOND;
|
||||||
}
|
}
|
||||||
if(ts.tv_nsec > static_cast<const int>(NANOSECONDS_PER_SECOND))
|
if(ts.tv_nsec > NANOSECONDS_PER_SECOND)
|
||||||
{
|
{
|
||||||
ts.tv_sec += ts.tv_nsec / NANOSECONDS_PER_SECOND;
|
ts.tv_sec += ts.tv_nsec / NANOSECONDS_PER_SECOND;
|
||||||
ts.tv_nsec %= NANOSECONDS_PER_SECOND;
|
ts.tv_nsec %= NANOSECONDS_PER_SECOND;
|
||||||
@@ -83,7 +80,7 @@ namespace {
|
|||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
inline void to_duration(const boost::xtime& xt, int& milliseconds)
|
inline void to_duration(const boost::xtime& xt, unsigned& milliseconds)
|
||||||
{
|
{
|
||||||
boost::xtime cur;
|
boost::xtime cur;
|
||||||
int res = 0;
|
int res = 0;
|
||||||
@@ -94,26 +91,9 @@ namespace {
|
|||||||
milliseconds = 0;
|
milliseconds = 0;
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
milliseconds = ((xt.sec - cur.sec) * MILLISECONDS_PER_SECOND) +
|
milliseconds = static_cast<unsigned>(((xt.sec - cur.sec) * MILLISECONDS_PER_SECOND) +
|
||||||
(((xt.nsec - cur.nsec) + (NANOSECONDS_PER_MILLISECOND/2)) /
|
(((xt.nsec - cur.nsec) + (NANOSECONDS_PER_MILLISECOND/2)) /
|
||||||
NANOSECONDS_PER_MILLISECOND);
|
NANOSECONDS_PER_MILLISECOND));
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
inline void to_microduration(const boost::xtime& xt, int& microseconds)
|
|
||||||
{
|
|
||||||
boost::xtime cur;
|
|
||||||
int res = 0;
|
|
||||||
res = boost::xtime_get(&cur, boost::TIME_UTC);
|
|
||||||
assert(res == boost::TIME_UTC);
|
|
||||||
|
|
||||||
if (xt.sec < cur.sec || (xt.sec == cur.sec && xt.nsec < cur.nsec))
|
|
||||||
microseconds = 0;
|
|
||||||
else
|
|
||||||
{
|
|
||||||
microseconds = ((xt.sec - cur.sec) * MICROSECONDS_PER_SECOND) +
|
|
||||||
(((xt.nsec - cur.nsec) + (NANOSECONDS_PER_MICROSECOND/2)) /
|
|
||||||
NANOSECONDS_PER_MICROSECOND);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
102
src/tss.cpp
102
src/tss.cpp
@@ -72,72 +72,6 @@ namespace {
|
|||||||
return handlers;
|
return handlers;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
#include <map>
|
|
||||||
namespace {
|
|
||||||
typedef std::pair<void(*)(void*), void*> cleanup_info;
|
|
||||||
typedef std::map<int, cleanup_info> cleanup_handlers;
|
|
||||||
|
|
||||||
TaskStorageIndex key;
|
|
||||||
boost::once_flag once = BOOST_ONCE_INIT;
|
|
||||||
|
|
||||||
void init_cleanup_key()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = MPAllocateTaskStorageIndex(&key);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup_handlers* get_handlers()
|
|
||||||
{
|
|
||||||
boost::call_once(&init_cleanup_key, once);
|
|
||||||
|
|
||||||
cleanup_handlers* handlers = reinterpret_cast<cleanup_handlers*>(MPGetTaskStorageValue(key));
|
|
||||||
if (!handlers)
|
|
||||||
{
|
|
||||||
try
|
|
||||||
{
|
|
||||||
handlers = new cleanup_handlers;
|
|
||||||
}
|
|
||||||
catch (...)
|
|
||||||
{
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
OSStatus lStatus = noErr;
|
|
||||||
lStatus = MPSetTaskStorageValue(key, reinterpret_cast<TaskStorageValue>(handlers));
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
// TODO - create a generalized mechanism for registering thread exit functions
|
|
||||||
// and use it here.
|
|
||||||
}
|
|
||||||
|
|
||||||
return handlers;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
namespace boost {
|
|
||||||
|
|
||||||
namespace detail {
|
|
||||||
|
|
||||||
|
|
||||||
void thread_cleanup()
|
|
||||||
{
|
|
||||||
cleanup_handlers* handlers = reinterpret_cast<cleanup_handlers*>(MPGetTaskStorageValue(key));
|
|
||||||
if(handlers != NULL)
|
|
||||||
{
|
|
||||||
for (cleanup_handlers::iterator it = handlers->begin(); it != handlers->end(); ++it)
|
|
||||||
{
|
|
||||||
cleanup_info info = it->second;
|
|
||||||
if (info.second)
|
|
||||||
info.first(info.second);
|
|
||||||
}
|
|
||||||
delete handlers;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
} // namespace boost
|
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
namespace boost { namespace detail {
|
namespace boost { namespace detail {
|
||||||
@@ -202,42 +136,6 @@ bool tss::set(void* value)
|
|||||||
{
|
{
|
||||||
return pthread_setspecific(m_key, value) == 0;
|
return pthread_setspecific(m_key, value) == 0;
|
||||||
}
|
}
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
tss::tss(void (*cleanup)(void*))
|
|
||||||
{
|
|
||||||
OSStatus lStatus = MPAllocateTaskStorageIndex(&m_key);
|
|
||||||
if(lStatus != noErr)
|
|
||||||
throw thread_resource_error();
|
|
||||||
|
|
||||||
m_cleanup = cleanup;
|
|
||||||
}
|
|
||||||
|
|
||||||
tss::~tss()
|
|
||||||
{
|
|
||||||
OSStatus lStatus = MPDeallocateTaskStorageIndex(m_key);
|
|
||||||
assert(lStatus == noErr);
|
|
||||||
}
|
|
||||||
|
|
||||||
void* tss::get() const
|
|
||||||
{
|
|
||||||
TaskStorageValue ulValue = MPGetTaskStorageValue(m_key);
|
|
||||||
return(reinterpret_cast<void *>(ulValue));
|
|
||||||
}
|
|
||||||
|
|
||||||
bool tss::set(void* value)
|
|
||||||
{
|
|
||||||
if (value && m_cleanup)
|
|
||||||
{
|
|
||||||
cleanup_handlers* handlers = get_handlers();
|
|
||||||
assert(handlers);
|
|
||||||
if (!handlers)
|
|
||||||
return false;
|
|
||||||
cleanup_info info(m_cleanup, value);
|
|
||||||
(*handlers)[m_key] = info;
|
|
||||||
}
|
|
||||||
OSStatus lStatus = MPSetTaskStorageValue(m_key, reinterpret_cast<TaskStorageValue>(value));
|
|
||||||
return(lStatus == noErr);
|
|
||||||
}
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
} // namespace detail
|
} // namespace detail
|
||||||
|
|||||||
@@ -15,61 +15,10 @@
|
|||||||
# include <windows.h>
|
# include <windows.h>
|
||||||
#elif defined(BOOST_HAS_GETTIMEOFDAY)
|
#elif defined(BOOST_HAS_GETTIMEOFDAY)
|
||||||
# include <sys/time.h>
|
# include <sys/time.h>
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
# include <DriverServices.h>
|
|
||||||
# include <boost/thread/detail/force_cast.hpp>
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
namespace boost {
|
namespace boost {
|
||||||
|
|
||||||
#ifdef BOOST_HAS_MPTASKS
|
|
||||||
|
|
||||||
namespace detail
|
|
||||||
{
|
|
||||||
|
|
||||||
using thread::force_cast;
|
|
||||||
|
|
||||||
struct startup_time_info
|
|
||||||
{
|
|
||||||
startup_time_info()
|
|
||||||
{
|
|
||||||
// 1970 Jan 1 at 00:00:00
|
|
||||||
static const DateTimeRec k_sUNIXBase = {1970, 1, 1, 0, 0, 0, 0};
|
|
||||||
static unsigned long s_ulUNIXBaseSeconds = 0UL;
|
|
||||||
|
|
||||||
if(s_ulUNIXBaseSeconds == 0UL)
|
|
||||||
{
|
|
||||||
// calculate the number of seconds between the Mac OS base and the UNIX base
|
|
||||||
// the first time we enter this constructor.
|
|
||||||
DateToSeconds(&k_sUNIXBase, &s_ulUNIXBaseSeconds);
|
|
||||||
}
|
|
||||||
|
|
||||||
unsigned long ulSeconds;
|
|
||||||
|
|
||||||
// get the time in UpTime units twice, with the time in seconds in the middle.
|
|
||||||
uint64_t ullFirstUpTime = force_cast<uint64_t>(UpTime());
|
|
||||||
GetDateTime(&ulSeconds);
|
|
||||||
uint64_t ullSecondUpTime = force_cast<uint64_t>(UpTime());
|
|
||||||
|
|
||||||
// calculate the midpoint of the two UpTimes, and save that.
|
|
||||||
uint64_t ullAverageUpTime = (ullFirstUpTime + ullSecondUpTime) / 2ULL;
|
|
||||||
m_sStartupAbsoluteTime = force_cast<AbsoluteTime>(ullAverageUpTime);
|
|
||||||
|
|
||||||
// save the number of seconds, recentered at the UNIX base.
|
|
||||||
m_ulStartupSeconds = ulSeconds - s_ulUNIXBaseSeconds;
|
|
||||||
}
|
|
||||||
|
|
||||||
AbsoluteTime m_sStartupAbsoluteTime;
|
|
||||||
UInt32 m_ulStartupSeconds;
|
|
||||||
};
|
|
||||||
|
|
||||||
static startup_time_info g_sStartupTimeInfo;
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
||||||
|
|
||||||
int xtime_get(struct xtime* xtp, int clock_type)
|
int xtime_get(struct xtime* xtp, int clock_type)
|
||||||
{
|
{
|
||||||
if (clock_type == TIME_UTC)
|
if (clock_type == TIME_UTC)
|
||||||
@@ -94,19 +43,6 @@ int xtime_get(struct xtime* xtp, int clock_type)
|
|||||||
xtp->sec = ts.tv_sec;
|
xtp->sec = ts.tv_sec;
|
||||||
xtp->nsec = ts.tv_nsec;
|
xtp->nsec = ts.tv_nsec;
|
||||||
return clock_type;
|
return clock_type;
|
||||||
#elif defined(BOOST_HAS_MPTASKS)
|
|
||||||
using detail::thread::force_cast;
|
|
||||||
// the Mac OS does not have an MP-safe way of getting the date/time, so we use a
|
|
||||||
// delta from the startup time. We _could_ defer this and use something that is
|
|
||||||
// interrupt-safe, but this would be _SLOW_, and we need speed here.
|
|
||||||
const uint64_t k_ullNanosecondsPerSecond(1000ULL * 1000ULL * 1000ULL);
|
|
||||||
AbsoluteTime sUpTime(UpTime());
|
|
||||||
uint64_t ullNanoseconds(force_cast<uint64_t>(AbsoluteDeltaToNanoseconds(sUpTime, detail::g_sStartupTimeInfo.m_sStartupAbsoluteTime)));
|
|
||||||
uint64_t ullSeconds = (ullNanoseconds / k_ullNanosecondsPerSecond);
|
|
||||||
ullNanoseconds -= (ullSeconds * k_ullNanosecondsPerSecond);
|
|
||||||
xtp->sec = detail::g_sStartupTimeInfo.m_ulStartupSeconds + ullSeconds;
|
|
||||||
xtp->nsec = ullNanoseconds;
|
|
||||||
return clock_type;
|
|
||||||
#else
|
#else
|
||||||
# error "xtime_get implementation undefined"
|
# error "xtime_get implementation undefined"
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
@@ -1,2 +0,0 @@
|
|||||||
bin
|
|
||||||
*.pdb
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user