UPnpCMGR Class Reference

#include <libmythupnp/upnpcmgr.h>

Inheritance diagram for UPnpCMGR:

Collaboration diagram for UPnpCMGR:

Public Member Functions
	UPnpCMGR (UPnpDevice *pDevice, const QString &sSharePath, const QString &sSourceProtocols="", const QString &sSinkProtocols="")
	~UPnpCMGR () override=default
void	AddSourceProtocol (const QString &sProtocol)
void	AddSinkProtocol (const QString &sProtocol)
QStringList	GetBasePaths () override
bool	ProcessRequest (HTTPRequest *pRequest) override
Public Member Functions inherited from Eventing
	Eventing (const QString &sExtensionName, QString sEventMethodName, const QString &sSharePath)
	~Eventing () override
QStringList	GetBasePaths () override
bool	ProcessRequest (HTTPRequest *pRequest) override
short	HoldEvents ()
short	ReleaseEvents ()
void	ExecutePostProcess () override
Public Member Functions inherited from HttpServerExtension
	HttpServerExtension (QString sName, QString sSharePath)
	~HttpServerExtension () override=default
virtual bool	ProcessRequest (HTTPRequest *pRequest)=0
virtual bool	ProcessOptions (HTTPRequest *pRequest)
	Handle an OPTIONS request. More...
virtual QStringList	GetBasePaths ()=0
virtual int	GetSocketTimeout () const
Public Member Functions inherited from StateVariables
	StateVariables ()=default
virtual	~StateVariables ()
void	AddVariable (StateVariableBase *pBase)
template<class T >
bool	SetValue (const QString &sName, const T &value)
template<class T >
T	GetValue (const QString &sName)
uint	BuildNotifyBody (QTextStream &ts, std::chrono::microseconds ttLastNotified) const
Public Member Functions inherited from IPostProcess
virtual void	ExecutePostProcess ()=0
virtual	~IPostProcess ()=default
Public Member Functions inherited from UPnpServiceImpl
	UPnpServiceImpl ()=default
virtual	~UPnpServiceImpl ()=default
void	RegisterService (UPnpDevice *device)
	Creates a UPnpService and adds it to the UPnpDevice's list of services. More...

Protected Member Functions
QString	GetServiceType () override
	Provices the schema urn. More...
QString	GetServiceId () override
	Provides the device specific urn. More...
QString	GetServiceControlURL () override
	Provices the base URL for control commands. More...
QString	GetServiceDescURL () override
	Provices the URL of the service description XML. More...
Protected Member Functions inherited from Eventing
void	Notify () override
void	NotifySubscriber (SubscriberInfo *pInfo)
void	HandleSubscribe (HTTPRequest *pRequest)
void	HandleUnsubscribe (HTTPRequest *pRequest)
QString	GetServiceEventURL () override
	Provides the URL of the event portion of the service. More...
virtual void	Notify ()=0
virtual QString	GetServiceType (void)=0
	Provices the schema urn. More...
virtual QString	GetServiceId (void)=0
	Provides the device specific urn. More...
virtual QString	GetServiceControlURL (void)=0
	Provices the base URL for control commands. More...
virtual QString	GetServiceDescURL (void)=0
	Provices the URL of the service description XML. More...
virtual QString	GetServiceEventURL (void)
	Provides the URL of the event portion of the service. More...

Private Member Functions
void	HandleGetProtocolInfo (HTTPRequest *pRequest)
void	HandleGetCurrentConnectionIDs (HTTPRequest *pRequest)
void	HandleGetFeatureList (HTTPRequest *pRequest)

Static Private Member Functions
static UPnpCMGRMethod	GetMethod (const QString &sURI)
static void	HandleGetCurrentConnectionInfo (HTTPRequest *pRequest)

Private Attributes
QString	m_sServiceDescFileName
QString	m_sControlUrl
UPnPFeatureList	m_features

Additional Inherited Members
Public Attributes inherited from HttpServerExtension
QString	m_sName
QString	m_sSharePath
int	m_nSocketTimeout { -1 }
uint	m_nSupportedMethods
Protected Types inherited from StateVariables
using	SVMap = QMap< QString, StateVariableBase * >
Protected Attributes inherited from Eventing
QMutex	m_mutex
QString	m_sEventMethodName
Subscribers	m_subscribers
std::chrono::seconds	m_nSubscriptionDuration {30min}
short	m_nHoldCount {0}
SubscriberInfo *	m_pInitializeSubscriber {nullptr}
Protected Attributes inherited from StateVariables
SVMap	m_map

