MythTV  master
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
UPnpCDS Class Reference

#include <upnpcds.h>

Inheritance diagram for UPnpCDS:
Inheritance graph
[legend]
Collaboration diagram for UPnpCDS:
Collaboration graph
[legend]

Public Member Functions

 UPnpCDS (UPnpDevice *pDevice, const QString &sSharePath)
 
virtual ~UPnpCDS ()
 
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, const QString &sEventMethodName, const QString &sSharePath)
 
virtual ~Eventing ()
 
short HoldEvents ()
 
short ReleaseEvents ()
 
void ExecutePostProcess () override
 
- Public Member Functions inherited from HttpServerExtension
 HttpServerExtension (const QString &sName, const QString &sSharePath)
 
virtual ~HttpServerExtension ()=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, T value)
 
template<class 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

UPnpCDSMethod GetMethod (const QString &sURI)
 
UPnpCDSBrowseFlag GetBrowseFlag (const QString &sFlag)
 
void HandleBrowse (HTTPRequest *pRequest)
 
void HandleSearch (HTTPRequest *pRequest)
 
void HandleGetSearchCapabilities (HTTPRequest *pRequest)
 Return the list of supported search fields. More...
 
void HandleGetSortCapabilities (HTTPRequest *pRequest)
 Return the list of supported sorting fields. More...
 
void HandleGetSystemUpdateID (HTTPRequest *pRequest)
 
void HandleGetFeatureList (HTTPRequest *pRequest)
 
void HandleGetServiceResetToken (HTTPRequest *pRequest)
 
void DetermineClient (HTTPRequest *pRequest, UPnpCDSRequest *pCDSRequest)
 

Private Attributes

UPnpCDSExtensionList m_extensions
 
CDSObject m_root
 
QString m_sServiceDescFileName
 
QString m_sControlUrl
 
UPnPFeatureList m_features
 
UPnPShortcutFeaturem_pShortCuts {nullptr}
 

Additional Inherited Members

- Public Attributes inherited from HttpServerExtension
QString m_sName
 
QString m_sSharePath
 
int m_nSocketTimeout
 
uint m_nSupportedMethods
 
- Protected Types inherited from StateVariables
typedef QMap< QString, StateVariableBase * > SVMap
 
- Protected Attributes inherited from Eventing
QMutex m_mutex
 
QString m_sEventMethodName
 
Subscribers m_Subscribers
 
int m_nSubscriptionDuration {1800}
 
short m_nHoldCount {0}
 
SubscriberInfom_pInitializeSubscriber {nullptr}
 
- Protected Attributes inherited from StateVariables
SVMap m_map
 

Detailed Description

Definition at line 281 of file upnpcds.h.

Constructor & Destructor Documentation

◆ UPnpCDS()

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

Definition at line 74 of file upnpcds.cpp.

◆ ~UPnpCDS()

UPnpCDS::~UPnpCDS ( )
virtual

Definition at line 125 of file upnpcds.cpp.

Member Function Documentation

◆ GetMethod()

UPnpCDSMethod UPnpCDS::GetMethod ( const QString &  sURI)
private

Definition at line 137 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ GetBrowseFlag()

UPnpCDSBrowseFlag UPnpCDS::GetBrowseFlag ( const QString &  sFlag)
private

Definition at line 156 of file upnpcds.cpp.

Referenced by HandleBrowse().

◆ HandleBrowse()

void UPnpCDS::HandleBrowse ( HTTPRequest pRequest)
private

Definition at line 368 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ HandleSearch()

void UPnpCDS::HandleSearch ( HTTPRequest pRequest)
private

Definition at line 542 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ HandleGetSearchCapabilities()

void UPnpCDS::HandleGetSearchCapabilities ( HTTPRequest pRequest)
private

Return the list of supported search fields.

Currently no searching is supported.

Definition at line 685 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ HandleGetSortCapabilities()

void UPnpCDS::HandleGetSortCapabilities ( HTTPRequest pRequest)
private

