UPnP::Search Struct Referenceabstract

This is a helper class used by ControlPoint to manage different search types. More...

#include <Search.h>

Inheritance diagram for UPnP::Search:
Collaboration diagram for UPnP::Search:

Public Types

enum class  Kind {
  none , ssdp , desc , device ,
  service
}
 

Public Member Functions

 Search ()=default
 
 Search (const Search &)=delete
 
 Search (Kind kind, const String &urn)
 
 Search (Kind kind, const Urn &urn)
 
virtual ~Search ()
 
virtual operator bool () const =0
 
String toString (Search::Kind kind) const
 
String toString () const
 

Public Attributes

Kind kind
 
String urn
 

Detailed Description

This is a helper class used by ControlPoint to manage different search types.

Member Enumeration Documentation

◆ Kind

enum UPnP::Search::Kind
strong
Enumerator
none 

No search active.

ssdp 

SSDP response.

desc 

Fetch description for any matching urn.

device 

Searching for pre-defined device class.

service 

Searching for pre-defined service class.

Constructor & Destructor Documentation

◆ Search() [1/4]

UPnP::Search::Search ( )
default

◆ Search() [2/4]

UPnP::Search::Search ( const Search )
delete

◆ Search() [3/4]

UPnP::Search::Search ( Kind  kind,
const String urn 
)
inline

◆ Search() [4/4]

UPnP::Search::Search ( Kind  kind,
const Urn urn 
)
inline

◆ ~Search()

virtual UPnP::Search::~Search ( )
inlinevirtual

Member Function Documentation

◆ operator bool()

virtual UPnP::Search::operator bool ( ) const
explicitpure virtual

◆ toString() [1/2]

String UPnP::Search::toString ( ) const
inline

◆ toString() [2/2]

String UPnP::Search::toString ( Search::Kind  kind) const
inline

Member Data Documentation

◆ kind

Kind UPnP::Search::kind

◆ urn

String UPnP::Search::urn

The documentation for this struct was generated from the following file: