RDK Documentation (Open Sourced RDK Components)
TR-069 Object (Device.DHCPv4.Interface.{i}) Public APIs

Description

Describe the details about RDK TR069 Device DHCPv4 Client APIs specifications.

Functions

int hostIf_DHCPv4Client::get_Device_DHCPv4_Client_InterfaceReference (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 This gets the interface information used by the DHCP(Dynamic Host Configuration Protocol) v4 client devices. More...
 
int hostIf_DHCPv4Client::get_Device_DHCPv4_Client_DnsServer (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 This gets the DNS server information used by the DHCP(Dynamic Host Configuration Protocol) v4 client devices. More...
 
int hostIf_DHCPv4Client::get_Device_DHCPv4_Client_IPRouters (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 This gets the IP Routers information used by the DHCP(Dynamic Host Configuration Protocol) v4 client devices. More...
 

Function Documentation

◆ get_Device_DHCPv4_Client_InterfaceReference()

int hostIf_DHCPv4Client::get_Device_DHCPv4_Client_InterfaceReference ( HOSTIF_MsgData_t stMsgData,
bool *  pChanged = NULL 
)

This gets the interface information used by the DHCP(Dynamic Host Configuration Protocol) v4 client devices.

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

Definition at line 167 of file Device_DHCPv4_Client.cpp.

◆ get_Device_DHCPv4_Client_DnsServer()

int hostIf_DHCPv4Client::get_Device_DHCPv4_Client_DnsServer ( HOSTIF_MsgData_t stMsgData,
bool *  pChanged = NULL 
)

This gets the DNS server information used by the DHCP(Dynamic Host Configuration Protocol) v4 client devices.

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

Definition at line 200 of file Device_DHCPv4_Client.cpp.

◆ get_Device_DHCPv4_Client_IPRouters()

int hostIf_DHCPv4Client::get_Device_DHCPv4_Client_IPRouters ( HOSTIF_MsgData_t stMsgData,
bool *  pChanged = NULL 
)

This gets the IP Routers information used by the DHCP(Dynamic Host Configuration Protocol) v4 client devices.

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

Definition at line 233 of file Device_DHCPv4_Client.cpp.