#include <libmythupnp/upnpcds.h>

Inheritance diagram for UPnpCDS:

Collaboration diagram for UPnpCDS:

Public Member Functions
	UPnpCDS (UPnpDevice *pDevice, const QString &sSharePath)

	~UPnpCDS () override

void	RegisterExtension (UPnpCDSExtension *pExtension)

void	UnregisterExtension (UPnpCDSExtension *pExtension)

void	RegisterShortCut (UPnPShortcutFeature::ShortCutType type, const QString &objectID)

void	RegisterFeature (UPnPFeature *feature)

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...

Private Member Functions
void	HandleBrowse (HTTPRequest *pRequest)

void	HandleSearch (HTTPRequest *pRequest)

void	HandleGetSystemUpdateID (HTTPRequest *pRequest)

void	HandleGetFeatureList (HTTPRequest *pRequest)

void	HandleGetServiceResetToken (HTTPRequest *pRequest)

Static Private Member Functions
static UPnpCDSMethod	GetMethod (const QString &sURI)

static UPnpCDSBrowseFlag	GetBrowseFlag (const QString &sFlag)

static void	HandleGetSearchCapabilities (HTTPRequest *pRequest)
	Return the list of supported search fields. More...

static void	HandleGetSortCapabilities (HTTPRequest *pRequest)
	Return the list of supported sorting fields. More...

static void	DetermineClient (HTTPRequest pRequest, UPnpCDSRequest pCDSRequest)

Private Attributes
UPnpCDSExtensionList	m_extensions

CDSObject	m_root

QString	m_sServiceDescFileName

QString	m_sControlUrl

UPnPFeatureList	m_features

UPnPShortcutFeature *	m_pShortCuts {nullptr}

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 282 of file upnpcds.h.

Constructor & Destructor Documentation

◆ UPnpCDS()

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

Definition at line 73 of file upnpcds.cpp.

◆ ~UPnpCDS()

UPnpCDS::~UPnpCDS ( )

override

Definition at line 124 of file upnpcds.cpp.

Member Function Documentation

◆ GetMethod()

UPnpCDSMethod UPnpCDS::GetMethod ( const QString & sURI )

staticprivate

Definition at line 136 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ GetBrowseFlag()

UPnpCDSBrowseFlag UPnpCDS::GetBrowseFlag ( const QString & sFlag )

staticprivate

Definition at line 155 of file upnpcds.cpp.

Referenced by HandleBrowse().

◆ HandleBrowse()

void UPnpCDS::HandleBrowse ( HTTPRequest * pRequest )

private

Definition at line 362 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ HandleSearch()

void UPnpCDS::HandleSearch ( HTTPRequest * pRequest )

private

Definition at line 543 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ HandleGetSearchCapabilities()

void UPnpCDS::HandleGetSearchCapabilities ( HTTPRequest * pRequest )

staticprivate

Return the list of supported search fields.

Currently no searching is supported.

Definition at line 686 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ HandleGetSortCapabilities()

void UPnpCDS::HandleGetSortCapabilities ( HTTPRequest * pRequest )

staticprivate

Return the list of supported sorting fields.

Currently no sorting is supported.

Definition at line 712 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ HandleGetSystemUpdateID()

void UPnpCDS::HandleGetSystemUpdateID ( HTTPRequest * pRequest )

private

Definition at line 736 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ HandleGetFeatureList()

void UPnpCDS::HandleGetFeatureList ( HTTPRequest * pRequest )

private

Definition at line 755 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ HandleGetServiceResetToken()

void UPnpCDS::HandleGetServiceResetToken ( HTTPRequest * pRequest )

private

Definition at line 769 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ DetermineClient()

void UPnpCDS::DetermineClient	(	HTTPRequest *	pRequest,
		UPnpCDSRequest *	pCDSRequest
	)

staticprivate

Definition at line 304 of file upnpcds.cpp.

Referenced by HandleBrowse(), and HandleSearch().

◆ GetServiceType()

QString UPnpCDS::GetServiceType ( )

inlineoverrideprotectedvirtual

Provices the schema urn.

Implements UPnpServiceImpl.

Definition at line 313 of file upnpcds.h.

◆ GetServiceId()

QString UPnpCDS::GetServiceId ( )

inlineoverrideprotectedvirtual

