wlan_plat/wlan_eapol_plugin_api/inc/wlaneapolinterface.h
changeset 0 c40eb8fe8501
equal deleted inserted replaced
-1:000000000000 0:c40eb8fe8501
       
     1 /*
       
     2 * Copyright (c) 2006-2007 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 "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:  ECom interface definition for WLAN EAPOL interface API.
       
    15 *
       
    16 */
       
    17 
       
    18 /*
       
    19 * %version: 3 %
       
    20 */
       
    21 
       
    22 #ifndef WLANEAPOLINTERFACE_H
       
    23 #define WLANEAPOLINTERFACE_H
       
    24 
       
    25 // INCLUDES
       
    26 #include <e32std.h>
       
    27 
       
    28 
       
    29 /**
       
    30  * @brief ECom interface definition for WLAN EAPOL inteface API.
       
    31  *
       
    32  * This class defines the methods used for configuring plugin and sending data from WLAN Engine to EAPOL.
       
    33  *
       
    34  * @since S60 v3.2
       
    35  */
       
    36 class MWlanEapolInterface
       
    37     {
       
    38 
       
    39 public:
       
    40 
       
    41     /**
       
    42      * Configure plugin implementation.
       
    43      *
       
    44      * @since S60 v3.2
       
    45      * @param aHeaderOffset Offset of EAP-header in packet_send.
       
    46      * @param aMTU Maximum transfer unit (MTU).
       
    47      * @param aTrailerLength Length of trailer needed by lower levels..
       
    48      * @return Return value is specified in interface specification.
       
    49      */
       
    50     virtual TInt Configure(
       
    51         const TInt aHeaderOffset,
       
    52         const TInt aMTU,
       
    53         const TInt aTrailerLength
       
    54         ) = 0;
       
    55 
       
    56     /**
       
    57      * Shutdown plugin implementation.
       
    58      *
       
    59      * @since S60 v3.2
       
    60      * @return Return value is specified in interface specification.
       
    61      */        
       
    62     virtual TInt Shutdown() = 0;
       
    63 
       
    64     /**
       
    65      * Send data to EAPOL.
       
    66      *
       
    67      * @since S60 v3.2
       
    68      * @param aData Pointer to the data to be sent.
       
    69      * @param aLength Length of the data to be sent.
       
    70      * @return Return value is specified in interface specification.
       
    71      */
       
    72     virtual TInt ProcessData(
       
    73         const void * const aData, 
       
    74         const TInt aLength ) = 0;
       
    75 
       
    76     };
       
    77 
       
    78 
       
    79 
       
    80 /**
       
    81  * @brief ECom interface definition for WLAN EAPOL inteface API.
       
    82  *
       
    83  * This class defines the method used for sending data from EAPOL to WLAN Engine.
       
    84  *
       
    85  * @since S60 v3.2
       
    86  */
       
    87 class MWlanEapolCallbackInterface
       
    88     {
       
    89 
       
    90 public:
       
    91 
       
    92     /**
       
    93      * Callback interface to partner.
       
    94      *
       
    95      * @since S60 v3.2
       
    96      * @param aData Pointer to the data to be sent.
       
    97      * @param aLength Length of the data to be sent.
       
    98      * @return Return value is specified in interface specification.
       
    99      */
       
   100     virtual TInt SendData(
       
   101         const void * const aData, 
       
   102         const TInt aLength ) = 0;
       
   103 
       
   104     };
       
   105 
       
   106 
       
   107 #endif // WLANEAPOLINTERFACE_H