Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Methods of Class Mutex


Mutex
Mutex();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Create a thread-local mutex.
Return
0 if the mutex could not be created, otherwise a handle to the mutex.
See Also
::osl_createMutex()

~Mutex
~Mutex();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Release the OS-structures and free mutex data-structure.
See Also
::osl_destroyMutex()

acquire
sal_Bool acquire();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Acquire the mutex, block if already acquired by another thread.
Return
sal_False if system-call fails.
See Also
::osl_acquireMutex()

tryToAcquire
sal_Bool tryToAcquire();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Try to acquire the mutex without blocking.
Return
sal_False if it could not be acquired.
See Also
::osl_tryToAcquireMutex()

release
sal_Bool release();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Release the mutex.
Return
sal_False if system-call fails.
See Also
::osl_releaseMutex()

Mutex
Mutex(
const Mutex & );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

Summary
The underlying oslMutex has no reference count.
Description
Since the underlying oslMutex is not a reference counted object, copy constructed Mutex may work on an already destructed oslMutex object.

Mutex
Mutex(
oslMutex Mutex );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

Summary
The underlying oslMutex has no reference count.
Description
When destructed, the Mutex object destroys the undelying oslMutex, which might cause severe problems in case it's a temporary object.

operator=
Mutex & operator=(
const Mutex & );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

Summary
This assignment operator is private for the same reason as the copy constructor.

operator=
Mutex & operator=(
oslMutex );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

Summary
This assignment operator is private for the same reason as the constructor taking a oslMutex argument.

getGlobalMutex
static Mutex * getGlobalMutex();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO YES YES NO

Description
Returns a global static mutex object. The global and static mutex object can be used to initialize other static objects in a thread safe manner.
Return
the global mutex object
See Also
::osl_getGlobalMutex()

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.