UPnP::ServiceSearch Struct Reference

#include <Search.h>

Inheritance diagram for UPnP::ServiceSearch:
Collaboration diagram for UPnP::ServiceSearch:

Public Types

using Callback = Delegate< bool(DeviceControl &device, ServiceControl &service)>
 Callback invoked when service has been located. More...
 
- Public Types inherited from UPnP::Search
enum class  Kind {
  none , ssdp , desc , device ,
  service
}
 

Public Member Functions

 ServiceSearch (const ObjectClass &cls, Callback callback)
 
 operator bool () const override
 
- Public Member Functions inherited from UPnP::Search
 Search ()=default
 
 Search (const Search &)=delete
 
 Search (Kind kind, const String &urn)
 
 Search (Kind kind, const Urn &urn)
 
virtual ~Search ()
 
String toString (Search::Kind kind) const
 
String toString () const
 

Public Attributes

const ObjectClasscls
 
Callback callback
 
- Public Attributes inherited from UPnP::Search
Kind kind
 
String urn
 

Member Typedef Documentation

◆ Callback

Callback invoked when service has been located.

Parameters
deviceA newly constructed instance matching the search criteria
serviceRequested service interface
Return values
boolReturn true to keep the device, false to destroy it
Note
If callback sends out action requests then must return true

Constructor & Destructor Documentation

◆ ServiceSearch()

UPnP::ServiceSearch::ServiceSearch ( const ObjectClass cls,
Callback  callback 
)
inline

Member Function Documentation

◆ operator bool()

UPnP::ServiceSearch::operator bool ( ) const
inlineexplicitoverridevirtual

Implements UPnP::Search.

Member Data Documentation

◆ callback

Callback UPnP::ServiceSearch::callback

◆ cls

const ObjectClass& UPnP::ServiceSearch::cls

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