14 * Description: Class creates and reads the messages used in EAP-general settings interface on the client side. |
14 * Description: Class creates and reads the messages used in EAP-general settings interface on the client side. |
15 * |
15 * |
16 */ |
16 */ |
17 |
17 |
18 /* |
18 /* |
19 * %version: 8 % |
19 * %version: 9 % |
20 */ |
20 */ |
21 |
21 |
22 #if !defined(_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H_) |
22 #if !defined(_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H_) |
23 #define _EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H_ |
23 #define _EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_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_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H) |
|
29 #define EAP_CLASS_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H EAP_NONSHARABLE |
|
30 #define EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H |
|
31 #define EAP_C_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H |
|
32 #define EAP_FUNC_EXPORT_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H |
|
33 #define EAP_C_FUNC_EXPORT_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H |
|
34 #elif defined(EAP_EXPORT_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H) |
|
35 #define EAP_CLASS_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H EAP_EXPORT |
|
36 #define EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H EAP_FUNC_EXPORT |
|
37 #define EAP_C_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H EAP_C_FUNC_EXPORT |
|
38 #define EAP_FUNC_EXPORT_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H EAP_FUNC_EXPORT |
|
39 #define EAP_C_FUNC_EXPORT_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H EAP_C_FUNC_EXPORT |
|
40 #else |
|
41 #define EAP_CLASS_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H EAP_IMPORT |
|
42 #define EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H EAP_FUNC_IMPORT |
|
43 #define EAP_C_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H EAP_C_FUNC_IMPORT |
|
44 #define EAP_FUNC_EXPORT_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H |
|
45 #define EAP_C_FUNC_EXPORT_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H |
|
46 #endif |
|
47 // End: added by script change_export_macros.sh. |
27 #include "eap_plugin_message_base.h" |
48 #include "eap_plugin_message_base.h" |
28 #include "abs_eap_am_message_if.h" |
49 #include "abs_eap_am_message_if.h" |
29 #include "eap_array.h" |
50 #include "eap_array.h" |
30 #include "eap_process_tlv_message_data.h" |
51 #include "eap_process_tlv_message_data.h" |
31 #include "eap_general_settings_message.h" |
52 #include "eap_general_settings_message.h" |
34 class eap_am_message_if_c; |
55 class eap_am_message_if_c; |
35 class abs_eap_general_settings_message_c; |
56 class abs_eap_general_settings_message_c; |
36 class eap_tlv_header_c; |
57 class eap_tlv_header_c; |
37 |
58 |
38 /// Class creates and reads the messages used in EAP-general settings interface on the client side. |
59 /// Class creates and reads the messages used in EAP-general settings interface on the client side. |
39 class EAP_EXPORT eap_general_settings_client_message_if_c |
60 class EAP_CLASS_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H eap_general_settings_client_message_if_c |
40 : public abs_eap_am_message_if_c |
61 : public abs_eap_am_message_if_c |
41 , public eap_general_settings_message_c |
62 , public eap_general_settings_message_c |
42 { |
63 { |
43 private: |
64 private: |
44 //-------------------------------------------------- |
65 //-------------------------------------------------- |
91 //-------------------------------------------------- |
112 //-------------------------------------------------- |
92 |
113 |
93 /** |
114 /** |
94 * The destructor of the eap_core class does nothing special. |
115 * The destructor of the eap_core class does nothing special. |
95 */ |
116 */ |
96 EAP_FUNC_IMPORT virtual ~eap_general_settings_client_message_if_c(); |
117 EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H virtual ~eap_general_settings_client_message_if_c(); |
97 |
118 |
98 /** |
119 /** |
99 * The constructor initializes member attributes using parameters passed to it. |
120 * The constructor initializes member attributes using parameters passed to it. |
100 * @param tools is pointer to the tools class. @see abs_eap_am_tools_c. |
121 * @param tools is pointer to the tools class. @see abs_eap_am_tools_c. |
101 * @param client_if is pointer to object which forwards message to the server. |
122 * @param client_if is pointer to object which forwards message to the server. |
102 * @param partner is back pointer to the user of EAP-general settings. |
123 * @param partner is back pointer to the user of EAP-general settings. |
103 */ |
124 */ |
104 EAP_FUNC_IMPORT eap_general_settings_client_message_if_c( |
125 EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H eap_general_settings_client_message_if_c( |
105 abs_eap_am_tools_c * const tools, |
126 abs_eap_am_tools_c * const tools, |
106 eap_am_message_if_c * const client_if, |
127 eap_am_message_if_c * const client_if, |
107 abs_eap_general_settings_message_c * const partner); |
128 abs_eap_general_settings_message_c * const partner); |
108 |
129 |
109 /** |
130 /** |
111 * state was after the configure() function call. |
132 * state was after the configure() function call. |
112 * If object reset succeeds this function must return eap_status_ok. |
133 * If object reset succeeds this function must return eap_status_ok. |
113 * If object reset fails this function must return corresponding error status. |
134 * If object reset fails this function must return corresponding error status. |
114 * @return This function returns the status of reset operation. |
135 * @return This function returns the status of reset operation. |
115 */ |
136 */ |
116 EAP_FUNC_IMPORT eap_status_e reset(); |
137 EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H eap_status_e reset(); |
117 |
138 |
118 // This is documented in abs_eap_stack_interface_c::configure(). |
139 // This is documented in abs_eap_stack_interface_c::configure(). |
119 EAP_FUNC_IMPORT eap_status_e configure(); |
140 EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H eap_status_e configure(); |
120 |
141 |
121 // This is documented in abs_eap_stack_interface_c::shutdown(). |
142 // This is documented in abs_eap_stack_interface_c::shutdown(). |
122 EAP_FUNC_IMPORT eap_status_e shutdown(); |
143 EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H eap_status_e shutdown(); |
123 |
144 |
124 // This is documented in abs_eap_stack_interface_c::get_is_valid(). |
145 // This is documented in abs_eap_stack_interface_c::get_is_valid(). |
125 EAP_FUNC_IMPORT bool get_is_valid(); |
146 EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H bool get_is_valid(); |
126 |
147 |
127 EAP_FUNC_IMPORT eap_status_e get_eap_methods(const eap_method_settings_c * const internal_settings); |
148 EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H eap_status_e get_eap_methods(const eap_method_settings_c * const internal_settings); |
128 |
149 |
129 EAP_FUNC_IMPORT eap_status_e set_eap_methods(const eap_method_settings_c * const internal_settings); |
150 EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H eap_status_e set_eap_methods(const eap_method_settings_c * const internal_settings); |
130 |
151 |
131 EAP_FUNC_IMPORT eap_status_e get_certificate_lists(const eap_method_settings_c * const internal_settings); |
152 EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H eap_status_e get_certificate_lists(const eap_method_settings_c * const internal_settings); |
132 |
153 |
133 EAP_FUNC_IMPORT eap_status_e delete_all_eap_settings(const eap_method_settings_c * const internal_settings); |
154 EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H eap_status_e delete_all_eap_settings(const eap_method_settings_c * const internal_settings); |
134 |
155 |
135 EAP_FUNC_IMPORT eap_status_e copy_all_eap_settings(const eap_method_settings_c * const internal_settings); |
156 EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H eap_status_e copy_all_eap_settings(const eap_method_settings_c * const internal_settings); |
136 |
157 |
137 EAP_FUNC_IMPORT eap_status_e send_data(const void * const data, const u32_t length); |
158 EAP_FUNC_VISIBILITY_EAP_GENERAL_SETTINGS_CLIENT_MESSAGE_IF_H eap_status_e send_data(const void * const data, const u32_t length); |
138 |
159 |
139 //-------------------------------------------------- |
160 //-------------------------------------------------- |
140 }; // class eap_general_settings_client_message_if_c |
161 }; // class eap_general_settings_client_message_if_c |
141 |
162 |
142 //-------------------------------------------------- |
163 //-------------------------------------------------- |