Symbian^3 Product Developer Library >

CSmsBufferSegmenter Class Reference

class CSmsBufferSegmenter : public CBase

Segments unpacked data from a CsmsBufferBase

Inherits from

Public Member Functions
~CSmsBufferSegmenter()
TSmsEncoding FindBestAlternativeEncodingL(TSmsEncoding, TInt)
TBool MoreL()
IMPORT_C CSmsBufferSegmenter *NewLC(CSmsAlphabetConverter &, const CSmsBufferBase &, TInt)
voidReset()
IMPORT_C TBoolSegmentNextL(TDes8 &, TInt &, TInt &, TSmsEncoding)
IMPORT_C TIntTotalConvertedLengthL(TSmsEncoding)
Protected Member Functions
CSmsBufferSegmenter(CSmsAlphabetConverter &, const CSmsBufferBase &, TInt)
voidCheckConvertedBufferAllocL(TInt)
voidConstructL()
TBool DoSegmentNextL(TDes8 &, TInt, TInt &, TInt &, TSmsEncoding)
TInt ElementsToReturnFromConvertedBufferL(TInt)
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()
Protected Attributes
CSmsAlphabetConverter &iAlphabetConverter
HBufC8 *iConvertedBuffer
TPtr8 iConvertedBufferPtr
TInt iElementsExtracted
TInt iSegmentSize
const CSmsBufferBase &iSmsBuffer

Constructor & Destructor Documentation

CSmsBufferSegmenter(CSmsAlphabetConverter &, const CSmsBufferBase &, TInt)

CSmsBufferSegmenter(CSmsAlphabetConverter &aAlphabetConverter,
const CSmsBufferBase &aBuffer,
TIntaSegmentSize
)[protected]

Parameters

CSmsAlphabetConverter & aAlphabetConverter
const CSmsBufferBase & aBuffer
TInt aSegmentSize

~CSmsBufferSegmenter()

IMPORT_C~CSmsBufferSegmenter()

Destructor - Free resource

capability
None

Member Functions Documentation

CheckConvertedBufferAllocL(TInt)

voidCheckConvertedBufferAllocL(TIntaMaxLength)[protected]

Ensures the segmentation buffer is of the specified length

Parameters

TInt aMaxLength

ConstructL()

voidConstructL()[protected]

2nd phase of constructor. Esures we have an initial buffer.

DoSegmentNextL(TDes8 &, TInt, TInt &, TInt &, TSmsEncoding)

TBool DoSegmentNextL(TDes8 &aSegmentBuffer,
TIntaSegmentSize,
TInt &aUnconvertedChars,
TInt &aDowngradedChars,
TSmsEncodingaEncoding
)[protected, virtual]

Parameters

TDes8 & aSegmentBuffer
TInt aSegmentSize
TInt & aUnconvertedChars
TInt & aDowngradedChars
TSmsEncoding aEncoding

ElementsToReturnFromConvertedBufferL(TInt)

TInt ElementsToReturnFromConvertedBufferL(TIntaSegmentSize)[protected]

Determines the number of converted elements that should be returned in the segment - called from DoSegmentNextL

Parameters

TInt aSegmentSize

FindBestAlternativeEncodingL(TSmsEncoding, TInt)

TSmsEncoding FindBestAlternativeEncodingL(TSmsEncodingaSuggestedEncoding,
TIntaMaxBodyLength
)const

Parameters

TSmsEncoding aSuggestedEncoding
TInt aMaxBodyLength

MoreL()

TBool MoreL()

NewLC(CSmsAlphabetConverter &, const CSmsBufferBase &, TInt)

IMPORT_C CSmsBufferSegmenter *NewLC(CSmsAlphabetConverter &aAlphabetConverter,
const CSmsBufferBase &aBuffer,
TIntaSegmentSize = 0
)[static]

This factory function creates a CsmsBufferSegmenter instance

capability
None

Parameters

CSmsAlphabetConverter & aAlphabetConverterPre-configured
const CSmsBufferBase & aBufferThe message data
TInt aSegmentSize = 0(Default = 0) The size of segment required. If the instance is to be used solely for determining the total length of the converted data with TotalConvertedLengthL() then the segment length need not be supplied, hence defaulting to zero.

Reset()

voidReset()

Resets the converted buffer

SegmentNextL(TDes8 &, TInt &, TInt &, TSmsEncoding)

IMPORT_C TBoolSegmentNextL(TDes8 &aSegmentBuffer,
TInt &aUnconvertedChars,
TInt &aDowngradedChars,
TSmsEncodingaEncoding
)

A client iteratively calls SegmentNextL() to retrieve each segment until ETrue is returned, indicating that the last segment has been reached. The output buffer, aSegmentBuffer, should be large enough to hold the number of elements specified by the segment size in the NewLC() constructor otherwise the call will Panic. The output buffer is automatically reset before it's filled.

capability
None

Parameters

TDes8 & aSegmentBufferThe next segment
TInt & aUnconvertedChars
TInt & aDowngradedChars
TSmsEncoding aEncoding

TotalConvertedLengthL(TSmsEncoding)

IMPORT_C TIntTotalConvertedLengthL(TSmsEncodingaEncoding)

TotalConvertedLengthL() determines the total length in User Data Elements when the input buffer is converted. Depending on the conversion properties returned from the alphabet converter, a complete conversion may need to be performed, i.e. this call can be quite expensive.

capability
None

Parameters

TSmsEncoding aEncoding

Member Data Documentation

CSmsAlphabetConverter & iAlphabetConverter

CSmsAlphabetConverter &iAlphabetConverter[protected]

HBufC8 * iConvertedBuffer

HBufC8 *iConvertedBuffer[protected]

TPtr8 iConvertedBufferPtr

TPtr8 iConvertedBufferPtr[protected]

TInt iElementsExtracted

TInt iElementsExtracted[protected]

TInt iSegmentSize

TInt iSegmentSize[protected]

const CSmsBufferBase & iSmsBuffer

const CSmsBufferBase &iSmsBuffer[protected]

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.