SOAPClient Class Reference

Subclass SOAPClient to perform actions using the command URL. More...

#include <soapclient.h>

Inheritance diagram for SOAPClient:

Public Member Functions
	SOAPClient (const QUrl &url, const QString &sNamespace, const QString &sControlPath)
	Full SOAPClient constructor.
	SOAPClient ()
	Empty SOAPClient constructor.
virtual	~SOAPClient ()
bool	Init (const QUrl &url, const QString &sNamespace, const QString &sControlPath)
	SOAPClient Initializer.
Protected Member Functions
int	GetNodeValue (const QDomNode &node, const QString &sName, int nDefault) const
	Gets the named value using QDomNode as the baseNode in the search, returns default if it is not found.
bool	GetNodeValue (const QDomNode &node, const QString &sName, bool bDefault) const
	Gets the named value using QDomNode as the baseNode in the search, returns default if it is not found.
QString	GetNodeValue (const QDomNode &node, const QString &sName, const QString &sDefault) const
	Gets the named value using QDomNode as the baseNode in the search, returns default if it is not found.
QString	GetNodeValue (const QDomNode &node, const QString &sName, const char *sDefault) const
QDomNode	FindNode (const QString &sName, const QDomNode &baseNode) const
	Used by GeNodeValue() methods to find the named node.
QDomDocument	SendSOAPRequest (const QString &sMethod, QStringMap &list, int &nErrCode, QString &sErrDesc, bool bInQtThread)
	Actually sends the sMethod action to the command URL specified in the constructor (url+[/]+sControlPath).
Protected Attributes
QUrl	m_url
QString	m_sNamespace
QString	m_sControlPath
Private Member Functions
QDomNode	FindNodeInternal (QStringList &sParts, const QDomNode &curNode) const
	This is an internal function used to implement FindNode.

Detailed Description

Subclass SOAPClient to perform actions using the command URL.

Definition at line 25 of file soapclient.h.

Constructor & Destructor Documentation

SOAPClient::SOAPClient	(	const QUrl &	url,
		const QString &	sNamespace,
		const QString &	sControlPath
	)

Full SOAPClient constructor.

After constructing the client with this constructor it is ready for SendSOAPRequest().

Parameters:

	url	The host and port portion of the command URL
	sNamespace	The part of the action before the # character
	sControlPath	The path portion of the command URL

Definition at line 29 of file soapclient.cpp.

SOAPClient::SOAPClient ( ) [inline]

Empty SOAPClient constructor.

When this is used, Init() Must be called before SendSOAPRequest().

Definition at line 33 of file soapclient.h.

virtual SOAPClient::~SOAPClient ( ) [inline, virtual]

Definition at line 34 of file soapclient.h.

Member Function Documentation

bool SOAPClient::Init	(	const QUrl &	url,
		const QString &	sNamespace,
		const QString &	sControlPath
	)

SOAPClient Initializer.

After constructing the client with the empty constructor call this before calling SendSOAPRequest() the first time.

Definition at line 41 of file soapclient.cpp.

int SOAPClient::GetNodeValue	(	const QDomNode &	node,
		const QString &	sName,
		int	nDefault
	)			const `[protected]`

Gets the named value using QDomNode as the baseNode in the search, returns default if it is not found.

Definition at line 106 of file soapclient.cpp.

Referenced by MythXMLClient::GetConnectionInfo(), GetNodeValue(), and SendSOAPRequest().

bool SOAPClient::GetNodeValue	(	const QDomNode &	node,
		const QString &	sName,
		bool	bDefault
	)			const `[protected]`

Gets the named value using QDomNode as the baseNode in the search, returns default if it is not found.

Definition at line 115 of file soapclient.cpp.

QString SOAPClient::GetNodeValue	(	const QDomNode &	node,
		const QString &	sName,
		const QString &	sDefault
	)			const `[protected]`

Gets the named value using QDomNode as the baseNode in the search, returns default if it is not found.

Definition at line 137 of file soapclient.cpp.

QString SOAPClient::GetNodeValue	(	const QDomNode &	node,
		const QString &	sName,
		const char *	sDefault
	)			const `[inline, protected]`

Definition at line 50 of file soapclient.h.

QDomNode SOAPClient::FindNode	(	const QString &	sName,
		const QDomNode &	baseNode
	)			const `[protected]`

Used by GeNodeValue() methods to find the named node.

Definition at line 79 of file soapclient.cpp.

Referenced by GetNodeValue(), and SendSOAPRequest().

QDomDocument SOAPClient::SendSOAPRequest	(	const QString &	sMethod,
		QStringMap &	list,
		int &	nErrCode,
		QString &	sErrDesc,
		bool	bInQtThread
	)			`[protected]`

Actually sends the sMethod action to the command URL specified in the constructor (url+[/]+sControlPath).

Parameters:

	sMethod	method to be invoked. e.g. "SetChannel", "GetConnectionInfoResult"
	list	Parsed as a series of key value pairs for the input params and then cleared and used for the output params.
	nErrCode	set to zero on success, non-zero in case of error.
	sErrCode	returns error description from device, when applicable.
	bInQtThread	May be set to true if this is run from within a QThread with a running an event loop.