eapol/eapol_framework/eapol_symbian/am/include/eap_am_tools_symbian.h
changeset 49 43351a4f2da3
parent 26 9abfd4f00d37
equal deleted inserted replaced
47:712b4ffd76bb 49:43351a4f2da3
    14 * Description:  EAP and WLAN authentication protocols.
    14 * Description:  EAP and WLAN authentication protocols.
    15 *
    15 *
    16 */
    16 */
    17 
    17 
    18 /*
    18 /*
    19 * %version: %
    19 * %version: 7 %
    20 */
    20 */
    21 
    21 
    22 // INCLUDES
    22 // INCLUDES
    23 #if !defined( _EAP_AM_TOOLS_SYMBIAN_H_ )
    23 #if !defined( _EAP_AM_TOOLS_SYMBIAN_H_ )
    24 #define _EAP_AM_TOOLS_SYMBIAN_H_
    24 #define _EAP_AM_TOOLS_SYMBIAN_H_
    31 #include "eap_am_tools.h"
    31 #include "eap_am_tools.h"
    32 #include "eap_variable_data.h"
    32 #include "eap_variable_data.h"
    33 #include "eap_tools.h"
    33 #include "eap_tools.h"
    34 #include "eap_status.h"
    34 #include "eap_status.h"
    35 #include "eap_am_export.h"
    35 #include "eap_am_export.h"
       
    36 // Start: added by script change_export_macros.sh.
       
    37 #if defined(EAP_NO_EXPORT_EAP_AM_TOOLS_SYMBIAN_H)
       
    38 	#define EAP_CLASS_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H EAP_NONSHARABLE 
       
    39 	#define EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H 
       
    40 	#define EAP_C_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H 
       
    41 	#define EAP_FUNC_EXPORT_EAP_AM_TOOLS_SYMBIAN_H 
       
    42 	#define EAP_C_FUNC_EXPORT_EAP_AM_TOOLS_SYMBIAN_H 
       
    43 #elif defined(EAP_EXPORT_EAP_AM_TOOLS_SYMBIAN_H)
       
    44 	#define EAP_CLASS_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H EAP_EXPORT 
       
    45 	#define EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H EAP_FUNC_EXPORT 
       
    46 	#define EAP_C_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H EAP_C_FUNC_EXPORT 
       
    47 	#define EAP_FUNC_EXPORT_EAP_AM_TOOLS_SYMBIAN_H EAP_FUNC_EXPORT 
       
    48 	#define EAP_C_FUNC_EXPORT_EAP_AM_TOOLS_SYMBIAN_H EAP_C_FUNC_EXPORT 
       
    49 #else
       
    50 	#define EAP_CLASS_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H EAP_IMPORT 
       
    51 	#define EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H EAP_FUNC_IMPORT 
       
    52 	#define EAP_C_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H EAP_C_FUNC_IMPORT 
       
    53 	#define EAP_FUNC_EXPORT_EAP_AM_TOOLS_SYMBIAN_H 
       
    54 	#define EAP_C_FUNC_EXPORT_EAP_AM_TOOLS_SYMBIAN_H 
       
    55 #endif
       
    56 // End: added by script change_export_macros.sh.
    36 #include "eap_am_crypto_symbian.h"
    57 #include "eap_am_crypto_symbian.h"
    37 #include "eap_timer_queue.h"
    58 #include "eap_timer_queue.h"
    38 #include "eap_am_mutex_symbian.h"
    59 #include "eap_am_mutex_symbian.h"
    39 #include <f32file.h>
    60 #include <f32file.h>
    40 #include <d32dbms.h>
    61 #include <d32dbms.h>
    41 
    62 
    42 /// This class implements functionality of platform adaptation of Symbian.
    63 /// This class implements functionality of platform adaptation of Symbian.
    43 /**
    64 /**
    44  *	See function comments on abs_eap_am_tools_c and eap_am_tools_c.
    65  *	See function comments on abs_eap_am_tools_c and eap_am_tools_c.
    45  */
    66  */
    46 class EAP_EXPORT eap_am_tools_symbian_c
    67 class EAP_CLASS_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_am_tools_symbian_c
    47 : public eap_am_tools_c
    68 : public eap_am_tools_c
    48 //, public CActive
    69 //, public CActive
    49 , public CTimer
    70 , public CTimer
    50 {
    71 {
    51 private:
    72 private:
   104 	// This flag tells whether the trace log file is open.
   125 	// This flag tells whether the trace log file is open.
   105 	bool m_logfile_open;
   126 	bool m_logfile_open;
   106 
   127 
   107 	// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
   128 	// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
   108 
   129 
   109 	EAP_FUNC_IMPORT void sprint(TDes& KPrintBuf, eap_const_string format, ...);
   130 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void sprint(TDes& KPrintBuf, eap_const_string format, ...);
   110 
   131 
   111 	EAP_FUNC_IMPORT void KFormatVArgs(TDes& aDes, const TDesC& aFmt, VA_LIST aList);
   132 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void KFormatVArgs(TDes& aDes, const TDesC& aFmt, VA_LIST aList);
   112 
   133 
   113 	// Member function to support active sceduler timer.
   134 	// Member function to support active sceduler timer.
   114 	void StartTimer(const TUint aInterval);
   135 	void StartTimer(const TUint aInterval);
   115 	void StopTimer();
   136 	void StopTimer();
   116 	TBool TimerRunning();
   137 	TBool TimerRunning();
   119 
   140 
   120 	u32_t limit_microsecond_timeout(u32_t next_timeout_millisecond);
   141 	u32_t limit_microsecond_timeout(u32_t next_timeout_millisecond);
   121 
   142 
   122 	// On purpose unimplemented constructors.
   143 	// On purpose unimplemented constructors.
   123 	eap_am_tools_symbian_c(eap_am_tools_symbian_c &source);
   144 	eap_am_tools_symbian_c(eap_am_tools_symbian_c &source);
       
   145 
       
   146 	// On purpose unimplemented operator.
   124 	const eap_am_tools_symbian_c & operator=(const eap_am_tools_symbian_c& source);
   147 	const eap_am_tools_symbian_c & operator=(const eap_am_tools_symbian_c& source);
   125 
   148 
       
   149 	void set_default_trace_mask();
       
   150 
   126 public:
   151 public:
   127 
   152 
   128 	EAP_FUNC_IMPORT virtual ~eap_am_tools_symbian_c();
   153 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H virtual ~eap_am_tools_symbian_c();
   129 
   154 
   130 	EAP_FUNC_IMPORT eap_am_tools_symbian_c(eap_const_string pfilename);
   155 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_am_tools_symbian_c(eap_const_string pfilename);
   131 
   156 
   132 
   157 
   133 	/// See function comments on abs_eap_am_tools_c and eap_am_tools_c.
   158 	/// See function comments on abs_eap_am_tools_c and eap_am_tools_c.
   134 
   159 
   135 	EAP_FUNC_IMPORT eap_status_e configure();
   160 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e configure();
   136 
   161 
   137 	EAP_FUNC_IMPORT bool get_use_eap_milli_second_timer();
   162 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H bool get_use_eap_milli_second_timer();
   138 
   163 
   139 	EAP_FUNC_IMPORT void set_use_eap_milli_second_timer(
   164 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void set_use_eap_milli_second_timer(
   140 		const bool use_eap_millisecond_timer);
   165 		const bool use_eap_millisecond_timer);
   141 
   166 
   142 	EAP_FUNC_IMPORT void enter_global_mutex();
   167 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void enter_global_mutex();
   143 
   168 
   144 	EAP_FUNC_IMPORT void leave_global_mutex();
   169 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void leave_global_mutex();
   145 
   170 
   146 	EAP_FUNC_IMPORT abs_eap_am_mutex_c * get_global_mutex();
   171 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H abs_eap_am_mutex_c * get_global_mutex();
   147 
   172 
   148 	EAP_FUNC_IMPORT void enter_trace_mutex();
   173 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void enter_trace_mutex();
   149 
   174 
   150 	EAP_FUNC_IMPORT void leave_trace_mutex();
   175 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void leave_trace_mutex();
   151 
   176 
   152 	EAP_FUNC_IMPORT abs_eap_am_mutex_c * get_trace_mutex();
   177 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H abs_eap_am_mutex_c * get_trace_mutex();
   153 
   178 
   154 
   179 
   155 	EAP_FUNC_IMPORT void set_timer_resolution_ms(const u32_t timer_resolution_ms);
   180 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void set_timer_resolution_ms(const u32_t timer_resolution_ms);
   156 
   181 
   157 	EAP_FUNC_IMPORT u32_t get_timer_resolution_ms();
   182 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H u32_t get_timer_resolution_ms();
   158 
   183 
   159 	EAP_FUNC_IMPORT u32_t pulse_timer(const u32_t elapsed_time_in_ms);
   184 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H u32_t pulse_timer(const u32_t elapsed_time_in_ms);
   160 
   185 
   161 	EAP_FUNC_IMPORT bool get_timer_queue_is_empty();
   186 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H bool get_timer_queue_is_empty();
   162 
   187 
   163 
   188 
   164 	EAP_FUNC_IMPORT eap_status_e start_timer_thread();
   189 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e start_timer_thread();
   165 
   190 
   166 	EAP_FUNC_IMPORT eap_status_e stop_timer_thread();
   191 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e stop_timer_thread();
   167 
   192 
   168 	EAP_FUNC_IMPORT bool get_is_timer_thread_active();
   193 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H bool get_is_timer_thread_active();
   169 
   194 
   170 
   195 
   171 	EAP_FUNC_IMPORT eap_status_e set_trace_prefix(
   196 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e set_trace_prefix(
   172 		const eap_variable_data_c * const prefix8bit);
   197 		const eap_variable_data_c * const prefix8bit);
   173 
   198 
   174 	EAP_FUNC_IMPORT eap_status_e set_trace_file_name(const eap_variable_data_c * const trace_output_file);
   199 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e set_trace_file_name(const eap_variable_data_c * const trace_output_file);
   175 
   200 
   176 	EAP_FUNC_IMPORT void set_max_trace_file_size(const u32_t max_trace_file_size);
   201 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void set_max_trace_file_size(const u32_t max_trace_file_size);
   177 
   202 
   178 	EAP_FUNC_IMPORT u32_t snprintf(u8_t * const buffer, u32_t buffer_size, eap_format_string format, ...);
   203 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H u32_t snprintf(u8_t * const buffer, u32_t buffer_size, eap_format_string format, ...);
   179 
   204 
   180 	EAP_FUNC_IMPORT void formatted_print(eap_format_string format, ...);
   205 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void formatted_print(eap_format_string format, ...);
   181 
   206 
   182 	EAP_FUNC_IMPORT void memmove(void *dest, const void *src, const u32_t count);
   207 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void memmove(void *dest, const void *src, const u32_t count);
   183 
   208 
   184 	EAP_FUNC_IMPORT i32_t memcmp(const void * const dest, const void * const src, const u32_t count);
   209 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H i32_t memcmp(const void * const dest, const void * const src, const u32_t count);
   185 
   210 
   186 	EAP_FUNC_IMPORT void memset(void * const src, const i32_t fill_byte, const u32_t count);
   211 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void memset(void * const src, const i32_t fill_byte, const u32_t count);
   187 
   212 
   188 	EAP_FUNC_IMPORT void *memchr(
   213 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void *memchr(
   189 		const void *buf,
   214 		const void *buf,
   190 		u8_t character,
   215 		u8_t character,
   191 		u32_t count);
   216 		u32_t count);
   192 
   217 
   193 	EAP_FUNC_IMPORT void *memrchr(
   218 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void *memrchr(
   194 		const void *buf,
   219 		const void *buf,
   195 		u8_t character,
   220 		u8_t character,
   196 		u32_t count);
   221 		u32_t count);
   197 
   222 
   198 	EAP_FUNC_IMPORT u32_t strlen(
   223 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H u32_t strlen(
   199 		eap_const_string string);
   224 		eap_const_string string);
   200 
   225 
   201 	EAP_FUNC_IMPORT u32_t config_strlen(
   226 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H u32_t config_strlen(
   202 		eap_config_string string);
   227 		eap_config_string string);
   203 
   228 
   204 	EAP_FUNC_IMPORT abs_eap_am_crypto_c * get_crypto();
   229 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H abs_eap_am_crypto_c * get_crypto();
   205 
   230 
   206 	EAP_FUNC_IMPORT u64_t get_hardware_ticks();
   231 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H u64_t get_hardware_ticks();
   207 
   232 
   208 	EAP_FUNC_IMPORT u64_t get_hardware_ticks_of_second();
   233 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H u64_t get_hardware_ticks_of_second();
   209 
   234 
   210 	EAP_FUNC_IMPORT u64_t get_clock_ticks();
   235 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H u64_t get_clock_ticks();
   211 
   236 
   212 	EAP_FUNC_IMPORT u64_t get_clock_ticks_of_second();
   237 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H u64_t get_clock_ticks_of_second();
   213 
   238 
   214 	EAP_FUNC_IMPORT u32_t get_gmt_unix_time();
   239 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H u32_t get_gmt_unix_time();
   215 
   240 
   216 	EAP_FUNC_IMPORT eap_status_e am_set_timer(
   241 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e am_set_timer(
   217 		abs_eap_base_timer_c * const initializer, 
   242 		abs_eap_base_timer_c * const initializer, 
   218 		const u32_t id, 
   243 		const u32_t id, 
   219 		void * const data,
   244 		void * const data,
   220 		const u32_t p_time_ms);
   245 		const u32_t p_time_ms);
   221 
   246 
   222 	EAP_FUNC_IMPORT eap_status_e am_cancel_timer(
   247 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e am_cancel_timer(
   223 		abs_eap_base_timer_c * const initializer, 
   248 		abs_eap_base_timer_c * const initializer, 
   224 		const u32_t id);
   249 		const u32_t id);
   225 
   250 
   226 	EAP_FUNC_IMPORT eap_status_e am_cancel_all_timers();
   251 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e am_cancel_all_timers();
   227 
   252 
   228 	EAP_FUNC_IMPORT eap_status_e re_activate_timer_queue();
   253 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e re_activate_timer_queue();
   229 
   254 
   230 	EAP_FUNC_IMPORT void enter_crypto_cs();
   255 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void enter_crypto_cs();
   231 	EAP_FUNC_IMPORT void leave_crypto_cs();
   256 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void leave_crypto_cs();
   232 
   257 
   233 	EAP_FUNC_IMPORT void timer_sleep(u32_t milli_seconds);
   258 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void timer_sleep(u32_t milli_seconds);
   234 
   259 
   235 	EAP_FUNC_IMPORT void sleep(u32_t milli_seconds);
   260 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H void sleep(u32_t milli_seconds);
   236 
   261 
   237 	EAP_FUNC_IMPORT bool get_is_valid() const;
   262 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H bool get_is_valid() const;
   238 
   263 
   239 	EAP_FUNC_IMPORT eap_status_e begin_db_transaction(RDbNamedDatabase& aDatabase);
   264 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e begin_db_transaction(RDbNamedDatabase& aDatabase);
   240 
   265 
   241 	EAP_FUNC_IMPORT eap_status_e begin_db_update(RDbView& aView);
   266 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e begin_db_update(RDbView& aView);
   242 	
   267 	
   243 	EAP_FUNC_IMPORT eap_status_e begin_db_delete(RDbView& aView);
   268 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e begin_db_delete(RDbView& aView);
   244 
   269 
   245 	/// This function must call eap_am_tools_c::shutdown_am_tools().
   270 	/// This function must call eap_am_tools_c::shutdown_am_tools().
   246 	EAP_FUNC_IMPORT eap_status_e shutdown();
   271 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e shutdown();
   247 
   272 
   248 	EAP_FUNC_IMPORT eap_status_e convert_unicode_to_utf8(
   273 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e convert_unicode_to_utf8(
   249 		eap_variable_data_c & dest,
   274 		eap_variable_data_c & dest,
   250 		const eap_variable_data_c & src);
   275 		const eap_variable_data_c & src);
   251 
   276 
   252 	EAP_FUNC_IMPORT eap_status_e convert_utf8_to_unicode(
   277 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e convert_utf8_to_unicode(
   253 		eap_variable_data_c & dest,
   278 		eap_variable_data_c & dest,
   254 		const eap_variable_data_c & src);
   279 		const eap_variable_data_c & src);
   255 
   280 
   256 	EAP_FUNC_IMPORT eap_status_e convert_am_error_to_eapol_error(const i32_t am_error_value);
   281 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e convert_am_error_to_eapol_error(const i32_t am_error_value);
   257 
   282 
   258 	EAP_FUNC_IMPORT i32_t convert_eapol_error_to_am_error(eap_status_e aErr);
   283 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H i32_t convert_eapol_error_to_am_error(eap_status_e aErr);
   259 
   284 
   260 	EAP_FUNC_IMPORT eap_status_e getenv(
   285 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H eap_status_e getenv(
   261 		const eap_variable_data_c * const environment_variable_name,
   286 		const eap_variable_data_c * const environment_variable_name,
   262 		eap_variable_data_c * const environment_variable_value);
   287 		eap_variable_data_c * const environment_variable_value);
   263 
   288 
   264 	EAP_FUNC_IMPORT bool isspace(const u8_t character);
   289 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H bool isspace(const u8_t character);
   265 
   290 
   266 	EAP_FUNC_IMPORT u64_struct u64_t_to_u64_struct(const u64_t value);
   291 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H u64_struct u64_t_to_u64_struct(const u64_t value);
   267 
   292 
   268 	EAP_FUNC_IMPORT u64_t u64_struct_to_u64_t(const u64_struct value);
   293 	EAP_FUNC_VISIBILITY_EAP_AM_TOOLS_SYMBIAN_H u64_t u64_struct_to_u64_t(const u64_struct value);
   269 };
   294 };
   270 
   295 
   271 #endif //#if !defined( _EAP_AM_TOOLS_SYMBIAN_H_ )
   296 #endif //#if !defined( _EAP_AM_TOOLS_SYMBIAN_H_ )
   272 
   297 
   273 
   298