hwrmhaptics/hapticsclient/inc/hwrmhapticsivtdatacacheao.h
changeset 0 4e1aa6a622a0
equal deleted inserted replaced
-1:000000000000 0:4e1aa6a622a0
       
     1 /*
       
     2 * Copyright (c) 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:  Header file of haptics client's IVT-data cache's internal 
       
    15 *                Active Object.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef HWRMHAPTICSIVTDATACACHEAO_H
       
    21 #define HWRMHAPTICSIVTDATACACHEAO_H
       
    22 
       
    23 #include <e32base.h>
       
    24 
       
    25 class CHWRMHapticsIVTDataCache;
       
    26 class RHWRMHapticsSession;
       
    27 
       
    28 /**
       
    29  * Haptics client's IVT-data cache's internal active object.
       
    30  *
       
    31  * @since S60 5.1
       
    32  */
       
    33 NONSHARABLE_CLASS( CHWRMHapticsIVTDataCacheAO ) : public CActive
       
    34     { 
       
    35 public:
       
    36     
       
    37     /**
       
    38      * Symbian two-phased constructor.
       
    39      *
       
    40      * @param 
       
    41      * @return Instance of the CHWRMHapticsIVTDataCacheAO class.
       
    42      */ 
       
    43     static CHWRMHapticsIVTDataCacheAO* NewL(
       
    44         TInt aFileHandle,
       
    45         CHWRMHapticsIVTDataCache* aCache,
       
    46         TRequestStatus& aStatus );
       
    47 
       
    48     /**
       
    49      * Symbian two-phased constructor.
       
    50      *
       
    51      * @return Instance of the CHWRMHapticsIVTDataCacheAO class.
       
    52      */ 
       
    53     static CHWRMHapticsIVTDataCacheAO* NewLC(
       
    54         TInt aFileHandle,
       
    55         CHWRMHapticsIVTDataCache* aCache,
       
    56         TRequestStatus& aStatus  );
       
    57 
       
    58     /**
       
    59      * Destructor.
       
    60      */
       
    61     virtual ~CHWRMHapticsIVTDataCacheAO();
       
    62 
       
    63     /**
       
    64      * Method for making the async play effect call to haptics server
       
    65      */
       
    66     void PlayEffectAsynch( RHWRMHapticsSession* aClientSession,
       
    67                            const TIpcArgs& aArgs );
       
    68 
       
    69 public:
       
    70 
       
    71     /**
       
    72      * From CActive
       
    73      */
       
    74     virtual void RunL();
       
    75     
       
    76     /**
       
    77      * From CActive
       
    78      */
       
    79     virtual void DoCancel();
       
    80 
       
    81     /**
       
    82      * From CActive
       
    83      */
       
    84     virtual TInt RunError( TInt aError );
       
    85 
       
    86 private:
       
    87 
       
    88     /**
       
    89      * C++ constructor.
       
    90      */
       
    91     CHWRMHapticsIVTDataCacheAO( TInt aFileHandle,
       
    92                                 CHWRMHapticsIVTDataCache* aCache,
       
    93                                 TRequestStatus& aStatus  );
       
    94 
       
    95     /**
       
    96      * Second phase construction.
       
    97      */
       
    98     void ConstructL();
       
    99 
       
   100 private:
       
   101 
       
   102     /**
       
   103      * The file handle for the data which is being played.
       
   104      */
       
   105     TInt iFileHandle;
       
   106      
       
   107     /**
       
   108      * Pointer to the cache which pointer array this AO belongs to.
       
   109      * Not owned.
       
   110      */
       
   111     CHWRMHapticsIVTDataCache* iCache;
       
   112     
       
   113     /**
       
   114      * Pointer to the request status of the client of haptics (that issued
       
   115      * the asynch play method in the first place).
       
   116      * Not owned.
       
   117      */
       
   118     TRequestStatus* iClientStatus;
       
   119     };
       
   120     
       
   121 #endif // HWRMHAPTICSIVTDATACACHEAO_H   
       
   122             
       
   123 // End of File