RDK Documentation (Open Sourced RDK Components)
DS Client RequestHandler Public Classes

Description

Describe the details about classes used in TR-069 dsClient request handler.

Data Structures

class  DSClientReqHandler
 This class provides device setting Client ReqHandler Interface operations for STBService defined under Host If. More...
 

Functions

virtual bool DSClientReqHandler::init ()
 This function is used to initialize the device manager. More...
 
virtual bool DSClientReqHandler::unInit ()
 This function is used to close all the instances of STB services such as HDMI, VideoOutput, VideoDecoder, AudioInterface and SPDIF. It also deinitialize the device manager. More...
 
virtual int DSClientReqHandler::handleSetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to handle the set message request of DsClient i.c STBService such as "HDMI", "VideoDecoder", "AudioOutput" and "SPDIF". More...
 
virtual int DSClientReqHandler::handleGetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to handle the get message request of DsClient i.e STBServices components and the total number of active entries of "VideoDecode", "AudioOutput", "VideoOutput", "HDMI", "SPDIF". More...
 

Data Structure Documentation

◆ DSClientReqHandler

class DSClientReqHandler

This class provides device setting Client ReqHandler Interface operations for STBService defined under Host If.

Definition at line 55 of file hostIf_dsClient_ReqHandler.h.

Inheritance diagram for DSClientReqHandler:
Inheritance graph
Collaboration diagram for DSClientReqHandler:
Collaboration graph

Public Member Functions

virtual bool init ()
 This function is used to initialize the device manager. More...
 
virtual bool unInit ()
 This function is used to close all the instances of STB services such as HDMI, VideoOutput, VideoDecoder, AudioInterface and SPDIF. It also deinitialize the device manager. More...
 
virtual int handleSetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to handle the set message request of DsClient i.c STBService such as "HDMI", "VideoDecoder", "AudioOutput" and "SPDIF". More...
 
virtual int handleGetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to handle the get message request of DsClient i.e STBServices components and the total number of active entries of "VideoDecode", "AudioOutput", "VideoOutput", "HDMI", "SPDIF". More...
 
virtual int handleGetAttributesMsg (HOSTIF_MsgData_t *stMsgData)
 
virtual int handleSetAttributesMsg (HOSTIF_MsgData_t *stMsgData)
 

Static Public Member Functions

static msgHandlergetInstance ()
 
static void registerUpdateCallback (updateCallback cb)
 
static void checkForUpdates ()
 

Static Private Attributes

static class DSClientReqHandlerpInstance = NULL
 
static updateCallback mUpdateCallback = NULL
 
static int curNumOfDevices [10]
 

Function Documentation

◆ init()

bool DSClientReqHandler::init ( )
virtual

This function is used to initialize the device manager.

Returns
Returns the status of the operation.
Return values
trueif initialization is successful.
falseif initialization is not successful.

Implements msgHandler.

Definition at line 81 of file hostIf_dsClient_ReqHandler.cpp.

◆ unInit()

bool DSClientReqHandler::unInit ( )
virtual

This function is used to close all the instances of STB services such as HDMI, VideoOutput, VideoDecoder, AudioInterface and SPDIF. It also deinitialize the device manager.

Returns
Returns the status of the operation.
Return values
trueif it successfully close all the instances.
falseif not able to close all the instances.

Implements msgHandler.

Definition at line 108 of file hostIf_dsClient_ReqHandler.cpp.

◆ handleSetMsg()

int DSClientReqHandler::handleSetMsg ( HOSTIF_MsgData_t stMsgData)
virtual

This function is used to handle the set message request of DsClient i.c STBService such as "HDMI", "VideoDecoder", "AudioOutput" and "SPDIF".

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns the status of the operation.
Return values
OKif successful.
ERR_INTERNAL_ERRORif not able to set the data to the device.

Implements msgHandler.

Definition at line 134 of file hostIf_dsClient_ReqHandler.cpp.

◆ handleGetMsg()

int DSClientReqHandler::handleGetMsg ( HOSTIF_MsgData_t stMsgData)
virtual

This function is used to handle the get message request of DsClient i.e STBServices components and the total number of active entries of "VideoDecode", "AudioOutput", "VideoOutput", "HDMI", "SPDIF".

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns the status of the operation.
Return values
OKif it is gets the data successfully.
ERR_INTERNAL_ERRORif not able to get the data from the device.

Implements msgHandler.

Definition at line 214 of file hostIf_dsClient_ReqHandler.cpp.