RDK Documentation (Open Sourced RDK Components)
hostIf_dsClient_ReqHandler.h
Go to the documentation of this file.
1 /*
2  * If not stated otherwise in this file or this component's Licenses.txt file the
3  * following copyright and licenses apply:
4  *
5  * Copyright 2016 RDK Management
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18 */
19 
20 /**
21  * @file hostIf_dsClient_ReqHandler.h
22  * @brief The header file provides HostIf ds client request handler information APIs.
23  */
24 
25 /**
26  * @defgroup TR-069HOSTIF_DSCLIENT_REQHANDLER_CLASSES DS Client RequestHandler Public Classes
27  * Describe the details about classes used in TR-069 dsClient request handler.
28  * @ingroup TR-069HOSTIF_DEVICECLIENT_HANDLER
29  */
30 
31 /**
32  * dsClient -interface is a platform agnostic IARM communication interface. It allows
33  * ds client applications to communicate by sending Get and Set operation
34  *
35  */
36 
37 /**
38 * @defgroup tr69hostif
39 * @{
40 * @defgroup hostif
41 * @{
42 **/
43 
44 
45 #ifndef HOSTIF_DSCLIENT_REQHANDLER_H_
46 #define HOSTIF_DSCLIENT_REQHANDLER_H_
47 
48 #include "hostIf_msgHandler.h"
49 #include "hostIf_updateHandler.h"
50 
51 /**
52  * @brief This class provides device setting Client ReqHandler Interface operations for STBService defined under Host If
53  * @ingroup TR-069HOSTIF_DSCLIENT_REQHANDLER_CLASSES
54  */
56 {
57  DSClientReqHandler() {};
58  ~DSClientReqHandler() {};
59  static class DSClientReqHandler *pInstance;
60  static updateCallback mUpdateCallback;
61 
62  static int curNumOfDevices[10];
63 
64 public:
65  virtual bool init();
66  virtual bool unInit();
67  virtual int handleSetMsg(HOSTIF_MsgData_t *stMsgData);
68  virtual int handleGetMsg(HOSTIF_MsgData_t *stMsgData);
69  virtual int handleGetAttributesMsg(HOSTIF_MsgData_t *stMsgData);
70  virtual int handleSetAttributesMsg(HOSTIF_MsgData_t *stMsgData);
71  static msgHandler* getInstance();
72  static void registerUpdateCallback(updateCallback cb);
73  static void checkForUpdates();
74 
75 };
76 
77 #endif /* HOSTIF_DSCLIENT_REQHANDLER_H_ */
78 /* End of HOSTIF_DSCLIENT_REQHANDLER_H_ doxygen group */
79 /**
80  * @}
81  */
82 
83 
84 /** @} */
85 /** @} */
DSClientReqHandler::handleSetMsg
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",...
Definition: hostIf_dsClient_ReqHandler.cpp:134
_HostIf_MsgData_t
Definition: hostIf_tr69ReqHandler.h:170
DSClientReqHandler::init
virtual bool init()
This function is used to initialize the device manager.
Definition: hostIf_dsClient_ReqHandler.cpp:81
DSClientReqHandler
This class provides device setting Client ReqHandler Interface operations for STBService defined unde...
Definition: hostIf_dsClient_ReqHandler.h:55
DSClientReqHandler::handleGetMsg
virtual int handleGetMsg(HOSTIF_MsgData_t *stMsgData)
This function is used to handle the get message request of DsClient i.e STBServices components and th...
Definition: hostIf_dsClient_ReqHandler.cpp:214
msgHandler
Definition: hostIf_msgHandler.h:103
DSClientReqHandler::unInit
virtual bool unInit()
This function is used to close all the instances of STB services such as HDMI, VideoOutput,...
Definition: hostIf_dsClient_ReqHandler.cpp:108
hostIf_msgHandler.h
The header file provides HostIf message handler information APIs.