eapol/eapol_framework/eapol_common/am/include/eap_am_stack.h
branchRCL_3
changeset 46 c74b3d9f6b9e
parent 45 bad0cc58d154
child 55 9c2aa05919d9
equal deleted inserted replaced
45:bad0cc58d154 46:c74b3d9f6b9e
     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 * %version: 11 %
       
    20 */
       
    21 
       
    22 #if !defined(_EAP_AM_STACK_H_)
       
    23 #define _EAP_AM_STACK_H_
       
    24 
       
    25 #include "eap_tools.h"
       
    26 #include "eap_status.h"
       
    27 #include "eap_am_export.h"
       
    28 #include "eap_expanded_type.h"
       
    29 #include "eap_array.h"
       
    30 #include "eap_database_reference_if.h"
       
    31 #include "eapol_key_types.h"
       
    32 
       
    33 class abs_eap_am_message_if_c;
       
    34 class eap_configuration_field_c;
       
    35 class eap_variable_data_c;
       
    36 class abs_eap_am_tools_c;
       
    37 class abs_eap_base_type_c;
       
    38 class eap_base_type_c;
       
    39 class eap_am_network_id_c;
       
    40 class abs_eap_am_stack_c;
       
    41 class abs_eap_configuration_if_c;
       
    42 
       
    43 /** @file */
       
    44 
       
    45 /// This class is the common part of EAP message interface.
       
    46 /// This class is interface to the message creation and parsing function.
       
    47 class EAP_EXPORT eap_am_stack_c
       
    48 : public eap_database_reference_if_c 
       
    49 {
       
    50 
       
    51 private:
       
    52 
       
    53 	// ----------------------------------------------------------------------
       
    54 
       
    55 public:
       
    56 
       
    57 	virtual ~eap_am_stack_c()
       
    58 	{
       
    59 	}
       
    60 
       
    61 	virtual bool get_is_valid() = 0;
       
    62 
       
    63 	virtual eap_status_e set_partner(
       
    64 		abs_eap_am_stack_c * const partner
       
    65 #if defined(USE_EAP_SIMPLE_CONFIG)
       
    66 		, abs_eap_configuration_if_c * const configuration_if
       
    67 #endif // #if defined(USE_EAP_SIMPLE_CONFIG)
       
    68 		) = 0;
       
    69 
       
    70 	// This is documented in abs_eap_stack_interface_c::configure().
       
    71 	virtual eap_status_e configure(
       
    72 		const eap_variable_data_c * const client_configuration) = 0;
       
    73 
       
    74 	// This is documented in abs_eap_stack_interface_c::shutdown().
       
    75 	virtual eap_status_e shutdown() = 0;
       
    76 
       
    77 	virtual eap_status_e read_configure(
       
    78 		const eap_configuration_field_c * const field,
       
    79 		eap_variable_data_c * const data) = 0;
       
    80 
       
    81 	virtual eap_status_e set_timer(
       
    82 		abs_eap_base_timer_c * const p_initializer, 
       
    83 		const u32_t p_id, 
       
    84 		void * const p_data,
       
    85 		const u32_t p_time_ms) = 0;
       
    86 
       
    87 	virtual eap_status_e cancel_timer(
       
    88 		abs_eap_base_timer_c * const p_initializer, 
       
    89 		const u32_t p_id) = 0;
       
    90 
       
    91 	virtual eap_status_e check_is_valid_eap_type(
       
    92 		const eap_type_value_e eap_type) = 0;
       
    93 
       
    94 	virtual eap_status_e get_eap_type_list(
       
    95 		eap_array_c<eap_type_value_e> * const eap_type_list) = 0;
       
    96 
       
    97 	virtual eap_status_e load_module(
       
    98 		const eap_type_value_e type,
       
    99 		const eap_type_value_e tunneling_type,
       
   100 		abs_eap_base_type_c * const partner,
       
   101 		eap_base_type_c ** const eap_type,
       
   102 		const bool is_client_when_true,
       
   103 		const eap_am_network_id_c * const receive_network_id) = 0;
       
   104 
       
   105 	virtual eap_status_e get_802_11_authentication_mode(
       
   106 		const eap_am_network_id_c * const receive_network_id,
       
   107 		const eapol_key_authentication_type_e authentication_type) = 0;
       
   108 
       
   109 	// ----------------------------------------------------------------------
       
   110 };
       
   111 
       
   112 EAP_FUNC_IMPORT eap_am_stack_c * new_eap_am_stack_c(
       
   113 	abs_eap_am_tools_c * const tools,
       
   114 	const bool is_client_when_true);
       
   115 
       
   116 #endif //#if !defined(_EAP_AM_STACK_H_)
       
   117 
       
   118 
       
   119 //--------------------------------------------------
       
   120 // End