Collapse all Symbian^3 Product Developer Library

Roap::CRoapParser Class Reference

class Roap::CRoapParser : public CBase

ROAP parser base class

roaphandler.dll

Since: S60 v3.0

Inherits from

Roap::CRoapParser
- CBase

Public Member Functions
	~CRoapParser()
TRoapStatus	ConvertRoapStatus(const TDesC8 &)
TInt	ExtractDomainKeyElements(const TDesC8 &, RPointerArray< HBufC8 > &)
TPtrC8	ExtractElement(const TDesC8 &, const TDesC8 &, TInt &)
HBufC8 *	GetAttributeValueL(const RAttributeArray &, const TDesC8 &)
TAny *	GetExtendedInterface(const TInt32)
CRoapParser *	NewL()
void	OnContentL(const TDesC8 &, TInt)
void	OnEndDocumentL(TInt)
void	OnEndElementL(const RTagInfo &, TInt)
void	OnEndPrefixMappingL(const RString &, TInt)
void	OnError(TInt)
void	OnIgnorableWhiteSpaceL(const TDesC8 &, TInt)
void	OnOutOfData()
void	OnProcessingInstructionL(const TDesC8 &, const TDesC8 &, TInt)
void	OnSkippedEntityL(const RString &, TInt)
void	OnStartDocumentL(const RDocumentParameters &, TInt)
void	OnStartElementL(const RTagInfo &, const RAttributeArray &, TInt)
void	OnStartPrefixMappingL(const RString &, const RString &, TInt)
CJoinDomainResp *	ParseJoinDomainRespL(const TDesC8 &, RPointerArray< HBufC8 > &)
CLeaveDomainResp *	ParseLeaveDomainRespL(const TDesC8 &)
CMeteringResp *	ParseMeteringRespL(const TDesC8 &)
CRIHello *	ParseRIHelloL(const TDesC8 &)
CRegistrationResp *	ParseRegistrationRespL(const TDesC8 &)
CRightsResp *	ParseRightsRespL(const TDesC8 &)
CRoapTrigger *	ParseRoapTriggerL(const TDesC8 &)

Protected Member Functions
	CRoapParser()
void	ConstructL()
TParserStackState	MatchStackState(void)
void	ParseL(const TDesC8 &)

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 Attributes
const TInt	KMaxElementCount
const TInt	KMaxElementNesting
HBufC8 *	iContent
TInt	iElementStack
TInt	iElementStackDepth
CParser *	iParser
MRespParser *	iResponseParser
RString	iRoapElements

Constructor & Destructor Documentation

CRoapParser()

CRoapParser

(

)

[protected]

From ?base_class ?member_description C++ default constructor.

~CRoapParser()

~CRoapParser

(

)

[virtual]

Destructor.

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[protected]

Symbian 2nd phase constructor.

ConvertRoapStatus(const TDesC8 &)

TRoapStatus

ConvertRoapStatus

(

const TDesC8 &

aStatus

)

?member_description.

Since: Series ?XX ?SeriesXX_version

Parameters

const TDesC8 & aStatus

ExtractDomainKeyElements(const TDesC8 &, RPointerArray< HBufC8 > &)

TInt	ExtractDomainKeyElements	(	const TDesC8 &	aMessage,
			RPointerArray< HBufC8 > &	aDomainKeyElements
		)	const

?member_description.

Since: Series ?XX ?SeriesXX_version

Parameters

const TDesC8 & aMessage
RPointerArray< HBufC8 > & aDomainKeyElements

ExtractElement(const TDesC8 &, const TDesC8 &, TInt &)

TPtrC8	ExtractElement	(	const TDesC8 &	aMessage,
			const TDesC8 &	aElement,
			TInt &	aOffset
		)	const

?member_description.

Since: Series ?XX ?SeriesXX_version

Parameters

const TDesC8 & aMessage
const TDesC8 & aElement
TInt & aOffset

GetAttributeValueL(const RAttributeArray &, const TDesC8 &)

HBufC8 *	GetAttributeValueL	(	const RAttributeArray &	aAttrList,
			const TDesC8 &	aAttrName
		)

?member_description.

Since: Series ?XX ?SeriesXX_version

Parameters

const RAttributeArray & aAttrList
const TDesC8 & aAttrName

GetExtendedInterface(const TInt32)

TAny *

GetExtendedInterface

(

const TInt32

aUid

)

From ?base_class ?member_description.

Parameters

const TInt32 aUid

the uid identifying the required interface.

MatchStackState(void)

TParserStackState

MatchStackState

(

void

)

[protected]

?member_description.

Since: Series ?XX ?SeriesXX_version

Since: Series ?XX ?SeriesXX_version

Parameters

void

NewL()

CRoapParser *

NewL

(

)

[static]

Two-phased constructor.

OnContentL(const TDesC8 &, TInt)

void	OnContentL	(	const TDesC8 &	aBytes,
			TInt	aErrorCode
		)

From ?base_class ?member_description.

Parameters

const TDesC8 & aBytes	is the raw content data for the element. The client is responsible for converting the data to the required character set if necessary. In some instances the content may be binary and must not be converted.
TInt aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnEndDocumentL(TInt)

void

OnEndDocumentL

(

TInt

aErrorCode

)

From ?base_class ?member_description.

Parameters

TInt aErrorCode

is the error code. If this is not KErrNone then special action may be required.

OnEndElementL(const RTagInfo &, TInt)

void	OnEndElementL	(	const RTagInfo &	aElement,
			TInt	aErrorCode
		)

From ?base_class ?member_description.

Parameters

