eapol/eapol_framework/wapi_common/include/abs_wapi_am_core.h
changeset 17 8840d3e38314
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eapol/eapol_framework/wapi_common/include/abs_wapi_am_core.h	Fri Mar 19 09:29:58 2010 +0200
@@ -0,0 +1,113 @@
+/*
+* ============================================================================
+*  Name        : ./accesssec/eapol/eapol_framework/wapi_common/include/abs_wapi_am_core.h
+*  Part of     : WAPI / WAPI       *** Info from the SWAD
+*  Description : WAPI authentication
+*  Version     : %version: 11 % << Don't touch! Updated by Synergy at check-out.
+*
+*  Copyright © 2001-2009 Nokia.  All rights reserved.
+*  This material, including documentation and any related computer
+*  programs, is protected by copyright controlled by Nokia.  All
+*  rights are reserved.  Copying, including reproducing, storing,
+*  adapting or translating, any or all of this material requires the
+*  prior written consent of Nokia.  This material also contains
+*  confidential information which may not be disclosed to others
+*  without the prior written consent of Nokia.
+* ============================================================================
+* Template version: 4.2
+*/
+
+
+
+#if !defined(_ABS_WAPI_AM_CORE_H_)
+#define _ABS_WAPI_AM_CORE_H_
+
+#if defined(USE_WAPI_CORE)
+
+#include "eap_am_export.h"
+
+/// This class declares the functions adaptation module of WAPI core
+/// requires from the WAPI core.
+class EAP_EXPORT abs_wapi_am_core_c
+{
+private:
+	//--------------------------------------------------
+
+	//--------------------------------------------------
+protected:
+	//--------------------------------------------------
+
+	//--------------------------------------------------
+public:
+	//--------------------------------------------------
+
+	// 
+	virtual ~abs_wapi_am_core_c()
+	{
+	}
+
+	// 
+	abs_wapi_am_core_c()
+	{
+	}
+
+	/**
+	 * The set_timer() function initializes timer to be elapsed after time_ms milliseconds.
+	 * @param initializer is pointer to object which timer_expired() function will
+	 * be called after timer elapses.
+	 * @param id is identifier which will be returned in timer_expired() function.
+	 * The user selects and interprets the id for this timer.
+	 * @param data is pointer to any user selected data which will be returned in timer_expired() function.
+	 * @param time_ms is the time of timer in milli seconds.
+	 *
+	 * Adaptation module internally implements the timer.
+	 */
+	virtual eap_status_e set_timer(
+		abs_eap_base_timer_c * const initializer, 
+		const u32_t id, 
+		void * const data,
+		const u32_t time_ms) = 0;
+
+	/**
+	 * The cancel_timer() function cancels the timer id initiated by initializer.
+	 * @param initializer is pointer to object which set the cancelled timer.
+	 * @param id is identifier which will be returned in timer_expired() function.
+	 * The user selects and interprets the id for this timer.
+	 *
+	 * Adaptation module internally implements the timer.
+	 */
+	virtual eap_status_e cancel_timer(
+		abs_eap_base_timer_c * const initializer, 
+		const u32_t id) = 0;
+
+	/**
+	 * The set_session_timeout() function changes the session timeout timer to be elapsed after session_timeout_ms milliseconds.
+	 */
+	virtual eap_status_e set_session_timeout(
+		const u32_t session_timeout_ms) = 0;
+
+	/**
+	 * The read_configure() function reads the configuration data identified
+	 * by the field string of field_length bytes length. Adaptation module must direct
+	 * the query to some persistent store.
+	 * @param field is generic configure string idenfying the required configure data.
+	 * @param field_length is length of the field string.
+	 * @param data is pointer to existing eap_variable_data object.
+	 * 
+	 * WAPI should store it's parameters to an own database. The own database should be accessed
+	 * through adaptation module of WAPI. See eap_am_type_gsmsim_simulator_c::type_configure_read.
+	 */
+	virtual eap_status_e read_configure(
+		const eap_configuration_field_c * const field,
+		eap_variable_data_c * const data) = 0;
+
+	//--------------------------------------------------
+}; // class abs_wapi_am_core_c
+
+#endif //#if defined(USE_WAPI_CORE)
+
+#endif //#if !defined(_ABS_WAPI_AM_CORE_H_)
+
+//--------------------------------------------------
+
+// End.