author | Maciej Seroka <maciejs@symbian.org> |
Fri, 11 Jun 2010 11:03:55 +0100 | |
branch | Symbian3 |
changeset 40 | 2870b072e108 |
parent 6 | c108117318cb |
permissions | -rw-r--r-- |
1
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
1 |
/** |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
2 |
* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies). |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
3 |
* All rights reserved. |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
4 |
* This component and the accompanying materials are made available |
6 | 5 |
* under the terms of the License "Eclipse Public License v1.0" |
1
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
6 |
* which accompanies this distribution, and is available |
6 | 7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html". |
1
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
8 |
* |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
9 |
* Initial Contributors: |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
10 |
* Nokia Corporation - initial contribution. |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
11 |
* |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
12 |
* Contributors: |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
13 |
* |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
14 |
* Description: |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
15 |
* |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
16 |
*/ |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
17 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
18 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
19 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
20 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
21 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
22 |
/** |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
23 |
@file |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
24 |
*/ |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
25 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
26 |
#ifndef LBS_LOGGER_H |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
27 |
#define LBS_LOGGER_H |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
28 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
29 |
#include <lbslogevent.h> |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
30 |
#include <e32base.h> |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
31 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
32 |
class CLbsLogWriterEngine; |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
33 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
34 |
class RLbsLogger |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
35 |
/** |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
36 |
Class the provides the APIs for adding and updating LBS events into the LogEng. |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
37 |
In order to add (or update) any event, a handle must have been opened for this class |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
38 |
(so OpenL() must have been called, without calling Close() meanwhile on the class). |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
39 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
40 |
Internally, the engine, queues the add and update requests until they can be processed. The |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
41 |
queue has a maximum size, so if too many items will get on the queue the AddEventL() method |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
42 |
can return an error. |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
43 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
44 |
When the client finishes sending all the add and update requests, Close() should be |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
45 |
called on the class. This will ensure that the internal engine logs all the events it |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
46 |
queued into the LogEng. When calling Close() it will wait for LogEng to finish |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
47 |
logging all the events. |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
48 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
49 |
@internalTechnology |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
50 |
@released |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
51 |
*/ |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
52 |
{ |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
53 |
public: |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
54 |
IMPORT_C RLbsLogger(); |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
55 |
IMPORT_C ~RLbsLogger(); |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
56 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
57 |
IMPORT_C TInt Open(TUint aMaxBufferSize); |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
58 |
IMPORT_C TInt AddEvent(CLbsLogEvent& aLogEvent); |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
59 |
IMPORT_C TInt UpdateEvent(CLbsLogEvent& aLogEvent); |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
60 |
IMPORT_C TInt Close(); |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
61 |
// for BC consideration |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
62 |
virtual void ExtensionInterfaceL(TUid aInterface, void*& aObject); |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
63 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
64 |
private: |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
65 |
void CheckLoggingAdminSettings(); |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
66 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
67 |
private: |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
68 |
/** Pointer to the active object which does the logging */ |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
69 |
CLbsLogWriterEngine* iLogWriterEngine; |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
70 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
71 |
/** Flag to indicate if logging is currently On or Off, determined from the admin db setting. */ |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
72 |
TBool iLoggingOn; |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
73 |
}; // class RLbsLogger |
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
74 |
|
8758140453c0
Added Symbian2 smoketests from FBF at changeset bde28f2b1d99
Maciej Seroka <maciejs@symbian.org>
parents:
diff
changeset
|
75 |
#endif // LBS_LOGGER_H |