Class CLogBase

class CLogBase : public CLogActive;

Description

Base class for the log engine implementation.

This class defines the interface that client code uses to perform simple actions on the log database.

The class provides default implementations for the event handling functions. The Log Engine, i.e. an instance of CLogClient, is derived from this class and provides implementations for the event handling functions.

The class also deals with some aspects of resource file handling.

An instance of this class is constructed by the log wrapper, CLogWrapper, if the phone does not implement logging.

An instance of this class is never constructed by clients.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CActive - The core class of the active object abstraction

• CLogActive - Common active object behaviour

• CLogBase - Base class for the log engine implementation

Members

Defined in CLogBase:
AddEvent(), CLogBase(), CLogBase_Reserved1(), ChangeEvent(), DeleteEvent(), DoRunL(), GetEvent(), GetString(), LoadResourcesL(), ResourceFile(), ~CLogBase()

Inherited from CActive:
Cancel(), Deque(), EPriorityHigh, EPriorityIdle, EPriorityLow, EPriorityStandard, EPriorityUserInput, Extension_(), IsActive(), IsAdded(), Priority(), RunError(), SetActive(), SetPriority(), TPriority, iStatus

Inherited from CBase:
Delete(), operator new()

Inherited from CLogActive:
Complete(), DoCancel(), DoComplete(), Queue(), RunL()

See also:

• CLogClient
• CLogWrapper

IMPORT_C CLogBase(TInt aPriority);

Description

Sets the priority of this active object.

Parameters

TInt aPriority The priority of this active object.

IMPORT_C ~CLogBase();

Description

Fees all resources owned by the object prior to its destruction. In particular it closes the resource file reader.

Capability:

Security policy note:

For built-in event types, the required capability level is defined in the event type's read access policy.

virtual IMPORT_C void GetEvent(CLogEvent &aEvent, TRequestStatus &aStatus);

Description

Gets the details of an existing event. This is an asynchronous request.

This function is overridden by log engine implementations.

Parameters

CLogEvent &aEvent A reference to a log event detail object. This value is not used. TRequestStatus &aStatus The request status. On completion of the asynchronous request, it always contains KErrNotSupported.

Capability:

Security policy note:

For built-in event types, the required capability level is defined in the event type's write access policy.

virtual IMPORT_C void AddEvent(CLogEvent &aEvent, TRequestStatus &aStatus);

Description

Adds an event to the log database. This is an asynchronous request.

This function is overridden by log engine implementations.

Parameters

CLogEvent &aEvent A reference to a log event detail object. This value is not used. TRequestStatus &aStatus The request status. On completion of the asynchronous request, it always contains KErrNotSupported.

Capability:

Security policy note:

For built-in event types, the required capability level is defined in the event type's write access policy.

virtual IMPORT_C void ChangeEvent(const CLogEvent &aEvent, TRequestStatus &aStatus);

Description

Changes the details of an existing event. This is an asynchronous request.

This function is overridden by log engine implementations.

Parameters

const CLogEvent &aEvent A reference to a log event detail object. This value is not used. TRequestStatus &aStatus The request status. On completion of the asynchronous request, it always contains KErrNotSupported.

Capability:

Security policy note:

For built-in event types, the required capability level is defined in the event type's write access policy.

virtual IMPORT_C void DeleteEvent(TLogId aId, TRequestStatus &aStatus);

Description

Deletes an event from the log. This is an asynchronous request.

This function is overridden by log engine implementations.

Parameters

TLogId aId The unique event ID of the event to be deleted. This value is not used. TRequestStatus &aStatus The request status. On completion of the asynchronous request, it always contains KErrNotSupported..

virtual IMPORT_C TInt GetString(TDes &aString, TInt aId) const;

Description

Gets a standard string from the logwrap.dll resource file.

This function is overridden by log engine implementations.

Parameters

TDes &aString A modifiable descriptor. The length of this descriptor is set to zero. TInt aId The resource ID for the string. This value is not used.

Return value

TInt KErrNotSupported.

See also:

• RResourceFile

protected: IMPORT_C void LoadResourcesL(RFs &aFs);

Description

Parameters

RFs &aFs

protected: inline const CResourceFile *ResourceFile() const;

Description

Return value

const CResourceFile *

private: virtual void DoRunL();

Description

private: virtual IMPORT_C void CLogBase_Reserved1();

Description