UPnP::Service Class Reference

#include <Service.h>

Inheritance diagram for UPnP::Service:

Signals
void	queryFinished (bool error)

Public Member Functions
int	getPendingRequests () const
	Service (const QString &hostname, int port, const QString &informationUrl)
	Service (const ServiceParameters &params)
virtual	~Service ()

Protected Member Functions
int	callAction (const QString &actionName, const QString &prefix)
int	callAction (const QString &actionName, const QMap< QString, QString > &arguments, const QString &prefix)
int	callInformationUrl ()
virtual void	gotActionErrorResponse (const QDomNode &response)
virtual void	gotActionResponse (const QString &responseType, const QMap< QString, QString > &resultValues)
virtual void	gotInformationResponse (const QDomNode &response)

Private Slots
void	slotRequestFinished ()

Private Member Functions
int	callActionInternal (const QString &actionName, const QMap< QString, QString > *arguments, const QString &prefix)

Private Attributes
int	m_iPendingRequests
int	m_iPort
QString	m_szBaseXmlPrefix
QString	m_szControlUrl
QString	m_szHostname
QString	m_szInformationUrl
QString	m_szServiceId
QString	m_szServiceType

Detailed Description

This base class to implement calls to a UPnP-enabled device. In UPnP terminology, a client is called a Control Point, and a service is a UPnP device.

This class different kind of calls. An information request queries the service for data with a HTTP GET. An action request issues a HTTP POST call to the given service.

Author

Diederik van der Boor

Constructor & Destructor Documentation

UPnP::Service::Service	(	const QString &	hostname,
		int	port,
		const QString &	informationUrl
	)

References m_szInformationUrl.

UPnP::Service::Service

(

const ServiceParameters &

params

)

References m_szControlUrl, and m_szServiceId.

UPnP::Service::~Service ( )

virtual

References m_szControlUrl, and m_szServiceId.

Member Function Documentation

int UPnP::Service::callAction ( const QString &  actionName, const QString &  prefix  )

protected

References callActionInternal().

Referenced by UPnP::WanConnectionService::addPortMapping(), UPnP::WanConnectionService::deletePortMapping(), UPnP::WanConnectionService::queryExternalIpAddress(), UPnP::WanConnectionService::queryNatEnabled(), and UPnP::WanConnectionService::queryPortMappingEntry().

int UPnP::Service::callAction ( const QString &  actionName, const QMap< QString, QString > &  arguments, const QString &  prefix  )

protected

References callActionInternal().

int UPnP::Service::callActionInternal ( const QString &  actionName, const QMap< QString, QString > *  arguments, const QString &  prefix  )

private

References connect(), KviNetworkAccessManager::getInstance(), m_iPendingRequests, m_iPort, m_szBaseXmlPrefix, m_szHostname, m_szServiceType, and slotRequestFinished().

Referenced by callAction().

int UPnP::Service::callInformationUrl ( )

protected

References connect(), KviNetworkAccessManager::getInstance(), m_iPendingRequests, m_iPort, m_szHostname, m_szInformationUrl, and slotRequestFinished().

Referenced by UPnP::RootService::queryDevice().

int UPnP::Service::getPendingRequests

(

)

const

References m_iPendingRequests.

void UPnP::Service::gotActionErrorResponse ( const QDomNode &  response )

protectedvirtual

References XmlFunctions::getNodeValue().

Referenced by slotRequestFinished().

void UPnP::Service::gotActionResponse ( const QString &  responseType, const QMap< QString, QString > &  resultValues  )

protectedvirtual

Reimplemented in UPnP::WanConnectionService.

Referenced by slotRequestFinished().

void UPnP::Service::gotInformationResponse ( const QDomNode &  response )

protectedvirtual

Reimplemented in UPnP::RootService.

Referenced by slotRequestFinished().

void UPnP::Service::queryFinished ( bool  error )

signal

Referenced by slotRequestFinished().

void UPnP::Service::slotRequestFinished ( )

privateslot

References XmlFunctions::getNode(), gotActionErrorResponse(), gotActionResponse(), gotInformationResponse(), i, m_iPendingRequests, m_szBaseXmlPrefix, and queryFinished().

Referenced by callActionInternal(), and callInformationUrl().

Member Data Documentation

int UPnP::Service::m_iPendingRequests

private

Referenced by callActionInternal(), callInformationUrl(), getPendingRequests(), and slotRequestFinished().

int UPnP::Service::m_iPort

private

Referenced by callActionInternal(), and callInformationUrl().

QString UPnP::Service::m_szBaseXmlPrefix

private

Referenced by callActionInternal(), and slotRequestFinished().

QString UPnP::Service::m_szControlUrl

private

Referenced by Service(), and ~Service().

QString UPnP::Service::m_szHostname

private

Referenced by callActionInternal(), and callInformationUrl().

QString UPnP::Service::m_szInformationUrl

private

Referenced by callInformationUrl(), and Service().

QString UPnP::Service::m_szServiceId

private

Referenced by Service(), and ~Service().

QString UPnP::Service::m_szServiceType

private

Referenced by callActionInternal().

---

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

• src/modules/upnp/Service.h
• src/modules/upnp/Service.cpp