Provides the device specific urn.

Implements UPnpServiceImpl.

Definition at line 315 of file upnpcds.h.

◆ GetServiceControlURL()

QString UPnpCDS::GetServiceControlURL ( )

inlineoverrideprotectedvirtual

Provices the base URL for control commands.

Implements UPnpServiceImpl.

Definition at line 317 of file upnpcds.h.

◆ GetServiceDescURL()

QString UPnpCDS::GetServiceDescURL ( )

inlineoverrideprotectedvirtual

Provices the URL of the service description XML.

Implements UPnpServiceImpl.

Definition at line 319 of file upnpcds.h.

◆ RegisterExtension()

void UPnpCDS::RegisterExtension ( UPnpCDSExtension * pExtension )

Definition at line 167 of file upnpcds.cpp.

Referenced by MediaServer::RegisterExtension().

◆ UnregisterExtension()

void UPnpCDS::UnregisterExtension ( UPnpCDSExtension * pExtension )

Definition at line 186 of file upnpcds.cpp.

Referenced by MediaServer::UnregisterExtension().

◆ RegisterShortCut()

void UPnpCDS::RegisterShortCut	(	UPnPShortcutFeature::ShortCutType	type,
		const QString &	objectID
	)

Definition at line 199 of file upnpcds.cpp.

Referenced by RegisterExtension().

◆ RegisterFeature()

void UPnpCDS::RegisterFeature ( UPnPFeature * feature )

Definition at line 209 of file upnpcds.cpp.

Referenced by UPnpCDS().

◆ GetBasePaths()

QStringList UPnpCDS::GetBasePaths ( )

overridevirtual

Reimplemented from Eventing.

Definition at line 218 of file upnpcds.cpp.

◆ ProcessRequest()

bool UPnpCDS::ProcessRequest ( HTTPRequest * pRequest )

overridevirtual

Reimplemented from Eventing.

Definition at line 227 of file upnpcds.cpp.

Member Data Documentation

◆ m_extensions

UPnpCDSExtensionList UPnpCDS::m_extensions

private

Definition at line 286 of file upnpcds.h.

Referenced by HandleBrowse(), HandleSearch(), RegisterExtension(), UnregisterExtension(), and ~UPnpCDS().

◆ m_root

CDSObject UPnpCDS::m_root

private

Definition at line 287 of file upnpcds.h.

Referenced by HandleBrowse(), and UPnpCDS().

◆ m_sServiceDescFileName

QString UPnpCDS::m_sServiceDescFileName

private

Definition at line 289 of file upnpcds.h.

Referenced by ProcessRequest(), and UPnpCDS().

◆ m_sControlUrl

QString UPnpCDS::m_sControlUrl

private

Definition at line 290 of file upnpcds.h.

Referenced by GetBasePaths(), and ProcessRequest().

◆ m_features

UPnPFeatureList UPnpCDS::m_features

private

Definition at line 292 of file upnpcds.h.

Referenced by HandleGetFeatureList(), RegisterFeature(), and UPnpCDS().

◆ m_pShortCuts

UPnPShortcutFeature* UPnpCDS::m_pShortCuts {nullptr}

private

Definition at line 293 of file upnpcds.h.

Referenced by RegisterShortCut(), and UPnpCDS().

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

mythtv/libs/libmythupnp/upnpcds.h
mythtv/libs/libmythupnp/upnpcds.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UPnpCDS()

◆ ~UPnpCDS()

Member Function Documentation

◆ GetMethod()

◆ GetBrowseFlag()

◆ HandleBrowse()

◆ HandleSearch()

◆ HandleGetSearchCapabilities()

◆ HandleGetSortCapabilities()

◆ HandleGetSystemUpdateID()

◆ HandleGetFeatureList()

◆ HandleGetServiceResetToken()

◆ DetermineClient()

◆ GetServiceType()

◆ GetServiceId()

◆ GetServiceControlURL()

◆ GetServiceDescURL()

◆ RegisterExtension()

◆ UnregisterExtension()

◆ RegisterShortCut()

◆ RegisterFeature()

◆ GetBasePaths()

◆ ProcessRequest()

Member Data Documentation

◆ m_extensions

◆ m_root

◆ m_sServiceDescFileName

◆ m_sControlUrl

◆ m_features

◆ m_pShortCuts