14 * Description: virtual functions of EAP-plugin interface. |
14 * Description: virtual functions of EAP-plugin interface. |
15 * |
15 * |
16 */ |
16 */ |
17 |
17 |
18 /* |
18 /* |
19 * %version: 6 % |
19 * %version: 7 % |
20 */ |
20 */ |
21 |
21 |
22 #if !defined(_EAP_PLUGIN_MESSAGE_BASE_H_) |
22 #if !defined(_EAP_PLUGIN_MESSAGE_BASE_H_) |
23 #define _EAP_PLUGIN_MESSAGE_BASE_H_ |
23 #define _EAP_PLUGIN_MESSAGE_BASE_H_ |
24 |
24 |
25 #include "eap_tools.h" |
25 #include "eap_tools.h" |
26 #include "eap_am_export.h" |
26 #include "eap_am_export.h" |
|
27 // Start: added by script change_export_macros.sh. |
|
28 #if defined(EAP_NO_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H) |
|
29 #define EAP_CLASS_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H EAP_NONSHARABLE |
|
30 #define EAP_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H |
|
31 #define EAP_C_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H |
|
32 #define EAP_FUNC_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H |
|
33 #define EAP_C_FUNC_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H |
|
34 #elif defined(EAP_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H) |
|
35 #define EAP_CLASS_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H EAP_EXPORT |
|
36 #define EAP_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H EAP_FUNC_EXPORT |
|
37 #define EAP_C_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H EAP_C_FUNC_EXPORT |
|
38 #define EAP_FUNC_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H EAP_FUNC_EXPORT |
|
39 #define EAP_C_FUNC_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H EAP_C_FUNC_EXPORT |
|
40 #else |
|
41 #define EAP_CLASS_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H EAP_IMPORT |
|
42 #define EAP_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H EAP_FUNC_IMPORT |
|
43 #define EAP_C_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H EAP_C_FUNC_IMPORT |
|
44 #define EAP_FUNC_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H |
|
45 #define EAP_C_FUNC_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H |
|
46 #endif |
|
47 // End: added by script change_export_macros.sh. |
27 |
48 |
28 class eap_method_settings_c; |
49 class eap_method_settings_c; |
29 class abs_eap_plugin_message_c; |
50 class abs_eap_plugin_message_c; |
30 |
51 |
31 class EAP_EXPORT eap_plugin_message_base_c |
52 class EAP_CLASS_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H eap_plugin_message_base_c |
32 { |
53 { |
33 private: |
54 private: |
34 //-------------------------------------------------- |
55 //-------------------------------------------------- |
35 |
56 |
36 |
57 |
43 //-------------------------------------------------- |
64 //-------------------------------------------------- |
44 |
65 |
45 /** |
66 /** |
46 * The destructor of the eap_core class does nothing special. |
67 * The destructor of the eap_core class does nothing special. |
47 */ |
68 */ |
48 EAP_FUNC_IMPORT virtual ~eap_plugin_message_base_c(); |
69 EAP_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H virtual ~eap_plugin_message_base_c(); |
49 |
70 |
50 /** |
71 /** |
51 * The constructor initializes member attributes using parameters passed to it. |
72 * The constructor initializes member attributes using parameters passed to it. |
52 * @param tools is pointer to the tools class. @see abs_eap_am_tools_c. |
73 * @param tools is pointer to the tools class. @see abs_eap_am_tools_c. |
53 * @param partner is back pointer to object which created this object. |
74 * @param partner is back pointer to object which created this object. |
54 * @param is_client_when_true indicates whether the network entity should act |
75 * @param is_client_when_true indicates whether the network entity should act |
55 * as a client (true) or server (false), in terms of EAP-protocol |
76 * as a client (true) or server (false), in terms of EAP-protocol |
56 * whether this network entity is EAP-supplicant (true) or EAP-authenticator (false). |
77 * whether this network entity is EAP-supplicant (true) or EAP-authenticator (false). |
57 */ |
78 */ |
58 EAP_FUNC_IMPORT eap_plugin_message_base_c(); |
79 EAP_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H eap_plugin_message_base_c(); |
59 |
80 |
60 /** |
81 /** |
61 * This function must reset the state of object to same as |
82 * This function must reset the state of object to same as |
62 * state was after the configure() function call. |
83 * state was after the configure() function call. |
63 * If object reset succeeds this function must return eap_status_ok. |
84 * If object reset succeeds this function must return eap_status_ok. |