libhomegear-base  0.7
Base library for Homegear and Homegear family modules.
BaseLib::Ssdp Class Reference

#include <Ssdp.h>

Public Member Functions

 Ssdp (BaseLib::SharedObjects *baseLib)
 
virtual ~Ssdp ()
 
void searchDevices (const std::string &stHeader, uint32_t timeout, std::vector< SsdpInfo > &devices)
 Searches for SSDP devices and returns the IPv4 addresses. More...
 
void searchDevicesPassive (const std::string &stHeader, uint32_t timeout, std::vector< SsdpInfo > &devices, std::atomic_bool &abort)
 Searches for SSDP devices by listening for NOTIFY packets and returns the IPv4 addresses. More...
 

Constructor & Destructor Documentation

§ Ssdp()

BaseLib::Ssdp::Ssdp ( BaseLib::SharedObjects baseLib)

§ ~Ssdp()

BaseLib::Ssdp::~Ssdp ( )
virtual

Member Function Documentation

§ searchDevices()

void BaseLib::Ssdp::searchDevices ( const std::string &  stHeader,
uint32_t  timeout,
std::vector< SsdpInfo > &  devices 
)

Searches for SSDP devices and returns the IPv4 addresses.

Parameters
[in]stHeaderThe ST header with the URN to search for (e. g. urn:schemas-upnp-org:device:basic:1)
[in]timeoutThe time to wait for responses
[out]devicesThe found devices with device information parsed from XML to a Homegear variable struct.

§ searchDevicesPassive()

void BaseLib::Ssdp::searchDevicesPassive ( const std::string &  stHeader,
uint32_t  timeout,
std::vector< SsdpInfo > &  devices,
std::atomic_bool &  abort 
)

Searches for SSDP devices by listening for NOTIFY packets and returns the IPv4 addresses.

Parameters
[in]stHeaderThe ST header with the URN to search for (e. g. urn:schemas-upnp-org:device:basic:1)
[in]timeoutThe time to wait for responses
[out]devicesThe found devices with device information parsed from XML to a Homegear variable struct.
[in]abortWhen set to true during the search, the search is aborted.

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