RDK Documentation (Open Sourced RDK Components)
StorageService RequestHandler Public Classes

Description

Describe the details about classes used in TR-069 storage service handler.

Data Structures

class  StorageSrvcReqHandler
 This class provides the interface for getting StorageService request handler information. More...
 

Functions

virtual bool StorageSrvcReqHandler::init ()
 This function is use to initialize. Currently not implemented. More...
 
virtual bool StorageSrvcReqHandler::unInit ()
 This function is used to close all the instances of storage service. More...
 
virtual int StorageSrvcReqHandler::handleSetMsg (HOSTIF_MsgData_t *stMsgData)
 This function use to handle the set message request of storage service. Currently not implemented. More...
 
virtual int StorageSrvcReqHandler::handleGetMsg (HOSTIF_MsgData_t *stMsgData)
 This function use to handle the get message request of storage service. More...
 
virtual int XRdkCentralT2::handleSetMsg (HOSTIF_MsgData_t *stMsgData)
 This function use to handle the set message request of telemetry multiprofile . This will be a pass through request to actual module having implementation registered with rbus . More...
 
virtual int XRdkCentralT2::handleGetMsg (HOSTIF_MsgData_t *stMsgData)
 This function use to handle the get message request of telemetry multiprofile . This will be a pass through request to actual module having implementation registered with rbus . More...
 

Data Structure Documentation

◆ StorageSrvcReqHandler

class StorageSrvcReqHandler

This class provides the interface for getting StorageService request handler information.

StorageService interface is a platform agnostic IARM communication interface. It allows StorageService applications to communicate by sending Get and Set operation

Definition at line 59 of file hostIf_StorageSrvc_ReqHandler.h.

Inheritance diagram for StorageSrvcReqHandler:
Inheritance graph
Collaboration diagram for StorageSrvcReqHandler:
Collaboration graph

Public Member Functions

virtual bool init ()
 This function is use to initialize. Currently not implemented. More...
 
virtual bool unInit ()
 This function is used to close all the instances of storage service. More...
 
virtual int handleSetMsg (HOSTIF_MsgData_t *stMsgData)
 This function use to handle the set message request of storage service. Currently not implemented. More...
 
virtual int handleGetMsg (HOSTIF_MsgData_t *stMsgData)
 This function use to handle the get message request of storage service. More...
 
virtual int handleGetAttributesMsg (HOSTIF_MsgData_t *stMsgData)
 
virtual int handleSetAttributesMsg (HOSTIF_MsgData_t *stMsgData)
 

Static Public Member Functions

static msgHandlergetInstance ()
 

Static Private Attributes

static class StorageSrvcReqHandlerpInstance = NULL
 

Function Documentation

◆ init()

bool StorageSrvcReqHandler::init ( )
virtual

This function is use to initialize. Currently not implemented.

Returns
Returns the status of the operation.
Return values
trueif initialization is successfully .
falseif initialization is not successful.

Implements msgHandler.

Definition at line 58 of file hostIf_StorageService_ReqHandler.cpp.

◆ unInit()

bool StorageSrvcReqHandler::unInit ( )
virtual

This function is used to close all the instances of storage service.

Returns
Returns the status of the operation.
Return values
trueif it is successfully close all the instances.
falseif not able to close all the instances.

Implements msgHandler.

Definition at line 72 of file hostIf_StorageService_ReqHandler.cpp.

◆ handleSetMsg() [1/2]

int StorageSrvcReqHandler::handleSetMsg ( HOSTIF_MsgData_t stMsgData)
virtual

This function use to handle the set message request of storage service. Currently not implemented.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns the status of the operation.
Return values
OKif it is successfully.
ERR_INTERNAL_ERRORif not able to set the data to the device.

Implements msgHandler.

Definition at line 92 of file hostIf_StorageService_ReqHandler.cpp.

◆ handleGetMsg() [1/2]

int StorageSrvcReqHandler::handleGetMsg ( HOSTIF_MsgData_t stMsgData)
virtual

This function use to handle the get message request of storage service.

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns the status of the operation.
Return values
OKif it is successfully.
ERR_INTERNAL_ERRORif not able to get data from the device.

Implements msgHandler.

Definition at line 113 of file hostIf_StorageService_ReqHandler.cpp.

◆ handleSetMsg() [2/2]

int XRdkCentralT2::handleSetMsg ( HOSTIF_MsgData_t stMsgData)
virtual

This function use to handle the set message request of telemetry multiprofile . This will be a pass through request to actual module having implementation registered with rbus .

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns the status of the operation.
Return values
OKif it is successfully.
ERR_INTERNAL_ERRORif not able to set the data to the device.

Implements msgHandler.

Definition at line 87 of file hostIf_XrdkCentralT2_ReqHandler.cpp.

◆ handleGetMsg() [2/2]

int XRdkCentralT2::handleGetMsg ( HOSTIF_MsgData_t stMsgData)
virtual

This function use to handle the get message request of telemetry multiprofile . This will be a pass through request to actual module having implementation registered with rbus .

Parameters
[out]stMsgDataTR-069 Host interface message request.
Returns
Returns the status of the operation.
Return values
OKif it is successfully.
ERR_INTERNAL_ERRORif not able to get data from the device.

Implements msgHandler.

Definition at line 148 of file hostIf_XrdkCentralT2_ReqHandler.cpp.