#include <libmythupnp/ssdpcache.h>

Inheritance diagram for SSDPCache:

Collaboration diagram for SSDPCache:

Public Member Functions
	~SSDPCache () override

void	Lock ()

void	Unlock ()

SSDPCacheEntriesMap::Iterator	Begin ()

SSDPCacheEntriesMap::Iterator	End ()

int	Count ()

void	Clear ()

void	Add (const QString &sURI, const QString &sUSN, const QString &sLocation, std::chrono::seconds sExpiresInSecs)

void	Remove (const QString &sURI, const QString &sUSN)

int	RemoveStale ()

void	Dump (void)
	Prints this device to the console in a human readable form. More...

QTextStream &	OutputXML (QTextStream &os, uint pnDevCount=nullptr, uint pnEntryCount=nullptr) const
	Outputs the XML for this device. More...

SSDPCacheEntries *	Find (const QString &sURI)
	Finds the SSDPCacheEntries in the cache, returns nullptr when absent. More...

DeviceLocation *	Find (const QString &sURI, const QString &sUSN)
	Finds the Device in the cache, returns nullptr when absent. More...

Public Member Functions inherited from MythObservable
	MythObservable ()

virtual	~MythObservable ()

void	addListener (QObject *listener)
	Add a listener to the observable. More...

void	removeListener (QObject *listener)
	Remove a listener to the observable. More...

void	dispatch (const MythEvent &event)
	Dispatch an event to all listeners. More...

bool	hasListeners (void)

Static Public Member Functions
static SSDPCache *	Instance ()

Protected Member Functions
void	NotifyAdd (const QString &sURI, const QString &sUSN, const QString &sLocation)

void	NotifyRemove (const QString &sURI, const QString &sUSN)

Protected Attributes
QMutex	m_mutex

SSDPCacheEntriesMap	m_cache

Protected Attributes inherited from MythObservable
QMutex *	m_lock {nullptr}

QSet< QObject * >	m_listeners

Private Member Functions
	SSDPCache ()

Private Attributes
QStringList	m_badUrlList

QStringList	m_goodUrlList

Static Private Attributes
static SSDPCache *	g_pSSDPCache = nullptr

Detailed Description

Definition at line 86 of file ssdpcache.h.

Constructor & Destructor Documentation

◆ SSDPCache()

SSDPCache::SSDPCache ( )

private

Definition at line 295 of file ssdpcache.cpp.

Referenced by Instance().

◆ ~SSDPCache()

SSDPCache::~SSDPCache ( )

override

Definition at line 312 of file ssdpcache.cpp.

Member Function Documentation

◆ Add()

void SSDPCache::Add	(	const QString &	sURI,
		const QString &	sUSN,
		const QString &	sLocation,
		std::chrono::seconds	sExpiresInSecs
	)

Definition at line 372 of file ssdpcache.cpp.

Referenced by ProcessNotify(), and ProcessSearchResponse().

◆ Begin()

SSDPCacheEntriesMap::Iterator SSDPCache::Begin ( void )

inline

Definition at line 125 of file ssdpcache.h.

◆ Clear()

void SSDPCache::Clear ( void )

Definition at line 326 of file ssdpcache.cpp.

Referenced by ~SSDPCache().

◆ Count()

int SSDPCache::Count ( void )

inline

Definition at line 128 of file ssdpcache.h.

◆ Dump()

void SSDPCache::Dump ( void )

Prints this device to the console in a human readable form.

Definition at line 625 of file ssdpcache.cpp.

Referenced by SSDPCacheTask::Execute().

◆ End()

SSDPCacheEntriesMap::Iterator SSDPCache::End ( void )

inline

Definition at line 126 of file ssdpcache.h.

◆ Find() [1/2]

SSDPCacheEntries * SSDPCache::Find ( const QString & sURI )

Finds the SSDPCacheEntries in the cache, returns nullptr when absent.

Note: Caller must call DecrRef on non-nullptr when done with it.

Definition at line 341 of file ssdpcache.cpp.