Detailed Description

Definition at line 48 of file upnpcmgr.h.

Constructor & Destructor Documentation

UPnpCMGR()

UPnpCMGR::UPnpCMGR	(	UPnpDevice *	pDevice,
		const QString &	sSharePath,
		const QString &	sSourceProtocols = "",
		const QString &	sSinkProtocols = ""
	)

Definition at line 23 of file upnpcmgr.cpp.

~UPnpCMGR()

UPnpCMGR::~UPnpCMGR ( )

overridedefault

Member Function Documentation

AddSinkProtocol()

void UPnpCMGR::AddSinkProtocol

(

const QString &

sProtocol

)

Definition at line 78 of file upnpcmgr.cpp.

AddSourceProtocol()

void UPnpCMGR::AddSourceProtocol

(

const QString &

sProtocol

)

Definition at line 62 of file upnpcmgr.cpp.

GetBasePaths()

QStringList UPnpCMGR::GetBasePaths ( )

overridevirtual

Reimplemented from Eventing.

Definition at line 110 of file upnpcmgr.cpp.

GetMethod()

UPnpCMGRMethod UPnpCMGR::GetMethod ( const QString &  sURI )

staticprivate

Definition at line 95 of file upnpcmgr.cpp.

Referenced by ProcessRequest().

GetServiceControlURL()

QString UPnpCMGR::GetServiceControlURL ( )

inlineoverrideprotectedvirtual

Provices the base URL for control commands.

Implements UPnpServiceImpl.

Definition at line 72 of file upnpcmgr.h.

GetServiceDescURL()

QString UPnpCMGR::GetServiceDescURL ( )

inlineoverrideprotectedvirtual

Provices the URL of the service description XML.

Implements UPnpServiceImpl.

Definition at line 74 of file upnpcmgr.h.

GetServiceId()

QString UPnpCMGR::GetServiceId ( )

inlineoverrideprotectedvirtual

Provides the device specific urn.

Implements UPnpServiceImpl.

Definition at line 70 of file upnpcmgr.h.

GetServiceType()

QString UPnpCMGR::GetServiceType ( )

inlineoverrideprotectedvirtual

Provices the schema urn.

Implements UPnpServiceImpl.

Definition at line 68 of file upnpcmgr.h.

HandleGetCurrentConnectionIDs()

void UPnpCMGR::HandleGetCurrentConnectionIDs ( HTTPRequest *  pRequest )

private

Definition at line 215 of file upnpcmgr.cpp.

Referenced by ProcessRequest().

HandleGetCurrentConnectionInfo()

void UPnpCMGR::HandleGetCurrentConnectionInfo ( HTTPRequest *  pRequest )

staticprivate

Definition at line 187 of file upnpcmgr.cpp.

Referenced by ProcessRequest().

HandleGetFeatureList()

void UPnpCMGR::HandleGetFeatureList ( HTTPRequest *  pRequest )

private

Definition at line 225 of file upnpcmgr.cpp.

Referenced by ProcessRequest().

HandleGetProtocolInfo()

void UPnpCMGR::HandleGetProtocolInfo ( HTTPRequest *  pRequest )

private

Definition at line 171 of file upnpcmgr.cpp.

Referenced by ProcessRequest().

ProcessRequest()

bool UPnpCMGR::ProcessRequest ( HTTPRequest *  pRequest )

overridevirtual

Reimplemented from Eventing.

Definition at line 119 of file upnpcmgr.cpp.

Member Data Documentation

m_features

UPnPFeatureList UPnpCMGR::m_features

private

Definition at line 55 of file upnpcmgr.h.

Referenced by HandleGetFeatureList(), and UPnpCMGR().

m_sControlUrl

QString UPnpCMGR::m_sControlUrl

private

Definition at line 53 of file upnpcmgr.h.

Referenced by GetBasePaths(), and ProcessRequest().

m_sServiceDescFileName

QString UPnpCMGR::m_sServiceDescFileName

private

Definition at line 52 of file upnpcmgr.h.

Referenced by ProcessRequest(), and UPnpCMGR().

---

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

• mythtv/libs/libmythupnp/upnpcmgr.h
• mythtv/libs/libmythupnp/upnpcmgr.cpp