From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/a03383.html | 239 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 239 insertions(+) create mode 100644 docs/doxygen/nel/a03383.html (limited to 'docs/doxygen/nel/a03383.html') diff --git a/docs/doxygen/nel/a03383.html b/docs/doxygen/nel/a03383.html new file mode 100644 index 00000000..252f4abd --- /dev/null +++ b/docs/doxygen/nel/a03383.html @@ -0,0 +1,239 @@ + + +NeL: NLMISC::CSharedMutex class Reference + + + +

NLMISC::CSharedMutex Class Reference

#include <mutex.h> +

Detailed Description

+Windows: uses Mutex, the handle can't be shared among processes, but the mutex still can be be shared by passing a common object name to createByName() / createByKey(). Note: the mutex must be explicitely destroyed by calling destroy().

Author:: Olivier Cado
+Nevrax France

Date:: 2002

+ +

+Definition at line 404 of file mutex.h. + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions
bool createByKey (int key, bool createNew)
Create (with createNew to true) or access an existing mutex (created by another process) with a specific key. Returns false if it failed.

CSharedMutex ()
Constructor (does not create the mutex, see createByName()/createByKey()).

void destroy ()
Destroy the mutex.

void enter ()
Enter the critical section.

void leave ()
Leave the critical section.

Private Attributes
int _SemId
The semaphore id.

+

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
NLMISC::CSharedMutex::CSharedMutex ( )
+
+ + + + + +
+ + + +
+Constructor (does not create the mutex, see createByName()/createByKey()). +
+
+

Member Function Documentation

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NLMISC::CSharedMutex::createByKey ( int key,
bool createNew
)
+
+ + + + + +
+ + + +
+Create (with createNew to true) or access an existing mutex (created by another process) with a specific key. Returns false if it failed. +
+
+

+ + + + +
+ + + + + + + + + +
void NLMISC::CSharedMutex::destroy ( )
+
+ + + + + +
+ + + +
+Destroy the mutex. +
+
+

+ + + + +
+ + + + + + + + + +
void NLMISC::CSharedMutex::enter ( )
+
+ + + + + +
+ + + +
+Enter the critical section. +
+
+

+ + + + +
+ + + + + + + + + +
void NLMISC::CSharedMutex::leave ( )
+
+ + + + + +
+ + + +
+Leave the critical section. +
+
+

Field Documentation

+ + + + +
+ + +
int NLMISC::CSharedMutex::_SemId [private] +
+
+ + + + + +
+ + + +
+The semaphore id. +
+ +
+Definition at line 435 of file mutex.h.
+

The documentation for this class was generated from the following file:

mutex.h

Generated on Tue Mar 16 13:32:44 2004 for NeL by + +

+1.3.6

+ + -- cgit v1.2.1


Public Member Functions
bool	createByKey (int key, bool createNew)
	Create (with createNew to true) or access an existing mutex (created by another process) with a specific key. Returns false if it failed.
	CSharedMutex ()
	Constructor (does not create the mutex, see createByName()/createByKey()).
void	destroy ()
	Destroy the mutex.
void	enter ()
	Enter the critical section.
void	leave ()
	Leave the critical section.
Private Attributes
int	_SemId
	The semaphore id.