DHCPv4 Client RequestHandler Public Classes

Description

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

Data Structures
class	DHCPv4ClientReqHandler
	This class provides the interface for request handler operations for the DHCPV4 Client. More...

Functions
virtual bool	DHCPv4ClientReqHandler::init ()
	This function is used to initialize. Currently not implemented. More...
virtual bool	DHCPv4ClientReqHandler::unInit ()
	This function is used to close all the instances of DHCPv4 client. More...
virtual int	DHCPv4ClientReqHandler::handleSetMsg (HOSTIF_MsgData_t *stMsgData)
	This function is used to handle the set message request of DHCPv4 Client. Currently not implemented. More...
virtual int	DHCPv4ClientReqHandler::handleGetMsg (HOSTIF_MsgData_t *stMsgData)
	This function is used to handle the get message request of DHCPv4 Client information such as "Interface", "IPRouters" and "DNSServers". More...

---

Data Structure Documentation

DHCPv4ClientReqHandler

class DHCPv4ClientReqHandler

This class provides the interface for request handler operations for the DHCPV4 Client.

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

Definition at line 60 of file hostIf_DHCPv4Client_ReqHandler.h.

Inheritance diagram for DHCPv4ClientReqHandler:

Collaboration diagram for DHCPv4ClientReqHandler:

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 DHCPv4 client. More...
virtual int	handleSetMsg (HOSTIF_MsgData_t *stMsgData)
	This function is used to handle the set message request of DHCPv4 Client. Currently not implemented. More...
virtual int	handleGetMsg (HOSTIF_MsgData_t *stMsgData)
	This function is used to handle the get message request of DHCPv4 Client information such as "Interface", "IPRouters" and "DNSServers". 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 class DHCPv4ClientReqHandler *	pInstance = NULL
static updateCallback	mUpdateCallback = NULL
static int	curNumOfDHCPv4Clients = 0

Function Documentation

init()

bool DHCPv4ClientReqHandler::init ( )

virtual

This function is used to initialize. Currently not implemented.

Returns

Returns the status of the operation.

Return values

true	if initialization is successful.
false	if initialization is not successful.

Implements msgHandler.

Definition at line 67 of file hostIf_DHCPv4Client_ReqHandler.cpp.

unInit()

bool DHCPv4ClientReqHandler::unInit ( )

virtual

This function is used to close all the instances of DHCPv4 client.

Returns

Returns the status of the operation.

Return values

true	if it successfully close all the instances.
false	if not able to close all the instances.

Implements msgHandler.

Definition at line 81 of file hostIf_DHCPv4Client_ReqHandler.cpp.

handleSetMsg()

int DHCPv4ClientReqHandler::handleSetMsg ( HOSTIF_MsgData_t *  stMsgData )

virtual

This function is used to handle the set message request of DHCPv4 Client. Currently not implemented.

Parameters

[out]

stMsgData

TR-069 Host interface message request.

Returns

Returns the status of the operation.

Return values

OK	if it is successful.
ERR_INTERNAL_ERROR	if not able to set the data to the device.

Implements msgHandler.

Definition at line 101 of file hostIf_DHCPv4Client_ReqHandler.cpp.

handleGetMsg()

int DHCPv4ClientReqHandler::handleGetMsg ( HOSTIF_MsgData_t *  stMsgData )

virtual

This function is used to handle the get message request of DHCPv4 Client information such as "Interface", "IPRouters" and "DNSServers".

Parameters

[out]

stMsgData

TR-069 Host interface message request.

Returns

Returns the status of the operation.

Return values

OK	if it gets the data successfully.
ERR_INTERNAL_ERROR	if not able to get the data from the device.

Implements msgHandler.

Definition at line 123 of file hostIf_DHCPv4Client_ReqHandler.cpp.