class UpnpControlPoint

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

Inheritance:

Public Fields

static bool includeDeviceInList

Stop including devices in list

Public Methods

UpnpControlPoint()

Basic Constructor for UpnpControlPoint

void addUpdateListener(IUpdateListener*updateListener)

add IUpdateListener to updateListener list

void addCPListener(IUpnpControlPointListener*cpListener)

add IUpnpControlPointListener to controlPointListener list

void removeUpdateListener(IUpdateListener*listener)

removes IUpdateListener from updateListener list

void removeCPListener(IUpnpControlPointListener*listener)

remove IUpnpControlPointListener from controlPointListener list

string subscribeToEvent(string UDN, string service)

subscribe to the service specified in service string

bool unsubscribeToEvent(string SID)

unsubscribe to the service specified in eventURL string

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

Performs the UPnP Action

void startDiscovery()

Update the TDMs with new UPnP device discovered in network

void stopDiscovery()

Update the TDMs for UPnP device non-availability in network

void setRelaxParserState(bool relaxParser)

Set the relax parser for UTF-8 encoding

static void targetDiscarded(string UDN)

Informs all listener targetDiscarded

bool checkForService(string UDN, string service)

Check for service for given device

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

Performs the UPnP Action

Inherited from IUpnpControlPoint:

Public Methods

virtual void* getDeviceProperty(string UDN, string prop)

Documentation

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

UpnpControlPoint()

Basic Constructor for UpnpControlPoint

void addUpdateListener(IUpdateListener*updateListener)

add IUpdateListener to updateListener list

Parameters:

updateListener - as IUpdateListener Object

void addCPListener(IUpnpControlPointListener*cpListener)

add IUpnpControlPointListener to controlPointListener list

Parameters:

cpListener - as IUpnpControlPointListener Object

void removeUpdateListener(IUpdateListener*listener)

removes IUpdateListener from updateListener list

Parameters:

listener - as IUpdateListener Object

void removeCPListener(IUpnpControlPointListener*listener)

remove IUpnpControlPointListener from controlPointListener list

Parameters:

listener - as IUpnpControlPointListener Object

string subscribeToEvent(string UDN, string service)

subscribe to the service specified in service string

Parameters:

UDN - String Value of media renderer UDN
service - String Value of service

bool unsubscribeToEvent(string SID)

unsubscribe to the service specified in eventURL string

Parameters:

SID - String Value of subscription id

Returns:

as true if successfull otherwise false

string doAction(string service, map<string, string>*paramMap, string controlURL, 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 of 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

void startDiscovery()

Update the TDMs with new UPnP device discovered in network

Parameters:

targetProps - specifying device properties

void stopDiscovery()

Update the TDMs for UPnP device non-availability in network

Parameters:

deviceId - as String

void setRelaxParserState(bool relaxParser)

Set the relax parser for UTF-8 encoding

Parameters:

relaxParser - bool , if true will replace non UTF-8 to '?' else declare fails for parsing

static bool includeDeviceInList

Stop including devices in list

static void targetDiscarded(string UDN)

Informs all listener targetDiscarded

Parameters:

UDN - String as UDN of device

bool checkForService(string UDN, string service)

Check for service for given device

Parameters:

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

Returns:

true if device has given service else false

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

This class has no child classes.

Author:

Parikshit Thakur & Team, Trace R&D Center

Version:

Revision: 1.0

Alphabetic index HTML hierarchy of classes or Java