eapol/eapol_framework/eapol_common/type/simple_config/simple_config/include/simple_config_message.h
branchRCL_3
changeset 46 c74b3d9f6b9e
parent 45 bad0cc58d154
equal deleted inserted replaced
45:bad0cc58d154 46:c74b3d9f6b9e
     9 * Initial Contributors:
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    10 * Nokia Corporation - initial contribution.
    11 *
    11 *
    12 * Contributors:
    12 * Contributors:
    13 *
    13 *
    14 * Description:  This class defines one SIMPLE_CONFIG-message.
    14 * Description:  EAP and WLAN authentication protocols.
    15 *
    15 *
    16 */
    16 */
    17 
    17 
    18 /*
    18 /*
    19 * %version: 12.1.2 %
    19 * %version: 14 %
    20 */
    20 */
    21 
    21 
    22 #if !defined(_SIMPLE_CONFIG_MESSAGE_H_)
    22 #if !defined(_SIMPLE_CONFIG_MESSAGE_H_)
    23 #define _SIMPLE_CONFIG_MESSAGE_H_
    23 #define _SIMPLE_CONFIG_MESSAGE_H_
    24 
    24 
    30 
    30 
    31 
    31 
    32 //----------------------------------------------------------------------------
    32 //----------------------------------------------------------------------------
    33 
    33 
    34 
    34 
    35 /// This class defines one SIMPLE_CONFIG-message.
    35 /// This class defines one SIMPLE_CONFIG-message. One SIMPLE_CONFIG message could include many SIMPLE_CONFIG-records.
    36 /**
    36 /**
    37  * This class defined one SIMPLE_CONFIG-message.
    37  * This class defined one SIMPLE_CONFIG-message.
    38  * Parse and analyse of SIMPLE_CONFIG-message is asyncronous.
    38  * Parse and analyse of SIMPLE_CONFIG-message is asyncronous.
       
    39  * m_analyse_index tells the index of message where asyncronous
       
    40  * analyse of SIMPLE_CONFIG-message must continue.
       
    41  * Analysed messages are skipped during the asyncronous
       
    42  * analyse of messages. Asyncronous analyse is needed
       
    43  * because of the PKI functions are asyncronous in
       
    44  * Symbian.
    39  */
    45  */
    40 class EAP_EXPORT simple_config_message_c
    46 class EAP_EXPORT simple_config_message_c
    41 {
    47 {
    42 private:
    48 private:
    43 	//--------------------------------------------------
    49 	//--------------------------------------------------
    46 	abs_eap_am_tools_c * const m_am_tools;
    52 	abs_eap_am_tools_c * const m_am_tools;
    47 
    53 
    48 	/// This buffer includes copy of the whole received SIMPLE_CONFIG-message data.
    54 	/// This buffer includes copy of the whole received SIMPLE_CONFIG-message data.
    49 	eap_variable_data_c m_simple_config_message_data;
    55 	eap_variable_data_c m_simple_config_message_data;
    50 
    56 
    51 	/// This is EAP-identifier of the EAP-packet that includes SIMPLE_CONFIG-message.
    57 	/// This is EAP-identifier of the EAP-packet that includes SIMPLE_CONFIG-message. This is needed in XP-PEAP.
    52 	u8_t m_received_eap_identifier;
    58 	u8_t m_received_eap_identifier;
       
    59 
    53 
    60 
    54 	/// This indicates whether this object is client (true) or server (false). This is mostly for traces.
    61 	/// This indicates whether this object is client (true) or server (false). This is mostly for traces.
    55 	const bool m_is_client;
    62 	const bool m_is_client;
    56 
    63 
    57 	//--------------------------------------------------
    64 	//--------------------------------------------------
    79 	 */
    86 	 */
    80 	EAP_FUNC_IMPORT eap_status_e reset();
    87 	EAP_FUNC_IMPORT eap_status_e reset();
    81 
    88 
    82 	/**
    89 	/**
    83 	 * This function copies the received SIMPLE_CONFIG-message data and EAP-identifier.
    90 	 * This function copies the received SIMPLE_CONFIG-message data and EAP-identifier.
    84 	 * EAP-identifier is needed in PEAPv0. That PEAP version uses
    91 	 * EAP-identifier is needed in XP PEAPv0. That stupid version uses
    85 	 * same EAP-identifier with PEAP header and tunneled EAP-header.
    92 	 * same EAP-identifier with PEAP header and tunneled EAP-header.
    86 	 */
    93 	 */
    87 	EAP_FUNC_IMPORT eap_status_e set_simple_config_message_data(
    94 	EAP_FUNC_IMPORT eap_status_e set_simple_config_message_data(
    88 		eap_variable_data_c * const simple_config_message_data,
    95 		eap_variable_data_c * const simple_config_message_data,
    89 		const u8_t received_eap_identifier);
    96 		const u8_t received_eap_identifier);