.TH "SbMutex" 3 "Wed May 23 2012" "Version 3.1.3" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SbMutex \- 
.PP
A basic class for managing a mutex\&.
.PP
This class provides a portable framework around the mutex interface of the underlying native thread-handling toolkit\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/threads/SbMutex\&.h>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSbMutex\fP (void)"
.br
.ti -1c
.RI "\fB~SbMutex\fP ()"
.br
.ti -1c
.RI "int \fBlock\fP (void)"
.br
.ti -1c
.RI "SbBool \fBtryLock\fP (void)"
.br
.ti -1c
.RI "int \fBunlock\fP (void)"
.br
.in -1c
.SH "Detailed Description"
.PP 
A basic class for managing a mutex\&.
.PP
This class provides a portable framework around the mutex interface of the underlying native thread-handling toolkit\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SbMutex::SbMutex (void)\fC [inline]\fP"
Constructor\&. 
.SS "SbMutex::~SbMutex ()\fC [inline]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "int SbMutex::lock (void)\fC [inline]\fP"
This method locks the mutex\&. \fC0\fP is returned on success\&.
.PP
If the mutex was previously unlocked, the thread will lock the mutex and continue running\&. If the mutex was already locked when this call is made, the thread will be suspended until the other thread holding the mutex releases it\&.
.PP
This is a blocking operation\&. 
.SS "SbBool SbMutex::tryLock (void)\fC [inline]\fP"
This method tries to lock the mutex, and returns whether it was locked or not\&. This is a non-blocking operation\&. 
.SS "int SbMutex::unlock (void)\fC [inline]\fP"
This method unlocks the mutex\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.