const RTagInfo & aElement	is a handle to the element's details.
TInt aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnEndPrefixMappingL(const RString &, TInt)

void	OnEndPrefixMappingL	(	const RString &	aPrefix,
			TInt	aErrorCode
		)

From ?base_class ?member_description.

Parameters

const RString & aPrefix	is the Namespace prefix that was mapped.
TInt aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnError(TInt)

void

OnError

(

TInt

aErrorCode

)

From ?base_class ?member_description.

Parameters

TInt aErrorCode

OnIgnorableWhiteSpaceL(const TDesC8 &, TInt)

void	OnIgnorableWhiteSpaceL	(	const TDesC8 &	aBytes,
			TInt	aErrorCode
		)

From ?base_class ?member_description.

Parameters

const TDesC8 & aBytes	are the ignored bytes from the document being parsed.
TInt aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnOutOfData()

void

OnOutOfData

(

)

From ?base_class ?member_description.

OnProcessingInstructionL(const TDesC8 &, const TDesC8 &, TInt)

void	OnProcessingInstructionL	(	const TDesC8 &	aTarget,
			const TDesC8 &	aData,
			TInt	aErrorCode
		)

From ?base_class ?member_description.

Parameters

const TDesC8 & aTarget	is the processing instruction target.
const TDesC8 & aData	is the processing instruction data. If empty none was supplied.
TInt aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnSkippedEntityL(const RString &, TInt)

void	OnSkippedEntityL	(	const RString &	aName,
			TInt	aErrorCode
		)

From ?base_class ?member_description.

Parameters

const RString & aName	is the name of the skipped entity.
TInt aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnStartDocumentL(const RDocumentParameters &, TInt)

void	OnStartDocumentL	(	const RDocumentParameters &	aDocParam,
			TInt	aErrorCode
		)

From ?base_class ?member_description.

Parameters

const RDocumentParameters & aDocParam	Specifies the various parameters of the document. aDocParam.iCharacterSetName The character encoding of the document.
TInt aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnStartElementL(const RTagInfo &, const RAttributeArray &, TInt)

void	OnStartElementL	(	const RTagInfo &	aElement,
			const RAttributeArray &	aAttributes,
			TInt	aErrorCode
		)

From ?base_class ?member_description.

Parameters

const RTagInfo & aElement	is a handle to the element's details.
const RAttributeArray & aAttributes	contains the attributes for the element.
TInt aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnStartPrefixMappingL(const RString &, const RString &, TInt)

void	OnStartPrefixMappingL	(	const RString &	aPrefix,
			const RString &	aUri,
			TInt	aErrorCode
		)

From ?base_class ?member_description.

Parameters

const RString & aPrefix	is the Namespace prefix being declared.
const RString & aUri	is the Namespace URI the prefix is mapped to.
TInt aErrorCode	is the error code. If this is not KErrNone then special action may be required.

ParseJoinDomainRespL(const TDesC8 &, RPointerArray< HBufC8 > &)

CJoinDomainResp *	ParseJoinDomainRespL	(	const TDesC8 &	aMessage,
			RPointerArray< HBufC8 > &	aDomainKeyElements
		)

?member_description.

Since: Series ?XX ?SeriesXX_version

Parameters

const TDesC8 & aMessage
RPointerArray< HBufC8 > & aDomainKeyElements

ParseL(const TDesC8 &)

void

ParseL

(

const TDesC8 &

aMessage

)

[protected]

?member_description.

Since: Series ?XX ?SeriesXX_version

Parameters

const TDesC8 & aMessage

ParseLeaveDomainRespL(const TDesC8 &)

CLeaveDomainResp *

ParseLeaveDomainRespL

(

const TDesC8 &

aMessage

)

?member_description.

Since: Series ?XX ?SeriesXX_version

Parameters

const TDesC8 & aMessage

ParseMeteringRespL(const TDesC8 &)

CMeteringResp *

ParseMeteringRespL

(

const TDesC8 &

aMessage

)

?member_description.

Since: Series ?XX ?SeriesXX_version

Parameters

const TDesC8 & aMessage

ParseRIHelloL(const TDesC8 &)

CRIHello *

ParseRIHelloL

(

const TDesC8 &

aMessage

)

?member_description.

Since: Series ?XX ?SeriesXX_version

Parameters

const TDesC8 & aMessage

ParseRegistrationRespL(const TDesC8 &)

CRegistrationResp *

ParseRegistrationRespL

(

const TDesC8 &

aMessage

)

?member_description.

Since: Series ?XX ?SeriesXX_version

Parameters

const TDesC8 & aMessage

ParseRightsRespL(const TDesC8 &)

CRightsResp *

ParseRightsRespL

(

const TDesC8 &

aMessage

)

?member_description.

Since: Series ?XX ?SeriesXX_version

Parameters

const TDesC8 & aMessage

ParseRoapTriggerL(const TDesC8 &)

CRoapTrigger *

ParseRoapTriggerL

(

const TDesC8 &

aMessage

)

?member_description.

Since: Series ?XX ?SeriesXX_version

Parameters

const TDesC8 & aMessage

Member Data Documentation

const TInt KMaxElementCount

const TInt

KMaxElementCount

[static]

const TInt KMaxElementNesting

const TInt

KMaxElementNesting

[static]

HBufC8 * iContent

HBufC8 *

iContent

TInt iElementStack

TInt	iElementStack

TInt iElementStackDepth

TInt	iElementStackDepth

CParser * iParser

CParser *

iParser

MRespParser * iResponseParser

MRespParser *

iResponseParser

RString iRoapElements

RString

iRoapElements