RDK Documentation (Open Sourced RDK Components)
hostIf_TimeClient_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_TimeClient_ReqHandler.h
22  * @brief The header file provides HostIf time client request handler information APIs.
23  */
24 
25 /**
26  * @defgroup TR-069HOSTIF_TIMECLIENT_REQHANDLER_CLASSES TimeClient RequestHandler Public Classes
27  * Describe the details about classes used in TR-069 time client request handler.
28  * @ingroup TR-069HOSTIF_DEVICECLIENT_HANDLER
29  */
30 
31 /**
32  * It allows moca client applications to communicate by sending Get operation
33  * from Time library.
34  */
35 
36 /**
37 * @defgroup tr69hostif
38 * @{
39 * @defgroup hostif
40 * @{
41 **/
42 
43 
44 #ifndef HOSTIF_TIMECLIENT_REQHANDLER_H_
45 #define HOSTIF_TIMECLIENT_REQHANDLER_H_
46 
47 #include "hostIf_msgHandler.h"
48 #include "hostIf_updateHandler.h"
49 #include "Device_Time.h"
50 
51 /**
52  * @brief This class provides the interface for getting TimeClient request handler information.
53  * @ingroup TR-069HOSTIF_TIMECLIENT_REQHANDLER_CLASSES
54  */
56 {
59  static class TimeClientReqHandler *pInstance;
60  static updateCallback mUpdateCallback;
61 
62 public:
63  virtual bool init();
64  virtual bool unInit();
65  virtual int handleSetMsg(HOSTIF_MsgData_t *stMsgData);
66  virtual int handleGetMsg(HOSTIF_MsgData_t *stMsgData);
67  virtual int handleGetAttributesMsg(HOSTIF_MsgData_t *stMsgData);
68  virtual int handleSetAttributesMsg(HOSTIF_MsgData_t *stMsgData);
69  static msgHandler* getInstance();
70  static void registerUpdateCallback(updateCallback cb);
71  static void checkForUpdates();
72 };
73 
74 #endif /* HOSTIF_TIMECLIENT_REQHANDLER_H_ */
75 /* End of HOSTIF_TIMECLIENT_REQHANDLER_H_ doxygen group */
76 /**
77  * @}
78  */
79 
80 
81 /** @} */
82 /** @} */
_HostIf_MsgData_t
Definition: hostIf_tr69ReqHandler.h:170
TimeClientReqHandler::init
virtual bool init()
This function is use to initialize. Currently not implemented.
Definition: hostIf_TimeClient_ReqHandler.cpp:59
TimeClientReqHandler::handleGetMsg
virtual int handleGetMsg(HOSTIF_MsgData_t *stMsgData)
This function use to handle the get message request of time client interface and get the attributes o...
Definition: hostIf_TimeClient_ReqHandler.cpp:154
Device_Time.h
TR-069 Device.Time object Public API.
TimeClientReqHandler
This class provides the interface for getting TimeClient request handler information.
Definition: hostIf_TimeClient_ReqHandler.h:55
TimeClientReqHandler::handleSetMsg
virtual int handleSetMsg(HOSTIF_MsgData_t *stMsgData)
This function is use to handle the set message request of time client interface and set the attribute...
Definition: hostIf_TimeClient_ReqHandler.cpp:97
msgHandler
Definition: hostIf_msgHandler.h:103
hostIf_msgHandler.h
The header file provides HostIf message handler information APIs.
TimeClientReqHandler::unInit
virtual bool unInit()
This function is used to close all the instances of time client.
Definition: hostIf_TimeClient_ReqHandler.cpp:75