class UpnpSatelliteBoxTA

Provide the method to Get/Set target Value/State and forward updates and received events to ITAListener.

Public Methods

UpnpSatelliteBoxTA(ITAListener* taListener)

Constructor Provides reference of the UpnpSatelliteBoxTAFacade to local variable.

map<string, list<string>*> * setValuesRequest(string sessionId, list<string>* paths, list<string>* operations, list<string>* reqValues)

Set the State/Value of the IUISocketElements specified by 'paths'.

map<string, string> * getValues(string sessionId, list<string>* paths)

Return a value/state of the IUISocketElements specified by 'paths'.

string getSocketName(string sessionId)

Get the Socket Name with whom the Session specified by 'sessionId' is existing.

bool addSession(string sessionId, Session* session)

Maintain the sessions by putting its respective entry in the Map sessionIdSessionMap.

string subscribeService(map<string, void*>* targetProps)

subscribe to the service for device

void updateValues(list<string>* paths, list<string>* operations, list<string>* values, list<bool>* hasDynRes)

It is called from UpnpControlPoint when event is received for the subscribed service.

void sessionClosed(string sessionId)

Close the existing session specified by 'sessionId'

Documentation

Provide the method to Get/Set target Value/State and forward updates and received events to ITAListener. Also maintain state of different Session and its IUISocketElements.

UpnpSatelliteBoxTA(ITAListener* taListener)

Constructor Provides reference of the UpnpSatelliteBoxTAFacade to local variable.

Parameters:

upnpSatelliteBoxTAFacade - an Object of UpnpSatelliteBoxTAFacade

map<string, list<string>*> * setValuesRequest(string sessionId, list<string>* paths, list<string>* operations, list<string>* reqValues)

Set the State/Value of the IUISocketElements specified by 'paths'. Also reflect the same changes to the SatelliteBox Device specified by 'sessionId'.

Parameters:

sessionId - a String value of sessionId
isValidated - a boolean value of isValidated
paths - List&lt;String&gt; of paths
operations - List&lt;String&gt; of operations
reqValues - List&lt;String&gt; of reqValues

Returns:

a Map&lt;String, List&lt;String&gt;&gt; of values @throws TAFatalException

map<string, string> * getValues(string sessionId, list<string>* paths)

Return a value/state of the IUISocketElements specified by 'paths'.

Parameters:

sessionId - a String value of sessionId
paths - a List&lt;String&gt; of paths

Returns:

Map&lt;String, String&gt; of values @throws TAFatalException

string getSocketName(string sessionId)

Get the Socket Name with whom the Session specified by 'sessionId' is existing.

Parameters:

sessionId - a String value of sessionId

Returns:

a String of socketName

bool addSession(string sessionId, Session* session)

Maintain the sessions by putting its respective entry in the Map sessionIdSessionMap.

Parameters:

sessionId - a String value of sessionId
session - an Object of Session

Returns:

whether session is added or not

string subscribeService(map<string, void*>* targetProps)

subscribe to the service for device

Parameters:

device - properties as map<string,void*>

Returns:

string as subscription Id

void updateValues(list<string>* paths, list<string>* operations, list<string>* values, list<bool>* hasDynRes)

It is called from UpnpControlPoint when event is received for the subscribed service. It invokes updateValues() of ITAListener.

Parameters:

list - <string> paths
list - <string> operations
list - <string> values
list - <string> hasDynRes

void sessionClosed(string sessionId)

Close the existing session specified by 'sessionId'

Parameters:

sessionId - a String value of sessionId

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