MythFEXML Class Reference

#include <mythfrontend/mythfexml.h>

Inheritance diagram for MythFEXML:

Collaboration diagram for MythFEXML:

Public Member Functions
	MythFEXML (UPnpDevice *pDevice, const QString &sSharePath)
	~MythFEXML () 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 MythFEXMLMethod	GetMethod (const QString &sURI)
static void	GetScreenShot (HTTPRequest *pRequest)
static void	GetActionListTest (HTTPRequest *pRequest)
static void	GetRemote (HTTPRequest *pRequest)

Private Attributes
QString	m_sControlUrl
QString	m_sServiceDescFileName

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 23 of file mythfexml.h.

Constructor & Destructor Documentation

MythFEXML()

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

Definition at line 34 of file mythfexml.cpp.

~MythFEXML()

MythFEXML::~MythFEXML ( )

overridedefault

Member Function Documentation

GetServiceType()

QString MythFEXML::GetServiceType ( )

inlineoverrideprotectedvirtual

Provices the schema urn.

Implements UPnpServiceImpl.

Definition at line 34 of file mythfexml.h.

GetServiceId()

QString MythFEXML::GetServiceId ( )

inlineoverrideprotectedvirtual

Provides the device specific urn.

Implements UPnpServiceImpl.

Definition at line 36 of file mythfexml.h.

GetServiceControlURL()

QString MythFEXML::GetServiceControlURL ( )

inlineoverrideprotectedvirtual

Provices the base URL for control commands.

Implements UPnpServiceImpl.

Definition at line 38 of file mythfexml.h.

GetServiceDescURL()

QString MythFEXML::GetServiceDescURL ( )

inlineoverrideprotectedvirtual

Provices the URL of the service description XML.

Implements UPnpServiceImpl.

Definition at line 40 of file mythfexml.h.

GetMethod()

MythFEXMLMethod MythFEXML::GetMethod ( const QString &  sURI )

staticprivate

Definition at line 52 of file mythfexml.cpp.

Referenced by ProcessRequest().

GetScreenShot()

void MythFEXML::GetScreenShot ( HTTPRequest *  pRequest )

staticprivate

Definition at line 114 of file mythfexml.cpp.

Referenced by ProcessRequest().

GetActionListTest()

void MythFEXML::GetActionListTest ( HTTPRequest *  pRequest )

staticprivate

Definition at line 166 of file mythfexml.cpp.

Referenced by ProcessRequest().

GetRemote()

void MythFEXML::GetRemote ( HTTPRequest *  pRequest )

staticprivate

Definition at line 207 of file mythfexml.cpp.

GetBasePaths()

QStringList MythFEXML::GetBasePaths ( )

overridevirtual

Reimplemented from Eventing.

Definition at line 66 of file mythfexml.cpp.

ProcessRequest()

bool MythFEXML::ProcessRequest ( HTTPRequest *  pRequest )

overridevirtual

Reimplemented from Eventing.

Definition at line 75 of file mythfexml.cpp.

Member Data Documentation

m_sControlUrl

QString MythFEXML::m_sControlUrl

private

Definition at line 27 of file mythfexml.h.

Referenced by GetBasePaths(), GetServiceControlURL(), GetServiceDescURL(), and ProcessRequest().

m_sServiceDescFileName

QString MythFEXML::m_sServiceDescFileName

private

Definition at line 28 of file mythfexml.h.

Referenced by MythFEXML(), and ProcessRequest().

---

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

• mythtv/programs/mythfrontend/mythfexml.h
• mythtv/programs/mythfrontend/mythfexml.cpp