Collapse all Symbian^3 Application Developer Library

CMsvRecipient Class Reference

class CMsvRecipient : public CBase

Base class for information relating to a message recipient.

Inherits from

CMsvRecipient
- CBase

Public Member Functions
TInt	Error ()
IMPORT_C void	ExternalizeL ( RWriteStream &)
void	IncreaseRetries ()
IMPORT_C void	InternalizeL ( RReadStream &)
void	ResetRetries ()
TInt	Retries ()
void	SetError ( TInt )
void	SetStatus ( TRecipientStatus )
TRecipientStatus	Status ()
const TTime &	Time ()
TTime &	Time ()

Protected Member Functions
	CMsvRecipient ()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	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()

Public Member Enumerations
enum	TRecipientStatus { ENotYetSent = 0, ESentSuccessfully = 1, EFailedToSend = 2 }

Private Attributes
TInt	iError
TInt	iRetries
TRecipientStatus	iStatus
TTime	iTime

Constructor & Destructor Documentation

CMsvRecipient()

IMPORT_C

CMsvRecipient

(

)

[protected]

Protected base class default constructor.

Member Functions Documentation

Error()

TInt

Error

(

)

const [inline]

Gets any error code for message sending to the recipient.

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

Externalises the object to a write stream.

Parameters

RWriteStream & aStream

Stream to which the object should be externalised.

IncreaseRetries()

void

IncreaseRetries

(

)

[inline]

Increments the number of retries for message sending to the recipient.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

[virtual]

Internalises the object from a read stream.

Parameters

RReadStream & aStream

The stream from which the object should be internalised.

ResetRetries()

void

ResetRetries

(

)

[inline]

Resets the number of retries for message sending to the recipient to zero.

Retries()

TInt

Retries

(

)

const [inline]

Gets the number of retries for message sending to the recipient.

SetError(TInt)

void

SetError

(

TInt

aError

)

[inline]

Sets any error code for message sending to the recipient.

Parameters

TInt aError

System wide error code

SetStatus(TRecipientStatus)

void

SetStatus

(

TRecipientStatus

aStatus

)

[inline]

Sets the message sending status for the recipient.

Parameters

TRecipientStatus aStatus

Message sending status for the recipient

Status()

TRecipientStatus

Status

(

)

const [inline]

Gets the message sending status for the recipient.

Time()

const TTime &

Time

(

)

const [inline]

Gets the (const) time for message sending to the recipient.

Time()

TTime &

Time

(

)

[inline]

Gets the (writable) time for message sending to the recipient.

Member Enumerations Documentation

Enum TRecipientStatus

Message sending status for a recipient.

Enumerators

ENotYetSent = 0	Message is not sent.
ESentSuccessfully = 1	Message has been sent.
EFailedToSend = 2	Message sending failed.

Member Data Documentation

TInt iError

TInt

iError

[private]

TInt iRetries

TInt

iRetries

[private]

TRecipientStatus iStatus

TRecipientStatus

iStatus

[private]

TTime iTime

TTime

iTime

[private]