RDK Documentation (Open Sourced RDK Components)
Ethernet Client RequestHandler Public Classes

Description

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

Data Structures

class  EthernetClientReqHandler
 This class provides the interface for getting Ethernet client request handler information. More...
 

Functions

virtual bool EthernetClientReqHandler::init ()
 This function is used to initialize. Currently not implemented. More...
 
virtual bool EthernetClientReqHandler::unInit ()
 This function is used to close all the instances of ethernet interface and ethernet interface stats. More...
 
virtual int EthernetClientReqHandler::handleSetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to handle the set message request of ethernet interface attribute such as "Enable", "Alias", "LowerLayers", "MaxBitRate" and "DuplexMode". More...
 
virtual int EthernetClientReqHandler::handleGetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to handle the get message request of ethernet interface attributes such as "Enable", "Status", "Name", "LastChange", "Upstream", "MACAddress" etc.. More...
 

Data Structure Documentation

◆ EthernetClientReqHandler

class EthernetClientReqHandler

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

Definition at line 56 of file hostIf_EthernetClient_ReqHandler.h.

Inheritance diagram for EthernetClientReqHandler:
Inheritance graph
Collaboration diagram for EthernetClientReqHandler:
Collaboration graph

Public Member Functions

virtual bool init ()
 This function is used to initialize. Currently not implemented. More...
 
virtual bool unInit ()
 This function is used to close all the instances of ethernet interface and ethernet interface stats. More...
 
virtual int handleSetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to handle the set message request of ethernet interface attribute such as "Enable", "Alias", "LowerLayers", "MaxBitRate" and "DuplexMode". More...
 
virtual int handleGetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to handle the get message request of ethernet interface attributes such as "Enable", "Status", "Name", "LastChange", "Upstream", "MACAddress" etc.. More...
 
virtual int handleGetAttributesMsg (HOSTIF_MsgData_t *stMsgData)
 
virtual int handleSetAttributesMsg (HOSTIF_MsgData_t *stMsgData)
 

Static Public Member Functions

static msgHandlergetInstance ()
 
static void registerUpdateCallback (updateCallback cb)
 
static void checkForUpdates ()
 
static void reset ()
 

Static Private Attributes

static class EthernetClientReqHandlerpInstance = NULL
 
static updateCallback mUpdateCallback = NULL
 
static int curNumOfDevices [10] = {0,}
 

Function Documentation

◆ init()

bool EthernetClientReqHandler::init ( )
virtual

This function is used to initialize. Currently not implemented.

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

Implements msgHandler.

Definition at line 67 of file hostIf_EthernetClient_ReqHandler.cpp.

◆ unInit()

bool EthernetClientReqHandler::unInit ( )
virtual

This function is used to close all the instances of ethernet interface and ethernet interface stats.

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 84 of file hostIf_EthernetClient_ReqHandler.cpp.

◆ handleSetMsg()

int EthernetClientReqHandler::handleSetMsg ( HOSTIF_MsgData_t stMsgData)
virtual

This function is used to handle the set message request of ethernet interface attribute such as "Enable", "Alias", "LowerLayers", "MaxBitRate" and "DuplexMode".

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.

Implements msgHandler.

Definition at line 107 of file hostIf_EthernetClient_ReqHandler.cpp.

◆ handleGetMsg()

int EthernetClientReqHandler::handleGetMsg ( HOSTIF_MsgData_t stMsgData)
virtual

This function is used to handle the get message request of ethernet interface attributes such as "Enable", "Status", "Name", "LastChange", "Upstream", "MACAddress" etc..

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

Implements msgHandler.

Definition at line 170 of file hostIf_EthernetClient_ReqHandler.cpp.