eapol/eapol_framework/eapol_common/include/eap_plugin_server_message_if.h
changeset 52 c23bdf5a328a
parent 33 938269283a16
equal deleted inserted replaced
51:e863583e6720 52:c23bdf5a328a
    22 #if !defined(_EAP_PLUGIN_SERVER_MESSAGE_IF_H_)
    22 #if !defined(_EAP_PLUGIN_SERVER_MESSAGE_IF_H_)
    23 #define _EAP_PLUGIN_SERVER_MESSAGE_IF_H_
    23 #define _EAP_PLUGIN_SERVER_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_PLUGIN_SERVER_MESSAGE_IF_H)
       
    29 	#define EAP_CLASS_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H EAP_NONSHARABLE 
       
    30 	#define EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H 
       
    31 	#define EAP_C_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H 
       
    32 	#define EAP_FUNC_EXPORT_EAP_PLUGIN_SERVER_MESSAGE_IF_H 
       
    33 	#define EAP_C_FUNC_EXPORT_EAP_PLUGIN_SERVER_MESSAGE_IF_H 
       
    34 #elif defined(EAP_EXPORT_EAP_PLUGIN_SERVER_MESSAGE_IF_H)
       
    35 	#define EAP_CLASS_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H EAP_EXPORT 
       
    36 	#define EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H EAP_FUNC_EXPORT 
       
    37 	#define EAP_C_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H EAP_C_FUNC_EXPORT 
       
    38 	#define EAP_FUNC_EXPORT_EAP_PLUGIN_SERVER_MESSAGE_IF_H EAP_FUNC_EXPORT 
       
    39 	#define EAP_C_FUNC_EXPORT_EAP_PLUGIN_SERVER_MESSAGE_IF_H EAP_C_FUNC_EXPORT 
       
    40 #else
       
    41 	#define EAP_CLASS_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H EAP_IMPORT 
       
    42 	#define EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H EAP_FUNC_IMPORT 
       
    43 	#define EAP_C_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H EAP_C_FUNC_IMPORT 
       
    44 	#define EAP_FUNC_EXPORT_EAP_PLUGIN_SERVER_MESSAGE_IF_H 
       
    45 	#define EAP_C_FUNC_EXPORT_EAP_PLUGIN_SERVER_MESSAGE_IF_H 
       
    46 #endif
       
    47 // End: added by script change_export_macros.sh.
    27 #include "abs_eap_session_core.h"
    48 #include "abs_eap_session_core.h"
    28 #include "eap_variable_data.h"
    49 #include "eap_variable_data.h"
    29 #include "abs_eap_am_mutex.h"
    50 #include "abs_eap_am_mutex.h"
    30 #include "eap_session_core_base.h"
    51 #include "eap_session_core_base.h"
    31 #include "abs_eap_am_message_if.h"
    52 #include "abs_eap_am_message_if.h"
    36 
    57 
    37 
    58 
    38 /** @file */
    59 /** @file */
    39 
    60 
    40 
    61 
    41 class EAP_EXPORT eap_plugin_server_message_if_c
    62 class EAP_CLASS_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H eap_plugin_server_message_if_c
    42 : public abs_eap_am_plugin_c
    63 : public abs_eap_am_plugin_c
    43 , public eap_am_message_if_c
    64 , public eap_am_message_if_c
    44 , public abs_eap_base_timer_c
    65 , public abs_eap_base_timer_c
    45 {
    66 {
    46 
    67 
   111 	//--------------------------------------------------
   132 	//--------------------------------------------------
   112 
   133 
   113 	/**
   134 	/**
   114 	 * The destructor deletes the m_eap_core object.
   135 	 * The destructor deletes the m_eap_core object.
   115 	 */
   136 	 */
   116 	EAP_FUNC_IMPORT virtual ~eap_plugin_server_message_if_c();
   137 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H virtual ~eap_plugin_server_message_if_c();
   117 
   138 
   118 	/**
   139 	/**
   119 	 * The constructor creates the eap_core object and initializes the m_eap_core
   140 	 * The constructor creates the eap_core object and initializes the m_eap_core
   120 	 * to point the eap_core object.
   141 	 * to point the eap_core object.
   121 	 * @param tools is pointer to the tools class. @see abs_eap_am_tools_c.
   142 	 * @param tools is pointer to the tools class. @see abs_eap_am_tools_c.
   122 	 */
   143 	 */
   123 	EAP_FUNC_IMPORT eap_plugin_server_message_if_c(
   144 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H eap_plugin_server_message_if_c(
   124 		abs_eap_am_tools_c * const tools);
   145 		abs_eap_am_tools_c * const tools);
   125 
   146 
   126 	EAP_FUNC_IMPORT void set_partner(abs_eap_am_message_if_c * const partner);
   147 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H void set_partner(abs_eap_am_message_if_c * const partner);
   127 
   148 
   128 	EAP_FUNC_IMPORT eap_status_e process_data(const void * const data, const u32_t length);
   149 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H eap_status_e process_data(const void * const data, const u32_t length);
   129 
   150 
   130 	// This is documented in abs_eap_stack_interface_c::configure().
   151 	// This is documented in abs_eap_stack_interface_c::configure().
   131 	EAP_FUNC_IMPORT eap_status_e configure(
   152 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H eap_status_e configure(
   132 		const eap_variable_data_c * const client_configuration);
   153 		const eap_variable_data_c * const client_configuration);
   133 
   154 
   134 	// This is documented in abs_eap_stack_interface_c::shutdown().
   155 	// This is documented in abs_eap_stack_interface_c::shutdown().
   135 	EAP_FUNC_IMPORT eap_status_e shutdown();
   156 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H eap_status_e shutdown();
   136 
   157 
   137 	// This is documented in abs_eap_stack_interface_c::set_is_valid().
   158 	// This is documented in abs_eap_stack_interface_c::set_is_valid().
   138 	EAP_FUNC_IMPORT void set_is_valid();
   159 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H void set_is_valid();
   139 
   160 
   140 	// This is documented in abs_eap_stack_interface_c::get_is_valid().
   161 	// This is documented in abs_eap_stack_interface_c::get_is_valid().
   141 	EAP_FUNC_IMPORT bool get_is_valid();
   162 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H bool get_is_valid();
   142 
   163 
   143 	// See abs_eap_base_timer_c::timer_expired().
   164 	// See abs_eap_base_timer_c::timer_expired().
   144 	EAP_FUNC_IMPORT eap_status_e timer_expired(
   165 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H eap_status_e timer_expired(
   145 		const u32_t id, void *data);
   166 		const u32_t id, void *data);
   146 
   167 
   147 	// See abs_eap_base_timer_c::timer_delete_data().
   168 	// See abs_eap_base_timer_c::timer_delete_data().
   148 	EAP_FUNC_IMPORT eap_status_e timer_delete_data(
   169 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H eap_status_e timer_delete_data(
   149 		const u32_t id, void *data);
   170 		const u32_t id, void *data);
   150 
   171 
   151 	EAP_FUNC_IMPORT eap_status_e complete_get_configuration(const eap_method_settings_c * const internal_settings);
   172 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H eap_status_e complete_get_configuration(const eap_method_settings_c * const internal_settings);
   152 
   173 
   153 	EAP_FUNC_IMPORT eap_status_e complete_set_configuration(const eap_method_settings_c * const internal_settings);
   174 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H eap_status_e complete_set_configuration(const eap_method_settings_c * const internal_settings);
   154 
   175 
   155 	EAP_FUNC_IMPORT eap_status_e complete_delete_configuration(const eap_method_settings_c * const internal_settings);
   176 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H eap_status_e complete_delete_configuration(const eap_method_settings_c * const internal_settings);
   156 
   177 
   157 	EAP_FUNC_IMPORT eap_status_e complete_copy_configuration(const eap_method_settings_c * const internal_settings);
   178 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H eap_status_e complete_copy_configuration(const eap_method_settings_c * const internal_settings);
   158 
   179 
   159 	EAP_FUNC_IMPORT eap_status_e complete_set_index(const eap_method_settings_c * const internal_settings);
   180 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H eap_status_e complete_set_index(const eap_method_settings_c * const internal_settings);
   160 
   181 
   161 	EAP_FUNC_IMPORT eap_status_e complete_get_type_info(const eap_method_settings_c * const internal_settings);
   182 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H eap_status_e complete_get_type_info(const eap_method_settings_c * const internal_settings);
   162 
   183 
   163 	EAP_FUNC_IMPORT eap_status_e complete_invoke_ui(const eap_method_settings_c * const internal_settings);
   184 	EAP_FUNC_VISIBILITY_EAP_PLUGIN_SERVER_MESSAGE_IF_H eap_status_e complete_invoke_ui(const eap_method_settings_c * const internal_settings);
   164 
   185 
   165 	//--------------------------------------------------
   186 	//--------------------------------------------------
   166 }; // class eap_plugin_server_message_if_c
   187 }; // class eap_plugin_server_message_if_c
   167 
   188 
   168 #endif //#if !defined(_EAP_PLUGIN_SERVER_MESSAGE_IF_H_)
   189 #endif //#if !defined(_EAP_PLUGIN_SERVER_MESSAGE_IF_H_)