Return the list of supported sorting fields.

Currently no sorting is supported.

Definition at line 711 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ HandleGetSystemUpdateID()

void UPnpCDS::HandleGetSystemUpdateID ( HTTPRequest pRequest)
private

Definition at line 735 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ HandleGetFeatureList()

void UPnpCDS::HandleGetFeatureList ( HTTPRequest pRequest)
private

Definition at line 754 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ HandleGetServiceResetToken()

void UPnpCDS::HandleGetServiceResetToken ( HTTPRequest pRequest)
private

Definition at line 768 of file upnpcds.cpp.

Referenced by ProcessRequest().

◆ DetermineClient()

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

Definition at line 307 of file upnpcds.cpp.

Referenced by HandleBrowse(), and HandleSearch().

◆ GetServiceType()

QString UPnpCDS::GetServiceType ( )
inlineoverrideprotectedvirtual

Provices the schema urn.

Implements UPnpServiceImpl.

Definition at line 312 of file upnpcds.h.

◆ GetServiceId()

QString UPnpCDS::GetServiceId ( )
inlineoverrideprotectedvirtual

Provides the device specific urn.

Implements UPnpServiceImpl.

Definition at line 314 of file upnpcds.h.

◆ GetServiceControlURL()

QString UPnpCDS::GetServiceControlURL ( )
inlineoverrideprotectedvirtual

Provices the base URL for control commands.

Implements UPnpServiceImpl.

Definition at line 316 of file upnpcds.h.

◆ GetServiceDescURL()

QString UPnpCDS::GetServiceDescURL ( )
inlineoverrideprotectedvirtual

Provices the URL of the service description XML.

Implements UPnpServiceImpl.

Definition at line 318 of file upnpcds.h.

◆ RegisterExtension()

void UPnpCDS::RegisterExtension ( UPnpCDSExtension pExtension)

Definition at line 168 of file upnpcds.cpp.

Referenced by MediaServer::RegisterExtension().

◆ UnregisterExtension()

void UPnpCDS::UnregisterExtension ( UPnpCDSExtension pExtension)

Definition at line 187 of file upnpcds.cpp.

Referenced by MediaServer::UnregisterExtension().

◆ RegisterShortCut()

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

Definition at line 200 of file upnpcds.cpp.

Referenced by RegisterExtension().

◆ RegisterFeature()

void UPnpCDS::RegisterFeature ( UPnPFeature feature)

Definition at line 210 of file upnpcds.cpp.

Referenced by UPnpCDS().

◆ GetBasePaths()

QStringList UPnpCDS::GetBasePaths ( )
overridevirtual

Reimplemented from Eventing.

Definition at line 219 of file upnpcds.cpp.

◆ ProcessRequest()

bool UPnpCDS::ProcessRequest ( HTTPRequest pRequest)
overridevirtual

Reimplemented from Eventing.

Definition at line 228 of file upnpcds.cpp.

Member Data Documentation

◆ m_extensions

UPnpCDSExtensionList UPnpCDS::m_extensions
private

◆ m_root

CDSObject UPnpCDS::m_root
private

Definition at line 286 of file upnpcds.h.

Referenced by HandleBrowse(), and UPnpCDS().

◆ m_sServiceDescFileName

QString UPnpCDS::m_sServiceDescFileName
private

Definition at line 288 of file upnpcds.h.

Referenced by ProcessRequest(), and UPnpCDS().

◆ m_sControlUrl

QString UPnpCDS::m_sControlUrl
private

Definition at line 289 of file upnpcds.h.

Referenced by GetBasePaths(), ProcessRequest(), and UPnpCDS().

◆ m_features

UPnPFeatureList UPnpCDS::m_features
private

Definition at line 291 of file upnpcds.h.

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

◆ m_pShortCuts

UPnPShortcutFeature* UPnpCDS::m_pShortCuts {nullptr}
private

Definition at line 292 of file upnpcds.h.

Referenced by RegisterShortCut(), and UPnpCDS().


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