PECengine/StorageManager2/ClientInc/RPEngStorageAdminClient.h
branchRCL_3
changeset 13 a941bc465d9f
parent 0 094583676ce7
equal deleted inserted replaced
12:6ca72c0fe49a 13:a941bc465d9f
       
     1 /*
       
     2 * Copyright (c) 2002 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:  Used for testing and connection of the Admin sub clients
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef __RPENGSTORAGEADMINCLIENT_H__
       
    20 #define __RPENGSTORAGEADMINCLIENT_H__
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32std.h>
       
    24 
       
    25 /**
       
    26  *  Storage Admin client
       
    27  *  It is used for connecting of the admin sub-clients
       
    28  *
       
    29  *  @lib PEngStoreMan2.dll
       
    30  *  @since 3.0
       
    31  */
       
    32 
       
    33 // CLASS DECLARATION
       
    34 class  RPEngStorageAdminClient: public RSessionBase
       
    35     {
       
    36 
       
    37     public:		// Constructors and destructors
       
    38         /**
       
    39          * Destructor.
       
    40          */
       
    41         IMPORT_C ~RPEngStorageAdminClient();
       
    42 
       
    43         /**
       
    44          * C++ default constructor.
       
    45          */
       
    46         IMPORT_C RPEngStorageAdminClient();
       
    47 
       
    48     public: 	// new methods
       
    49 
       
    50         /**
       
    51          * Connects to the presence server
       
    52          *
       
    53          *	@since 3.0
       
    54          *	@return KErrNone if connected
       
    55          *			or any of system wide error codes
       
    56          */
       
    57         IMPORT_C TInt Connect();
       
    58 
       
    59         /**
       
    60          *	Close connection to the presence server
       
    61          *
       
    62          *	@since 3.0
       
    63          */
       
    64         IMPORT_C void Close();
       
    65 
       
    66     public: // testing support
       
    67 
       
    68         /**
       
    69          *  Clean Session slot out of the Storage
       
    70          *	intended for testing, since session is wiped with brute force
       
    71          *
       
    72          *  @since 3.0
       
    73          *  @param aSessionId packed session slot id to wipe out
       
    74          *  @return KErrNone if operation went fine, or system wide
       
    75          *			error code
       
    76          */
       
    77         IMPORT_C TInt WipeSession( const TDesC8& aSessionId );
       
    78 
       
    79     private:	// New functions
       
    80 
       
    81         /**
       
    82          * Get version
       
    83           * @since 3.0
       
    84          * @return version of the client
       
    85          */
       
    86         TVersion Version() const;
       
    87 
       
    88     private:	// Data
       
    89 
       
    90         /// Flag if client is connected to the Storage Server
       
    91         TBool					iConnected ;
       
    92 
       
    93     };
       
    94 
       
    95 #endif      //  __RPENGSTORAGEADMINCLIENT_H__
       
    96 
       
    97 
       
    98 
       
    99 
       
   100 
       
   101 
       
   102 
       
   103 
       
   104 
       
   105 
       
   106 
       
   107 
       
   108 
       
   109 
       
   110 
       
   111 
       
   112 
       
   113 
       
   114 
       
   115 
       
   116