1 /*

     2 * Copyright (c) 2001-2006 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of the License "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  EAP and WLAN authentication protocols.

    15 *

    16 */

    17 

    18 

    19 

    20 

    21 #if !defined(_EAP_GSMSIM_STATE_NOTIFICATION_H_)

    22 #define _EAP_GSMSIM_STATE_NOTIFICATION_H_

    23 

    24 #include "eap_variable_data.h"

    25 #include "eap_am_export.h"

    26 #include "eap_protocol_layer.h"

    27 #include "abs_eap_state_notification.h"

    28 

    29 

    30 /// A eap_gsmsim_state_notification_c class.

    31 /// This is used for debugging and protocol testing.

    32 class EAP_EXPORT eap_gsmsim_state_notification_c

    33 : public abs_eap_state_notification_c

    34 {

    35 private:

    36 	//--------------------------------------------------

    37 

    38 	abs_eap_am_tools_c * const m_am_tools; ///< This is pointer to the tools class. @see abs_eap_am_tools_c.

    39 

    40 	eap_protocol_layer_e m_layer; ///< Here is the protocol layer (EAP type).

    41 

    42 	eap_variable_data_c m_notification_string; ///< Here is the notification string.

    43 

    44 	eap_boolean_e m_needs_confirmation_from_user; ///< This flag tells whether user interaction is required.

    45 

    46 	u32_t m_protocol; ///< Here is the EAP type.

    47 

    48 	u32_t m_previous_state; ///< Here is the previous state of the EAP type.

    49 	

    50 	u32_t m_current_state; ///< Here is the current state of the EAP type.

    51 	

    52 	const eap_am_network_id_c *m_send_network_id;

    53 	

    54 	eap_boolean_e m_is_client;

    55 	

    56 	u8_t m_eap_identifier;

    57 	

    58 	eap_boolean_e m_allow_send_eap_success;

    59 

    60 	EAP_FUNC_IMPORT eap_const_string get_state_string(const u32_t state) const;

    61 

    62 	//--------------------------------------------------

    63 protected:

    64 	//--------------------------------------------------

    65 

    66 	//--------------------------------------------------

    67 public:

    68 	//--------------------------------------------------

    69 

    70 	/**

    71 	 * The destructor of the eap_gsmsim_state_notification_c class does nothing special.

    72 	 */

    73 	EAP_FUNC_IMPORT virtual ~eap_gsmsim_state_notification_c();

    74 

    75 	/**

    76 	 * The constructor of the eap_gsmsim_state_notification_c class does nothing special.

    77 	 */

    78 	EAP_FUNC_IMPORT eap_gsmsim_state_notification_c(

    79 		abs_eap_am_tools_c * const tools,

    80 		const eap_am_network_id_c * const send_network_id,

    81 		eap_boolean_e is_client,

    82 		eap_protocol_layer_e layer,

    83 		u32_t protocol,

    84 		u32_t previous_state,

    85 		u32_t current_state,

    86 		u8_t eap_identifier,

    87 		eap_boolean_e allow_send_eap_success);

    88 

    89 	// This is commented in abs_eap_state_notification_c::get_send_network_id().

    90 	EAP_FUNC_IMPORT const eap_am_network_id_c * const get_send_network_id() const;

    91 

    92 	// This is commented in abs_eap_state_notification_c::get_protocol_layer().

    93 	EAP_FUNC_IMPORT const eap_protocol_layer_e get_protocol_layer() const;

    94 

    95 	// This is commented in abs_eap_state_notification_c::get_protocol().

    96 	EAP_FUNC_IMPORT const u32_t get_protocol() const;

    97 

    98 	// This is commented in abs_eap_state_notification_c::get_previous_state().

    99 	EAP_FUNC_IMPORT const u32_t get_previous_state() const;

   100 

   101 	// This is commented in abs_eap_state_notification_c::get_previous_state_string().

   102 	EAP_FUNC_IMPORT eap_const_string get_previous_state_string() const;

   103 

   104 	// This is commented in abs_eap_state_notification_c::get_current_state().

   105 	EAP_FUNC_IMPORT const u32_t get_current_state() const;

   106 

   107 	// This is commented in abs_eap_state_notification_c::get_current_state_string().

   108 	EAP_FUNC_IMPORT eap_const_string get_current_state_string() const;

   109 

   110 	// This is commented in abs_eap_state_notification_c::get_is_client().

   111 	EAP_FUNC_IMPORT const eap_boolean_e get_is_client() const;

   112 

   113 	// This is commented in abs_eap_state_notification_c::get_eap_identifier().

   114 	EAP_FUNC_IMPORT const u8_t get_eap_identifier() const;

   115 

   116 	// This is commented in abs_eap_state_notification_c::get_allow_send_eap_success().

   117 	EAP_FUNC_IMPORT eap_boolean_e get_allow_send_eap_success() const;

   118 

   119 	// This is commented in abs_eap_state_notification_c::set_notification_string().

   120 	EAP_FUNC_IMPORT const eap_status_e set_notification_string(

   121 		const eap_variable_data_c * const notification_string,

   122 		const eap_boolean_e needs_confirmation_from_user);

   123 

   124 	//--------------------------------------------------

   125 }; // class eap_gsmsim_state_notification_c

   126 

   127 #endif //#if !defined(_EAP_GSMSIM_STATE_NOTIFICATION_H_)

   128 

   129 //--------------------------------------------------

   130 

   131 

   132 

   133 // End.