Symbian
Developer Library

DEVELOPER LIBRARY

[Index] [Glossary] [Previous] [Next]

 » Developer Library » API Reference » C++ API reference » SMS Utilities » CSmsEventLogger

Location: smsulog.h
Link against: smsu.lib

Class CSmsEventLogger

class CSmsEventLogger : public CSmsuActiveBase;

Support

Supported from 6.1

Description

Logs SMS-related events.

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

Derivation

CActiveThe core class of the active object abstraction
CBaseBase class for all classes to be instantiated on the heap
CSmsEventLoggerLogs SMS-related events
CSmsuActiveBaseBae class for SMS active objects

Defined in CSmsEventLogger:
AddEvent(), CSmsEventLogger(), ChangeEvent(), ClientAvailable(), ConstructL(), DeleteEvent(), DoAddEventL(), DoCancel(), DoComplete(), DoRunL(), ESmsEventLoggerAddingEvent, ESmsEventLoggerChangingEvent, ESmsEventLoggerDeletingEvent, ESmsEventLoggerGettingEvent, ESmsEventLoggerIdle, Event(), Event(), GetEvent(), GetString(), GetStringL(), NewL(), SetDataL(), SmsPDUData(), TSmsEventLoggerState, iLogEvent, iLogWrapper, iSmsPDUData, iState, ~CSmsEventLogger()

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

Inherited from CBase:
operator new()

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

Construction and destruction

NewL()

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

Description

Allocates and creates a logger.

Parameters

RFs& aFs

File server handle
TInt aPriority=CActive::EPriorityStandard

Active object priority

Return value

CSmsEventLogger*

New CSmsEventLogger object

~CSmsEventLogger()

~CSmsEventLogger();

Description

Destructor.

[Top]

Member functions

AddEvent()

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

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=NULL

Optional string to include in the log message, specified by resource ID

GetEvent()

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

ChangeEvent()

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

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=NULL

Optional string to include in the log message, specified by resource ID

DeleteEvent()

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

ClientAvailable()

inline TBool ClientAvailable() const;

Description

Tests whether the Log Engine is installed.

Return value

TBool

True if there is a Log Engine, otherwise false

GetString()

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

Event()

inline CLogEvent& Event();

Description

Gets the current log event.

Return value

CLogEvent&

Current log event

Event()

inline const CLogEvent& Event() const;

Description

Gets the current (const) log event.

Return value

const CLogEvent&

Current log event

SmsPDUData()

inline const TLogSmsPduData& SmsPDUData() const;

Description

Gets the current event's SMS PDU data.

Return value

const TLogSmsPduData&

Current event's SMS PDU data

[Top]

Internal members

CSmsEventLogger()

private: CSmsEventLogger(TInt aPriority);

Description

This member is internal and not intended for use.

ConstructL()

private: void ConstructL(RFs& aFs);

Description

This member is internal and not intended for use.

iState

private: TSmsEventLoggerState iState;

Description

This member is internal and not intended for use.

iLogWrapper

private: CLogWrapper* iLogWrapper;

Description

This member is internal and not intended for use.

iLogEvent

private: CLogEvent* iLogEvent;

Description

This member is internal and not intended for use.

iSmsPDUData

private: TLogSmsPduData iSmsPDUData;

Description

This member is internal and not intended for use.

DoCancel()

protected: void DoCancel();

Description

This member is internal and not intended for use.

DoRunL()

private: void DoRunL();

Description

This member is internal and not intended for use.

DoAddEventL()

private: void DoAddEventL(const CSmsMessage& aSmsMessage, TInt* aStatusId);

Description

This member is internal and not intended for use.

SetDataL()

private: void SetDataL(const CSmsMessage& aSmsMessage, TInt* aStatusId);

Description

This member is internal and not intended for use.

DoComplete()

private: void DoComplete(TInt& aStatus);

Description

This member is internal and not intended for use.

GetStringL()

private: inline void GetStringL(TDes& aString, TInt aId) const;

Description

This member is internal and not intended for use.

Enum TSmsEventLoggerState

private: TSmsEventLoggerState

Description

This member is internal and not intended for use.

ESmsEventLoggerIdle

This member is internal and not intended for use.
ESmsEventLoggerGettingEvent

This member is internal and not intended for use.
ESmsEventLoggerAddingEvent

This member is internal and not intended for use.
ESmsEventLoggerChangingEvent

This member is internal and not intended for use.
ESmsEventLoggerDeletingEvent

This member is internal and not intended for use.

©2002 Symbian Ltd.

[Top]