UPnpMSRR Class Reference

#include <libmythupnp/upnpmsrr.h>

Inheritance diagram for UPnpMSRR:

Collaboration diagram for UPnpMSRR:

Public Member Functions
	UPnpMSRR (UPnpDevice *pDevice, const QString &sSharePath)
	~UPnpMSRR () override=default
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
short	HoldEvents ()
short	ReleaseEvents ()
void	ExecutePostProcess () override
Public Member Functions inherited from HttpServerExtension
	HttpServerExtension (QString sName, QString sSharePath)
	~HttpServerExtension () override=default
virtual bool	ProcessOptions (HTTPRequest *pRequest)
	Handle an OPTIONS request. More...
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, TaskTime ttLastNotified) const
Public Member Functions inherited from IPostProcess
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...

Static Private Member Functions
static UPnpMSRRMethod	GetMethod (const QString &sURI)
static void	HandleIsAuthorized (HTTPRequest *pRequest)
static void	HandleRegisterDevice (HTTPRequest *pRequest)
static void	HandleIsValidated (HTTPRequest *pRequest)

Private Attributes
QString	m_sServiceDescFileName
QString	m_sControlUrl

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 29 of file upnpmsrr.h.

Constructor & Destructor Documentation

UPnpMSRR()

UPnpMSRR::UPnpMSRR	(	UPnpDevice *	pDevice,
		const QString &	sSharePath
	)

Definition at line 20 of file upnpmsrr.cpp.

~UPnpMSRR()

UPnpMSRR::~UPnpMSRR ( )

overridedefault

Member Function Documentation

GetMethod()

UPnpMSRRMethod UPnpMSRR::GetMethod ( const QString &  sURI )

staticprivate

Definition at line 51 of file upnpmsrr.cpp.

Referenced by ProcessRequest().

HandleIsAuthorized()

void UPnpMSRR::HandleIsAuthorized ( HTTPRequest *  pRequest )

staticprivate

Definition at line 119 of file upnpmsrr.cpp.

Referenced by ProcessRequest().

HandleRegisterDevice()

void UPnpMSRR::HandleRegisterDevice ( HTTPRequest *  pRequest )

staticprivate

Definition at line 137 of file upnpmsrr.cpp.

Referenced by ProcessRequest().

HandleIsValidated()

void UPnpMSRR::HandleIsValidated ( HTTPRequest *  pRequest )

staticprivate

Definition at line 148 of file upnpmsrr.cpp.

Referenced by ProcessRequest().

GetServiceType()

QString UPnpMSRR::GetServiceType ( )

inlineoverrideprotectedvirtual

Provices the schema urn.

Implements UPnpServiceImpl.

Definition at line 46 of file upnpmsrr.h.

GetServiceId()

QString UPnpMSRR::GetServiceId ( )

inlineoverrideprotectedvirtual

Provides the device specific urn.

Implements UPnpServiceImpl.

Definition at line 48 of file upnpmsrr.h.

GetServiceControlURL()

QString UPnpMSRR::GetServiceControlURL ( )

inlineoverrideprotectedvirtual

Provices the base URL for control commands.

Implements UPnpServiceImpl.

Definition at line 50 of file upnpmsrr.h.

GetServiceDescURL()

QString UPnpMSRR::GetServiceDescURL ( )

inlineoverrideprotectedvirtual

Provices the URL of the service description XML.

Implements UPnpServiceImpl.

Definition at line 52 of file upnpmsrr.h.

GetBasePaths()

QStringList UPnpMSRR::GetBasePaths ( )

overridevirtual

Reimplemented from Eventing.

Definition at line 69 of file upnpmsrr.cpp.

ProcessRequest()

bool UPnpMSRR::ProcessRequest ( HTTPRequest *  pRequest )

overridevirtual

Reimplemented from Eventing.

Definition at line 78 of file upnpmsrr.cpp.

Member Data Documentation

m_sServiceDescFileName

QString UPnpMSRR::m_sServiceDescFileName

private

Definition at line 33 of file upnpmsrr.h.

Referenced by ProcessRequest(), and UPnpMSRR().

m_sControlUrl

QString UPnpMSRR::m_sControlUrl

private

Definition at line 34 of file upnpmsrr.h.

Referenced by GetBasePaths(), and ProcessRequest().

---

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

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