eapol/eapol_framework/eapol_symbian/eap_if/include/eap_am_message_if_symbian.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-2010 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:  Message interface on client side.
       
    15 *
       
    16 */
       
    17 
       
    18 /*
       
    19 * %version: 9 %
       
    20 */
       
    21 
       
    22 #ifndef _EAP_AM_MESSAGE_IF_SYMBIAN_H_
       
    23 #define _EAP_AM_MESSAGE_IF_SYMBIAN_H_
       
    24 
       
    25 // INCLUDES
       
    26 #include <e32std.h>
       
    27 #include "REapSession.h"
       
    28 #include "SendPacketHandler.h"
       
    29 #include "EapSendInterface.h"
       
    30 #include "abs_eap_am_tools.h"
       
    31 #include "abs_eap_am_message_if.h"
       
    32 #include "eap_am_message_if.h"
       
    33 #include "EapClientIf.h"
       
    34 
       
    35 class EapMessageBuffer;
       
    36 
       
    37 /**
       
    38  * Message interface on client side.
       
    39  */
       
    40 class EAP_EXPORT eap_am_message_if_symbian_c
       
    41 : public eap_am_message_if_c
       
    42 , public MSendPacketHandler
       
    43 , public EapClientIf
       
    44 {
       
    45 
       
    46 public:
       
    47 
       
    48 	// - - - - - - - - - - - - - - - - - - - - - - - - - - - -
       
    49 	// Functions from CWlanEapolClient.
       
    50 
       
    51     /**
       
    52      * C++ default constructor.
       
    53      */
       
    54     EAP_FUNC_IMPORT eap_am_message_if_symbian_c(
       
    55 		abs_eap_am_tools_c * const tools,
       
    56 		const TEapRequests if_request);
       
    57 
       
    58 	/**
       
    59 	 * Destructor.
       
    60 	 */
       
    61     EAP_FUNC_IMPORT virtual ~eap_am_message_if_symbian_c();
       
    62 
       
    63 	// - - - - - - - - - - - - - - - - - - - - - - - - - - - -
       
    64 	// Functions from eap_am_message_if_c.
       
    65 
       
    66     EAP_FUNC_IMPORT bool get_is_valid();
       
    67 
       
    68     EAP_FUNC_IMPORT void set_partner(abs_eap_am_message_if_c * const client);
       
    69 
       
    70 	/// Function receives the data message from lower layer.
       
    71 	/// Data is formatted to Attribute-Value Pairs.
       
    72 	/// Look at eap_tlv_header_c and eap_tlv_message_data_c.
       
    73     EAP_FUNC_IMPORT eap_status_e process_data(const void * const data, const u32_t length);
       
    74 
       
    75 	// This is documented in abs_eap_stack_interface_c::configure().
       
    76     EAP_FUNC_IMPORT eap_status_e configure(
       
    77 		const eap_variable_data_c * const client_configuration);
       
    78 
       
    79 	// This is documented in abs_eap_stack_interface_c::shutdown().
       
    80     EAP_FUNC_IMPORT eap_status_e shutdown();
       
    81 
       
    82 	// - - - - - - - - - - - - - - - - - - - - - - - - - - - -
       
    83 	// Functions from MSendPacketHandler.
       
    84 
       
    85 	/// Function sends the data message to lower layer.
       
    86 	/// Data is formatted to Attribute-Value Pairs.
       
    87 	/// Look at eap_tlv_header_c and eap_tlv_message_data_c.
       
    88     EAP_FUNC_IMPORT eap_status_e send_data(const TDesC8& message);
       
    89 
       
    90 
       
    91 private:
       
    92 
       
    93 	// - - - - - - - - - - - - - - - - - - - - - - - - - - - -
       
    94 
       
    95 	abs_eap_am_tools_c * const m_am_tools;
       
    96 
       
    97 	abs_eap_am_message_if_c * m_partner;
       
    98 
       
    99 	const TEapRequests m_if_request;
       
   100 
       
   101 	REapSession iSession;
       
   102 
       
   103 	bool m_is_valid;
       
   104 	
       
   105 };
       
   106 
       
   107 
       
   108 #endif // _EAP_AM_MESSAGE_IF_SYMBIAN_H_
       
   109 
       
   110 // End of file.