PXMLRPCBlock Class Reference

#include <pxmlrpc.h>

Inheritance diagram for PXMLRPCBlock:

List of all members.

Public Member Functions
	PXMLRPCBlock ()
	PXMLRPCBlock (const PString &method)
	PXMLRPCBlock (const PString &method, const PXMLRPCStructBase &structData)
BOOL	Load (const PString &str)
PXMLElement *	GetParams ()
PXMLElement *	GetParam (PINDEX idx) const
PINDEX	GetParamCount () const
PINDEX	GetFaultCode () const
PString	GetFaultText () const
void	SetFault (PINDEX code, const PString &text)
BOOL	ValidateResponse ()
BOOL	GetParams (PXMLRPCStructBase &data)
BOOL	GetParam (PINDEX idx, PString &type, PString &result)
BOOL	GetExpectedParam (PINDEX idx, const PString &expectedType, PString &value)
BOOL	GetParam (PINDEX idx, PString &result)
BOOL	GetParam (PINDEX idx, int &result)
BOOL	GetParam (PINDEX idx, double &result)
BOOL	GetParam (PINDEX idx, PTime &result, int tz=PTime::GMT)
BOOL	GetParam (PINDEX idx, PStringToString &result)
BOOL	GetParam (PINDEX idx, PXMLRPCStructBase &result)
BOOL	GetParam (PINDEX idx, PStringArray &result)
BOOL	GetParam (PINDEX idx, PArray< PStringToString > &result)
BOOL	ParseScalar (PXMLElement *element, PString &type, PString &value)
BOOL	ParseStruct (PXMLElement *element, PStringToString &structDict)
BOOL	ParseStruct (PXMLElement *element, PXMLRPCStructBase &structData)
BOOL	ParseArray (PXMLElement *element, PStringArray &array)
BOOL	ParseArray (PXMLElement *element, PArray< PStringToString > &array)
BOOL	ParseArray (PXMLElement *element, PXMLRPCVariableBase &array)
void	AddParam (PXMLElement *parm)
void	AddParam (const PString &str)
void	AddParam (int value)
void	AddParam (double value)
void	AddParam (const PTime &time)
void	AddParam (const PXMLRPCStructBase &structData)
void	AddBinary (const PBYTEArray &data)
void	AddStruct (const PStringToString &dict)
void	AddStruct (const PStringToString &dict, const PString &typeStr)
void	AddArray (const PStringArray &array)
void	AddArray (const PStringArray &array, const PString &typeStr)
void	AddArray (const PStringArray &array, const PStringArray &types)
void	AddArray (const PArray< PStringToString > &array)
Static Public Member Functions
static PXMLElement *	CreateValueElement (PXMLElement *element)
static PXMLElement *	CreateScalar (const PString &type, const PString &scalar)
static PXMLElement *	CreateMember (const PString &name, PXMLElement *value)
static PXMLElement *	CreateScalar (const PString &str)
static PXMLElement *	CreateScalar (int value)
static PXMLElement *	CreateScalar (double value)
static PXMLElement *	CreateDateAndTime (const PTime &time)
static PXMLElement *	CreateBinary (const PBYTEArray &data)
static PXMLElement *	CreateStruct ()
static PXMLElement *	CreateStruct (const PStringToString &dict)
static PXMLElement *	CreateStruct (const PStringToString &dict, const PString &typeStr)
static PXMLElement *	CreateStruct (const PXMLRPCStructBase &structData)
static PXMLElement *	CreateArray (const PStringArray &array)
static PXMLElement *	CreateArray (const PStringArray &array, const PString &typeStr)
static PXMLElement *	CreateArray (const PStringArray &array, const PStringArray &types)
static PXMLElement *	CreateArray (const PArray< PStringToString > &array)
static PXMLElement *	CreateArray (const PXMLRPCVariableBase &array)
Protected Attributes
PXMLElement *	params
PString	faultText
PINDEX	faultCode

---

Constructor & Destructor Documentation

PXMLRPCBlock::PXMLRPCBlock

(

)

PXMLRPCBlock::PXMLRPCBlock

(

const PString &

method

)

PXMLRPCBlock::PXMLRPCBlock	(	const PString &	method,
		const PXMLRPCStructBase &	structData
	)

---

Member Function Documentation

BOOL PXMLRPCBlock::Load

(

const PString &

str

)

PXMLElement* PXMLRPCBlock::GetParams

(

)

PXMLElement* PXMLRPCBlock::GetParam

(

PINDEX

idx

)

const

PINDEX PXMLRPCBlock::GetParamCount

(

)

const

PINDEX PXMLRPCBlock::GetFaultCode

(

)

const [inline]

PString PXMLRPCBlock::GetFaultText

(

)

const [inline]

void PXMLRPCBlock::SetFault	(	PINDEX	code,
		const PString &	text
	)			[inline]

BOOL PXMLRPCBlock::ValidateResponse

(

)

BOOL PXMLRPCBlock::GetParams

(

PXMLRPCStructBase &

data

)

BOOL PXMLRPCBlock::GetParam	(	PINDEX	idx,
		PString &	type,
		PString &	result
	)

