/*

* Copyright (c) 2001-2006 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  EAP and WLAN authentication protocols.

*

*/

/*

* %version: %

*/

#if !defined( _ABS_EAP_AM_MUTEX_H_ )

#define _ABS_EAP_AM_MUTEX_H_

#include "eap_am_types.h"

#include "eap_variable_data.h"

#include "eap_am_export.h"

class eap_am_mutex_reference_c;

// ---------------------------------------------

/// This class is interface to mutex.

{

private:

public:

	// - - - - - - - - - - - - - - - - - - - - - - - -

	/**

	 * This function enters the mutex. Thread will block until the mutex is released

	 * by other owner of the mutex.

	 */

	/**

	 * This function leaves the mutex. Other blocking thread will continue execution.

	 */

	/**

	 * The mutex handle must be dublicated in Symbian operating system for each thread.

	 */

	/**

	 * This function returns the flag that indicates whether the mutex is reserved. 

	 * This is used in debug asserts. Those will check the mutex is really reserved when critical code is entered.

	 */

	/**

	 * Returns the validity of the mutex.

	 */

#if defined(USE_EAPOL_MUTEX_SEMAPHORE_TRACES)

#endif //#if defined(USE_EAPOL_MUTEX_SEMAPHORE_TRACES)

	// - - - - - - - - - - - - - - - - - - - - - - - -

};

// ---------------------------------------------

/// This class defines a reference counter of a mutex.

{

private:

	/// This is the reference count to the mutex.

	u32_t m_reference_count;

	/// This flag indicates whether the mutex is reserved. 

	/// This is used in debug asserts. Those will check the mutex is really reserved when critical code is entered.

	bool m_is_reserved;

	// On purpose unimplemented constructors.

	eap_am_mutex_reference_c(eap_am_mutex_reference_c &source);

	const eap_am_mutex_reference_c & operator=(const eap_am_mutex_reference_c& source);

public:

	/**

	 * This function adds one reference to the mutex. 

	 */

	/**

	 * This function removes one reference to the mutex. 

	 */

	/**

	 * This function returns the reference count of the mutex. 

	 */

	/**

	 * This function sets the flag that indicates whether the mutex is reserved. 

	 */

	/**

	 * This function returns the flag that indicates whether the mutex is reserved. 

	 * This is used in debug asserts. Those will check the mutex is really reserved when critical code is entered.

	 */

};

// ---------------------------------------------

/// This class is base of the mutex.

{

private:

	eap_am_mutex_reference_c * m_reference;

	bool m_is_valid;

	// On purpose unimplemented constructors.

	eap_am_mutex_base_c(eap_am_mutex_base_c &source);

	const eap_am_mutex_base_c & operator=(const eap_am_mutex_base_c& source);

public:

	/**

	 * This function returns pointer to the reference counter object of the mutex.

	 */

	// - - - - - - - - - - - - - - - - - - - - - - - -

	/**

	 * This function returns the flag that indicates whether the mutex is reserved. 

	 * This is used in debug asserts. Those will check the mutex is really reserved when critical code is entered.

	 */

	/**

	 * Returns the validity of the mutex.

	 */

	// - - - - - - - - - - - - - - - - - - - - - - - -

};

// ---------------------------------------------

#endif //#if !defined( _ABS_EAP_AM_MUTEX_H_ )

// End.