testexecfw/stf/api/api_platform/inc/SettingServerClient.h
changeset 2 8bb370ba6d1d
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/testexecfw/stf/api/api_platform/inc/SettingServerClient.h	Fri Apr 09 10:46:28 2010 +0800
@@ -0,0 +1,134 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "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: This file contains the header file of the 
+* RSettingServer
+*
+*/
+
+#ifndef SETTING_SERVER_CLIENT_H
+#define SETTING_SERVER_CLIENT_H
+
+//  INCLUDES
+#include <e32std.h>
+#include <e32base.h>
+
+#include <TestEngineClient.h>
+
+// CONSTANTS
+
+// FUNCTION PROTOTYPES
+
+// FORWARD DECLARATIONS
+
+// CLASS DECLARATION
+
+// DESCRIPTION
+// RSettingServer is a client class of Setting server
+// The connect function starts the server, if it not already running.
+
+class RSettingServer
+        :public RSessionBase 
+    {
+    public: // Enumerations
+        // None
+
+    private: // Enumerations
+        // None
+
+    public:  // Constructors and destructor
+        
+        /**
+        * Constructor.
+        */
+        IMPORT_C RSettingServer();
+
+        /**
+        * Closes the RSettingServer session.
+        */
+        IMPORT_C void Close();
+
+    public: // New functions
+        
+        /**
+        * Connect method creates new RSettingServer session 
+        */
+        IMPORT_C TInt Connect();
+
+        /**
+        * Version returns the client side version number from the RSettingServer.
+        */
+        IMPORT_C TVersion Version() const;
+
+        /**
+        * Read Logger setting from initialization file. Mainly use from
+        * TestEngine side.
+        */
+        IMPORT_C TInt LoadLoggerSettingsFromIniFile( 
+                                        TLoggerSettings& aLoggerSettings, 
+                                        const TDesC& aIniFile,
+                                        TBool aOverwritePreviousSettings = ETrue );
+
+        /**
+        * Get Logger settings. Mainly use from Logger side.
+        */
+        IMPORT_C TInt GetLoggerSettings( TLoggerSettings& aLoggerSettings );
+
+        /**
+        * Set new initialization file setting(e.g. SetAttribute).
+        */
+        IMPORT_C TInt SetLoggerOutputPath( const TDesC& aLoggerOutputPath );
+
+        IMPORT_C TInt ResetLoggerSettings();
+        
+        /**
+        * Read Logger setting from command line. Mainly use from
+        * TestEngine side.
+        */
+        IMPORT_C TInt LoadLoggerSettingsFromCommandLine(TDesC& aLoggerSettings);
+        
+    public:     // Functions from base classes
+        // None
+
+    protected:  // New functions
+        // None
+
+    protected:  // Functions from base classes
+        // None
+
+    private:    // Functions from base classes
+        // None
+
+    public:     // Data
+        // None
+
+    protected:  // Data
+        // None
+
+    private:    // Data
+        // None
+
+    public:     // Friend classes
+        // None
+
+    protected:  // Friend classes
+        // None
+
+    private:    // Friend classes
+        // None
+
+    };
+
+#endif // SETTING_SERVER_CLIENT_H
+
+// End of File