BOOL PXMLRPCBlock::GetExpectedParam	(	PINDEX	idx,
		const PString &	expectedType,
		PString &	value
	)

BOOL PXMLRPCBlock::GetParam	(	PINDEX	idx,
		PString &	result
	)

BOOL PXMLRPCBlock::GetParam	(	PINDEX	idx,
		int &	result
	)

BOOL PXMLRPCBlock::GetParam	(	PINDEX	idx,
		double &	result
	)

BOOL PXMLRPCBlock::GetParam	(	PINDEX	idx,
		PTime &	result,
		int	tz = PTime::GMT
	)

BOOL PXMLRPCBlock::GetParam	(	PINDEX	idx,
		PStringToString &	result
	)

BOOL PXMLRPCBlock::GetParam	(	PINDEX	idx,
		PXMLRPCStructBase &	result
	)

BOOL PXMLRPCBlock::GetParam	(	PINDEX	idx,
		PStringArray &	result
	)

BOOL PXMLRPCBlock::GetParam	(	PINDEX	idx,
		PArray< PStringToString > &	result
	)

BOOL PXMLRPCBlock::ParseScalar	(	PXMLElement *	element,
		PString &	type,
		PString &	value
	)

BOOL PXMLRPCBlock::ParseStruct	(	PXMLElement *	element,
		PStringToString &	structDict
	)

BOOL PXMLRPCBlock::ParseStruct	(	PXMLElement *	element,
		PXMLRPCStructBase &	structData
	)

BOOL PXMLRPCBlock::ParseArray	(	PXMLElement *	element,
		PStringArray &	array
	)

BOOL PXMLRPCBlock::ParseArray	(	PXMLElement *	element,
		PArray< PStringToString > &	array
	)

BOOL PXMLRPCBlock::ParseArray	(	PXMLElement *	element,
		PXMLRPCVariableBase &	array
	)

static PXMLElement* PXMLRPCBlock::CreateValueElement

(

PXMLElement *

element

)

[static]

static PXMLElement* PXMLRPCBlock::CreateScalar	(	const PString &	type,
		const PString &	scalar
	)			[static]

static PXMLElement* PXMLRPCBlock::CreateMember	(	const PString &	name,
		PXMLElement *	value
	)			[static]

static PXMLElement* PXMLRPCBlock::CreateScalar

(

const PString &

str

)

[static]

static PXMLElement* PXMLRPCBlock::CreateScalar

(

int

value

)

[static]

static PXMLElement* PXMLRPCBlock::CreateScalar

(

double

value

)

[static]

static PXMLElement* PXMLRPCBlock::CreateDateAndTime

(

const PTime &

time

)

[static]

static PXMLElement* PXMLRPCBlock::CreateBinary

(

const PBYTEArray &

data

)

[static]

static PXMLElement* PXMLRPCBlock::CreateStruct

(

)

[static]

static PXMLElement* PXMLRPCBlock::CreateStruct

(

const PStringToString &

dict

)

[static]

static PXMLElement* PXMLRPCBlock::CreateStruct	(	const PStringToString &	dict,
		const PString &	typeStr
	)			[static]

static PXMLElement* PXMLRPCBlock::CreateStruct

(

const PXMLRPCStructBase &

structData

)

[static]

static PXMLElement* PXMLRPCBlock::CreateArray

(

const PStringArray &

array

)

[static]

static PXMLElement* PXMLRPCBlock::CreateArray	(	const PStringArray &	array,
		const PString &	typeStr
	)			[static]

static PXMLElement* PXMLRPCBlock::CreateArray	(	const PStringArray &	array,
		const PStringArray &	types
	)			[static]

static PXMLElement* PXMLRPCBlock::CreateArray

(

const PArray< PStringToString > &

array

)

[static]

static PXMLElement* PXMLRPCBlock::CreateArray

(

const PXMLRPCVariableBase &

array

)

[static]

void PXMLRPCBlock::AddParam

(

PXMLElement *

parm

)

void PXMLRPCBlock::AddParam

(

const PString &

str

)

void PXMLRPCBlock::AddParam

(

int

value

)

void PXMLRPCBlock::AddParam

(

double

value

)

void PXMLRPCBlock::AddParam

(

const PTime &

time

)

void PXMLRPCBlock::AddParam

(

const PXMLRPCStructBase &

structData

)

void PXMLRPCBlock::AddBinary

(

const PBYTEArray &

data

)

void PXMLRPCBlock::AddStruct

(

const PStringToString &

dict

)

void PXMLRPCBlock::AddStruct	(	const PStringToString &	dict,
		const PString &	typeStr
	)

void PXMLRPCBlock::AddArray

(

const PStringArray &

array

)

void PXMLRPCBlock::AddArray	(	const PStringArray &	array,
		const PString &	typeStr
	)

void PXMLRPCBlock::AddArray	(	const PStringArray &	array,
		const PStringArray &	types
	)

void PXMLRPCBlock::AddArray

(

const PArray< PStringToString > &

array

)

---

Member Data Documentation

PXMLElement* PXMLRPCBlock::params [protected]

PString PXMLRPCBlock::faultText [protected]

PINDEX PXMLRPCBlock::faultCode [protected]

---

The documentation for this class was generated from the following file:

• pxmlrpc.h

---