|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE concept |
|
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
|
12 <concept id="GUID-D14CD452-BFCE-5EBA-B73B-61AA045D23E4" xml:lang="en"><title>Log |
|
13 Engine Overview</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
14 <p>This topic describes the key concepts of Log Engine. </p> |
|
15 <section id="GUID-ECD7C71D-F465-48FC-8478-65E5D09E6124"><title>Purpose</title> <p>Used to record events of interest to the |
|
16 user, of which they may not be immediately aware, or of high importance as |
|
17 costs are incurred, such as telephone calls. These events can be retrieved |
|
18 by a viewer application and displayed to the user. </p> </section> |
|
19 <section id="GUID-44BF0863-2E2B-4E2B-A04A-03956C9A64BA"><title>Architectural relationships</title> <p>The Log Engine is split |
|
20 into a wrapper (a stub interface) that is present on all UI variants, and |
|
21 an actual logging DLL that may or may not be present. On UI variants on which |
|
22 the actual logging engine is not present, calls to the wrapper will have no |
|
23 effect. Programs written for multiple UI variants should use the wrapper only. |
|
24 Programs for a particular UI variant on which the log engine is present can |
|
25 use it directly. </p> </section> |
|
26 <section id="GUID-D2D4E2AA-1842-4394-B916-3B473C578DBE"><title>Description</title> <p>The API has five key concepts: log |
|
27 engine wrapper, log client, event, view, and filter. </p> <p><b>Log |
|
28 engine wrapper</b> </p> <p>The log engine wrapper provides simple interfaces |
|
29 to record events, and is present on all UI variants. The wrapper interfaces |
|
30 are <xref href="GUID-146D719E-BDD6-3F20-80B1-EDE09081A6EA.dita"><apiname>CLogWrapper</apiname></xref> and <xref href="GUID-4A7D312F-A8C6-3663-8455-13FA73F1CFB5.dita"><apiname>CLogBase</apiname></xref>. </p> <p><b>Log client</b> </p> <p>The log client is the main direct interface on |
|
31 the log engine. It is used to add, delete, and change log events, and allows |
|
32 log administration. It is also used to create filtered views of events. </p> <p>The |
|
33 log client interface is <xref href="GUID-51C67545-12BA-326D-BD8F-662B24C68ED2.dita"><apiname>CLogClient</apiname></xref>. </p> <p><b>Event</b> </p> <p>A log event is an entry in the log. Events have a fixed |
|
34 number of data fields, though some fields do not apply to all events. </p> <p>The |
|
35 event interface is <xref href="GUID-CDFB61A7-1C74-3F63-9FDF-5A3B8603A010.dita"><apiname>CLogEvent</apiname></xref>. </p> <p><b>View</b> </p> <p>A view allows a filtered list of events to be accessed. |
|
36 Views are provided for the main event log (<codeph>CLogViewEvent</codeph>) |
|
37 and for recent events only (<xref href="GUID-F40F9556-F223-36A5-9812-6EF6FF3F5156.dita"><apiname>CLogViewRecent</apiname></xref>). </p> <p><b>Filter </b> </p> <p>A filter specifies the type of events that appear |
|
38 in a view. The filter interface is <xref href="GUID-99144BA6-F79A-3D3C-B1D3-272B3723C42C.dita"><apiname>CLogFilter</apiname></xref>. </p> </section> |
|
39 </conbody><related-links> |
|
40 <link href="GUID-B0D76734-1DB7-5465-91AE-BB3521599A75.dita"><linktext>How To Use |
|
41 the Log Engine</linktext></link> |
|
42 <link href="GUID-F3770B99-5228-5D29-8CA6-71028A327714.dita"><linktext> Log Engine |
|
43 Using Central Repository</linktext></link> |
|
44 </related-links></concept> |