wlan_bearer/wlanldd/wlan_common/osa_common/inc/osadfc.h
changeset 0 c40eb8fe8501
equal deleted inserted replaced
-1:000000000000 0:c40eb8fe8501
       
     1 /*
       
     2 * Copyright (c) 2007-2009 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:   WlanDfc declaration
       
    15 *
       
    16 */
       
    17 
       
    18 /*
       
    19 * %version: 4 %
       
    20 */
       
    21 
       
    22 #ifndef WLANDFC_H
       
    23 #define WLANDFC_H
       
    24 
       
    25 #include <wlandfc.h>
       
    26 #include "wlanobject.h"
       
    27 
       
    28 class WlanOsa;
       
    29 struct WlanDfcImpl;
       
    30 
       
    31 /**
       
    32  *  concrete DFC context object
       
    33  *
       
    34  *
       
    35  *  @lib wlanosa.lib
       
    36  *  @since S60 v3.2
       
    37  */
       
    38 class WlanDfc : public MWlanDfc, public WlanObject
       
    39     {
       
    40 
       
    41     friend class WlanDfcImpl;
       
    42 
       
    43 public:
       
    44 
       
    45     /**
       
    46      * Destructor.
       
    47      *
       
    48      * @since S60 v3.2
       
    49      */
       
    50     virtual ~WlanDfc();
       
    51 
       
    52 	/**
       
    53 	 * Constructor.
       
    54 	 *
       
    55 	 * @since S60 v3.2
       
    56      * @param aOsa wlanosa object
       
    57      * @param aDfcQueue Pointer to the DFC queue to use
       
    58 	 */
       
    59     explicit WlanDfc( 
       
    60         WlanOsa& aOsa, 
       
    61         void* aDfcQueue );
       
    62 
       
    63 protected:
       
    64 
       
    65 // from base class MWlanDfc
       
    66 
       
    67     /**
       
    68      * From MWlanDfc.
       
    69      * Enqueue a dfc for execution. 
       
    70      * Either succeeds or has no effect.
       
    71      * Calling this method for allready queued dfc has no effect
       
    72      *
       
    73      * @since S60 v3.2
       
    74      * @param aDfcClient client interface
       
    75      * @param aCtx context passed back in client callback
       
    76      */
       
    77      virtual void Enqueue( MWlanDfcClient& aDfcClient, TInt aCtx );
       
    78 
       
    79     /**
       
    80      * From MWlanDfc.
       
    81      * Dequeue a queued dfc. 
       
    82      * Either succeeds or has no effect.
       
    83      * Calling this method for non queued dfc has no effect 
       
    84      *
       
    85      * @since S60 v3.2
       
    86      */
       
    87      virtual void Dequeue();
       
    88 
       
    89 private:
       
    90 
       
    91     // Prohibit copy constructor.
       
    92     WlanDfc( const WlanDfc& );
       
    93     // Prohibit assigment operator.
       
    94     WlanDfc& operator= ( const WlanDfc& );
       
    95 
       
    96     /**
       
    97      * DFC execution entry
       
    98      *
       
    99      * @since S60 v3.2
       
   100      */
       
   101     void RealDfc();
       
   102 
       
   103     /**
       
   104      * Extracts implementation details
       
   105      *
       
   106      * @since S60 v3.2
       
   107      * @return implementation details
       
   108      */
       
   109     inline WlanDfcImpl& Pimpl();
       
   110 
       
   111 private: // data
       
   112 
       
   113     /**
       
   114      * implementation
       
   115      * Own.  
       
   116      */
       
   117     WlanDfcImpl* iPimpl;
       
   118     };
       
   119 
       
   120 #include "osadfc.inl"
       
   121 
       
   122 #endif // WLANDFC_H