Symbian^3 Application Developer Library >

TSAREntry Class Reference

class TSAREntry

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                          |
  -----------------------------------------------------------------
Public Member Functions
TSAREntry ()
TInt Count ()
TInt Data3 ()
TStreamId DataStreamId ()
TPtrC Description1 ()
TPtrC Description2 ()
IMPORT_C void ExternalizeL ( RWriteStream &)
IMPORT_C void InternalizeL ( RReadStream &)
TBool IsComplete ()
TInt LogServerId ()
TInt Reference ()
void SetCount ( TInt )
void SetData3 ( TInt )
void SetDataStreamId ( TStreamId )
void SetDescription1 (const TDesC &)
void SetDescription2 (const TDesC &)
void SetLogServerId ( TInt )
void SetReference ( TInt )
void SetTime (const TTime &)
void SetTotal ( TInt )
const TTime & Time ()
TInt Total ()
Private Member Functions
TBool IsAdded ()
TBool IsDeleted ()
void SetIsAdded ( TBool )
void SetIsDeleted ( TBool )
Public Member Enumerations
enum anonymous { ESmsSAREntryDescriptionLength  = 32 }
Private Member Enumerations
enum TSAREntryFlags { ESAREntryIsDeleted  = 0x01, ESAREntryIsAdded  = 0x02 }
Protected Attributes
TInt iData1
TInt iData2
TInt iData3
TInt iData4
Private Attributes
TInt iCount
TStreamId iDataStreamId
TBuf < ESmsSAREntryDescriptionLength > iDescription1
TBuf < ESmsSAREntryDescriptionLength > iDescription2
TInt iFlags
TInt iReference
TTime iTime
TInt iTotal

Constructor & Destructor Documentation

TSAREntry()

IMPORT_C TSAREntry ( )

Constructor

capability
None

Member Functions Documentation

Count()

TInt Count ( ) const [inline]

Gets the Count field.

Data3()

TInt Data3 ( ) const [inline]

Gets the Data3 field.

DataStreamId()

TStreamId DataStreamId ( ) const [inline]

Gets the data stream ID.

Description1()

TPtrC Description1 ( ) const [inline]

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

Description2()

TPtrC Description2 ( ) const [inline]

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

ExternalizeL(RWriteStream &)

IMPORT_C void ExternalizeL ( RWriteStream & aStream ) const

Externalises the object.

capability
None

Parameters

RWriteStream & aStream Stream to write to

InternalizeL(RReadStream &)

IMPORT_C void InternalizeL ( RReadStream & aStream )

Internalises the object.

capability
None

Parameters

RReadStream & aStream Stream to read from

IsAdded()

TBool IsAdded ( ) const [private, inline]

IsComplete()

TBool IsComplete ( ) const [inline]

Tests if the whole message is sent/received.

IsDeleted()

TBool IsDeleted ( ) const [private, inline]

LogServerId()

TInt LogServerId ( ) const [inline]

Gets the Log server ID field.

Reference()

TInt Reference ( ) const [inline]

Gets the Reference field.

SetCount(TInt)

void SetCount ( TInt aCount ) [inline]

Sets the Count field.

Parameters

TInt aCount The number of PDUs sent/received

SetData3(TInt)

void SetData3 ( TInt aData ) [inline]

Sets the Data3 field.

Parameters

TInt aData Data3 field

SetDataStreamId(TStreamId)

void SetDataStreamId ( TStreamId aStreamId ) [inline]

Sets the data stream ID.

Parameters

TStreamId aStreamId Data stream ID

SetDescription1(const TDesC &)

void SetDescription1 ( const TDesC & aDescription ) [inline]

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

Parameters

const TDesC & aDescription Description1 field

SetDescription2(const TDesC &)

void SetDescription2 ( const TDesC & aDescription ) [inline]

Sets the Description2 field: the original address.

Parameters

const TDesC & aDescription Description2 field

SetIsAdded(TBool)

void SetIsAdded ( TBool aIsAdded ) [private, inline]

Sets if this message should be marked as added

Parameters

TBool aIsAdded

SetIsDeleted(TBool)

void SetIsDeleted ( TBool aIsDeleted ) [private, inline]

Sets if this message should be marked as deleted

Parameters

TBool aIsDeleted Set to True to mark a message as deleted

SetLogServerId(TInt)

void SetLogServerId ( TInt aId ) [inline]

Sets the Log server ID field.

Parameters

TInt aId Log server ID field

SetReference(TInt)

void SetReference ( TInt aReference ) [inline]

Sets the Reference field.

Parameters

TInt aReference The concatenation reference

SetTime(const TTime &)

void SetTime ( const TTime & aTime ) [inline]

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

Parameters

const TTime & aTime Time field

SetTotal(TInt)

void SetTotal ( TInt aTotal ) [inline]

Sets the total number of PDUs in SMS message

Parameters

TInt aTotal The 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.

Total()

TInt Total ( ) const [inline]

Gets the Total field.

Member Enumerations Documentation

Enum anonymous

Enumerators

ESmsSAREntryDescriptionLength = 32

Enum TSAREntryFlags

Enumerators

ESAREntryIsDeleted = 0x01
ESAREntryIsAdded = 0x02

Member Data Documentation

TInt iCount

TInt iCount [private]

TInt iData1

TInt iData1 [protected]

TInt iData2

TInt iData2 [protected]

TInt iData3

TInt iData3 [protected]

TInt iData4

TInt iData4 [protected]

TStreamId iDataStreamId

TStreamId iDataStreamId [private]

TBuf< ESmsSAREntryDescriptionLength > iDescription1

TBuf < ESmsSAREntryDescriptionLength > iDescription1 [private]

TBuf< ESmsSAREntryDescriptionLength > iDescription2

TBuf < ESmsSAREntryDescriptionLength > iDescription2 [private]

TInt iFlags

TInt iFlags [private]

TInt iReference

TInt iReference [private]

TTime iTime

TTime iTime [private]

TInt iTotal

TInt iTotal [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.