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(CLogEvent &,TRequestStatus &)Adds an event to the log database. This is an asynchronous request.
• CLogBase(TInt)Sets the priority of this active object.
• CLogBase_Reserved1()
• ChangeEvent(const CLogEvent &,TRequestStatus &)Changes the details of an existing event. This is an asynchronous request.
• DeleteEvent(TLogId,TRequestStatus &)Deletes an event from the log. This is an asynchronous request.
• DoRunL()
• GetEvent(CLogEvent &,TRequestStatus &)Gets the details of an existing event. This is an asynchronous request.
• GetString(TDes &,TInt)constGets a standard string from the logwrap.dll resource file.
• LoadResourcesL(RFs &)
• ResourceFile()const
• ~CLogBase()Fees all resources owned by the object prior to its destruction. In particular i...

Inherited from CActive:

• CActive(TInt)Constructs the active object with the specified priority.
• Cancel()Cancels the wait for completion of an outstanding request.
• Deque()Removes the active object from the active scheduler's list of active objects.
• EPriorityHighA priority higher than EPriorityUserInput.
• EPriorityIdleA low priority, useful for active objects representing background processing.
• EPriorityLowA priority higher than EPriorityIdle but lower than EPriorityStandard.
• EPriorityStandardMost active objects will have this priority.
• EPriorityUserInputA priority higher than EPriorityStandard; useful for active objects handling use...
• Extension_(TUint,TAny *&,TAny *)Extension function
• IsActive()constDetermines whether the active object has a request outstanding.
• IsAdded()constDetermines whether the active object has been added to the active scheduler's li...
• Priority()constGets the priority of the active object.
• RunError(TInt)Handles a leave occurring in the request completion event handler CActive::RunL(...
• RunL()Handles an active object's request completion event.
• SetActive()Indicates that the active object has issued a request and that it is now outstan...
• SetPriority(TInt)Sets the priority of the active object.
• TPriorityDefines standard priorities for active objects.
• iStatusThe request status associated with an asynchronous request.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CLogActive:

• CLogActive(TInt)
• Complete(TInt)
• DoCancel()Implements cancellation of an outstanding request.
• Queue(TRequestStatus &)

See also:

• CLogClientLog Engine implementation.
• CLogWrapperThe log wrapper.

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.

IMPORT_C virtual 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.

IMPORT_C virtual 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.

IMPORT_C virtual 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.

IMPORT_C virtual 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..

IMPORT_C virtual 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

TDes16 &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:

• RResourceFileAccesses a resource file and reads the resource data into a buffer.

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: IMPORT_C virtual void CLogBase_Reserved1();

Description