Class CSmsEventLogger

class CSmsEventLogger : public CSmsuActiveBase;

Description

Logs SMS-related events.

The class uses the log engine functionality provided by the Log Engine (CLogWrapper etc.).

Derivation

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

• CActive - The core class of the active object abstraction

• CSmsuActiveBase - Base class for SMS active objects

• CSmsEventLogger - Logs SMS-related events

Members

Defined in CSmsEventLogger:
AddEvent(), ChangeEvent(), ClientAvailable(), DeleteEvent(), DoCancel(), DoComplete(), DoRunL(), Event(), Event(), GetEvent(), GetString(), NewL(), SmsPDUData(), ~CSmsEventLogger()

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

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

Inherited from CSmsuActiveBase:
Complete(), CompleteMyself(), ConstructTimeoutL(), Queue(), RunError(), RunL(), TimedSetActive(), iReport, iSmsuTimeout

Capability:

Illegal

static IMPORT_C CSmsEventLogger *NewL(RFs &aFs, TInt aPriority=CActive::EPriorityStandard);

Description

Allocates and creates a logger.

Parameters

RFs &aFs File server handle TInt aPriority Active object priority

Return value

CSmsEventLogger * New CSmsEventLogger object

Capability:

Illegal

IMPORT_C ~CSmsEventLogger();

Description

Destructor.

Capability:

WriteUserData

IMPORT_C void AddEvent(TRequestStatus &aStatus, const CSmsMessage &aSmsMessage, const TLogSmsPduData &aData, TInt *aStatusId=0);

Description

Adds an event to the log database.

Parameters

TRequestStatus &aStatus Asynchronous status word to signal when the operation is complete const CSmsMessage &aSmsMessage The SMS message that the event concerns const TLogSmsPduData &aData SMS PDU information for the event TInt *aStatusId Optional string to include in the log message, specified by resource ID

Capability:

ReadUserData

IMPORT_C void GetEvent(TRequestStatus &aStatus, TLogId aId);

Description

Gets the specified event from the log.

The event itself can be obtained using a subsequent call to Event().

Parameters

TRequestStatus &aStatus Asynchronous status word to signal when the operation is complete TLogId aId Log event ID for the event

Capability:

WriteUserData

IMPORT_C void ChangeEvent(TRequestStatus &aStatus, const CSmsMessage &aSmsMessage, const TLogSmsPduData &aData, TInt *aStatusId=0);

Description

Changes the details of an existing event.

Use GetEvent() to specify the event.

Parameters

TRequestStatus &aStatus Asynchronous status word to signal when the operation is complete const CSmsMessage &aSmsMessage The SMS message that the event concerns const TLogSmsPduData &aData SMS PDU information for the event TInt *aStatusId Optional string to include in the log message, specified by resource ID

Capability:

WriteUserData

IMPORT_C void DeleteEvent(TRequestStatus &aStatus);

Description

Deletes an event.

Use GetEvent() to specify the event.

Parameters

TRequestStatus &aStatus Asynchronous status word to signal when the operation is complete

inline TBool ClientAvailable() const;

Description

Tests whether the Log Engine is installed.

Return value

TBool True if there is a Log Engine, otherwise false

inline TInt GetString(TDes &aString, TInt aId) const;

Description

Gets a standard string from the specified resource.

Parameters

TDes &aString On return, string read from resource TInt aId Resource ID

Return value

TInt KErrNone, if successful; otherwise, one of the other system wide error codes

inline CLogEvent &Event();

Description

Gets the current log event.

Return value

CLogEvent & Current log event

inline const CLogEvent &Event() const;

Description

Gets the current (const) log event.

Return value

const CLogEvent & Current log event

inline const TLogSmsPduData &SmsPDUData() const;

Description

Gets the current event's SMS PDU data.

Return value

const TLogSmsPduData & Current event's SMS PDU data

protected: virtual void DoCancel();

Description

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

private: virtual void DoRunL();

Description

< Trapped in CSmsuActiveBase::RunError() which calls Complete().

private: virtual void DoComplete(TInt &aStatus);

Description

Implements derived-class specified Complete() behaviour.

This is called from Complete().

Parameters

TInt &aStatus