Multi platform plug-in development made easy!

/*!

\section terms_of_use Terms of Use

libspl - the simple plugin layer library.
Copyright (C) 2004 Andreas Loeffler and Ren� Stuhr (www.unitedbytes.de).

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

\section author Author
Ren� Stuhr (www.unitedbytes.de)

*/

//---------------------------------------------------------------------------------------------------------------------------
/// @file		spl_mutex.h
/// @version	1.0
/// @brief		Cross platform mutex class.
/// @author		Ren� Stuhr
/// @remarks	All thread safe classes of SPL are derivated from this class. 
//---------------------------------------------------------------------------------------------------------------------------

#ifndef		__SPL_MUTEX_H__
#define		__SPL_MUTEX_H__

#ifndef		__SPL_PLATFORM_H__
#include	"spl_platform.h"
#endif

#if				SPL_PLATFORM == SPL_PLATFORM_LINUX
	#include	<errno.h>
	#include	<pthread.h>
#endif

#if				SPL_PLATFORM == SPL_PLATFORM_WIN32
	#include	<windows.h>
#endif

#ifndef		EBUSY
#define		EBUSY	16	
#endif

#if SPL_PLATFORM == SPL_PLATFORM_WIN32
	#if		defined ( SPL_MAKE_DLL )
		#define SPL_API		__declspec( dllexport )
	#elif	defined ( SPL_USE_DLL )
		#define SPL_API		__declspec( dllimport )
	#else 
		#define SPL_API	
	#endif
#else
	#define SPL_API 
#endif

namespace SPL 
{

//---------------------------------------------------------------------------------------------------------------------------
///	@brief		Multiplatform mutex class.
///	@ingroup	SPL
//---------------------------------------------------------------------------------------------------------------------------
class slcMutex
{
	//
	//-----------------------------------------------------------------------------------------------------------------------
	//***********************************************     CON/DESTRUCTION     ***********************************************
	//-----------------------------------------------------------------------------------------------------------------------
	//
public:

	//-----------------------------------------------------------------------------------------------------------------------
	///	@brief		Default constructor.
	//-----------------------------------------------------------------------------------------------------------------------
	SPL_API slcMutex( void );

	//-----------------------------------------------------------------------------------------------------------------------
	///	@brief		Default destructor.
	//-----------------------------------------------------------------------------------------------------------------------
	virtual SPL_API ~slcMutex( void );

	//
	//-----------------------------------------------------------------------------------------------------------------------
	//************************************************     MODIFICATION     *************************************************
	//-----------------------------------------------------------------------------------------------------------------------
	//
public:

	//-----------------------------------------------------------------------------------------------------------------------
	///	@brief		Locks a section - If section is already busy then block and wait until it's ready again.
	//-----------------------------------------------------------------------------------------------------------------------
	virtual void SPL_API Lock( void );

	//-----------------------------------------------------------------------------------------------------------------------
	///	@brief		Locks a section - If section is busy, return without blocking.
	///	@return		The method returns one of the following values:
	///	@retval		EBUSY | Section is still locked from another caller.
	///	@retval		0     | Section is now locked by current call.
	//-----------------------------------------------------------------------------------------------------------------------
	virtual long SPL_API TryLock( void );

	//-----------------------------------------------------------------------------------------------------------------------
	///	@brief		Unlocks a section.
	//-----------------------------------------------------------------------------------------------------------------------
	virtual void SPL_API Unlock( void );

	//
	//-----------------------------------------------------------------------------------------------------------------------
	//*************************************************     ATTRIBUTES     **************************************************
	//-----------------------------------------------------------------------------------------------------------------------
	//
private:

#if	SPL_PLATFORM == SPL_PLATFORM_WIN32		
	
	HANDLE				m_access;				///< WIN32 mutex.
	SECURITY_ATTRIBUTES m_sa;

#elif SPL_PLATFORM == SPL_PLATFORM_LINUX

	pthread_mutex_t		m_access;				///< POSIX mutex.

#endif	
};

} // End of namespace SPL

#endif	// __SPL_MUTEX_H__