Referenced by BackendSelection::customEvent(), MythContext::Impl::DefaultUPnP(), SatIP::doUPNPsearch(), VBox::doUPNPSearch(), HttpStatus::FillStatusXML(), V2Status::FillStatusXML(), Find(), SatIP::findServers(), BackendSelection::Init(), and MythContext::Impl::UPnPautoconf().

◆ Find() [2/2]

DeviceLocation * SSDPCache::Find	(	const QString &	sURI,
		const QString &	sUSN
	)

Finds the Device in the cache, returns nullptr when absent.

Note: Caller must call DecrRef on non-nullptr when done with it.

Definition at line 354 of file ssdpcache.cpp.

◆ Instance()

SSDPCache * SSDPCache::Instance ( )

static

◆ Lock()

void SSDPCache::Lock ( void )

inline

Definition at line 122 of file ssdpcache.h.

Referenced by Remove(), and RemoveStale().

◆ NotifyAdd()

void SSDPCache::NotifyAdd	(	const QString &	sURI,
		const QString &	sUSN,
		const QString &	sLocation
	)

protected

Definition at line 558 of file ssdpcache.cpp.

Referenced by Add().

◆ NotifyRemove()

void SSDPCache::NotifyRemove	(	const QString &	sURI,
		const QString &	sUSN
	)

protected

Definition at line 577 of file ssdpcache.cpp.

Referenced by Remove().

◆ OutputXML()

QTextStream & SSDPCache::OutputXML	(	QTextStream &	os,
		uint *	pnDevCount = `nullptr`,
		uint *	pnEntryCount = `nullptr`
	)		const

Outputs the XML for this device.

Definition at line 590 of file ssdpcache.cpp.

Referenced by SSDPExtension::GetDeviceList().

◆ Remove()

void SSDPCache::Remove	(	const QString &	sURI,
		const QString &	sUSN
	)

Definition at line 457 of file ssdpcache.cpp.

Referenced by ProcessNotify().

◆ RemoveStale()

int SSDPCache::RemoveStale ( )

Definition at line 499 of file ssdpcache.cpp.

Referenced by SSDPCacheTask::Execute().

◆ Unlock()

void SSDPCache::Unlock ( void )

inline

Definition at line 123 of file ssdpcache.h.

Referenced by Remove(), and RemoveStale().

Member Data Documentation

◆ g_pSSDPCache

SSDPCache * SSDPCache::g_pSSDPCache = nullptr

staticprivate

Definition at line 93 of file ssdpcache.h.

Referenced by Instance().

◆ m_badUrlList

QStringList SSDPCache::m_badUrlList

private

Definition at line 94 of file ssdpcache.h.

Referenced by Add().

◆ m_cache

SSDPCacheEntriesMap SSDPCache::m_cache

protected

Definition at line 100 of file ssdpcache.h.

Referenced by Add(), Clear(), Dump(), Find(), OutputXML(), Remove(), and RemoveStale().

◆ m_goodUrlList

QStringList SSDPCache::m_goodUrlList

private

Definition at line 95 of file ssdpcache.h.

Referenced by Add().

◆ m_mutex

QMutex SSDPCache::m_mutex

mutableprotected

Definition at line 99 of file ssdpcache.h.

Referenced by Add(), Clear(), Dump(), Find(), and OutputXML().

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

mythtv/libs/libmythupnp/ssdpcache.h
mythtv/libs/libmythupnp/ssdpcache.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SSDPCache()

◆ ~SSDPCache()

Member Function Documentation

◆ Add()

◆ Begin()

◆ Clear()

◆ Count()

◆ Dump()

◆ End()

◆ Find() [1/2]

◆ Find() [2/2]

◆ Instance()

◆ Lock()

◆ NotifyAdd()

◆ NotifyRemove()

◆ OutputXML()

◆ Remove()

◆ RemoveStale()

◆ Unlock()

Member Data Documentation

◆ g_pSSDPCache

◆ m_badUrlList

◆ m_cache

◆ m_goodUrlList

◆ m_mutex