2
|
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 |
* CSettingServer.
|
|
16 |
*
|
|
17 |
*/
|
|
18 |
|
|
19 |
#ifndef SETTING_SERVER_H
|
|
20 |
#define SETTING_SERVER_H
|
|
21 |
|
|
22 |
// INCLUDES
|
|
23 |
#include <e32std.h>
|
|
24 |
#include <e32base.h>
|
|
25 |
#include <StifLogger.h>
|
|
26 |
#include "Logging.h"
|
|
27 |
#include "TestEngineClient.h"
|
|
28 |
#include "SettingServerClientServer.h"
|
|
29 |
|
|
30 |
// CONSTANTS
|
|
31 |
|
|
32 |
// MACROS
|
|
33 |
|
|
34 |
// DATA TYPES
|
|
35 |
|
|
36 |
// FORWARD DECLARATIONS
|
|
37 |
// None
|
|
38 |
|
|
39 |
// CLASS DECLARATION
|
|
40 |
|
|
41 |
// DESCRIPTION
|
|
42 |
// CSettingServer is a server class.
|
|
43 |
class CSettingServer
|
|
44 |
:public CServer2 // Inter Process Communication version 2 is used(EKA2)
|
|
45 |
{
|
|
46 |
public: // Enumerations
|
|
47 |
enum { ESettingServerSchedulerPriority = CActive::EPriorityHigh };
|
|
48 |
|
|
49 |
private: // Enumerations
|
|
50 |
|
|
51 |
public: // Constructors and destructor
|
|
52 |
|
|
53 |
/**
|
|
54 |
* NewL is first phase of two-phased constructor.
|
|
55 |
*/
|
|
56 |
static CSettingServer* NewL( const TName& aName );
|
|
57 |
|
|
58 |
/**
|
|
59 |
* Destructor of CSettingServer.
|
|
60 |
*/
|
|
61 |
~CSettingServer();
|
|
62 |
|
|
63 |
public: // New functions
|
|
64 |
|
|
65 |
/**
|
|
66 |
* ThreadFunction is used to create new thread.
|
|
67 |
*/
|
|
68 |
static TInt ThreadFunction( TAny* aStarted );
|
|
69 |
|
|
70 |
/**
|
|
71 |
* PanicServer panics the CSettingServer
|
|
72 |
*/
|
|
73 |
static void PanicServer( const TSettingServerPanic aPanic );
|
|
74 |
|
|
75 |
/**
|
|
76 |
* Return pointer to the Logger(iSettingServerLogger)
|
|
77 |
*/
|
|
78 |
CStifLogger* CSettingServer::Logger();
|
|
79 |
|
|
80 |
public: // Functions from base classes
|
|
81 |
|
|
82 |
/**
|
|
83 |
* NewSessionL creates new CSettingServer session.
|
|
84 |
*/
|
|
85 |
CSession2* NewSessionL( const TVersion &aVersion,
|
|
86 |
const RMessage2& aMessage ) const;
|
|
87 |
/**
|
|
88 |
* Open session
|
|
89 |
*/
|
|
90 |
void OpenSession();
|
|
91 |
|
|
92 |
/**
|
|
93 |
* Close session
|
|
94 |
*/
|
|
95 |
void CloseSession();
|
|
96 |
|
|
97 |
|
|
98 |
void ResetLoggerSettings();
|
|
99 |
protected: // New functions
|
|
100 |
// None
|
|
101 |
|
|
102 |
protected: // Functions from base classes
|
|
103 |
// None
|
|
104 |
|
|
105 |
private:
|
|
106 |
|
|
107 |
/**
|
|
108 |
* C++ default constructor.
|
|
109 |
*/
|
|
110 |
CSettingServer();
|
|
111 |
|
|
112 |
/**
|
|
113 |
* By default Symbian OS constructor is private.
|
|
114 |
*/
|
|
115 |
void ConstructL();
|
|
116 |
|
|
117 |
public: //Data
|
|
118 |
|
|
119 |
// NOTE:
|
|
120 |
// There is one CSettingServer and may be many CLoggerSetting sessions
|
|
121 |
// so variables are defined here and are available to all sessions.
|
|
122 |
|
|
123 |
// Logger overwrite settings
|
|
124 |
TLoggerSettings iLoggerSettings;
|
|
125 |
|
|
126 |
// Includes inifile name and path information
|
|
127 |
TFileName iIniFile;
|
|
128 |
|
|
129 |
TBool iDefaultSettings;
|
|
130 |
protected: // Data
|
|
131 |
// None
|
|
132 |
|
|
133 |
private: // Data
|
|
134 |
|
|
135 |
// Session counter
|
|
136 |
TInt iSessions;
|
|
137 |
|
|
138 |
// Logger instance
|
|
139 |
CStifLogger* iSettingServerLogger;
|
|
140 |
|
|
141 |
public: // Friend classes
|
|
142 |
// None
|
|
143 |
|
|
144 |
protected: // Friend classes
|
|
145 |
// None
|
|
146 |
|
|
147 |
private: // Friend classes
|
|
148 |
// None
|
|
149 |
|
|
150 |
};
|
|
151 |
|
|
152 |
// DESCRIPTION
|
|
153 |
// CLoggerSetting is a session class.
|
|
154 |
// Session for the CSettingServer server, to a single client-side session
|
|
155 |
// a session may own any number of CCounter objects
|
|
156 |
|
|
157 |
class CLoggerSetting
|
|
158 |
:public CSession2
|
|
159 |
{
|
|
160 |
public:
|
|
161 |
// None
|
|
162 |
|
|
163 |
private: // Enumerations
|
|
164 |
// None
|
|
165 |
|
|
166 |
public: // Constructors and destructor
|
|
167 |
|
|
168 |
/**
|
|
169 |
* Construct a clean-up server session
|
|
170 |
*/
|
|
171 |
static CLoggerSetting* NewL( CSettingServer* aServer );
|
|
172 |
|
|
173 |
/**
|
|
174 |
* Destructor
|
|
175 |
*/
|
|
176 |
virtual ~CLoggerSetting();
|
|
177 |
|
|
178 |
public: // New functions
|
|
179 |
|
|
180 |
/**
|
|
181 |
* Dispatch message
|
|
182 |
*/
|
|
183 |
TInt DispatchMessageL( const RMessage2& aMessage,
|
|
184 |
TBool& aIsMessageSync );
|
|
185 |
|
|
186 |
/**
|
|
187 |
* Close the session to CSettingpServer.
|
|
188 |
*/
|
|
189 |
TInt CloseSession( /*const RMessage& aMessage*/ );
|
|
190 |
|
|
191 |
/**
|
|
192 |
* Read Logger setting from initialization file. Mainly use from
|
|
193 |
* TestEngine side.
|
|
194 |
*/
|
|
195 |
TInt LoadLoggerSettingsFromIniFile( const RMessage2& aMessage );
|
|
196 |
/**
|
|
197 |
* Read Logger setting from Command Line . Mainly use from
|
|
198 |
* TestEngine side.
|
|
199 |
*/
|
|
200 |
TInt LoadLoggerSettingsFromCommandLine( const RMessage2& aMessage );
|
|
201 |
|
|
202 |
/**
|
|
203 |
* Get Logger settings. Mainly use from Logger side.
|
|
204 |
*/
|
|
205 |
TInt GetLoggerSettings( const RMessage2& aMessage );
|
|
206 |
|
|
207 |
/**
|
|
208 |
*
|
|
209 |
*/
|
|
210 |
TInt SetLoggerOutputPath( const RMessage2& aMessage );
|
|
211 |
|
|
212 |
/**
|
|
213 |
*
|
|
214 |
*/
|
|
215 |
TInt ResetLoggerSettings( const RMessage2& aMessage );
|
|
216 |
|
|
217 |
/**
|
|
218 |
* PanicClient panics the user of CLoggerSetting
|
|
219 |
*/
|
|
220 |
void PanicClient( TInt aPanic, const RMessage2& aMessage ) const;
|
|
221 |
|
|
222 |
public: // Functions from base classes
|
|
223 |
|
|
224 |
/**
|
|
225 |
* ServiceL handles the messages to CSettingServer
|
|
226 |
*/
|
|
227 |
virtual void ServiceL( const RMessage2& aMessage );
|
|
228 |
|
|
229 |
protected: // New functions
|
|
230 |
// None
|
|
231 |
|
|
232 |
protected: // Functions from base classes
|
|
233 |
// None
|
|
234 |
private:
|
|
235 |
TInt UpdateLoggerSettings(TDesC& aKey,TDesC& aValue);
|
|
236 |
|
|
237 |
private:
|
|
238 |
|
|
239 |
/**
|
|
240 |
* C++ default constructor.
|
|
241 |
*/
|
|
242 |
CLoggerSetting();
|
|
243 |
|
|
244 |
/**
|
|
245 |
* By default Symbian OS constructor is private.
|
|
246 |
*/
|
|
247 |
void ConstructL( CSettingServer* aServer );
|
|
248 |
|
|
249 |
/**
|
|
250 |
* Real resource reservation routine
|
|
251 |
*/
|
|
252 |
TInt ReserveInternalL( const RMessage2& aMessage );
|
|
253 |
|
|
254 |
/**
|
|
255 |
* Read Logger default parameters for initialization file.
|
|
256 |
*/
|
|
257 |
TInt ReadLoggerDefaults();
|
|
258 |
|
|
259 |
public: // Data
|
|
260 |
// None
|
|
261 |
|
|
262 |
protected: // Data
|
|
263 |
// None
|
|
264 |
|
|
265 |
private: // Data
|
|
266 |
|
|
267 |
// Pointer to "parent"
|
|
268 |
CSettingServer* iSettingServer;
|
|
269 |
|
|
270 |
// Indication for reading logger defaults from initialization file.
|
|
271 |
TBool iReadOrUpdateLoggerDefaults;
|
|
272 |
|
|
273 |
public: // Friend classes
|
|
274 |
// None
|
|
275 |
|
|
276 |
protected: // Friend classes
|
|
277 |
// None
|
|
278 |
|
|
279 |
private: // Friend classes
|
|
280 |
// None
|
|
281 |
|
|
282 |
};
|
|
283 |
|
|
284 |
#endif // SETTING_SERVER_H
|
|
285 |
|
|
286 |
// End of File
|