ncdengine/provider/client/inc/ncdbaseproxy.h
changeset 0 ba25891c3a9e
equal deleted inserted replaced
-1:000000000000 0:ba25891c3a9e
       
     1 /*
       
     2 * Copyright (c) 2006 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:   Contains CNcdBaseProxy class
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef NCD_BASE_PROXY_H
       
    20 #define NCD_BASE_PROXY_H
       
    21 
       
    22 
       
    23 #include <e32base.h>
       
    24 
       
    25 
       
    26 class MCatalogsClientServer;
       
    27 
       
    28 
       
    29 /**
       
    30  * Base class for the proxies.
       
    31  * Provides basic methods for client server session function calls.
       
    32  *
       
    33  *  @lib ?library
       
    34  *  @since S60 ?S60_version *** for example, S60 v3.0
       
    35  */
       
    36 class CNcdBaseProxy: public CBase                     
       
    37     {
       
    38 
       
    39 protected:
       
    40 
       
    41     /**
       
    42      * Constructor
       
    43      *
       
    44      * @param aSession The session between the client proxy and the
       
    45      * corresponding server object.
       
    46      * @param aHandle The handle which identifies the server object
       
    47      * that this proxy uses.
       
    48      */
       
    49     CNcdBaseProxy( MCatalogsClientServer& aSession, 
       
    50                    TInt aHandle );
       
    51 
       
    52     /**
       
    53      * Destructor
       
    54      */
       
    55     virtual ~CNcdBaseProxy();
       
    56 
       
    57 
       
    58 public:
       
    59 
       
    60     /**
       
    61      * ClientServerSession
       
    62      *
       
    63      * @return MCatalogsClientServer& an object that contains
       
    64      * the client server session information
       
    65      */
       
    66     MCatalogsClientServer& ClientServerSession() const;
       
    67 
       
    68 
       
    69     /**
       
    70      * Handle
       
    71      *
       
    72      * @return TInt a handle that identifies the server side object
       
    73      * that this proxy uses.
       
    74      */
       
    75     TInt Handle() const;
       
    76         
       
    77     
       
    78 private:
       
    79     // Prevent if not implemented
       
    80     CNcdBaseProxy( const CNcdBaseProxy& aObject );
       
    81     CNcdBaseProxy& operator =( const CNcdBaseProxy& aObject );
       
    82 
       
    83     
       
    84 private: // data
       
    85 
       
    86     /**
       
    87      * Interface for communicating to the server-side.
       
    88      */    
       
    89     MCatalogsClientServer& iSession;
       
    90 
       
    91     /**
       
    92      * Handle to identify the server-side counterpart for object of this
       
    93      * class.
       
    94      */
       
    95     TInt iHandle;
       
    96     
       
    97     };
       
    98 
       
    99 
       
   100 #endif // NCD_BASE_PROXY_H