TSAREntry Class Reference

#include <gsmustor.h>

Link against: gsmu.lib

class TSAREntry

Detailed 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.


			
  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 tables below detail
  the uses:
  Reassembly Store:
  -----------------------------------------------------------------
  |  member |    3      |      2      |      1      |      0      |
  -----------------------------------------------------------------
  | iData1  |    bits7to4             | identifier1 | identifier2 |
  | iData2  |                   Log server ID                     |
  | iData3  |                                       | PDU type    |
  | iData4  |                 SMS message storage                 |
  -----------------------------------------------------------------
  Segmentation Store:
  -----------------------------------------------------------------
  |  member |    3      |      2      |      1      |      0      |
  -----------------------------------------------------------------
  | iData1  |    N delivered          |         N failed          |
  | iData2  |                   Log server ID                     |
  | iData3  |              SMS submit validity period             |
  | iData4  |   message PDU type      | reference1  | reference2  |
  -----------------------------------------------------------------
  WAP Reassembly Store:
  -----------------------------------------------------------------
  |  member |    3      |      2      |      1      |      0      |
  -----------------------------------------------------------------
  | iData1  |                    to port                          |
  | iData2  |                   not used                          |
  | iData3  |                   not used                          |
  | iData4  |                   not used                          |
  -----------------------------------------------------------------
  

Member Attribute Documentation

iData1

TInt iData1[protected]

iData2

TInt iData2[protected]

iData3

TInt iData3[protected]

iData4

TInt iData4[protected]

Member Enumeration Documentation

Enum anonymous

EnumeratorValueDescription
ESmsSAREntryDescriptionLength32

Constructor & Destructor Documentation

TSAREntry ( )

IMPORT_CTSAREntry()

Constructor

capability
None

Member Function Documentation

Count ( )

TInt Count()const [inline]

Gets the Count field.

Returns: Number of PDUs sent/received

Data3 ( )

TInt Data3()const [inline]

Gets the Data3 field.

Returns: Data3 field

DataStreamId ( )

TStreamId DataStreamId()const [inline]

Gets the data stream ID.

Returns: Data stream ID

Description1 ( )

TPtrC Description1()const [inline]

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

Returns: Description1 field

Description2 ( )

TPtrC Description2()const [inline]

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

Returns: Description2 field

ExternalizeL ( RWriteStream & )

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Externalises the object.

capability
None
ParameterDescription
aStreamStream to write to

InternalizeL ( RReadStream & )

IMPORT_C voidInternalizeL(RReadStream &aStream)

Internalises the object.

capability
None
ParameterDescription
aStreamStream to read from

IsComplete ( )

TBool IsComplete()const [inline]

Tests if the whole message is sent/received.

Returns: True if the whole message is sent/received

LogServerId ( )

TInt LogServerId()const [inline]

Gets the Log server ID field.

Returns: Log server ID field

Reference ( )

TInt Reference()const [inline]

Gets the Reference field.

Returns: Concatenation reference

SetCount ( TInt )

voidSetCount(TIntaCount)[inline]

Sets the Count field.

ParameterDescription
aCountThe number of PDUs sent/received

SetData3 ( TInt )

voidSetData3(TIntaData)[inline]

Sets the Data3 field.

ParameterDescription
aDataData3 field

SetDataStreamId ( TStreamId )

voidSetDataStreamId(TStreamIdaStreamId)[inline]

Sets the data stream ID.

ParameterDescription
aStreamIdData stream ID

SetDescription1 ( const TDesC & )

voidSetDescription1(const TDesC &aDescription)[inline]

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

ParameterDescription
aDescriptionDescription1 field

SetDescription2 ( const TDesC & )

voidSetDescription2(const TDesC &aDescription)[inline]

Sets the Description2 field: the original address.

ParameterDescription
aDescriptionDescription2 field

SetLogServerId ( TInt )

voidSetLogServerId(TIntaId)[inline]

Sets the Log server ID field.

ParameterDescription
aIdLog server ID field

SetReference ( TInt )

voidSetReference(TIntaReference)[inline]

Sets the Reference field.

ParameterDescription
aReferenceThe concatenation reference

SetTime ( const TTime & )

voidSetTime(const TTime &aTime)[inline]

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

ParameterDescription
aTimeTime field

SetTotal ( TInt )

voidSetTotal(TIntaTotal)[inline]

Sets the total number of PDUs in SMS message

ParameterDescription
aTotalThe total number of PDUs in the message

Time ( )

const TTime &Time()const [inline]

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

Returns: Time field

Total ( )

TInt Total()const [inline]

Gets the Total field.

Returns: The total number of PDUs in SMS message