wlan_plat/wlan_osa_api/inc/wlantimer.h
changeset 0 c40eb8fe8501
equal deleted inserted replaced
-1:000000000000 0:c40eb8fe8501
       
     1 /*
       
     2 * Copyright (c) 2007-2008 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:  timer context interface declaration
       
    15 *
       
    16 */
       
    17 
       
    18 /*
       
    19 * %version: 4 %
       
    20 */
       
    21 
       
    22 #ifndef M_WLANTIMER_H
       
    23 #define M_WLANTIMER_H
       
    24 
       
    25 #include <wlanosaplatform.h>
       
    26 
       
    27 class MWlanTimerClient;
       
    28 
       
    29 /**
       
    30  *  timer context interface declaration
       
    31  *
       
    32  *
       
    33  *  @lib wlanosa.lib
       
    34  *  @since S60 v3.2
       
    35  */
       
    36 class MWlanTimer 
       
    37     {
       
    38 
       
    39 public:
       
    40 
       
    41 	/**
       
    42 	 * Destructor.
       
    43 	 *
       
    44 	 * @since S60 v3.2
       
    45 	 */
       
    46      virtual ~MWlanTimer() {};
       
    47 
       
    48     /**
       
    49      * Enqueue a timeout for execution. 
       
    50      * Either succeeds or has no effect.
       
    51      * Calling this method for allready queued timeout has no effect
       
    52      *
       
    53      * @since S60 v3.2
       
    54      * @param aTimerClient timer client
       
    55      * @param aCtx context for timer client callback
       
    56      * @param aTimeoutInMicroSeconds timeout in microseconds
       
    57      * @param aPeriodic periodic timer or not
       
    58      */
       
    59      virtual void Enqueue( 
       
    60          MWlanTimerClient& aTimerClient, 
       
    61          TInt aCtx,
       
    62          TInt aTimeoutInMicroSeconds, 
       
    63          TBool aPeriodic ) = 0;
       
    64 
       
    65     /**
       
    66      * Dequeue a queued timeout. 
       
    67      * Either succeeds or has no effect.
       
    68      * Calling this method for non queued timeout has no effect
       
    69      *
       
    70      * @since S60 v3.2
       
    71      */
       
    72      virtual void Dequeue() = 0;
       
    73     };
       
    74 
       
    75 #endif // M_WLANTIMER_H