eapol/eapol_framework/eapol_common/am/include/abs_eap_am_tools.h
changeset 52 c23bdf5a328a
parent 33 938269283a16
equal deleted inserted replaced
51:e863583e6720 52:c23bdf5a328a
    22 #if !defined( _ABS_EAP_AM_TOOLS_H_ )
    22 #if !defined( _ABS_EAP_AM_TOOLS_H_ )
    23 #define _ABS_EAP_AM_TOOLS_H_
    23 #define _ABS_EAP_AM_TOOLS_H_
    24 
    24 
    25 #include "eap_am_types.h"
    25 #include "eap_am_types.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_ABS_EAP_AM_TOOLS_H)
       
    29 	#define EAP_CLASS_VISIBILITY_ABS_EAP_AM_TOOLS_H EAP_NONSHARABLE 
       
    30 	#define EAP_FUNC_VISIBILITY_ABS_EAP_AM_TOOLS_H 
       
    31 	#define EAP_C_FUNC_VISIBILITY_ABS_EAP_AM_TOOLS_H 
       
    32 	#define EAP_FUNC_EXPORT_ABS_EAP_AM_TOOLS_H 
       
    33 	#define EAP_C_FUNC_EXPORT_ABS_EAP_AM_TOOLS_H 
       
    34 #elif defined(EAP_EXPORT_ABS_EAP_AM_TOOLS_H)
       
    35 	#define EAP_CLASS_VISIBILITY_ABS_EAP_AM_TOOLS_H EAP_EXPORT 
       
    36 	#define EAP_FUNC_VISIBILITY_ABS_EAP_AM_TOOLS_H EAP_FUNC_EXPORT 
       
    37 	#define EAP_C_FUNC_VISIBILITY_ABS_EAP_AM_TOOLS_H EAP_C_FUNC_EXPORT 
       
    38 	#define EAP_FUNC_EXPORT_ABS_EAP_AM_TOOLS_H EAP_FUNC_EXPORT 
       
    39 	#define EAP_C_FUNC_EXPORT_ABS_EAP_AM_TOOLS_H EAP_C_FUNC_EXPORT 
       
    40 #else
       
    41 	#define EAP_CLASS_VISIBILITY_ABS_EAP_AM_TOOLS_H EAP_IMPORT 
       
    42 	#define EAP_FUNC_VISIBILITY_ABS_EAP_AM_TOOLS_H EAP_FUNC_IMPORT 
       
    43 	#define EAP_C_FUNC_VISIBILITY_ABS_EAP_AM_TOOLS_H EAP_C_FUNC_IMPORT 
       
    44 	#define EAP_FUNC_EXPORT_ABS_EAP_AM_TOOLS_H 
       
    45 	#define EAP_C_FUNC_EXPORT_ABS_EAP_AM_TOOLS_H 
       
    46 #endif
       
    47 // End: added by script change_export_macros.sh.
    27 #include "eap_status.h"
    48 #include "eap_status.h"
    28 #include "abs_eap_base_timer.h"
    49 #include "abs_eap_base_timer.h"
    29 //#include "eap_am_memory_store_data.h"
    50 //#include "eap_am_memory_store_data.h"
    30 
    51 
    31 
    52 
    51  * abstract virtual class abs_eap_am_tools. A pointer to the abs_eap_am_tools
    72  * abstract virtual class abs_eap_am_tools. A pointer to the abs_eap_am_tools
    52  * class is given to all other classes as a parameter to each constructor.
    73  * class is given to all other classes as a parameter to each constructor.
    53  * Adaptation module creates the eap_am_tools_Y class before it initializes the stack.
    74  * Adaptation module creates the eap_am_tools_Y class before it initializes the stack.
    54  * This prevents the need of global objects.
    75  * This prevents the need of global objects.
    55  */
    76  */
    56 class EAP_EXPORT abs_eap_am_tools_c
    77 class EAP_CLASS_VISIBILITY_ABS_EAP_AM_TOOLS_H abs_eap_am_tools_c
    57 {
    78 {
    58 
    79 
    59 public:
    80 public:
    60 
    81 
    61 	/**
    82 	/**
    75 	/**
    96 	/**
    76 	 * This function allocates platform specific tools object.
    97 	 * This function allocates platform specific tools object.
    77 	 * Note this function calls also configure() of the allocated tools object.
    98 	 * Note this function calls also configure() of the allocated tools object.
    78 	 * The platform specific module must implement this function.
    99 	 * The platform specific module must implement this function.
    79 	 */
   100 	 */
    80 	EAP_FUNC_IMPORT_INTERFACE static abs_eap_am_tools_c * new_abs_eap_am_tools_c();
   101 	EAP_FUNC_VISIBILITY_ABS_EAP_AM_TOOLS_H static abs_eap_am_tools_c * new_abs_eap_am_tools_c();
    81 
   102 
    82 	/**
   103 	/**
    83 	 * This function deletes platform specific tools object.
   104 	 * This function deletes platform specific tools object.
    84 	 * Note this function calls also shutdown() of the allocated tools object.
   105 	 * Note this function calls also shutdown() of the allocated tools object.
    85 	 * The platform specific module must implement this function.
   106 	 * The platform specific module must implement this function.
    86 	 */
   107 	 */
    87 	EAP_FUNC_IMPORT_INTERFACE static void delete_abs_eap_am_tools_c(abs_eap_am_tools_c * const am_tools);
   108 	EAP_FUNC_VISIBILITY_ABS_EAP_AM_TOOLS_H static void delete_abs_eap_am_tools_c(abs_eap_am_tools_c * const am_tools);
    88 
   109 
    89 	/**
   110 	/**
    90 	 * The configure() function is called after the constructor of the 
   111 	 * The configure() function is called after the constructor of the 
    91 	 * object is successfully executed. During the function call the object 
   112 	 * object is successfully executed. During the function call the object 
    92 	 * could query the configuration. Each derived class must define this function.
   113 	 * could query the configuration. Each derived class must define this function.