RDK Documentation (Open Sourced RDK Components)
hostIf_StorageSrvc_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_StorageSrvc_ReqHandler.h
22  * @brief The header file provides HostIf Storage service request handler information APIs.
23  */
24 
25 /**
26  * @defgroup TR-069HOSTIF_STORAGESERVICE_REQHANDLER_CLASSES StorageService RequestHandler Public Classes
27  * Describe the details about classes used in TR-069 storage service handler.
28  * @ingroup TR-069HOSTIF_DEVICECLIENT_HANDLER
29  */
30 
31 /**
32  * @file hostIf_StorageSrvc_ReqHandler.h
33  *
34  * @brief host Interface for Storage Service Request Handler
35  *
36  * This exposes APIs for get and set operations for the Storage service
37  *
38  * @author karsomas@cisco.com
39  *
40  */
41 
42 /**
43  * StorageService interface is a platform agnostic IARM communication interface. It allows
44  * StorageService applications to communicate by sending Get and Set operation
45  *
46  */
47 
48 
49 #ifndef HOSTIF_STORAGESRVC_REQHANDLER_H_
50 #define HOSTIF_STORAGESRVC_REQHANDLER_H_
51 
52 #include "hostIf_msgHandler.h"
53 #include "hostIf_updateHandler.h"
54 
55 /**
56  * @brief This class provides the interface for getting StorageService request handler information.
57  * @ingroup TR-069HOSTIF_STORAGESERVICE_REQHANDLER_CLASSES
58  */
59 class StorageSrvcReqHandler : public msgHandler
60 {
61  StorageSrvcReqHandler() {};
62 
63  static class StorageSrvcReqHandler *pInstance;
64 protected:
65  virtual ~StorageSrvcReqHandler() {};
66 public:
67  virtual bool init();
68  virtual bool unInit();
69  virtual int handleSetMsg(HOSTIF_MsgData_t *stMsgData);
70  virtual int handleGetMsg(HOSTIF_MsgData_t *stMsgData);
71  virtual int handleGetAttributesMsg(HOSTIF_MsgData_t *stMsgData);
72  virtual int handleSetAttributesMsg(HOSTIF_MsgData_t *stMsgData);
73  static msgHandler* getInstance();
74 
75 };
76 
77 #endif /* HOSTIF_StorageSrvc_REQHANDLER_H_ */
78 /* End of HOSTIF_StorageSrvc_REQHANDLER_H_ doxygen group */
79 /**
80  * @}
81  */
_HostIf_MsgData_t
Definition: hostIf_tr69ReqHandler.h:170
StorageSrvcReqHandler::handleSetMsg
virtual int handleSetMsg(HOSTIF_MsgData_t *stMsgData)
This function use to handle the set message request of storage service. Currently not implemented.
Definition: hostIf_StorageService_ReqHandler.cpp:92
StorageSrvcReqHandler
This class provides the interface for getting StorageService request handler information.
Definition: hostIf_StorageSrvc_ReqHandler.h:59
StorageSrvcReqHandler::init
virtual bool init()
This function is use to initialize. Currently not implemented.
Definition: hostIf_StorageService_ReqHandler.cpp:58
msgHandler
Definition: hostIf_msgHandler.h:103
hostIf_msgHandler.h
The header file provides HostIf message handler information APIs.
StorageSrvcReqHandler::unInit
virtual bool unInit()
This function is used to close all the instances of storage service.
Definition: hostIf_StorageService_ReqHandler.cpp:72
StorageSrvcReqHandler::handleGetMsg
virtual int handleGetMsg(HOSTIF_MsgData_t *stMsgData)
This function use to handle the get message request of storage service.
Definition: hostIf_StorageService_ReqHandler.cpp:113