/*

* 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.

*

*/

/*

*/

#if !defined( _EAP_AM_TOOLS_MEMORY_STORE_DATA_H_ )

#define _EAP_AM_TOOLS_MEMORY_STORE_DATA_H_

#include "eap_am_export.h"

#include "eap_tlv_message_data.h"

class eap_variable_data_c;

class abs_eap_am_tools_c;

/// This class is base class for data stored to memory store.

/**

 * Here the functions eap_core_map_c template requires.

 */

class EAP_EXPORT eap_am_memory_store_tlv_data_c

{

private:

	abs_eap_am_tools_c * const m_am_tools;

	eap_tlv_message_data_c m_tlv_data;

	u32_t m_timer_id;

public:

	/**

	 * The destructor of the eap_am_memory_store_tlv_data_c class does nothing special.

	 */

	EAP_FUNC_IMPORT virtual ~eap_am_memory_store_tlv_data_c();

	/**

	 * The constructor of the eap_am_memory_store_tlv_data_c does nothing special.

	 */

	EAP_FUNC_IMPORT eap_am_memory_store_tlv_data_c(

		abs_eap_am_tools_c * const tools);

	EAP_FUNC_IMPORT eap_status_e copy_message_data(

		const eap_tlv_message_data_c * const tlv_data,

		const u32_t timer_id);

	EAP_FUNC_IMPORT u32_t get_timer_id() const;

	/**

	 * This function returns the pointer to the data.

	 * Empty message return NULL pointer.

	 */

	EAP_FUNC_IMPORT void * get_message_data() const;

	/**

	 * This function returns the length of the data.

	 * Empty message return zero.

	 */

	EAP_FUNC_IMPORT u32_t get_message_data_length() const;

	/**

	 * This function should increase reference count.

	 */

	EAP_FUNC_IMPORT void object_increase_reference_count();

	/**

	 * This function should first decrease reference count

	 * and second return the remaining reference count.

	 * Reference count must not be decreased when it is zero.

	 */

	EAP_FUNC_IMPORT u32_t object_decrease_reference_count();

};

#endif //#if !defined( _EAP_AM_TOOLS_MEMORY_STORE_DATA_H_ )

// End.