Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: gsmustor.h
Link against: gsmu.lib

This item is not part of the S60 3rd Edition SDK for Symbian OS, Feature Pack 2.

Class TSAREntry

class TSAREntry;

Description

Provides generic information useful for the segmentation and reassembly of SMS messages and reassembly of WAP datagrams.

The constituent parts of both concatenated SMS messages and concatenated 7-bit WAP datagrams contain a reference, the total number of parts and the index of the part in the complete message or datagram.

Field for the segmentation store are:

Reference - concatenation reference Total - total number of PDUs in SMS message Count - number of PDUs sent Data1 - total PDUs delivered<<16 and failed Data2 - log server id Data3 - validity period Data4 - type and min and max message reference Description1 - first 32 characters from buffer Description2 - original address Time - time on SMS message

Abstracts an entry which is stored in the CSARStore

The data stored in Data1-4 has a different meaning depending on if it is used by the Reassembly store or the Segmentation store. The lists below detail the uses:

Reassembly store:

Data1: byte 3: bits7to4; byte 1: identifier1; byte 0: identifier2.

Data2: Log server ID.

Data3: byte 0: PDU type.

Data4: SMS message storage .

Segmentation store:

Data1: bytes 3, 2: N delivered; byte 1,0 N failed.

Data2: Log server ID.

Data3: SMS submit validity period.

Data4: byte 3,2 message PDU type; byte 1: reference1; byte 0: reference2.

WAP reassembly store:

Data1: to port.

Data2: not used .

Data3: not used.

Data4: not used.

Members

Defined in TSAREntry:
Count(), Data3(), DataStreamId(), Description1(), Description2(), ESmsSAREntryDescriptionLength, ExternalizeL(), InternalizeL(), IsComplete(), LogServerId(), Reference(), SetCount(), SetData3(), SetDataStreamId(), SetDescription1(), SetDescription2(), SetLogServerId(), SetReference(), SetTime(), SetTotal(), TSAREntry(), Time(), Total(), anonymous, iData1, iData2, iData3, iData4


Construction and destruction


TSAREntry()

IMPORT_C TSAREntry();

Description

Constructor.

[Top]


Member functions


Reference()

inline TInt Reference() const;

Description

Gets the Reference field.

Return value

TInt

Concatenation reference


SetReference()

inline void SetReference(TInt aReference);

Description

Sets the Reference field.

Parameters

TInt aReference

The concatenation reference


Total()

inline TInt Total() const;

Description

Gets the Total field.

Return value

TInt

The total number of PDUs in SMS message


SetTotal()

inline void SetTotal(TInt aTotal);

Description

Sets the total number of PDUs in SMS message

Parameters

TInt aTotal

The total number of PDUs in the message


Count()

inline TInt Count() const;

Description

Gets the Count field.

Return value

TInt

Number of PDUs sent/received


SetCount()

inline void SetCount(TInt aCount);

Description

Sets the Count field.

Parameters

TInt aCount

The number of PDUs sent/received


IsComplete()

inline TBool IsComplete() const;

Description

Tests if the whole message is sent/received.

Return value

TBool

True if the whole message is sent/received


LogServerId()

inline TInt LogServerId() const;

Description

Gets the Log server ID field.

Return value

TInt

Log server ID field


SetLogServerId()

inline void SetLogServerId(TInt aId);

Description

Sets the Log server ID field.

Parameters

TInt aId

Log server ID field


Description1()

inline TPtrC Description1() const;

Description

Gets the Description1 field: a pointer to the first 32 characters from buffer.

Return value

TPtrC

Description1 field


SetDescription1()

inline void SetDescription1(const TDesC &aDescription);

Description

Sets the Description1 field: the first 32 characters in buffer.

Parameters

const TDesC &aDescription

Description1 field


Description2()

inline TPtrC Description2() const;

Description

Gets the Description2 field: a pointer to the original address.

Return value

TPtrC

Description2 field


SetDescription2()

inline void SetDescription2(const TDesC &aDescription);

Description

Sets the Description2 field: the original address.

Parameters

const TDesC &aDescription

Description2 field


Data3()

inline TInt Data3() const;

Description

Gets the Data3 field.

Return value

TInt

Data3 field


SetData3()

inline void SetData3(TInt aData);

Description

Sets the Data3 field.

Parameters

TInt aData

Data3 field


Time()

inline const TTime &Time() const;

Description

Gets the Time field: the time when this message was sent/received.

Return value

const TTime &

Time field


SetTime()

inline void SetTime(const TTime &aTime);

Description

Sets the Time field: the time when this message was sent/received.

Parameters

const TTime &aTime

Time field


DataStreamId()

inline TStreamId DataStreamId() const;

Description

Gets the data stream ID.

Return value

TStreamId

Data stream ID


SetDataStreamId()

inline void SetDataStreamId(TStreamId aStreamId);

Description

Sets the data stream ID.

Parameters

TStreamId aStreamId

Data stream ID


InternalizeL()

Capability: Illegal

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises the object.

Parameters

RReadStream &aStream

Stream to read from


ExternalizeL()

Capability: Illegal

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises the object.

Parameters

RWriteStream &aStream

Stream to write to

[Top]


Member enumerations


Enum anonymous

n/a

Description

ESmsSAREntryDescriptionLength

[Top]


Member data


iData1

protected: TInt iData1;

Description


iData2

protected: TInt iData2;

Description

Log server ID.


iData3

protected: TInt iData3;

Description


iData4

protected: TInt iData4;

Description