RDK Documentation (Open Sourced RDK Components)
x_rdk_req_handler.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 2022 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 x_rdk_req_handler.h
22  * @brief The header file provides Device.X_RDK_<Parameter> client request handler information APIs.
23  */
24 
25 /**
26  * @defgroup x_rdk_req_handler Client RequestHandler Public Classes
27  * Describe the details about classes used in Device.X_RDK_ request handler.
28  * @ingroup x_rdk_req_handler
29  */
30 
31 /**
32  * @file x_rdk_req_handler.h
33  *
34  * @brief host Interface for Device.X_RDK_<Parameter> Client Request Handler.
35  *
36  * This API defines the request handler operations for the Device.X_RDK_<Parameter> Client
37  *
38  * @author
39  *
40  */
41 
42 /**
43  * x_rdk_req_handler stack client applications to communicate by sending Get and Set operation
44  *
45  */
46 
47 
48 #ifndef X_RDK_REQ_HANDLER_H_
49 #define X_RDK_REQ_HANDLER_H_
50 
51 #include "hostIf_msgHandler.h"
52 #include "hostIf_updateHandler.h"
53 #include "x_rdk_profile.h"
54 
55 /**
56  * @brief This class provides the interface for getting Device.X_RDK_<Parameter> client request handler information.
57  * @ingroup Device.X_RDK_ CLIENT_REQHANDLER_CLASSES
58  */
59 class X_rdk_req_hdlr : public msgHandler
60 {
61  X_rdk_req_hdlr() {};
62  ~X_rdk_req_hdlr() {};
63 
64  static std::mutex m;
65  static class X_rdk_req_hdlr *pInstance;
66 
67 public:
68  virtual bool init();
69  virtual bool unInit();
70  virtual int handleSetMsg(HOSTIF_MsgData_t *stMsgData);
71  virtual int handleGetMsg(HOSTIF_MsgData_t *stMsgData);
72  virtual int handleGetAttributesMsg(HOSTIF_MsgData_t *stMsgData);
73  virtual int handleSetAttributesMsg(HOSTIF_MsgData_t *stMsgData);
74  static msgHandler* getInstance();
75 };
76 
77 #endif /* X_RDK_REQ_HANDLER_H_ */
78 /* End of X_RDK_REQ_HANDLER_H_ doxygen group */
79 /**
80  * @}
81  */
X_rdk_req_hdlr::handleGetMsg
virtual int handleGetMsg(HOSTIF_MsgData_t *stMsgData)
This function is used to handle the get message request of InterfaceStack Client. Gets the total numb...
Definition: x_rdk_req_handler.cpp:121
X_rdk_req_hdlr::unInit
virtual bool unInit()
This function is used to close all the instances of interface stack.
Definition: x_rdk_req_handler.cpp:70
X_rdk_req_hdlr::init
virtual bool init()
This function is used to initialize. Currently not implemented.
Definition: x_rdk_req_handler.cpp:56
x_rdk_profile.h
The header file provides components Xrdk SDCard information APIs.
_HostIf_MsgData_t
Definition: hostIf_tr69ReqHandler.h:170
X_rdk_req_hdlr::handleSetMsg
virtual int handleSetMsg(HOSTIF_MsgData_t *stMsgData)
This function is used to handle the set message request of InterfaceStack Client. Currently not imple...
Definition: x_rdk_req_handler.cpp:88
X_rdk_req_hdlr
This class provides the interface for getting Device.X_RDK_<Parameter> client request handler informa...
Definition: x_rdk_req_handler.h:59
msgHandler
Definition: hostIf_msgHandler.h:103
hostIf_msgHandler.h
The header file provides HostIf message handler information APIs.