CSmsEventLogger Class Reference

#include <smsulog.h>

Link against: smsu.lib

class CSmsEventLogger : public CSmsuActiveBase

Inherits from

CSmsEventLogger
- CSmsuActiveBase
  - CActive
    - CBase
  - CActive
    - CBase

Public Member Functions
	~CSmsEventLogger()
IMPORT_C void	AddEvent(TRequestStatus &, const CSmsMessage &, const TLogSmsPduData &, TInt *)
IMPORT_C void	ChangeEvent(TRequestStatus &, const CSmsMessage &, const TLogSmsPduData &, TInt *)
IMPORT_C void	ChangeEvent(TRequestStatus &, const CSmsMessage &, const TTime , const TLogSmsPduData &, TInt )
TBool	ClientAvailable()
IMPORT_C void	DeleteEvent(TRequestStatus &)
CLogEvent &	Event()
const CLogEvent &	Event()
IMPORT_C void	GetEvent(TRequestStatus &, TLogId)
TInt	GetString(TDes &, TInt)
IMPORT_C CSmsEventLogger *	NewL(RFs &, TInt)
const TLogSmsPduData &	SmsPDUData()

Protected Member Functions
virtual void	DoCancel()

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 void	AddEvent	(	TRequestStatus &	aStatus,
			const CSmsMessage &	aSmsMessage,
			const TLogSmsPduData &	aData,
			TInt *	aStatusId = 0
		)

Adds an event to the log database.

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

Capability
WriteUserData

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

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

Changes the details of an existing event.

Use GetEvent() to specify the event.

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

Capability
WriteUserData

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

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

Changes the details of an existing event.

Use GetEvent() to specify the event.

Parameters
aStatus	Asynchronous status word to signal when the operation is complete
aSmsMessage	The SMS message that the event concerns
aTime	SMS delivery time
aData	SMS PDU information for the event
aStatusId	Optional string to include in the log message, specified by resource ID

Capability
WriteUserData

ClientAvailable ( )

TBool

ClientAvailable

(

)

const [inline]

DeleteEvent ( TRequestStatus & )

IMPORT_C void

DeleteEvent

(

TRequestStatus &

aStatus

)

Deletes an event.

Use GetEvent() to specify the event.

Parameters
aStatus	Asynchronous status word to signal when the operation is complete

Capability
WriteUserData

DoCancel ( )

void

DoCancel

(

)

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

Event ( )

CLogEvent &

Event

(

)

[inline]

Gets the current log event.

Return Value: Current log event

Event ( )

const CLogEvent &

Event

(

)

const [inline]

Gets the current (const) log event.

Return Value: Current log event

GetEvent ( TRequestStatus &, TLogId )

IMPORT_C void	GetEvent	(	TRequestStatus &	aStatus,
			TLogId	aId
		)

Gets the specified event from the log.

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

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

Capability
ReadUserData

GetString ( TDes &, TInt )

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

Gets a standard string from the specified resource.

Parameters
aString	On return, string read from resource
aId	Resource ID

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

NewL ( RFs &, TInt )

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

Allocates and creates a logger.

Parameters
aFs	File server handle
aPriority	Active object priority

Return Value: New CSmsEventLogger object

Capability
None

SmsPDUData ( )

const TLogSmsPduData &

SmsPDUData

(

)

const [inline]

Gets the current event's SMS PDU data.

Return Value: Current event's SMS PDU data

CSmsEventLogger Class Reference

Inherits from

Detailed Description

Constructor & Destructor Documentation

~CSmsEventLogger ( )

Member Function Documentation

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

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

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

ClientAvailable ( )

DeleteEvent ( TRequestStatus & )

DoCancel ( )

Event ( )

Event ( )

GetEvent ( TRequestStatus &, TLogId )

GetString ( TDes &, TInt )

NewL ( RFs &, TInt )

SmsPDUData ( )

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