class CLogClient : public CLogBase |
Log Engine implementation.
It creates a shared session on the log database and allows log viewers to retrieve events from the log.
The class also provides log administration functions.
Wherever time values are used by this class, they must be specified as UTC rather than local time.
Private Member Functions | |
---|---|
CLogClient ( RFs &, TInt ) | |
IMPORT_C void | CLogBase_Reserved1 () |
void | ConstructL () |
void | DoCancel () |
void | DoGetStringL ( TDes &, TInt ) |
void | DoRunL () |
Inherited Enumerations | |
---|---|
CActive:TPriority |
Private Attributes | |
---|---|
CLogAddEventClientOp * | iAddEvent |
CLogAddTypeClientOp * | iAddType |
CLogChangeConfigClientOp * | iChangeConfig |
CLogChangeEventClientOp * | iChangeEvent |
CLogClientObserver * | iChangeObserver |
CLogChangeTypeClientOp * | iChangeType |
CLogClearLogClientOp * | iClearLog |
CLogClearRecentClientOp * | iClearRecent |
CLogDeleteEventClientOp * | iDeleteEvent |
CLogDeleteTypeClientOp * | iDeleteType |
RFs & | iFs |
CLogGetConfigClientOp * | iGetConfig |
CLogGetEventClientOp * | iGetEvent |
CLogGetTypeClientOp * | iGetType |
CLogPackage * | iPackage |
RLogSession * | iSession |
Inherited Attributes | |
---|---|
CActive::iStatus |
IMPORT_C | ~CLogClient | ( | ) |
Frees all resources owned by the Log Engine object prior to its destruction. In particular, any outstanding asynchronous request is cancelled, the database, the database session and the resource file are all closed.
IMPORT_C void | AddEvent | ( | CLogEvent & | aEvent, |
TRequestStatus & | aStatus | |||
) | [virtual] |
Adds an event to the log database. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
CLogEvent & aEvent | A log event detail object containing the attributes of the event to be added. The Log Engine sets the unique event ID, the UTC time and the event description, replacing any supplied values. The caller must ensure that this object remains in existence and valid until the request is complete. |
TRequestStatus & aStatus | The request status. On request completion,contains: KErrNone, if the event has been successfully added to the log database; KErrNotFound, if the event type is not registered with the Log Engine; KErrNotSupported, if the logging of events of this type has been disabled; otherwise, one of the other system wide error codes. |
IMPORT_C void | AddEventType | ( | const CLogEventType & | aType, |
TRequestStatus & | aStatus | |||
) |
Registers a new event type. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
const CLogEventType & aType | The event type detail object containing the attributes of the event type to be registered. The caller must ensure that this object remains in existence and valid until the request is complete. |
TRequestStatus & aStatus | The request status. On request completion, contains:KErrNone, if successful; otherwise, one of the other system wide error codes. |
IMPORT_C void | ChangeConfig | ( | const TLogConfig & | aConfig, |
TRequestStatus & | aStatus | |||
) |
Changes the Log Engine configuration. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
const TLogConfig & aConfig | The new configuration values for the Log Engine. |
TRequestStatus & aStatus | The request status. On request completion, contains:KErrNone, if successful; otherwise, one of the other system wide error codes. |
IMPORT_C void | ChangeEvent | ( | const CLogEvent & | aEvent, |
TRequestStatus & | aStatus | |||
) | [virtual] |
Changes the details of an existing event. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
Note that it is not possible to change the event type using this function.
const CLogEvent & aEvent | The event detail object containing the attributes of the event to be changed. Before calling the function, this object must contain the appropriate unique event ID; if no unique event ID is set, the function raises a LogCli 13 panic. The caller must ensure that this object remains in existence and valid until the request is complete. |
TRequestStatus & aStatus | The request status. On request completion, contains:KErrNone, if successful; otherwise, one of the other system wide error codes. |
IMPORT_C void | ChangeEventType | ( | const CLogEventType & | aType, |
TRequestStatus & | aStatus | |||
) |
Changes the details of an existing event type. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
const CLogEventType & aType | The event type detail object containing the attributes of the event type to be changed. Before calling the function, this object must contain the UID identifying the event type; if no UID is set, the function raises a LogCli 13 panic. The caller must ensure that this object remains in existence and valid until the request is complete. |
TRequestStatus & aStatus | The request status. On request completion, contains: KErrNone, if successful; otherwise, one of the other system wide error codes. |
IMPORT_C void | ClearLog | ( | const TTime & | aDate, |
TRequestStatus & | aStatus | |||
) |
Clears all events from the main event log that occurred before the specified date and time. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
const TTime & aDate | The UTC date and time. |
TRequestStatus & aStatus | The request status. On request completion, contains:KErrNone, if successful; otherwise, one of the other system wide error codes. |
IMPORT_C void | ClearLog | ( | TInt | aRecentList, |
TRequestStatus & | aStatus | |||
) |
Clears the specified recent event list. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
TInt aRecentList | Identifies the recent event list to be cleared. The value KlogNullRecentList indicates that all recent event lists are to be cleared. |
TRequestStatus & aStatus | The request status. On request completion, contains:KErrNone, if successful; otherwise, one of the other system wide error codes. |
IMPORT_C void | ClearLog | ( | const TTime & | aDate, |
TSimId | aSimid, | |||
TRequestStatus & | aStatus | |||
) |
Not supported.
const TTime & aDate | |
TSimId aSimid | |
TRequestStatus & aStatus |
IMPORT_C void | ClearLog | ( | TInt | aRecentList, |
TSimId | aSimid, | |||
TRequestStatus & | aStatus | |||
) |
Not supported.
TInt aRecentList | |
TSimId aSimid | |
TRequestStatus & aStatus |
IMPORT_C void | DeleteEvent | ( | TLogId | aId, |
TRequestStatus & | aStatus | |||
) | [virtual] |
Deletes the event with the specified unique event ID, from the main event log.
TLogId aId | The unique event ID of the event to be deleted. This must not be the null unique event ID, KLogNullId, otherwise the function raises a LogCli 13 panic. |
TRequestStatus & aStatus | The request status. On request completion, contains:KErrNone, if successful; otherwise, one of the other system wide error codes. |
IMPORT_C void | DeleteEventType | ( | TUid | aId, |
TRequestStatus & | aStatus | |||
) |
Removes an existing event type. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
Note that this function does not remove events from the event log, so it is possible to have events in the log that are of an unknown type. This function allows an event type associated with a component to be removed when that component is uninstalled.
TUid aId | The UID of the event type to be deleted. |
TRequestStatus & aStatus | The request status. On request completion, contains:KErrNone, if successful; otherwise, one of the other system wide error codes. |
void | DoCancel | ( | ) | [private, virtual] |
Implements cancellation of an outstanding request.
This function is called as part of the active object's Cancel() .
It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.
DoCancel() must not wait for event completion; this is handled by Cancel() .
IMPORT_C void | GetConfig | ( | TLogConfig & | aConfig, |
TRequestStatus & | aStatus | |||
) |
Gets the Log Engine configuration. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
TLogConfig & aConfig | A reference to a Log Engine configuration object. The caller must ensure that this object remains in existence and valid until the request is complete. On successful completion of the request, it contains the Log Engine configuration data. |
TRequestStatus & aStatus | The request status. On request completion, contains:KErrNone, if successful; otherwise, one of the other system wide error codes. |
IMPORT_C void | GetEvent | ( | CLogEvent & | aEvent, |
TRequestStatus & | aStatus | |||
) | [virtual] |
Gets the details of the specified event. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
CLogEvent & aEvent | A reference to a log event detail object. Before calling the function, this object must contain the appropriate unique event ID; if no unique event ID is set, the function raises a LogServ 50 panic. The caller must ensure that this object remains in existence and valid until the request is complete. On successful completion of the request, it contains the appropriate log event detail. |
TRequestStatus & aStatus | The request status. On request completion, contains:KErrNone, if successful; otherwise, one of the other system wide error codes. |
IMPORT_C void | GetEventType | ( | CLogEventType & | aType, |
TRequestStatus & | aStatus | |||
) |
Gets the details of an event type. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
CLogEventType & aType | A reference to an event type detail object. Before calling the function, this object must contain the UID identifying the event type; if no UID is set, the function raises a LogCli 13 panic. The caller must ensure that this object remains in existence and valid until the request is complete. On successful completion of the request, it contains the appropriate event type detail. |
TRequestStatus & aStatus | The request status. On request completion, contains: KErrNone, if successful; otherwise one of the other system wide error codes. |
IMPORT_C TInt | GetString | ( | TDes & | aString, |
TInt | aId | |||
) | const [virtual] |
Gets a standard string from the specified resource in logwrap.dll resource file.
The function can be used to populate some of the event fields in a CLogEvent object before creating or changing an event.
Note that TLogString is a modifiable buffer descriptor that is guaranteed to be large enough to contain all standard strings used in the Log Engine; pass an instance of this type to this function.
IMPORT_C CLogClient * | NewL | ( | RFs & | aFs, |
TInt | aPriority = CActive::EPriorityStandard | |||
) | [static] |
IMPORT_C void | NotifyChange | ( | TTimeIntervalMicroSeconds32 | aDelay, |
TRequestStatus & | aStatus | |||
) |
Requests notification of changes to the Log Engine database. This is an asynchronous request.
The function requires the caller to specify a minimum time that must elapse before this notification request can complete. The Log Engine buffers all changes that occur during this time; the request, then completes after this minimum time period has elapsed. If no changes occur within this time period, then the request completes when the next change to the database occurs.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
Note that once a notification request has completed, this function must be called again to get further change notifications.
TTimeIntervalMicroSeconds32 aDelay | The minimum time, in microseconds, that elapses before the notification request can complete. |
TRequestStatus & aStatus | The request status. On request completion, contains:KErrNone, if successful;KErrCancel, if an outstanding notification request is cancelled; otherwise, one of the other system wide error codes. |
IMPORT_C void | NotifyChangeCancel | ( | ) |
Cancels any outstanding notification request for changes to Log Engine database.
IMPORT_C void | SetGlobalChangeObserverL | ( | MLogClientChangeObserver * | aObserver | ) |
MLogClientChangeObserver * aObserver |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.