eapol/eapol_framework/wapi_common/include/abs_wapi_am_wlan_authentication.h
changeset 17 8840d3e38314
equal deleted inserted replaced
2:1c7bc153c08e 17:8840d3e38314
       
     1 /*
       
     2 * ============================================================================
       
     3 *  Name        : ./accesssec/eapol/eapol_framework/wapi_common/include/abs_wapi_am_wlan_authentication.h
       
     4 *  Part of     : WAPI / WAPI       *** Info from the SWAD
       
     5 *  Description : WAPI authentication
       
     6 *  Version     : %version: 5 % << Don't touch! Updated by Synergy at check-out.
       
     7 *
       
     8 *  Copyright © 2001-2009 Nokia.  All rights reserved.
       
     9 *  This material, including documentation and any related computer
       
    10 *  programs, is protected by copyright controlled by Nokia.  All
       
    11 *  rights are reserved.  Copying, including reproducing, storing,
       
    12 *  adapting or translating, any or all of this material requires the
       
    13 *  prior written consent of Nokia.  This material also contains
       
    14 *  confidential information which may not be disclosed to others
       
    15 *  without the prior written consent of Nokia.
       
    16 * ============================================================================
       
    17 * Template version: 4.2
       
    18 */
       
    19 
       
    20 
       
    21 
       
    22 #if !defined(_ABS_WAPI_AM_WLAN_AUTHENTICATION_H_)
       
    23 #define _ABS_WAPI_AM_WLAN_AUTHENTICATION_H_
       
    24 
       
    25 #include "eap_am_export.h"
       
    26 #include "eapol_key_types.h"
       
    27 
       
    28 /// This class declares the functions the adaptation module of WAPI
       
    29 /// requires from wapi_wlan_authentication_c
       
    30 class EAP_EXPORT abs_wapi_am_wlan_authentication_c
       
    31 {
       
    32 private:
       
    33 	//--------------------------------------------------
       
    34 
       
    35 	//--------------------------------------------------
       
    36 protected:
       
    37 	//--------------------------------------------------
       
    38 
       
    39 	//--------------------------------------------------
       
    40 public:
       
    41 	//--------------------------------------------------
       
    42 
       
    43 	// 
       
    44 	virtual ~abs_wapi_am_wlan_authentication_c()
       
    45 	{
       
    46 	}
       
    47 
       
    48 	// 
       
    49 	abs_wapi_am_wlan_authentication_c()
       
    50 	{
       
    51 	}
       
    52 
       
    53 	/**
       
    54 	 *	This function disassociates the connection.
       
    55 	 */
       
    56 	virtual eap_status_e disassociation(
       
    57 		const eap_am_network_id_c * const receive_network_id ///< source includes remote address, destination includes local address.
       
    58 		) = 0;
       
    59 
       
    60 
       
    61 	/**
       
    62 	 *	This function indicates the state of WLAN authentication.
       
    63 	 */
       
    64 	virtual eap_status_e wapi_indication(
       
    65 		const eap_am_network_id_c * const receive_network_id, ///< source includes remote address, destination includes local address.
       
    66 		const eapol_wlan_authentication_state_e wlan_authentication_state) = 0;
       
    67 
       
    68 	/**
       
    69 	 * This is notification of internal state transition.
       
    70 	 * This is used for notifications, debugging and protocol testing.
       
    71 	 * The primal notifications are eap_state_variable_e::eap_state_authentication_finished_successfully
       
    72 	 * and eap_state_variable_e::eap_state_authentication_terminated_unsuccessfully. WAPI MUST send these
       
    73 	 * two notifications to lower layer.
       
    74 	 * These two notifications are sent using WAPI-protocol layer (eap_protocol_layer_e::eap_protocol_layer_wapi).
       
    75 	 * See also eap_state_notification_c.
       
    76 	 */
       
    77 	virtual void state_notification(
       
    78 		const abs_eap_state_notification_c * const state) = 0;
       
    79 
       
    80 	//--------------------------------------------------
       
    81 }; // class abs_wapi_am_wlan_authentication_c
       
    82 
       
    83 #endif //#if !defined(_ABS_WAPI_AM_WLAN_AUTHENTICATION_H_)
       
    84 
       
    85 //--------------------------------------------------
       
    86 
       
    87 
       
    88 
       
    89 // End.