eapol/eapol_framework/eapol_common/type/tls_peap/tls/include/tls_completion.h
changeset 49 43351a4f2da3
parent 26 9abfd4f00d37
equal deleted inserted replaced
47:712b4ffd76bb 49:43351a4f2da3
    24 
    24 
    25 #include "eap_tools.h"
    25 #include "eap_tools.h"
    26 #include "eap_array.h"
    26 #include "eap_array.h"
    27 #include "tls_record_message.h"
    27 #include "tls_record_message.h"
    28 #include "abs_tls_message_hash.h"
    28 #include "abs_tls_message_hash.h"
       
    29 #include "eap_am_export.h"
       
    30 // Start: added by script change_export_macros.sh.
       
    31 #if defined(EAP_NO_EXPORT_TLS_COMPLETION_H)
       
    32 	#define EAP_CLASS_VISIBILITY_TLS_COMPLETION_H EAP_NONSHARABLE 
       
    33 	#define EAP_FUNC_VISIBILITY_TLS_COMPLETION_H 
       
    34 	#define EAP_C_FUNC_VISIBILITY_TLS_COMPLETION_H 
       
    35 	#define EAP_FUNC_EXPORT_TLS_COMPLETION_H 
       
    36 	#define EAP_C_FUNC_EXPORT_TLS_COMPLETION_H 
       
    37 #elif defined(EAP_EXPORT_TLS_COMPLETION_H)
       
    38 	#define EAP_CLASS_VISIBILITY_TLS_COMPLETION_H EAP_EXPORT 
       
    39 	#define EAP_FUNC_VISIBILITY_TLS_COMPLETION_H EAP_FUNC_EXPORT 
       
    40 	#define EAP_C_FUNC_VISIBILITY_TLS_COMPLETION_H EAP_C_FUNC_EXPORT 
       
    41 	#define EAP_FUNC_EXPORT_TLS_COMPLETION_H EAP_FUNC_EXPORT 
       
    42 	#define EAP_C_FUNC_EXPORT_TLS_COMPLETION_H EAP_C_FUNC_EXPORT 
       
    43 #else
       
    44 	#define EAP_CLASS_VISIBILITY_TLS_COMPLETION_H EAP_IMPORT 
       
    45 	#define EAP_FUNC_VISIBILITY_TLS_COMPLETION_H EAP_FUNC_IMPORT 
       
    46 	#define EAP_C_FUNC_VISIBILITY_TLS_COMPLETION_H EAP_C_FUNC_IMPORT 
       
    47 	#define EAP_FUNC_EXPORT_TLS_COMPLETION_H 
       
    48 	#define EAP_C_FUNC_EXPORT_TLS_COMPLETION_H 
       
    49 #endif
       
    50 // End: added by script change_export_macros.sh.
       
    51 
    29 
    52 
    30 /** @file */
    53 /** @file */
    31 
    54 
    32 /**
    55 /**
    33  * This is enumeration of TLS competion actions.
    56  * This is enumeration of TLS competion actions.
    63 
    86 
    64 //----------------------------------------------------------------------------
    87 //----------------------------------------------------------------------------
    65 
    88 
    66 
    89 
    67 /// This class defines one TLS completion action.
    90 /// This class defines one TLS completion action.
    68 class EAP_EXPORT tls_completion_c
    91 class EAP_CLASS_VISIBILITY_TLS_COMPLETION_H tls_completion_c
    69 {
    92 {
    70 private:
    93 private:
    71 	//--------------------------------------------------
    94 	//--------------------------------------------------
    72 
    95 
    73 	/// This is pointer to the tools class. @see abs_eap_am_tools_c.
    96 	/// This is pointer to the tools class. @see abs_eap_am_tools_c.
    81 
   104 
    82 	/**
   105 	/**
    83 	 * The set_is_valid() function sets the state of the object valid.
   106 	 * The set_is_valid() function sets the state of the object valid.
    84 	 * The creator of this object calls this function after it is initialized. 
   107 	 * The creator of this object calls this function after it is initialized. 
    85 	 */
   108 	 */
    86 	EAP_FUNC_IMPORT void set_is_valid();
   109 	EAP_FUNC_VISIBILITY_TLS_COMPLETION_H void set_is_valid();
    87 
   110 
    88 	//--------------------------------------------------
   111 	//--------------------------------------------------
    89 protected:
   112 protected:
    90 	//--------------------------------------------------
   113 	//--------------------------------------------------
    91 
   114 
    94 	//--------------------------------------------------
   117 	//--------------------------------------------------
    95 
   118 
    96 	/**
   119 	/**
    97 	 * Destructor does nothing special.
   120 	 * Destructor does nothing special.
    98 	 */
   121 	 */
    99 	EAP_FUNC_IMPORT virtual ~tls_completion_c();
   122 	EAP_FUNC_VISIBILITY_TLS_COMPLETION_H virtual ~tls_completion_c();
   100 
   123 
   101 	/**
   124 	/**
   102 	 * Constructor initializes object.
   125 	 * Constructor initializes object.
   103 	 */
   126 	 */
   104 	EAP_FUNC_IMPORT tls_completion_c(
   127 	EAP_FUNC_VISIBILITY_TLS_COMPLETION_H tls_completion_c(
   105 		abs_eap_am_tools_c * const tools,
   128 		abs_eap_am_tools_c * const tools,
   106 		tls_completion_action_e completion_action);
   129 		tls_completion_action_e completion_action);
   107 
   130 
   108 	/**
   131 	/**
   109 	 * Object must indicate it's validity.
   132 	 * Object must indicate it's validity.
   110 	 * If object initialization fails this function must return false.
   133 	 * If object initialization fails this function must return false.
   111 	 * @return This function returns the validity of this object.
   134 	 * @return This function returns the validity of this object.
   112 	 */
   135 	 */
   113 	EAP_FUNC_IMPORT bool get_is_valid();
   136 	EAP_FUNC_VISIBILITY_TLS_COMPLETION_H bool get_is_valid();
   114 
   137 
   115 	/**
   138 	/**
   116 	 * This function sets the completion action type.
   139 	 * This function sets the completion action type.
   117 	 */
   140 	 */
   118 	EAP_FUNC_IMPORT void set_completion_action(tls_completion_action_e completion_action);
   141 	EAP_FUNC_VISIBILITY_TLS_COMPLETION_H void set_completion_action(tls_completion_action_e completion_action);
   119 
   142 
   120 	/**
   143 	/**
   121 	 * This function gets the completion action type.
   144 	 * This function gets the completion action type.
   122 	 */
   145 	 */
   123 	EAP_FUNC_IMPORT tls_completion_action_e get_completion_action() const;
   146 	EAP_FUNC_VISIBILITY_TLS_COMPLETION_H tls_completion_action_e get_completion_action() const;
   124 
   147 
   125 	/**
   148 	/**
   126 	 * This function gets the debug string of the completion action type.
   149 	 * This function gets the debug string of the completion action type.
   127 	 */
   150 	 */
   128 	EAP_FUNC_IMPORT eap_const_string  get_completion_action_string() const;
   151 	EAP_FUNC_VISIBILITY_TLS_COMPLETION_H eap_const_string  get_completion_action_string() const;
   129 
   152 
   130 	// 
   153 	// 
   131 	//--------------------------------------------------
   154 	//--------------------------------------------------
   132 }; // class tls_completion_c
   155 }; // class tls_completion_c
   133 
   156