RDK Documentation (Open Sourced RDK Components)
hostIf_MoCAClient_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_MoCAClient_ReqHandler.h
22  * @brief The header file provides HostIf MoCA client request handler information APIs.
23  */
24 
25 /**
26  * @defgroup TR-069HOSTIF_MOCACLIENT_REQHANDLER_CLASSES MoCA Client RequestHandler Public Classes
27  * Describe the details about classes used in TR-069 IPClient request handler.
28  * @ingroup TR-069HOSTIF_DEVICECLIENT_HANDLER
29  */
30 
31 
32 /**
33  * It allows moca client applications to communicate by sending Get operation
34  * from MoCA library.
35  */
36 
37 /**
38 * @defgroup tr69hostif
39 * @{
40 * @defgroup hostif
41 * @{
42 **/
43 
44 
45 #ifndef HOSTIF_MOCACLIENT_REQHANDLER_H_
46 #define HOSTIF_MOCACLIENT_REQHANDLER_H_
47 
48 #include "hostIf_msgHandler.h"
49 #include "hostIf_updateHandler.h"
50 
51 /**
52  * @brief This class provides the interface for getting MoCA client request handler information.
53  * @ingroup TR-069HOSTIF_MOCACLIENT_REQHANDLER_CLASSES
54  */
55 class MoCAClientReqHandler : public msgHandler
56 {
57  MoCAClientReqHandler() {};
58  ~MoCAClientReqHandler() {};
59  static class MoCAClientReqHandler *pInstance;
60  static updateCallback mUpdateCallback;
61 
62  static int curNumOfDevices[10];
63  static int numOfMocaMeshEntries;
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  static void reset();
75 };
76 
77 #endif /* HOSTIF_MOCACLIENT_REQHANDLER_H_ */
78 /* End of HOSTIF_MOCACLIENT_REQHANDLER_H_ doxygen group */
79 /**
80  * @}
81  */
82 
83 
84 /** @} */
85 /** @} */
MoCAClientReqHandler::handleSetMsg
virtual int handleSetMsg(HOSTIF_MsgData_t *stMsgData)
This is a pure virtual function used to handle the set message request. Currently not implemented.
MoCAClientReqHandler::unInit
virtual bool unInit()
This is a pure virtual function used for un initialization. Currently not implemented.
_HostIf_MsgData_t
Definition: hostIf_tr69ReqHandler.h:170
MoCAClientReqHandler::handleGetMsg
virtual int handleGetMsg(HOSTIF_MsgData_t *stMsgData)
This is a pure virtual function used to handle the get message request. Currently not implemented.
MoCAClientReqHandler
This class provides the interface for getting MoCA client request handler information.
Definition: hostIf_MoCAClient_ReqHandler.h:55
msgHandler
Definition: hostIf_msgHandler.h:103
hostIf_msgHandler.h
The header file provides HostIf message handler information APIs.
MoCAClientReqHandler::init
virtual bool init()
This is a pure virtual function used for initialization. Currently not implemented.