RDK Documentation (Open Sourced RDK Components)
Data Structures | Functions
Device Client RequestHandler Public Classes
TR-069 » TR-069 Host Interface » TR-069 Host Interface Handler

Description

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

Data Structures

class  DeviceClientReqHandler
 This class provides the interface for getting device client request handler information. More...
 

Functions

virtual bool DeviceClientReqHandler::init ()
 This function is used to initialize all the current process and processor to '0' using memset. More...
 
virtual bool DeviceClientReqHandler::unInit ()
 This function is used to close all the instances of device info, device processor interface, device process status interface. More...
 
virtual int DeviceClientReqHandler::handleSetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to set the Device reset, FirmwareDownload and FirmwareDownload Status. The possible reset states of the device are "Cold", "Factory", "Warehouse" and "Customer". More...
 
virtual int DeviceClientReqHandler::handleGetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to get the Process information such as "PID", "Command" "Size", "Priority", "CPUTime" and "State". It is also used to get the processor information, process status such as total number of active process entries and CPUUsage and device info such as "BootStatus", "Manufacturer", "ManufacturerOUI", "ModelName", "Description", "ProductClass" "SerialNumber", "HardwareVersion", "SoftwareVersion", "AdditionalHardwareVersion" etc.. More...
 

Data Structure Documentation

◆ DeviceClientReqHandler

class DeviceClientReqHandler

This class provides the interface for getting device client request handler information.

Definition at line 86 of file hostIf_DeviceClient_ReqHandler.h.

Inheritance diagram for DeviceClientReqHandler:
Inheritance graph
Collaboration diagram for DeviceClientReqHandler:
Collaboration graph

Public Member Functions

virtual bool init ()
 This function is used to initialize all the current process and processor to '0' using memset. More...
 
virtual bool unInit ()
 This function is used to close all the instances of device info, device processor interface, device process status interface. More...
 
virtual int handleSetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to set the Device reset, FirmwareDownload and FirmwareDownload Status. The possible reset states of the device are "Cold", "Factory", "Warehouse" and "Customer". More...
 
virtual int handleGetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to get the Process information such as "PID", "Command" "Size", "Priority", "CPUTime" and "State". It is also used to get the processor information, process status such as total number of active process entries and CPUUsage and device info such as "BootStatus", "Manufacturer", "ManufacturerOUI", "ModelName", "Description", "ProductClass" "SerialNumber", "HardwareVersion", "SoftwareVersion", "AdditionalHardwareVersion" etc.. More...
 
virtual int handleGetAttributesMsg (HOSTIF_MsgData_t *stMsgData)
 
virtual int handleSetAttributesMsg (HOSTIF_MsgData_t *stMsgData)
 

Static Public Member Functions

static msgHandler * getInstance ()
 
static void registerUpdateCallback (updateCallback cb)
 
static void checkForUpdates ()
 
static void reset ()
 
static void notifyIARM (IARM_Bus_tr69HostIfMgr_EventId_t event_type, const char *paramName, const char *paramValue, HostIf_ParamType_t paramtype)
 

Static Private Attributes

static class DeviceClientReqHandler * pInstance = NULL
 
static updateCallback mUpdateCallback = NULL
 
static int curNumOfProcess [100] = {0,}
 
static int curNumOfProcessor [10] = {0,}
 

Function Documentation

◆ init()

bool DeviceClientReqHandler::init ( )
virtual

This function is used to initialize all the current process and processor to '0' using memset.

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

Implements msgHandler.

Definition at line 85 of file hostIf_DeviceClient_ReqHandler.cpp.

◆ unInit()

bool DeviceClientReqHandler::unInit ( )
virtual

This function is used to close all the instances of device info, device processor interface, device process status interface.

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

Implements msgHandler.

Definition at line 104 of file hostIf_DeviceClient_ReqHandler.cpp.

◆ handleSetMsg()

int DeviceClientReqHandler::handleSetMsg ( HOSTIF_MsgData_t *  stMsgData)
virtual

This function is used to set the Device reset, FirmwareDownload and FirmwareDownload Status. The possible reset states of the device are "Cold", "Factory", "Warehouse" and "Customer".

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

Implements msgHandler.

Definition at line 127 of file hostIf_DeviceClient_ReqHandler.cpp.

◆ handleGetMsg()

int DeviceClientReqHandler::handleGetMsg ( HOSTIF_MsgData_t *  stMsgData)
virtual

This function is used to get the Process information such as "PID", "Command" "Size", "Priority", "CPUTime" and "State". It is also used to get the processor information, process status such as total number of active process entries and CPUUsage and device info such as "BootStatus", "Manufacturer", "ManufacturerOUI", "ModelName", "Description", "ProductClass" "SerialNumber", "HardwareVersion", "SoftwareVersion", "AdditionalHardwareVersion" etc..

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

Implements msgHandler.

Definition at line 326 of file hostIf_DeviceClient_ReqHandler.cpp.