imservices/instantmessagingcache/imcacheclient/inc/mimcacheclient.h
author hgs
Wed, 03 Nov 2010 22:25:05 +0530
changeset 52 3d676fce9a4e
parent 51 61fad867f68e
permissions -rw-r--r--
201044_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
51
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  message change observer
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#ifndef __MIMCACHECLIENT_H
hgs
parents:
diff changeset
    21
#define __MIMCACHECLIENT_H
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
#include <e32std.h>
hgs
parents:
diff changeset
    24
#include <imcachedefs.h>
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
/**
hgs
parents:
diff changeset
    27
 * An interface through which client gets information
hgs
parents:
diff changeset
    28
 * about available  data updates.
hgs
parents:
diff changeset
    29
 *
hgs
parents:
diff changeset
    30
 * @since
hgs
parents:
diff changeset
    31
 */
hgs
parents:
diff changeset
    32
class MIMCacheClient
hgs
parents:
diff changeset
    33
    {
hgs
parents:
diff changeset
    34
    public:
hgs
parents:
diff changeset
    35
    
hgs
parents:
diff changeset
    36
    	
hgs
parents:
diff changeset
    37
		/**
hgs
parents:
diff changeset
    38
    	* Registeres the cache update observer to server
hgs
parents:
diff changeset
    39
    	* @param aStatus status message to regisetr
hgs
parents:
diff changeset
    40
		* @param aRight, operations
hgs
parents:
diff changeset
    41
    	*/
hgs
parents:
diff changeset
    42
        virtual void RegisterObserverToServerL( TRequestStatus& aStatus, EIMCacheOperations aRight ) = 0;
hgs
parents:
diff changeset
    43
        
hgs
parents:
diff changeset
    44
        /**
hgs
parents:
diff changeset
    45
    	* unRegisteres the cache update  observer to server
hgs
parents:
diff changeset
    46
    	* @param aStatus status message to regisetr
hgs
parents:
diff changeset
    47
		* @param aRight, operations
hgs
parents:
diff changeset
    48
    	*/
hgs
parents:
diff changeset
    49
        virtual void UnRegisterObserverToServerL( TRequestStatus& aStatus, EIMCacheOperations aRight ) = 0 ;
hgs
parents:
diff changeset
    50
              
hgs
parents:
diff changeset
    51
        /**
hgs
parents:
diff changeset
    52
        * Gets called when data update is available.
hgs
parents:
diff changeset
    53
        * Client can then decide wether to use the old one
hgs
parents:
diff changeset
    54
        * @param aRight, operations
hgs
parents:
diff changeset
    55
        * @param abuuferptr 
hgs
parents:
diff changeset
    56
        */
hgs
parents:
diff changeset
    57
        virtual TPtr8 GetBufferedDataL(EIMCacheOperations aOperationType ) = 0 ;
hgs
parents:
diff changeset
    58
        
hgs
parents:
diff changeset
    59
        /**
hgs
parents:
diff changeset
    60
         * cancels any outstanding requests pending from the server
hgs
parents:
diff changeset
    61
         * @param aStatus status message to regisetr
hgs
parents:
diff changeset
    62
         * @param aRight,right is operations
hgs
parents:
diff changeset
    63
         */
hgs
parents:
diff changeset
    64
        virtual void CancelRequestL( TRequestStatus& aStatus, EIMCacheOperations aRight) = 0;
hgs
parents:
diff changeset
    65
         
hgs
parents:
diff changeset
    66
protected:
hgs
parents:
diff changeset
    67
    	/**
hgs
parents:
diff changeset
    68
    	* Destructor
hgs
parents:
diff changeset
    69
    	*/
hgs
parents:
diff changeset
    70
    	virtual ~MIMCacheClient() {};
hgs
parents:
diff changeset
    71
    };
hgs
parents:
diff changeset
    72
hgs
parents:
diff changeset
    73
#endif //__MIMCACHECLIENT_H
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75