libupnpp  0.16.0
A C++ wrapper for the Portable UPnP reference library
Classes | Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
UPnPClient::OHProduct Class Reference

OHProduct Service client class. More...

#include <ohproduct.hxx>

Inheritance diagram for UPnPClient::OHProduct:
UPnPClient::Service

Classes

struct  Source
 

Public Member Functions

 OHProduct (const UPnPDeviceDesc &device, const UPnPServiceDesc &service)
 
virtual bool serviceTypeMatch (const std::string &tp)
 Perform a comparison to the service type string for this specific service. More...
 
int getSources (std::vector< Source > &sources)
 
int sourceIndex (int *index)
 
int setSourceIndex (int index)
 
int setSourceIndexByName (const std::string &name)
 
int standby (bool *value)
 
int setStanby (bool value)
 
- Public Member Functions inherited from UPnPClient::Service
 Service (const UPnPDeviceDesc &device, const UPnPServiceDesc &service)
 Construct by copying data from device and service objects. More...
 
 Service ()
 Empty object. More...
 
bool initFromDescription (const UPnPDeviceDesc &description)
 Initialize empty object from device description. More...
 
virtual void reSubscribe ()
 
const std::string & getFriendlyName () const
 
const std::string & getDeviceId () const
 
const std::string & getServiceType () const
 
const std::string & getActionURL () const
 
const std::string & getModelName () const
 
const std::string & getManufacturer () const
 
virtual int runAction (const UPnPP::SoapOutgoing &args, UPnPP::SoapIncoming &data)
 Call Soap action and return resulting data. More...
 
int runTrivialAction (const std::string &actionName)
 Run trivial action where there are neither input parameters nor return data (beyond the status)
 
template<class T >
int runSimpleGet (const std::string &actnm, const std::string &valnm, T *valuep)
 Run action where there are no input parameters and a single named value is to be retrieved from the result.
 
template<class T >
int runSimpleAction (const std::string &actnm, const std::string &valnm, T value)
 Run action with a single input parameter and no return data.
 
virtual VarEventReportergetReporter ()
 Get pointer to installed event reporter. More...
 
virtual void installReporter (VarEventReporter *reporter)
 Install event data reporter object.
 

Static Public Member Functions

static bool isOHPrService (const std::string &st)
 Test service type from discovery message.
 

Static Protected Attributes

static const std::string SType
 

Additional Inherited Members

- Protected Member Functions inherited from UPnPClient::Service
virtual bool serviceInit (const UPnPDeviceDesc &device, const UPnPServiceDesc &service)
 Service-specific part of initialization. More...
 
void registerCallback (evtCBFunc c)
 Used by a derived class to register its callback method. More...
 
void unregisterCallback ()
 Cancel subscription to the service events, forget installed callback.
 

Detailed Description

OHProduct Service client class.

Member Function Documentation

◆ getSources()

int UPnPClient::OHProduct::getSources ( std::vector< Source > &  sources)
Returns
0 for success, upnp error else

◆ serviceTypeMatch()

bool UPnPClient::OHProduct::serviceTypeMatch ( const std::string &  tp)
virtual

Perform a comparison to the service type string for this specific service.

This allows embedding knowledge of the service type string inside the derived class. It is used, e.g., by initFromDescription() to look up an appropriate entry from the device description service list. Can also be used by external code wishing to do the same.

Parameters
tpService type string to be compared with the one for the derived class.

Implements UPnPClient::Service.


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