CLogClient Class Reference

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.

Inherits from

CLogClient
- CLogBase
  - CLogActive
    - CActive
      - CBase

Public Member Functions
	~CLogClient()
IMPORT_C void	AddEvent(CLogEvent &, TRequestStatus &)
IMPORT_C void	AddEventType(const CLogEventType &, TRequestStatus &)
IMPORT_C void	ChangeConfig(const TLogConfig &, TRequestStatus &)
IMPORT_C void	ChangeEvent(const CLogEvent &, TRequestStatus &)
IMPORT_C void	ChangeEventType(const CLogEventType &, TRequestStatus &)
IMPORT_C void	ClearLog(const TTime &, TRequestStatus &)
IMPORT_C void	ClearLog(TInt, TRequestStatus &)
IMPORT_C void	ClearLog(const TTime &, TSimId, TRequestStatus &)
IMPORT_C void	ClearLog(TInt, TSimId, TRequestStatus &)
IMPORT_C void	DeleteEvent(TLogId, TRequestStatus &)
IMPORT_C void	DeleteEventType(TUid, TRequestStatus &)
IMPORT_C void	GetConfig(TLogConfig &, TRequestStatus &)
IMPORT_C void	GetEvent(CLogEvent &, TRequestStatus &)
IMPORT_C void	GetEventType(CLogEventType &, TRequestStatus &)
IMPORT_C TInt	GetString(TDes &, TInt)
IMPORT_C CLogClient *	NewL(RFs &, TInt)
IMPORT_C void	NotifyChange(TTimeIntervalMicroSeconds32, TRequestStatus &)
IMPORT_C void	NotifyChangeCancel()
RLogSession &	Session()
IMPORT_C void	SetGlobalChangeObserverL(MLogClientChangeObserver *)

Private Member Functions
	CLogClient(RFs &, TInt)
IMPORT_C void	CLogBase_Reserved1()
void	ConstructL()
void	DoCancel()
void	DoGetStringL(TDes &, TInt)
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::Queue(TRequestStatus &)
	CLogActive::~CLogActive()
	CLogBase::CLogBase(TInt)
	CLogBase::LoadResourcesL(RFs &)
	CLogBase::ResourceFile()const
	CLogBase::~CLogBase()

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

Constructor & Destructor Documentation

CLogClient(RFs &, TInt)

CLogClient	(	RFs &	aFs,
		TInt	aPriority
	)	[private]

Parameters

RFs & aFs
TInt aPriority

~CLogClient()

IMPORT_C

~CLogClient

(

)

Member Functions Documentation

AddEvent(CLogEvent &, TRequestStatus &)

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

Parameters

CLogEvent & aEvent
TRequestStatus & aStatus

AddEventType(const CLogEventType &, TRequestStatus &)

IMPORT_C void	AddEventType	(	const CLogEventType &	aType,
			TRequestStatus &	aStatus
		)

Parameters

const CLogEventType & aType
TRequestStatus & aStatus

CLogBase_Reserved1()

IMPORT_C void

CLogBase_Reserved1

(

)

[private, virtual]

ChangeConfig(const TLogConfig &, TRequestStatus &)

IMPORT_C void	ChangeConfig	(	const TLogConfig &	aConfig,
			TRequestStatus &	aStatus
		)

Parameters

const TLogConfig & aConfig
TRequestStatus & aStatus

ChangeEvent(const CLogEvent &, TRequestStatus &)

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

Parameters

const CLogEvent & aEvent
TRequestStatus & aStatus

ChangeEventType(const CLogEventType &, TRequestStatus &)

IMPORT_C void	ChangeEventType	(	const CLogEventType &	aType,
			TRequestStatus &	aStatus
		)

Parameters

const CLogEventType & aType
TRequestStatus & aStatus

ClearLog(const TTime &, TRequestStatus &)

IMPORT_C void	ClearLog	(	const TTime &	aDate,
			TRequestStatus &	aStatus
		)

Parameters

const TTime & aDate
TRequestStatus & aStatus

ClearLog(TInt, TRequestStatus &)

IMPORT_C void	ClearLog	(	TInt	aRecentList,
			TRequestStatus &	aStatus
		)

Parameters

TInt aRecentList
TRequestStatus & aStatus

ClearLog(const TTime &, TSimId, TRequestStatus &)

IMPORT_C void	ClearLog	(	const TTime &	aDate,
			TSimId	aSimid,
			TRequestStatus &	aStatus
		)

Parameters

