CSmsEventLogger Class Reference

#include <smsulog.h>

Link against: smsu.lib

class CSmsEventLogger : public CSmsuActiveBase

Inherits from

Public Member Functions
~CSmsEventLogger()
IMPORT_C voidAddEvent(TRequestStatus &, const CSmsMessage &, const TLogSmsPduData &, TInt *)
IMPORT_C voidChangeEvent(TRequestStatus &, const CSmsMessage &, const TLogSmsPduData &, TInt *)
IMPORT_C voidChangeEvent(TRequestStatus &, const CSmsMessage &, const TTime *, const TLogSmsPduData &, TInt *)
TBool ClientAvailable()
IMPORT_C voidDeleteEvent(TRequestStatus &)
CLogEvent &Event()
const CLogEvent &Event()
IMPORT_C voidGetEvent(TRequestStatus &, TLogId)
TInt GetString(TDes &, TInt)
IMPORT_C CSmsEventLogger *NewL(RFs &, TInt)
const TLogSmsPduData &SmsPDUData()
Protected Member Functions
virtual voidDoCancel()
Inherited Attributes
CActive::iStatus
CSmsuActiveBase::iReport
CSmsuActiveBase::iSmsuTimeout
Inherited Enumerations
CActive:TPriority
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::Extension_(TUint,TAny *&,TAny *)
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
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()
CSmsuActiveBase::CSmsuActiveBase(TInt)
CSmsuActiveBase::Complete(TInt)
CSmsuActiveBase::CompleteMyself(TInt,TBool)
CSmsuActiveBase::CompleteMyselfAfterTimeout(TInt)
CSmsuActiveBase::ConstructTimeoutL()
CSmsuActiveBase::Queue(TRequestStatus &)
CSmsuActiveBase::RunError(TInt)
CSmsuActiveBase::RunL()
CSmsuActiveBase::TimedOut()const
CSmsuActiveBase::TimedSetActive(const TTimeIntervalMicroSeconds32 &)
CSmsuActiveBase::TimedSetActiveCancel()
CSmsuActiveBase::~CSmsuActiveBase()

Detailed Description

Logs SMS-related events.

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

Constructor & Destructor Documentation

~CSmsEventLogger ( )

IMPORT_C~CSmsEventLogger()
Destructor.
capability
None

Member Function Documentation

AddEvent ( TRequestStatus &, const CSmsMessage &, const TLogSmsPduData &, TInt * )

IMPORT_C voidAddEvent(TRequestStatus &aStatus,
const CSmsMessage &aSmsMessage,
const TLogSmsPduData &aData,
TInt *aStatusId = NULL
)

Adds an event to the log database.

capability
WriteUserData
ParameterDescription
aStatusAsynchronous status word to signal when the operation is complete
aSmsMessageThe SMS message that the event concerns
aDataSMS PDU information for the event
aStatusIdOptional string to include in the log message, specified by resource ID

ChangeEvent ( TRequestStatus &, const CSmsMessage &, const TLogSmsPduData &, TInt * )

IMPORT_C voidChangeEvent(TRequestStatus &aStatus,
const CSmsMessage &aSmsMessage,
const TLogSmsPduData &aData,
TInt *aStatusId = NULL
)

Changes the details of an existing event.

Use GetEvent() to specify the event.

capability
WriteUserData
ParameterDescription
aStatusAsynchronous status word to signal when the operation is complete
aSmsMessageThe SMS message that the event concerns
aDataSMS PDU information for the event
aStatusIdOptional string to include in the log message, specified by resource ID

ChangeEvent ( TRequestStatus &, const CSmsMessage &, const TTime *, const TLogSmsPduData &, TInt * )

IMPORT_C voidChangeEvent(TRequestStatus &aStatus,
const CSmsMessage &aSmsMessage,
const TTime *aTime,
const TLogSmsPduData &aData,
TInt *aStatusId = NULL
)

Changes the details of an existing event.

Use GetEvent() to specify the event.

capability
WriteUserData
ParameterDescription
aStatusAsynchronous status word to signal when the operation is complete
aSmsMessageThe SMS message that the event concerns
aTimeSMS delivery time
aDataSMS PDU information for the event
aStatusIdOptional string to include in the log message, specified by resource ID

ClientAvailable ( )

TBool ClientAvailable()const [inline]

DeleteEvent ( TRequestStatus & )

IMPORT_C voidDeleteEvent(TRequestStatus &aStatus)

Deletes an event.

Use GetEvent() to specify the event.

capability
WriteUserData
ParameterDescription
aStatusAsynchronous status word to signal when the operation is complete

DoCancel ( )

voidDoCancel()[protected, virtual]

Reimplemented from CActive::DoCancel()

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

See also: CActive::Cancel

Event ( )

CLogEvent &Event()[inline]

Gets the current log event.

Returns: Current log event

Event ( )

const CLogEvent &Event()const [inline]

Gets the current (const) log event.

Returns: Current log event

GetEvent ( TRequestStatus &, TLogId )

IMPORT_C voidGetEvent(TRequestStatus &aStatus,
TLogIdaId
)

Gets the specified event from the log.

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

capability
ReadUserData
ParameterDescription
aStatusAsynchronous status word to signal when the operation is complete
aIdLog event ID for the event

GetString ( TDes &, TInt )

TInt GetString(TDes &aString,
TIntaId
)const [inline]

Gets a standard string from the specified resource.

ParameterDescription
aStringOn return, string read from resource
aIdResource ID

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

NewL ( RFs &, TInt )

IMPORT_C CSmsEventLogger *NewL(RFs &aFs,
TIntaPriority = CActive::EPriorityStandard
)[static]

Allocates and creates a logger.

capability
None
ParameterDescription
aFsFile server handle
aPriorityActive object priority

Returns: New CSmsEventLogger object

SmsPDUData ( )

const TLogSmsPduData &SmsPDUData()const [inline]

Gets the current event's SMS PDU data.

Returns: Current event's SMS PDU data

© Nokia 2011.