RDK Documentation (Open Sourced RDK Components)
Message Handler Public Classes

Description

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

Functions

virtual bool msgHandler::init ()=0
 This is a pure virtual function used for initialization. Currently not implemented. More...
 
virtual bool msgHandler::unInit ()=0
 This is a pure virtual function used for un initialization. Currently not implemented. More...
 
virtual int msgHandler::handleSetMsg (HOSTIF_MsgData_t *stMsgData)=0
 This is a pure virtual function used to handle the set message request. Currently not implemented. More...
 
virtual int msgHandler::handleGetMsg (HOSTIF_MsgData_t *stMsgData)=0
 This is a pure virtual function used to handle the get message request. Currently not implemented. More...
 

Function Documentation

◆ init()

virtual bool msgHandler::init ( )
pure virtual

This is a pure virtual function used for initialization. Currently not implemented.

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

Implemented in DeviceClientReqHandler, SNMPClientReqHandler, IPClientReqHandler, DHCPv4ClientReqHandler, InterfaceStackClientReqHandler, XREClientReqHandler, X_rdk_req_hdlr, StorageSrvcReqHandler, DSClientReqHandler, EthernetClientReqHandler, MoCAClientReqHandler, TimeClientReqHandler, and XRdkCentralT2.

◆ unInit()

virtual bool msgHandler::unInit ( )
pure virtual

This is a pure virtual function used for un initialization. Currently not implemented.

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

Implemented in DeviceClientReqHandler, SNMPClientReqHandler, IPClientReqHandler, DHCPv4ClientReqHandler, InterfaceStackClientReqHandler, XREClientReqHandler, X_rdk_req_hdlr, StorageSrvcReqHandler, DSClientReqHandler, EthernetClientReqHandler, MoCAClientReqHandler, TimeClientReqHandler, and XRdkCentralT2.

◆ handleSetMsg()

virtual int msgHandler::handleSetMsg ( HOSTIF_MsgData_t stMsgData)
pure virtual

This is a pure virtual function used to handle the set message request. Currently not implemented.

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

Implemented in DeviceClientReqHandler, SNMPClientReqHandler, IPClientReqHandler, DHCPv4ClientReqHandler, InterfaceStackClientReqHandler, XREClientReqHandler, X_rdk_req_hdlr, StorageSrvcReqHandler, DSClientReqHandler, EthernetClientReqHandler, MoCAClientReqHandler, TimeClientReqHandler, and XRdkCentralT2.

◆ handleGetMsg()

virtual int msgHandler::handleGetMsg ( HOSTIF_MsgData_t stMsgData)
pure virtual

This is a pure virtual function used to handle the get message request. Currently not implemented.

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

Implemented in DeviceClientReqHandler, SNMPClientReqHandler, IPClientReqHandler, DHCPv4ClientReqHandler, InterfaceStackClientReqHandler, XREClientReqHandler, X_rdk_req_hdlr, StorageSrvcReqHandler, DSClientReqHandler, EthernetClientReqHandler, MoCAClientReqHandler, TimeClientReqHandler, and XRdkCentralT2.