eapol/eapol_framework/eapol_symbian/eap_if/include/EapProcessInterface.h
author hgs
Thu, 27 May 2010 10:23:43 +0300
changeset 27 9660a5eb236f
parent 26 9abfd4f00d37
permissions -rw-r--r--
201021_1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
26
hgs
parents:
diff changeset
     1
/*
27
9660a5eb236f 201021_1
hgs
parents: 26
diff changeset
     2
* Copyright (c) 2001-2006 Nokia Corporation and/or its subsidiary(-ies).
26
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
27
9660a5eb236f 201021_1
hgs
parents: 26
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
26
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
27
9660a5eb236f 201021_1
hgs
parents: 26
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
26
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Wrapper class for instantiating an implementation of
hgs
parents:
diff changeset
    15
*                MWlanEapolInterface via ECom framework.
hgs
parents:
diff changeset
    16
*
hgs
parents:
diff changeset
    17
*/
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
/*
27
9660a5eb236f 201021_1
hgs
parents: 26
diff changeset
    20
* %version: 9 %
26
hgs
parents:
diff changeset
    21
*/
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
#ifndef EAP_PROCESS_INTERFACE_H
hgs
parents:
diff changeset
    24
#define EAP_PROCESS_INTERFACE_H
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
#include <ecom/ecom.h>
hgs
parents:
diff changeset
    27
#include "abs_eap_am_tools.h"
hgs
parents:
diff changeset
    28
#include "EapSendInterface.h"
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
//const TInt KCWlanEapolClientUid = 0x2000B05C;
hgs
parents:
diff changeset
    31
//const TInt KCWlanWapiClientUid = 0x200195A1;
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
/**
hgs
parents:
diff changeset
    34
 * @brief Class for instantiating an implementation of MWlanEapolInterface 
hgs
parents:
diff changeset
    35
 *
hgs
parents:
diff changeset
    36
 * @since S60 v3.2
hgs
parents:
diff changeset
    37
 */
hgs
parents:
diff changeset
    38
class CEapProcessInterface: public CBase
hgs
parents:
diff changeset
    39
    {
hgs
parents:
diff changeset
    40
hgs
parents:
diff changeset
    41
public:
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
    /**
hgs
parents:
diff changeset
    44
     * Static constructor.
hgs
parents:
diff changeset
    45
     * @param aUid UID of implementation to instantiate.
hgs
parents:
diff changeset
    46
     * @param aPartner Pointer to callback instance.
hgs
parents:
diff changeset
    47
     * @return Pointer to the constructed instance.
hgs
parents:
diff changeset
    48
     */
hgs
parents:
diff changeset
    49
    inline static CEapProcessInterface* NewL(
hgs
parents:
diff changeset
    50
        TInt aUid,
hgs
parents:
diff changeset
    51
        MEapSendInterface* aPartner);
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
    /**
hgs
parents:
diff changeset
    54
     * Destructor.
hgs
parents:
diff changeset
    55
     */
hgs
parents:
diff changeset
    56
    inline virtual ~CEapProcessInterface();
hgs
parents:
diff changeset
    57
hgs
parents:
diff changeset
    58
hgs
parents:
diff changeset
    59
		virtual TInt SetEnv(abs_eap_am_tools_c * const tools, const u32_t MTU) = 0;
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
    /**
hgs
parents:
diff changeset
    62
      * Configure plugin implementation.
hgs
parents:
diff changeset
    63
      *
hgs
parents:
diff changeset
    64
      * @since S60 v3.2
hgs
parents:
diff changeset
    65
      * @param aHeaderOffset Offset of EAP-header in packet_send.
hgs
parents:
diff changeset
    66
      * @param aMTU Maximum transfer unit (MTU).
hgs
parents:
diff changeset
    67
      * @param aTrailerLength Length of trailer needed by lower levels..
hgs
parents:
diff changeset
    68
      * @return Return value is specified in interface specification.
hgs
parents:
diff changeset
    69
      */
hgs
parents:
diff changeset
    70
	virtual TInt Configure(
hgs
parents:
diff changeset
    71
		const TInt aHeaderOffset,
hgs
parents:
diff changeset
    72
		const TInt aMTU,
hgs
parents:
diff changeset
    73
		const TInt aTrailerLength,
hgs
parents:
diff changeset
    74
		const void * const aConfigurationData,
hgs
parents:
diff changeset
    75
		const TInt aConfigurationDataLength
hgs
parents:
diff changeset
    76
		) = 0;
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
     /**
hgs
parents:
diff changeset
    79
      * Shutdown plugin implementation.
hgs
parents:
diff changeset
    80
      *
hgs
parents:
diff changeset
    81
      * @since S60 v3.2
hgs
parents:
diff changeset
    82
      * @return Return value is specified in interface specification.
hgs
parents:
diff changeset
    83
      */        
hgs
parents:
diff changeset
    84
     virtual TInt Shutdown() = 0;
hgs
parents:
diff changeset
    85
hgs
parents:
diff changeset
    86
     /**
hgs
parents:
diff changeset
    87
      * Send data to EAPOL.
hgs
parents:
diff changeset
    88
      *
hgs
parents:
diff changeset
    89
      * @since S60 v3.2
hgs
parents:
diff changeset
    90
      * @param aData Pointer to the data to be sent.
hgs
parents:
diff changeset
    91
      * @param aLength Length of the data to be sent.
hgs
parents:
diff changeset
    92
      * @return Return value is specified in interface specification.
hgs
parents:
diff changeset
    93
      */
hgs
parents:
diff changeset
    94
     virtual TInt ProcessData(
hgs
parents:
diff changeset
    95
         const void * const aData, 
hgs
parents:
diff changeset
    96
         const TInt aLength ) = 0;
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
  private: // data
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
     /**
hgs
parents:
diff changeset
   101
      * Identifies the instance of an implementation created by
hgs
parents:
diff changeset
   102
      * the ECOM framework.
hgs
parents:
diff changeset
   103
      */
hgs
parents:
diff changeset
   104
     TUid iInstanceIdentifier;
hgs
parents:
diff changeset
   105
hgs
parents:
diff changeset
   106
    };
hgs
parents:
diff changeset
   107
hgs
parents:
diff changeset
   108
#include "EapProcessInterface.inl"
hgs
parents:
diff changeset
   109
hgs
parents:
diff changeset
   110
#endif // EAP_PROCESS_INTERFACE_H