From 307bbdc951fa5ea59a4fa3512a24d061d76ddea3 Mon Sep 17 00:00:00 2001 From: Beman Dawes Date: Wed, 25 Jul 2001 20:10:39 +0000 Subject: [PATCH] Format updated. [SVN r10707] --- doc/mutex.html | 66 +++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 52 insertions(+), 14 deletions(-) diff --git a/doc/mutex.html b/doc/mutex.html index 6d329e24..d1d67573 100644 --- a/doc/mutex.html +++ b/doc/mutex.html @@ -3,6 +3,7 @@ + Boost.Threads, mutex @@ -22,6 +23,18 @@
+

Introduction
+Header
+Class mutex Synopsis
+Class mutex Members
+Class try_mutex Synopsis
+Class try_mutex Members
+Class timed_mutex Synopsis
+Class timed_mutex Members
+Example

+ +

Introduction

+

The mutex, try_mutex and timed_mutex classes define full featured mutex models. These type should be used to synchronize access to shared resources when recursive locking mechanics need not be employed. Each type adds another @@ -43,18 +56,16 @@ not defined.

Programmers should assume that threads waiting for a lock on these mutex types shall acquire the lock in a random order, though the specific behavior for a given platform may be different.

-

Header

+

Header

 #include <boost/thread/mutex.hpp>
-

Public Interface

- -
+

Class mutex Synopsis

-    class mutex : private boost::noncopyable
+    class mutex : private boost::noncopyable
     {
     public:
         typedef boost::basic_lock<mutex> lock;
@@ -64,7 +75,11 @@ the lock in a random order, though the specific behavior for a given platform ma
     };
-
+

+ Class mutex Members +

+ +

Constructor

@@ -74,15 +89,21 @@ the lock in a random order, though the specific behavior for a given platform ma

Constructs a mutex.

+
+

Destructor

     ~mutex();
-

Destructs a mutex.

+

Destroys *this.

-
+
+ +

+ Class try_mutex Synopsis +

     class try_mutex : private boost::noncopyable
@@ -96,7 +117,9 @@ the lock in a random order, though the specific behavior for a given platform ma
     };
-
+

Class try_mutex Members

+ +

Constructor

@@ -106,15 +129,21 @@ the lock in a random order, though the specific behavior for a given platform ma

Constructs a try_mutex.

+
+

Destructor

     ~try_mutex();
-

Destructs a try_mutex.

+

Destroys *this.

-
+
+ +

+ Class timed_mutex Synopsis +

     class timed_mutex : private boost::noncopyable
@@ -129,7 +158,9 @@ the lock in a random order, though the specific behavior for a given platform ma
     };
-
+

Class timed_mutex Members

+ +

Constructor

@@ -139,15 +170,19 @@ the lock in a random order, though the specific behavior for a given platform ma

Constructs a timed_mutex.

+
+

Destructor

     ~timed_mutex();
-

Destructs a mutex.

+

Destroys *this.

-

Example Usage

+
+ +

Example Usage

 #include <boost/thread/mutex.hpp>
@@ -203,6 +238,9 @@ count == 4
 
 

 
+
Revised 25 July, 2001
+

+
 
Copyright William E. Kempf
 2001 all rights reserved.