libupnpp 0.16.0
A C++ wrapper for the Portable UPnP reference library
Public Member Functions | Static Public Member Functions | List of all members
UPnPClient::ConnectionManager Class Reference
Inheritance diagram for UPnPClient::ConnectionManager:
UPnPClient::TypedService UPnPClient::Service

Public Member Functions

 ConnectionManager (const std::string &tp)
 
int getProtocolInfo (std::vector< UPnPP::ProtocolinfoEntry > &sourceEntries, std::vector< UPnPP::ProtocolinfoEntry > &sinkEntries)
 
bool serviceTypeMatch (const std::string &tp) override
 Perform a comparison to the service type string for this specific service.
 
- Public Member Functions inherited from UPnPClient::TypedService
 TypedService (const std::string &tp)
 Build an empty object.
 
bool serviceTypeMatch (const std::string &tp) override
 Check if the input matches our service type.
 
virtual int runAction (const std::string &name, std::vector< std::string > args, std::map< std::string, std::string > &retdata)
 Run an action specified by name, with specified input return output.
 
- Public Member Functions inherited from UPnPClient::Service
 Service (const UPnPDeviceDesc &device, const UPnPServiceDesc &service)
 Construct by copying data from device and service objects.
 
 Service ()
 Empty object.
 
 Service (const Service &)=delete
 
Serviceoperator= (const Service &)=delete
 
bool initFromDescription (const UPnPDeviceDesc &description)
 Initialize empty object from device description.
 
bool ok ()
 Check that initialization went well.
 
virtual bool reSubscribe ()
 Restart the subscription to get all the State variable values, in case we get the events before we are ready (e.g.
 
const std::string & getFriendlyName () const
 Accessors for the values extracted from the device description during initialization.
 
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
 
int runTrivialAction (const std::string &actionName, ActionOptions *opts=nullptr)
 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, ActionOptions *opts=nullptr)
 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, ActionOptions *opts=nullptr)
 Run action with a single input parameter and no return data.
 
virtual VarEventReportergetReporter ()
 Get pointer to installed event reporter.
 
virtual void installReporter (VarEventReporter *reporter)
 Install or uninstall event data reporter object.
 

Static Public Member Functions

static bool isConManService (const std::string &st)
 

Additional Inherited Members

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

Member Function Documentation

◆ serviceTypeMatch()

bool UPnPClient::ConnectionManager::serviceTypeMatch ( const std::string &  tp)
overridevirtual

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: