eapol/eapol_framework/eapol_common/include/eap_rogue_ap_entry.h
changeset 49 43351a4f2da3
parent 26 9abfd4f00d37
equal deleted inserted replaced
47:712b4ffd76bb 49:43351a4f2da3
    23 #define EAP_ROGUE_AP_ENTRY_H
    23 #define EAP_ROGUE_AP_ENTRY_H
    24 
    24 
    25 // INCLUDES
    25 // INCLUDES
    26 #include "eap_am_tools.h"
    26 #include "eap_am_tools.h"
    27 #include "eapol_ethernet_address.h"
    27 #include "eapol_ethernet_address.h"
       
    28 #include "eap_am_export.h"
       
    29 // Start: added by script change_export_macros.sh.
       
    30 #if defined(EAP_NO_EXPORT_EAP_ROGUE_AP_ENTRY_H)
       
    31 	#define EAP_CLASS_VISIBILITY_EAP_ROGUE_AP_ENTRY_H EAP_NONSHARABLE 
       
    32 	#define EAP_FUNC_VISIBILITY_EAP_ROGUE_AP_ENTRY_H 
       
    33 	#define EAP_C_FUNC_VISIBILITY_EAP_ROGUE_AP_ENTRY_H 
       
    34 	#define EAP_FUNC_EXPORT_EAP_ROGUE_AP_ENTRY_H 
       
    35 	#define EAP_C_FUNC_EXPORT_EAP_ROGUE_AP_ENTRY_H 
       
    36 #elif defined(EAP_EXPORT_EAP_ROGUE_AP_ENTRY_H)
       
    37 	#define EAP_CLASS_VISIBILITY_EAP_ROGUE_AP_ENTRY_H EAP_EXPORT 
       
    38 	#define EAP_FUNC_VISIBILITY_EAP_ROGUE_AP_ENTRY_H EAP_FUNC_EXPORT 
       
    39 	#define EAP_C_FUNC_VISIBILITY_EAP_ROGUE_AP_ENTRY_H EAP_C_FUNC_EXPORT 
       
    40 	#define EAP_FUNC_EXPORT_EAP_ROGUE_AP_ENTRY_H EAP_FUNC_EXPORT 
       
    41 	#define EAP_C_FUNC_EXPORT_EAP_ROGUE_AP_ENTRY_H EAP_C_FUNC_EXPORT 
       
    42 #else
       
    43 	#define EAP_CLASS_VISIBILITY_EAP_ROGUE_AP_ENTRY_H EAP_IMPORT 
       
    44 	#define EAP_FUNC_VISIBILITY_EAP_ROGUE_AP_ENTRY_H EAP_FUNC_IMPORT 
       
    45 	#define EAP_C_FUNC_VISIBILITY_EAP_ROGUE_AP_ENTRY_H EAP_C_FUNC_IMPORT 
       
    46 	#define EAP_FUNC_EXPORT_EAP_ROGUE_AP_ENTRY_H 
       
    47 	#define EAP_C_FUNC_EXPORT_EAP_ROGUE_AP_ENTRY_H 
       
    48 #endif
       
    49 // End: added by script change_export_macros.sh.
       
    50 
    28 
    51 
    29 enum eap_rogue_ap_reason_e
    52 enum eap_rogue_ap_reason_e
    30 {
    53 {
    31 	rogue_ap_none,
    54 	rogue_ap_none,
    32 	rogue_ap_association_failed,
    55 	rogue_ap_association_failed,
    35 	rogue_ap_challenge_to_ap_failed
    58 	rogue_ap_challenge_to_ap_failed
    36 };
    59 };
    37 
    60 
    38 // CLASS DECLARATION
    61 // CLASS DECLARATION
    39 
    62 
    40 class EAP_EXPORT eap_rogue_ap_entry_c
    63 class EAP_CLASS_VISIBILITY_EAP_ROGUE_AP_ENTRY_H eap_rogue_ap_entry_c
    41 {
    64 {
    42 	public:
    65 	public:
    43 
    66 
    44 		// Constructors and destructor
    67 		// Constructors and destructor
    45 
    68 
    46 		/**
    69 		/**
    47 		* Constructor
    70 		* Constructor
    48 		* @param tools Pointer to EAP tools class
    71 		* @param tools Pointer to EAP tools class
    49 		*/        
    72 		*/        
    50 		EAP_FUNC_IMPORT eap_rogue_ap_entry_c(
    73 		EAP_FUNC_VISIBILITY_EAP_ROGUE_AP_ENTRY_H eap_rogue_ap_entry_c(
    51 			abs_eap_am_tools_c * const tools);
    74 			abs_eap_am_tools_c * const tools);
    52 
    75 
    53 		/**
    76 		/**
    54 		* Destructor
    77 		* Destructor
    55 		*/
    78 		*/
    56 		EAP_FUNC_IMPORT virtual ~eap_rogue_ap_entry_c();
    79 		EAP_FUNC_VISIBILITY_EAP_ROGUE_AP_ENTRY_H virtual ~eap_rogue_ap_entry_c();
    57 
    80 
    58 		/**
    81 		/**
    59 		* Returns a copy of this object.
    82 		* Returns a copy of this object.
    60 		*/
    83 		*/
    61 		EAP_FUNC_IMPORT eap_rogue_ap_entry_c * copy() const;
    84 		EAP_FUNC_VISIBILITY_EAP_ROGUE_AP_ENTRY_H eap_rogue_ap_entry_c * copy() const;
    62 
    85 
    63 		/**
    86 		/**
    64 		* Returns pointer to MAC address
    87 		* Returns pointer to MAC address
    65 		* @return Pointer to MAC address
    88 		* @return Pointer to MAC address
    66 		*/
    89 		*/
    67 		EAP_FUNC_IMPORT u8_t * get_mac_address() const;
    90 		EAP_FUNC_VISIBILITY_EAP_ROGUE_AP_ENTRY_H u8_t * get_mac_address() const;
    68 
    91 
    69 		/**
    92 		/**
    70 		* Returns pointer to MAC address and copies MAC address into given pointer
    93 		* Returns pointer to MAC address and copies MAC address into given pointer
    71 		* @param mac_address Copies MAC address into this
    94 		* @param mac_address Copies MAC address into this
    72 		* @return Pointer to MAC address
    95 		* @return Pointer to MAC address
    73 		*/
    96 		*/
    74 		EAP_FUNC_IMPORT u8_t * get_mac_address(u8_t * const mac_address) const;
    97 		EAP_FUNC_VISIBILITY_EAP_ROGUE_AP_ENTRY_H u8_t * get_mac_address(u8_t * const mac_address) const;
    75 
    98 
    76 		/**
    99 		/**
    77 		* Sets MAC address
   100 		* Sets MAC address
    78 		* @param mac_address pointer to MAC address
   101 		* @param mac_address pointer to MAC address
    79 		*/
   102 		*/
    80 		EAP_FUNC_IMPORT void set_mac_address(const u8_t * const mac_address);
   103 		EAP_FUNC_VISIBILITY_EAP_ROGUE_AP_ENTRY_H void set_mac_address(const u8_t * const mac_address);
    81 
   104 
    82 		/**
   105 		/**
    83 		* Sets Rogue reason code
   106 		* Sets Rogue reason code
    84 		* @param reason Rogue reson code
   107 		* @param reason Rogue reson code
    85 		*/
   108 		*/
    86 		EAP_FUNC_IMPORT void set_rogue_reason(const eap_rogue_ap_reason_e reason);
   109 		EAP_FUNC_VISIBILITY_EAP_ROGUE_AP_ENTRY_H void set_rogue_reason(const eap_rogue_ap_reason_e reason);
    87 
   110 
    88 		/**
   111 		/**
    89 		* Returns reson code of Rogue AP entry
   112 		* Returns reson code of Rogue AP entry
    90 		* @return Rogue reson code
   113 		* @return Rogue reson code
    91 		*/
   114 		*/
    92 		EAP_FUNC_IMPORT eap_rogue_ap_reason_e get_rogue_reason() const;
   115 		EAP_FUNC_VISIBILITY_EAP_ROGUE_AP_ENTRY_H eap_rogue_ap_reason_e get_rogue_reason() const;
    93 
   116 
    94 	private: // Data
   117 	private: // Data
    95 
   118 
    96 		/// Pointer to EAP tools
   119 		/// Pointer to EAP tools
    97 		abs_eap_am_tools_c * const m_am_tools;
   120 		abs_eap_am_tools_c * const m_am_tools;