RDK Documentation (Open Sourced RDK Components)
hostIf_XREClient_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  * @file hostIf_XREClient_ReqHandler.h
21  * @brief The header file provides HostIf XRE Client request handler information APIs.
22  */
23 
24 /**
25  * @defgroup TR-069HOSTIF_XRECLIENT_REQHANDLER_CLASSES XREClient RequestHandler Public Classes
26  * Describe the details about classes used in TR-069 XREClient request handler.
27  * @ingroup TR-069HOSTIF_DEVICECLIENT_HANDLER
28  */
29 
30 /**
31 * HOST-IF is a platform agnostic Inter-process communication (IPC) interface. It allows
32 * applications to communicate with each other by sending Events or invoking Remote
33 * Procedure Calls. The common programming APIs offered by the RDK IARM-Bus interface is
34 * independent of the operating system or the underlying IPC mechanism.
35 *
36 */
37 
38 
39 /**
40 * @defgroup tr69hostif
41 * @{
42 * @defgroup hostif
43 * @{
44 **/
45 
46 
47 #ifndef HOSTIF_XRECLIENT_REQHANDLER_H_
48 #define HOSTIF_XRECLIENT_REQHANDLER_H_
49 
50 #include "hostIf_msgHandler.h"
51 #include "hostIf_updateHandler.h"
52 #include "hostIf_main.h"
53 
54 /**
55  * @brief This class provides the interface for getting XRE request handler information.
56  * @ingroup TR-069HOSTIF_XRECLIENT_REQHANDLER_CLASSES
57  */
58 class XREClientReqHandler : public msgHandler
59 {
60  XREClientReqHandler() {};
61  ~XREClientReqHandler() {};
62  static class XREClientReqHandler *pInstance;
63  static updateCallback mUpdateCallback;
64  static GMutex *m_mutex;
65  static void getLock();
66  static int numOfEntries;
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 void releaseLock();
75  static void checkForUpdates();
76  static void reset();
77  static void registerUpdateCallback(updateCallback cb);
78  static msgHandler* getInstance();
79 };
80 
81 #endif /* HOSTIF_XRECLIENT_REQHANDLER_H_ */
82 /* End of HOSTIF_XRECLIENT_REQHANDLER_H_ doxygen group */
83 /**
84  * @}
85  */
86 
87 
88 /** @} */
89 /** @} */
_HostIf_MsgData_t
Definition: hostIf_tr69ReqHandler.h:170
hostIf_main.h
hostIf_main API.
XREClientReqHandler
This class provides the interface for getting XRE request handler information.
Definition: hostIf_XREClient_ReqHandler.h:58
XREClientReqHandler::handleGetMsg
virtual int handleGetMsg(HOSTIF_MsgData_t *stMsgData)
This is a pure virtual function used to handle the get message request. Currently not implemented.
XREClientReqHandler::handleSetMsg
virtual int handleSetMsg(HOSTIF_MsgData_t *stMsgData)
This is a pure virtual function used to handle the set message request. Currently not implemented.
XREClientReqHandler::init
virtual bool init()
This is a pure virtual function used for initialization. Currently not implemented.
msgHandler
Definition: hostIf_msgHandler.h:103
hostIf_msgHandler.h
The header file provides HostIf message handler information APIs.
XREClientReqHandler::unInit
virtual bool unInit()
This is a pure virtual function used for un initialization. Currently not implemented.