Collapse all Symbian^3 Product Developer Library

CLogBase Class Reference

class CLogBase : public CLogActive

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.

CLogClient CLogWrapper

Inherits from

CLogBase
- CLogActive
  - CActive
    - CBase

Public Member Functions
	CLogBase(TInt)
	~CLogBase()
IMPORT_C void	AddEvent(CLogEvent &, TRequestStatus &)
IMPORT_C void	ChangeEvent(const CLogEvent &, TRequestStatus &)
IMPORT_C void	DeleteEvent(TLogId, TRequestStatus &)
IMPORT_C void	GetEvent(CLogEvent &, TRequestStatus &)
IMPORT_C TInt	GetString(TDes &, TInt)

Protected Member Functions
IMPORT_C void	LoadResourcesL(RFs &)
const CResourceFile *	ResourceFile()

Private Member Functions
IMPORT_C void	CLogBase_Reserved1()
void	DoRunL()

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::RunError(TInt)
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CLogActive::CLogActive(TInt)
	CLogActive::Complete(TInt)
	CLogActive::DoCancel()
	CLogActive::Queue(TRequestStatus &)
	CLogActive::~CLogActive()

Inherited Enumerations
	CActive:TPriority

Private Attributes
TAny *	CLogBase_Reserved
CResourceFile *	iResourceFile

Inherited Attributes
	CActive::iStatus

Constructor & Destructor Documentation

CLogBase(TInt)

IMPORT_C

CLogBase

(

TInt

aPriority

)

Sets the priority of this active object.

Parameters

TInt aPriority

The priority of this active object.

~CLogBase()

IMPORT_C

~CLogBase

(

)

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

Member Functions Documentation

AddEvent(CLogEvent &, TRequestStatus &)

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

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

This function is overridden by log engine implementations.

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

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.

CLogBase_Reserved1()

IMPORT_C void

CLogBase_Reserved1

(

)

[private, virtual]

ChangeEvent(const CLogEvent &, TRequestStatus &)

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

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

This function is overridden by log engine implementations.

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

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.

DeleteEvent(TLogId, TRequestStatus &)

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

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

This function is overridden by log engine implementations.

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

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

DoRunL()

void

DoRunL

(

)

[private, virtual]

GetEvent(CLogEvent &, TRequestStatus &)

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

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

This function is overridden by log engine implementations.

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

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.

GetString(TDes &, TInt)

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

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

This function is overridden by log engine implementations.

RResourceFile

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.

LoadResourcesL(RFs &)

IMPORT_C void

LoadResourcesL

(

RFs &

aFs

)

[protected]

Parameters

RFs & aFs

ResourceFile()

const CResourceFile *

ResourceFile

(

)

const [protected, inline]

Member Data Documentation

TAny * CLogBase_Reserved

TAny *

CLogBase_Reserved

[private]

CResourceFile * iResourceFile

CResourceFile *

iResourceFile

[private]