class IUpnpControlPoint

Provide the method to forward device status to TDMs Provide the method to forward updates and received events to IUpdateListener.

Inheritance:

Public Methods

virtual void startDiscovery()

start Discovery for all available UPnP devices in network

virtual void stopDiscovery()

stops Discovery for UPnP devices in network

virtual void addUpdateListener(IUpdateListener*listener)

Add IUpdateListener to updateListener list

virtual void addCPListener(IUpnpControlPointListener*listener)

add IUpnpControlPointListener to controlPointListener list

virtual void removeUpdateListener(IUpdateListener*listener)

removes IUpdateListener to updateListener list

virtual void removeCPListener(IUpnpControlPointListener*listener)

add IUpnpControlPointListener to controlPointListener list

virtual string subscribeToEvent(string UDN, string service)

subscribe to the service specified in eventURL string

virtual bool unsubscribeToEvent(string SID)

unsubscribe to the service specified in eventURL string

virtual string doAction(string service, map<string, string>*paramMap, string UDN, bool makeAction, string action)

Performs the UPnP Action

virtual void* getDeviceProperty(string UDN, string prop)

Return the value of given property in paramter for particular device.

virtual void setRelaxParserState(bool relaxParser)

Set the state of UTF-8 encoding relaxParserIf true then non UTF-8 characters are replaced by '?' else parsing fails.

virtual bool checkForService(string UDN, string service)

Check for service for given device

virtual IXML_Document* doAction(string service, string UDN, string action, bool makeAction, map<string, string>*paramMap)

Performs the UPnP Action

Documentation

Provide the method to forward device status to TDMs Provide the method to forward updates and received events to IUpdateListener.

virtual void startDiscovery()

start Discovery for all available UPnP devices in network

virtual void stopDiscovery()

stops Discovery for UPnP devices in network

virtual void addUpdateListener(IUpdateListener*listener)

Add IUpdateListener to updateListener list

Parameters:

listener - as IUpdateListener Object

virtual void addCPListener(IUpnpControlPointListener*listener)

add IUpnpControlPointListener to controlPointListener list

Parameters:

listener - as IUpnpControlPointListener Object

virtual void removeUpdateListener(IUpdateListener*listener)

removes IUpdateListener to updateListener list

Parameters:

listener - as IUpdateListener Object

virtual void removeCPListener(IUpnpControlPointListener*listener)

add IUpnpControlPointListener to controlPointListener list

Parameters:

listener - as IUpnpControlPointListener Object

virtual string subscribeToEvent(string UDN, string service)

subscribe to the service specified in eventURL string

Parameters:

UDN - String Value media Renderer UDN
service - String Value of service

Returns:

String Value of subscription Id

virtual bool unsubscribeToEvent(string SID)

unsubscribe to the service specified in eventURL string

Parameters:

SID - String Value of SID

Returns:

as true if successfull otherwise false

virtual string doAction(string service, map<string, string>*paramMap, string UDN, bool makeAction, string action)

Performs the UPnP Action

Parameters:

service - as String Value of service
paramMap - as map<string,string> which includes the UPnP specified action name and it's corresponding value
UDN - String Value media Renderer UDN
makeAction - as bool specifies whether whether to make action or add action
action - as String specifying the action name

Returns:

string response from UPnP device

virtual void* getDeviceProperty(string UDN, string prop)

Return the value of given property in paramter for particular device.

Parameters:

UDN - string UDN of device
prop - property name, which value is required to be obtained.

Returns:

object string object for parameter 'location' and map object for 'controlURLs' and 'eventURLs' parameter

virtual void setRelaxParserState(bool relaxParser)

Set the state of UTF-8 encoding relaxParserIf true then non UTF-8 characters are replaced by '?' else parsing fails.

Parameters:

relaxParser - boolean value of relaxParser

virtual bool checkForService(string UDN, string service)

Check for service for given device

Parameters:

UDN - String UDN of media renderer device
service - String service to be checked

Returns:

true if device has given service else false

virtual IXML_Document* doAction(string service, string UDN, string action, bool makeAction, map<string, string>*paramMap)

Performs the UPnP Action

Parameters:

service - as String Value of service
UDN - String Value of media renderer UDN
action - as String specifying the action name
makeAction - as bool specifies whether whether to make action or add action
paramMap - as map<string,string> which includes the UPnP specified action name and it's corresponding value

Returns:

a IXML_Document Object containing the response

Direct child classes:

UpnpControlPoint

Author:

Parikshit Thakur & Team, Trace R&D Center

Version:

Revision: 1.0

Alphabetic index HTML hierarchy of classes or Java