RDK Documentation (Open Sourced RDK Components)
hostIf_DHCPv4Client_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_DHCPv4Client_ReqHandler.h
22  *
23  * @brief host Interface for DHCPV4 Client Request Handler.
24  *
25  * This API defines the request handler operations for the DHCPV4 Client
26  *
27  * @author vejuturu@cisco.com
28  *
29  */
30 
31 /**
32  * @file hostIf_DHCPv4Client_ReqHandler.h
33  * @brief The header file provides HostIf DHCPv4 client request handler information APIs.
34  */
35 
36 /**
37  * @defgroup TR-069HOSTIF_DHCPV4CLIENT_REQHANDLER_CLASSES DHCPv4 Client RequestHandler Public Classes
38  * Describe the details about classes used in TR-069 DHCPv4Client request handler.
39  * @ingroup TR-069HOSTIF_DEVICECLIENT_HANDLER
40  */
41 
42 
43 /**
44  * DHCPv4Client interface is a platform agnostic IARM communication interface. It allows
45  * DHCPv4 client applications to communicate by sending Get and Set operation
46  *
47  */
48 
49 
50 #ifndef HOSTIF_DHCPv4CLIENT_REQHANDLER_H_
51 #define HOSTIF_DHCPv4CLIENT_REQHANDLER_H_
52 
53 #include "hostIf_msgHandler.h"
54 #include "hostIf_updateHandler.h"
55 
56 /**
57  * @brief This class provides the interface for request handler operations for the DHCPV4 Client.
58  * @ingroup TR-069HOSTIF_DHCPV4CLIENT_REQHANDLER_CLASSES
59  */
61 {
64 
65  static class DHCPv4ClientReqHandler *pInstance;
66  static updateCallback mUpdateCallback;
67 
68  static int curNumOfDHCPv4Clients;
69 
70 public:
71  virtual bool init();
72  virtual bool unInit();
73  virtual int handleSetMsg(HOSTIF_MsgData_t *stMsgData);
74  virtual int handleGetMsg(HOSTIF_MsgData_t *stMsgData);
75  virtual int handleGetAttributesMsg(HOSTIF_MsgData_t *stMsgData);
76  virtual int handleSetAttributesMsg(HOSTIF_MsgData_t *stMsgData);
77  static msgHandler* getInstance();
78  static void registerUpdateCallback(updateCallback cb);
79  static void checkForUpdates();
80  static void reset();
81 
82 };
83 
84 #endif /* HOSTIF_DHCPv4CLIENT_REQHANDLER_H_ */
85 /* End of HOSTIF_DHCPv4CLIENT_REQHANDLER_H_ doxygen group */
86 /**
87  * @}
88  */
DHCPv4ClientReqHandler::unInit
virtual bool unInit()
This function is used to close all the instances of DHCPv4 client.
Definition: hostIf_DHCPv4Client_ReqHandler.cpp:81
_HostIf_MsgData_t
Definition: hostIf_tr69ReqHandler.h:170
DHCPv4ClientReqHandler::handleSetMsg
virtual int handleSetMsg(HOSTIF_MsgData_t *stMsgData)
This function is used to handle the set message request of DHCPv4 Client. Currently not implemented.
Definition: hostIf_DHCPv4Client_ReqHandler.cpp:101
DHCPv4ClientReqHandler
This class provides the interface for request handler operations for the DHCPV4 Client.
Definition: hostIf_DHCPv4Client_ReqHandler.h:60
msgHandler
Definition: hostIf_msgHandler.h:103
hostIf_msgHandler.h
The header file provides HostIf message handler information APIs.
DHCPv4ClientReqHandler::init
virtual bool init()
This function is used to initialize. Currently not implemented.
Definition: hostIf_DHCPv4Client_ReqHandler.cpp:67
DHCPv4ClientReqHandler::handleGetMsg
virtual int handleGetMsg(HOSTIF_MsgData_t *stMsgData)
This function is used to handle the get message request of DHCPv4 Client information such as "Interfa...
Definition: hostIf_DHCPv4Client_ReqHandler.cpp:123