const TTime & aDate
TSimId aSimid
TRequestStatus & aStatus

ClearLog(TInt, TSimId, TRequestStatus &)

IMPORT_C void	ClearLog	(	TInt	aRecentList,
			TSimId	aSimid,
			TRequestStatus &	aStatus
		)

Parameters

TInt aRecentList
TSimId aSimid
TRequestStatus & aStatus

ConstructL()

void

ConstructL

(

)

[private]

DeleteEvent(TLogId, TRequestStatus &)

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

Parameters

TLogId aId
TRequestStatus & aStatus

DeleteEventType(TUid, TRequestStatus &)

IMPORT_C void	DeleteEventType	(	TUid	aId,
			TRequestStatus &	aStatus
		)

Parameters

TUid aId
TRequestStatus & aStatus

DoCancel()

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

CActive::Cancel

DoGetStringL(TDes &, TInt)

void	DoGetStringL	(	TDes &	aString,
			TInt	aId
		)	const [private]

Parameters

TDes & aString
TInt aId

DoRunL()

void

DoRunL

(

)

[private, virtual]

GetConfig(TLogConfig &, TRequestStatus &)

IMPORT_C void	GetConfig	(	TLogConfig &	aConfig,
			TRequestStatus &	aStatus
		)

Parameters

TLogConfig & aConfig
TRequestStatus & aStatus

GetEvent(CLogEvent &, TRequestStatus &)

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

Parameters

CLogEvent & aEvent
TRequestStatus & aStatus

GetEventType(CLogEventType &, TRequestStatus &)

IMPORT_C void	GetEventType	(	CLogEventType &	aType,
			TRequestStatus &	aStatus
		)

Parameters

CLogEventType & aType
TRequestStatus & aStatus

GetString(TDes &, TInt)

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

Parameters

TDes & aString
TInt aId

NewL(RFs &, TInt)

IMPORT_C CLogClient *	NewL	(	RFs &	aFs,
			TInt	aPriority = CActive::EPriorityStandard
		)	[static]

Parameters

RFs & aFs
TInt aPriority = CActive::EPriorityStandard

NotifyChange(TTimeIntervalMicroSeconds32, TRequestStatus &)

IMPORT_C void	NotifyChange	(	TTimeIntervalMicroSeconds32	aDelay,
			TRequestStatus &	aStatus
		)

Parameters

TTimeIntervalMicroSeconds32 aDelay
TRequestStatus & aStatus

NotifyChangeCancel()

IMPORT_C void

NotifyChangeCancel

(

)

Session()

RLogSession &

Session

(

)

const

SetGlobalChangeObserverL(MLogClientChangeObserver *)

IMPORT_C void

SetGlobalChangeObserverL

(

MLogClientChangeObserver *

aObserver

)

Parameters

MLogClientChangeObserver * aObserver

Member Data Documentation

CLogAddEventClientOp * iAddEvent

CLogAddEventClientOp *

iAddEvent

[private]

CLogAddTypeClientOp * iAddType

CLogAddTypeClientOp *

iAddType

[private]

CLogChangeConfigClientOp * iChangeConfig

CLogChangeConfigClientOp *

iChangeConfig

[private]

CLogChangeEventClientOp * iChangeEvent

CLogChangeEventClientOp *

iChangeEvent

[private]

CLogClientObserver * iChangeObserver

CLogClientObserver *

iChangeObserver

[private]

CLogChangeTypeClientOp * iChangeType

CLogChangeTypeClientOp *

iChangeType

[private]

CLogClearLogClientOp * iClearLog

CLogClearLogClientOp *

iClearLog

[private]

CLogClearRecentClientOp * iClearRecent

CLogClearRecentClientOp *

iClearRecent

[private]

CLogDeleteEventClientOp * iDeleteEvent

CLogDeleteEventClientOp *

iDeleteEvent

[private]

CLogDeleteTypeClientOp * iDeleteType

CLogDeleteTypeClientOp *

iDeleteType

[private]

RFs & iFs

RFs &

iFs

[private]

CLogGetConfigClientOp * iGetConfig

CLogGetConfigClientOp *

iGetConfig

[private]

CLogGetEventClientOp * iGetEvent

CLogGetEventClientOp *

iGetEvent

[private]

CLogGetTypeClientOp * iGetType

CLogGetTypeClientOp *

iGetType

[private]

CLogPackage * iPackage

CLogPackage *

iPackage

[private]

RLogSession * iSession

RLogSession *

iSession

[private]