RDK Documentation (Open Sourced RDK Components)
Data Structures | Functions
IP 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 IPClient request handler.

Data Structures

class  IPClientReqHandler
 This class provides the interface for getting IP client request handler information. More...
 

Functions

virtual bool IPClientReqHandler::init ()
 This function is used to initialize. Currently not implemented. More...
 
virtual bool IPClientReqHandler::unInit ()
 This function is used to close all the instances of IP interface, IP interface stats IPv4 Address, IPActivePort and IP. More...
 
virtual int IPClientReqHandler::handleGetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to handle the get message request of IP interface, IPv4Address, IPActivePort and IP. Gets the attribute of IP interface such as "BytesSent", "BytesReceived", "PacketsSent", "PacketsReceived" ect.. The attributes of IPv4Address such as "Enable", "IPv4Enable", "ULAEnable" etc.. More...
 
virtual int IPClientReqHandler::handleSetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to handle the set message request of IP interface IPv4Address and IP. Gets the attribute of IP interface such as "Enable", "IPv4Enable", "Reset", "MaxMTUSize" . The attributes of IPv4Address such as "Enable", "SubnetMask" and "IPAddress". More...
 

Data Structure Documentation

◆ IPClientReqHandler

class IPClientReqHandler

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

Definition at line 57 of file hostIf_IPClient_ReqHandler.h.

Inheritance diagram for IPClientReqHandler:
Inheritance graph
Collaboration diagram for IPClientReqHandler:
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 IP interface, IP interface stats IPv4 Address, IPActivePort and IP. More...
 
virtual int handleSetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to handle the set message request of IP interface IPv4Address and IP. Gets the attribute of IP interface such as "Enable", "IPv4Enable", "Reset", "MaxMTUSize" . The attributes of IPv4Address such as "Enable", "SubnetMask" and "IPAddress". More...
 
virtual int handleGetMsg (HOSTIF_MsgData_t *stMsgData)
 This function is used to handle the get message request of IP interface, IPv4Address, IPActivePort and IP. Gets the attribute of IP interface such as "BytesSent", "BytesReceived", "PacketsSent", "PacketsReceived" ect.. The attributes of IPv4Address such as "Enable", "IPv4Enable", "ULAEnable" 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 Private Attributes

static std::mutex m_mutex
 
static class IPClientReqHandler * pInstance = NULL
 
static updateCallback mUpdateCallback = NULL
 
static int curNumOfIPInterface = 0
 
static int curNumOfInterfaceIPv4Addresses [100] = {0,}
 
static int curNumOfIPv4Interface [20] = {0,}
 
static int curNumOfActivePorts [20] = {0,}
 

Function Documentation

◆ init()

bool IPClientReqHandler::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 101 of file hostIf_IPClient_ReqHandler.cpp.

◆ unInit()

bool IPClientReqHandler::unInit ( )
virtual

This function is used to close all the instances of IP interface, IP interface stats IPv4 Address, IPActivePort and IP.

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 118 of file hostIf_IPClient_ReqHandler.cpp.

◆ handleGetMsg()

int IPClientReqHandler::handleGetMsg ( HOSTIF_MsgData_t *  stMsgData)
virtual

This function is used to handle the get message request of IP interface, IPv4Address, IPActivePort and IP. Gets the attribute of IP interface such as "BytesSent", "BytesReceived", "PacketsSent", "PacketsReceived" ect.. The attributes of IPv4Address such as "Enable", "IPv4Enable", "ULAEnable" etc..

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 146 of file hostIf_IPClient_ReqHandler.cpp.

◆ handleSetMsg()

int IPClientReqHandler::handleSetMsg ( HOSTIF_MsgData_t *  stMsgData)
virtual

This function is used to handle the set message request of IP interface IPv4Address and IP. Gets the attribute of IP interface such as "Enable", "IPv4Enable", "Reset", "MaxMTUSize" . The attributes of IPv4Address such as "Enable", "SubnetMask" and "IPAddress".

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 271 of file hostIf_IPClient_ReqHandler.cpp.