1 /* |
|
2 * ============================================================================ |
|
3 * Name : ./accesssec/eapol/eapol_framework/wapi_common/include/abs_wapi_am_core.h |
|
4 * Part of : WAPI / WAPI *** Info from the SWAD |
|
5 * Description : WAPI authentication |
|
6 * Version : %version: 11 % << Don't touch! Updated by Synergy at check-out. |
|
7 * |
|
8 * Copyright © 2001-2009 Nokia. All rights reserved. |
|
9 * This material, including documentation and any related computer |
|
10 * programs, is protected by copyright controlled by Nokia. All |
|
11 * rights are reserved. Copying, including reproducing, storing, |
|
12 * adapting or translating, any or all of this material requires the |
|
13 * prior written consent of Nokia. This material also contains |
|
14 * confidential information which may not be disclosed to others |
|
15 * without the prior written consent of Nokia. |
|
16 * ============================================================================ |
|
17 * Template version: 4.2 |
|
18 */ |
|
19 |
|
20 |
|
21 |
|
22 #if !defined(_ABS_WAPI_AM_CORE_H_) |
|
23 #define _ABS_WAPI_AM_CORE_H_ |
|
24 |
|
25 #if defined(USE_WAPI_CORE) |
|
26 |
|
27 #include "eap_am_export.h" |
|
28 |
|
29 /// This class declares the functions adaptation module of WAPI core |
|
30 /// requires from the WAPI core. |
|
31 class EAP_EXPORT abs_wapi_am_core_c |
|
32 { |
|
33 private: |
|
34 //-------------------------------------------------- |
|
35 |
|
36 //-------------------------------------------------- |
|
37 protected: |
|
38 //-------------------------------------------------- |
|
39 |
|
40 //-------------------------------------------------- |
|
41 public: |
|
42 //-------------------------------------------------- |
|
43 |
|
44 // |
|
45 virtual ~abs_wapi_am_core_c() |
|
46 { |
|
47 } |
|
48 |
|
49 // |
|
50 abs_wapi_am_core_c() |
|
51 { |
|
52 } |
|
53 |
|
54 /** |
|
55 * The set_timer() function initializes timer to be elapsed after time_ms milliseconds. |
|
56 * @param initializer is pointer to object which timer_expired() function will |
|
57 * be called after timer elapses. |
|
58 * @param id is identifier which will be returned in timer_expired() function. |
|
59 * The user selects and interprets the id for this timer. |
|
60 * @param data is pointer to any user selected data which will be returned in timer_expired() function. |
|
61 * @param time_ms is the time of timer in milli seconds. |
|
62 * |
|
63 * Adaptation module internally implements the timer. |
|
64 */ |
|
65 virtual eap_status_e set_timer( |
|
66 abs_eap_base_timer_c * const initializer, |
|
67 const u32_t id, |
|
68 void * const data, |
|
69 const u32_t time_ms) = 0; |
|
70 |
|
71 /** |
|
72 * The cancel_timer() function cancels the timer id initiated by initializer. |
|
73 * @param initializer is pointer to object which set the cancelled timer. |
|
74 * @param id is identifier which will be returned in timer_expired() function. |
|
75 * The user selects and interprets the id for this timer. |
|
76 * |
|
77 * Adaptation module internally implements the timer. |
|
78 */ |
|
79 virtual eap_status_e cancel_timer( |
|
80 abs_eap_base_timer_c * const initializer, |
|
81 const u32_t id) = 0; |
|
82 |
|
83 /** |
|
84 * The set_session_timeout() function changes the session timeout timer to be elapsed after session_timeout_ms milliseconds. |
|
85 */ |
|
86 virtual eap_status_e set_session_timeout( |
|
87 const u32_t session_timeout_ms) = 0; |
|
88 |
|
89 /** |
|
90 * The read_configure() function reads the configuration data identified |
|
91 * by the field string of field_length bytes length. Adaptation module must direct |
|
92 * the query to some persistent store. |
|
93 * @param field is generic configure string idenfying the required configure data. |
|
94 * @param field_length is length of the field string. |
|
95 * @param data is pointer to existing eap_variable_data object. |
|
96 * |
|
97 * WAPI should store it's parameters to an own database. The own database should be accessed |
|
98 * through adaptation module of WAPI. See eap_am_type_gsmsim_simulator_c::type_configure_read. |
|
99 */ |
|
100 virtual eap_status_e read_configure( |
|
101 const eap_configuration_field_c * const field, |
|
102 eap_variable_data_c * const data) = 0; |
|
103 |
|
104 //-------------------------------------------------- |
|
105 }; // class abs_wapi_am_core_c |
|
106 |
|
107 #endif //#if defined(USE_WAPI_CORE) |
|
108 |
|
109 #endif //#if !defined(_ABS_WAPI_AM_CORE_H_) |
|
110 |
|
111 //-------------------------------------------------- |
|
112 |
|
113 // End. |
|