TorcSSDP Class Reference

The public class for handling Simple Service Discovery Protocol searches and announcements. More...

#include <torcssdp.h>

Inheritance diagram for TorcSSDP:

Static Public Member Functions
static void	Search (TorcHTTPServer::Status Options)
	Search for Torc UPnP device type. More...
static void	CancelSearch (void)
	Stop searching for a UPnP device type. More...
static void	Announce (TorcHTTPServer::Status Options)
	Publish the device. More...
static void	CancelAnnounce (void)

Static Public Attributes
static TorcSSDP *	gSSDP = nullptr
static QMutex *	gSSDPLock = new QMutex(QMutex::Recursive)
static bool	gSearchEnabled = false
static TorcHTTPServer::Status	gSearchOptions = TorcHTTPServer::Status()
static bool	gAnnounceEnabled = false
static TorcHTTPServer::Status	gAnnounceOptions = TorcHTTPServer::Status()

Protected Slots
void	SearchPriv (void)
void	CancelSearchPriv (void)
void	AnnouncePriv (void)
void	CancelAnnouncePriv (void)
void	SendSearch (void)
void	SendAnnounce (bool IsIPv6, bool Alive)
bool	event (QEvent *Event) override
void	Read (void)
void	ProcessResponses (void)

Protected Member Functions
	TorcSSDP ()
	~TorcSSDP ()

Static Protected Member Functions
static TorcSSDP *	Create (bool Destroy=false)

Friends
class	TorcSSDPThread

Detailed Description

The public class for handling Simple Service Discovery Protocol searches and announcements.

All SSDP interaction is via the static methods Search, CancelSearch, Announce and CancelAnnounce

Definition at line 45 of file torcssdp.h.

Constructor & Destructor Documentation

TorcSSDP::TorcSSDP ( )

protected

Definition at line 63 of file torcssdp.cpp.

TorcSSDP::~TorcSSDP ( )

protected

Definition at line 109 of file torcssdp.cpp.

Member Function Documentation

void TorcSSDP::Announce ( TorcHTTPServer::Status  Options )

static

Publish the device.

Definition at line 294 of file torcssdp.cpp.

void TorcSSDP::AnnouncePriv ( void  )

protectedslot

Definition at line 439 of file torcssdp.cpp.

void TorcSSDP::CancelAnnounce ( void  )

static

Definition at line 305 of file torcssdp.cpp.

void TorcSSDP::CancelAnnouncePriv ( void  )

protectedslot

Definition at line 446 of file torcssdp.cpp.

void TorcSSDP::CancelSearch ( void  )

static

Stop searching for a UPnP device type.

Notifications about new or removed UPnP devices will no longer be sent.

Definition at line 283 of file torcssdp.cpp.

void TorcSSDP::CancelSearchPriv ( void  )

protectedslot

Definition at line 434 of file torcssdp.cpp.

TorcSSDP * TorcSSDP::Create ( bool  Destroy = false )

staticprotected

Definition at line 314 of file torcssdp.cpp.

bool TorcSSDP::event ( QEvent *  Event )

overrideprotectedslot

Definition at line 566 of file torcssdp.cpp.

void TorcSSDP::ProcessResponses ( void  )

protectedslot

Definition at line 760 of file torcssdp.cpp.

void TorcSSDP::Read ( void  )

protectedslot

Definition at line 634 of file torcssdp.cpp.

void TorcSSDP::Search ( TorcHTTPServer::Status  Options )

static

Search for Torc UPnP device type.

See also

TorcSSDDP::CancelSearch

Definition at line 269 of file torcssdp.cpp.

void TorcSSDP::SearchPriv ( void  )

protectedslot

Definition at line 427 of file torcssdp.cpp.

void TorcSSDP::SendAnnounce ( bool  IsIPv6, bool  Alive  )

protectedslot

Definition at line 502 of file torcssdp.cpp.

void TorcSSDP::SendSearch ( void  )

protectedslot

Definition at line 380 of file torcssdp.cpp.

Friends And Related Function Documentation

friend class TorcSSDPThread

friend

Definition at line 47 of file torcssdp.h.

Member Data Documentation

bool TorcSSDP::gAnnounceEnabled = false

static

Definition at line 61 of file torcssdp.h.

TorcHTTPServer::Status TorcSSDP::gAnnounceOptions = TorcHTTPServer::Status()

static

Definition at line 62 of file torcssdp.h.

bool TorcSSDP::gSearchEnabled = false

static

Definition at line 59 of file torcssdp.h.

TorcHTTPServer::Status TorcSSDP::gSearchOptions = TorcHTTPServer::Status()

static

Definition at line 60 of file torcssdp.h.

TorcSSDP * TorcSSDP::gSSDP = nullptr

static

Definition at line 57 of file torcssdp.h.

QMutex * TorcSSDP::gSSDPLock = new QMutex(QMutex::Recursive)

static

Definition at line 58 of file torcssdp.h.

---

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

• torcssdp.h
• torcssdp.cpp