sapi_sysinfo/inc/sysinfocallbackmap.h
author andrews@symbian.org
Thu, 25 Jun 2009 01:40:38 +0100
changeset 18 79513c90e348
parent 0 14df0fbfcc4e
permissions -rw-r--r--
Tag source matching PDK_2.0.c

/*
* Copyright (c) 2005-2006 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of the License "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  Map of callback and transaction id.
*
*/


#ifndef __SYSINFOKCALLBACKMAP_H__
#define __SYSINFOKCALLBACKMAP_H__


//FORWARD DECLARATION
class MLiwNotifyCallback;

/**
* CSysInfoCallbackMap
* This class keeps a map of the transaction id allocated to an asynchronous 
* request with the callback of the request.
*/

// CLASS DECLARATION
NONSHARABLE_CLASS(CSysInfoCallbackMap): public CBase
    {
    public:// Constructors

    /**
    * CSysInfoCallbackMap
    * Constructor.
    *
    * @param aTransactionId The transaction id alloted to asynchronous request.
    * @param aCallback The callback associated with the asynchronous request.
    */
    inline CSysInfoCallbackMap( TInt32 aTransactionId, 
                                    MLiwNotifyCallback* aCallback );
    
    /**
    * ~CSysInfoCallbackMap
    * Destructor.
    */
    inline ~CSysInfoCallbackMap() {}

    public:

    /**
    * Set
    * Sets the transaction id and callback.
    *
    * @param aTransactionId The transaction id alloted to asynchronous request.
    * @param aCallback The callback associated with the asynchronous request.
    */
    inline void Set( TInt32 aTransactionId, MLiwNotifyCallback* aCallback );

    /**
    * Get
    * Gets the transaction id and callback.
    *
    * @param aTransactionId The transaction id alloted to asynchronous request.
    * @param aCallback The reference to the callback associated with the asynchronous request.
    * @return True if aCallback is set else False.
    */
    inline TBool Get( TInt32 aTransactionId, MLiwNotifyCallback*& aCallback) const;

    private:// Data

    /**
    * iTransactionId
    * The transaction id of the async call.
    */
    TInt32 iTransactionId;

    /**
    * iCallback
    * The handle to MLiwNotifyCallback.
    */
    MLiwNotifyCallback* iCallback;

    };

#include "sysinfocallbackmap.inl"

#endif // __SYSINFOKCALLBACKMAP_H__