testexecfw/stf/api/api_platform/inc/SettingServerClient.h
changeset 2 8bb370ba6d1d
equal deleted inserted replaced
1:bbd31066657e 2:8bb370ba6d1d
       
     1 /*
       
     2 * Copyright (c) 2009 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: This file contains the header file of the 
       
    15 * RSettingServer
       
    16 *
       
    17 */
       
    18 
       
    19 #ifndef SETTING_SERVER_CLIENT_H
       
    20 #define SETTING_SERVER_CLIENT_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32std.h>
       
    24 #include <e32base.h>
       
    25 
       
    26 #include <TestEngineClient.h>
       
    27 
       
    28 // CONSTANTS
       
    29 
       
    30 // FUNCTION PROTOTYPES
       
    31 
       
    32 // FORWARD DECLARATIONS
       
    33 
       
    34 // CLASS DECLARATION
       
    35 
       
    36 // DESCRIPTION
       
    37 // RSettingServer is a client class of Setting server
       
    38 // The connect function starts the server, if it not already running.
       
    39 
       
    40 class RSettingServer
       
    41         :public RSessionBase 
       
    42     {
       
    43     public: // Enumerations
       
    44         // None
       
    45 
       
    46     private: // Enumerations
       
    47         // None
       
    48 
       
    49     public:  // Constructors and destructor
       
    50         
       
    51         /**
       
    52         * Constructor.
       
    53         */
       
    54         IMPORT_C RSettingServer();
       
    55 
       
    56         /**
       
    57         * Closes the RSettingServer session.
       
    58         */
       
    59         IMPORT_C void Close();
       
    60 
       
    61     public: // New functions
       
    62         
       
    63         /**
       
    64         * Connect method creates new RSettingServer session 
       
    65         */
       
    66         IMPORT_C TInt Connect();
       
    67 
       
    68         /**
       
    69         * Version returns the client side version number from the RSettingServer.
       
    70         */
       
    71         IMPORT_C TVersion Version() const;
       
    72 
       
    73         /**
       
    74         * Read Logger setting from initialization file. Mainly use from
       
    75         * TestEngine side.
       
    76         */
       
    77         IMPORT_C TInt LoadLoggerSettingsFromIniFile( 
       
    78                                         TLoggerSettings& aLoggerSettings, 
       
    79                                         const TDesC& aIniFile,
       
    80                                         TBool aOverwritePreviousSettings = ETrue );
       
    81 
       
    82         /**
       
    83         * Get Logger settings. Mainly use from Logger side.
       
    84         */
       
    85         IMPORT_C TInt GetLoggerSettings( TLoggerSettings& aLoggerSettings );
       
    86 
       
    87         /**
       
    88         * Set new initialization file setting(e.g. SetAttribute).
       
    89         */
       
    90         IMPORT_C TInt SetLoggerOutputPath( const TDesC& aLoggerOutputPath );
       
    91 
       
    92         IMPORT_C TInt ResetLoggerSettings();
       
    93         
       
    94         /**
       
    95         * Read Logger setting from command line. Mainly use from
       
    96         * TestEngine side.
       
    97         */
       
    98         IMPORT_C TInt LoadLoggerSettingsFromCommandLine(TDesC& aLoggerSettings);
       
    99         
       
   100     public:     // Functions from base classes
       
   101         // None
       
   102 
       
   103     protected:  // New functions
       
   104         // None
       
   105 
       
   106     protected:  // Functions from base classes
       
   107         // None
       
   108 
       
   109     private:    // Functions from base classes
       
   110         // None
       
   111 
       
   112     public:     // Data
       
   113         // None
       
   114 
       
   115     protected:  // Data
       
   116         // None
       
   117 
       
   118     private:    // Data
       
   119         // None
       
   120 
       
   121     public:     // Friend classes
       
   122         // None
       
   123 
       
   124     protected:  // Friend classes
       
   125         // None
       
   126 
       
   127     private:    // Friend classes
       
   128         // None
       
   129 
       
   130     };
       
   131 
       
   132 #endif // SETTING_SERVER_CLIENT_H
       
   133 
       
   134 // End of File