RDK-B
Functions
DHCPV4C HAL APIs
DHCPV4C HAL

Description

Functions

int dhcp4c_get_ert_lease_time (unsigned int *pValue)
 
int dhcp4c_get_ert_remain_lease_time (unsigned int *pValue)
 
int dhcp4c_get_ert_remain_renew_time (unsigned int *pValue)
 
int dhcp4c_get_ert_remain_rebind_time (unsigned int *pValue)
 
int dhcp4c_get_ert_config_attempts (int *pValue)
 
int dhcp4c_get_ert_ifname (char *pName)
 
int dhcp4c_get_ert_fsm_state (int *pValue)
 
int dhcp4c_get_ert_ip_addr (unsigned int *pValue)
 
int dhcp4c_get_ert_mask (unsigned int *pValue)
 
int dhcp4c_get_ert_gw (unsigned int *pValue)
 
int dhcp4c_get_ert_dns_svrs (ipv4AddrList_t *pList)
 
int dhcp4c_get_ert_dhcp_svr (unsigned int *pValue)
 
int dhcp4c_get_ecm_lease_time (unsigned int *pValue)
 
int dhcp4c_get_ecm_remain_lease_time (unsigned int *pValue)
 
int dhcp4c_get_ecm_remain_renew_time (unsigned int *pValue)
 
int dhcp4c_get_ecm_remain_rebind_time (unsigned int *pValue)
 
int dhcp4c_get_ecm_config_attempts (int *pValue)
 
int dhcp4c_get_ecm_ifname (char *pName)
 
int dhcp4c_get_ecm_fsm_state (int *pValue)
 
int dhcp4c_get_ecm_ip_addr (unsigned int *pValue)
 
int dhcp4c_get_ecm_mask (unsigned int *pValue)
 
int dhcp4c_get_ecm_gw (unsigned int *pValue)
 
int dhcp4c_get_ecm_dns_svrs (ipv4AddrList_t *pList)
 
int dhcp4c_get_ecm_dhcp_svr (unsigned int *pValue)
 
int dhcp4c_get_emta_remain_lease_time (unsigned int *pValue)
 
int dhcp4c_get_emta_remain_renew_time (unsigned int *pValue)
 
int dhcp4c_get_emta_remain_rebind_time (unsigned int *pValue)
 
int ert_dhcp6c_get_info (dhcp6cInfo_t *pInfo)
 
int ecm_dhcp6c_get_info (dhcp6cInfo_t *pInfo)
 
int dhcpv4c_get_ert_lease_time (unsigned int *pValue)
 
int dhcpv4c_get_ert_remain_lease_time (unsigned int *pValue)
 
int dhcpv4c_get_ert_remain_renew_time (unsigned int *pValue)
 
int dhcpv4c_get_ert_remain_rebind_time (unsigned int *pValue)
 
int dhcpv4c_get_ert_config_attempts (int *pValue)
 
int dhcpv4c_get_ert_ifname (char *pName)
 
int dhcpv4c_get_ert_fsm_state (int *pValue)
 
int dhcpv4c_get_ert_ip_addr (unsigned int *pValue)
 
int dhcpv4c_get_ert_mask (unsigned int *pValue)
 
int dhcpv4c_get_ert_gw (unsigned int *pValue)
 
int dhcpv4c_get_ert_dns_svrs (dhcpv4c_ip_list_t *pList)
 
int dhcpv4c_get_ert_dhcp_svr (unsigned int *pValue)
 
int dhcpv4c_get_ecm_lease_time (unsigned int *pValue)
 
int dhcpv4c_get_ecm_remain_lease_time (unsigned int *pValue)
 
int dhcpv4c_get_ecm_remain_renew_time (unsigned int *pValue)
 
int dhcpv4c_get_ecm_remain_rebind_time (unsigned int *pValue)
 
int dhcpv4c_get_ecm_config_attempts (int *pValue)
 
int dhcpv4c_get_ecm_ifname (char *pName)
 
int dhcpv4c_get_ecm_fsm_state (int *pValue)
 
int dhcpv4c_get_ecm_ip_addr (unsigned int *pValue)
 
int dhcpv4c_get_ecm_mask (unsigned int *pValue)
 
int dhcpv4c_get_ecm_gw (unsigned int *pValue)
 
int dhcpv4c_get_ecm_dns_svrs (dhcpv4c_ip_list_t *pList)
 
int dhcpv4c_get_ecm_dhcp_svr (unsigned int *pValue)
 
int dhcpv4c_get_emta_remain_lease_time (unsigned int *pValue)
 
int dhcpv4c_get_emta_remain_renew_time (unsigned int *pValue)
 
int dhcpv4c_get_emta_remain_rebind_time (unsigned int *pValue)
 

Function Documentation

◆ dhcp4c_get_ert_lease_time()

int dhcp4c_get_ert_lease_time ( unsigned int *  pValue)

@description Gets the E-Router Offered Lease Time

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ert_remain_lease_time()

int dhcp4c_get_ert_remain_lease_time ( unsigned int *  pValue)

@description Gets the E-Router Remaining Lease Time

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ert_remain_renew_time()

int dhcp4c_get_ert_remain_renew_time ( unsigned int *  pValue)

@description Gets the E-Router Interface Remaining Time to Renew

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ert_remain_rebind_time()

int dhcp4c_get_ert_remain_rebind_time ( unsigned int *  pValue)

@description Gets the E-Router Interface Remaining Time to Rebind

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ert_config_attempts()

int dhcp4c_get_ert_config_attempts ( int *  pValue)

@description Gets the E-Router Number of Attemts to Configure.

Parameters
pValue- Count.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ert_ifname()

int dhcp4c_get_ert_ifname ( char *  pName)

@description Gets the E-Router Interface Name.

Parameters
pName- Interface Name (e.g. ert0)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ert_fsm_state()

int dhcp4c_get_ert_fsm_state ( int *  pValue)

@description Gets the E-Router DHCP State

Parameters
pValue- State of the DHCP (RENEW/ACQUIRED etc.)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ert_ip_addr()

int dhcp4c_get_ert_ip_addr ( unsigned int *  pValue)

@description Gets the E-Router Interface IP Address

Parameters
pValue- IP Address (of the Interface)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ert_mask()

int dhcp4c_get_ert_mask ( unsigned int *  pValue)

@description Gets the E-Router Subnet Mask.

Parameters
pValue- Subnet Mask (bitmask)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ert_gw()

int dhcp4c_get_ert_gw ( unsigned int *  pValue)

@description Gets the E-Router Gateway IP Address

Parameters
pValue- IP Address (of the Gateway)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ert_dns_svrs()

int dhcp4c_get_ert_dns_svrs ( ipv4AddrList_t *  pList)

@description Gets the E-Router List of DNS Servers

Parameters
pList- List of IP Address (of DNS Servers)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ert_dhcp_svr()

int dhcp4c_get_ert_dhcp_svr ( unsigned int *  pValue)

@description Gets the E-Router DHCP Server IP Address

Parameters
pValue- IP Address (of DHCP Server)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ecm_lease_time()

int dhcp4c_get_ecm_lease_time ( unsigned int *  pValue)

@description Gets the ECM Offered Lease Time.

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ecm_remain_lease_time()

int dhcp4c_get_ecm_remain_lease_time ( unsigned int *  pValue)

@description Gets the ECM Remaining Lease Time

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ecm_remain_renew_time()

int dhcp4c_get_ecm_remain_renew_time ( unsigned int *  pValue)

@description Gets the ECM Interface Remaining time to Renew.

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ecm_remain_rebind_time()

int dhcp4c_get_ecm_remain_rebind_time ( unsigned int *  pValue)

@description Gets the ECM Interface Remaining time to Rebind.

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ecm_config_attempts()

int dhcp4c_get_ecm_config_attempts ( int *  pValue)

@description Gets the ECM Configuration Number of Attemts.

Parameters
pValue- Count.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ecm_ifname()

int dhcp4c_get_ecm_ifname ( char *  pName)

@description Gets the ECM Interface Name.

Parameters
pName- Name of the Interface (e.g doc0)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ecm_fsm_state()

int dhcp4c_get_ecm_fsm_state ( int *  pValue)

@description Gets the ECM DHCP State

Parameters
pValue- State of the DHCP (RENEW/ACQUIRED etc)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ecm_ip_addr()

int dhcp4c_get_ecm_ip_addr ( unsigned int *  pValue)

@description Gets the ECM Interface IP Address

Parameters
pValue- IP Address of the Interface.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ecm_mask()

int dhcp4c_get_ecm_mask ( unsigned int *  pValue)

@description Gets the ECM Interface Subnet Mask.

Parameters
pValue- Subnet Mask (bitmask).
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ecm_gw()

int dhcp4c_get_ecm_gw ( unsigned int *  pValue)

@description Gets the ECM Gateway IP Address

Parameters
pValue- IP Address of Gateway
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ecm_dns_svrs()

int dhcp4c_get_ecm_dns_svrs ( ipv4AddrList_t *  pList)

@description Gets the ECM List of DNS Servers

Parameters
pList- List of IP Addresses (of DNS Servers)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_ecm_dhcp_svr()

int dhcp4c_get_ecm_dhcp_svr ( unsigned int *  pValue)

@description Gets the ECM DHCP Server IP Address

Parameters
pValue- IP Address
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_emta_remain_lease_time()

int dhcp4c_get_emta_remain_lease_time ( unsigned int *  pValue)

@description Gets the E-MTA interface Least Time

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_emta_remain_renew_time()

int dhcp4c_get_emta_remain_renew_time ( unsigned int *  pValue)

@description Gets the E-MTA interface Remaining Time to Renew

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcp4c_get_emta_remain_rebind_time()

int dhcp4c_get_emta_remain_rebind_time ( unsigned int *  pValue)

@description Gets the E-MTA interface Remaining Time to Rebind

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ ert_dhcp6c_get_info()

int ert_dhcp6c_get_info ( dhcp6cInfo_t *  pInfo)

@description Gets the E-Router Info.

Parameters
pInfo- E-Router Info(elements of structure "dhcp6cInfo_t"), to be returned
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ ecm_dhcp6c_get_info()

int ecm_dhcp6c_get_info ( dhcp6cInfo_t *  pInfo)

@description Gets the ECM Info.

Parameters
pInfo- ECM Info(elements of structure "dhcp6cInfo_t"), to be returned
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ert_lease_time()

int dhcpv4c_get_ert_lease_time ( unsigned int *  pValue)

@description Gets the E-Router Offered Lease Time

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ert_remain_lease_time()

int dhcpv4c_get_ert_remain_lease_time ( unsigned int *  pValue)

@description Gets the E-Router Remaining Lease Time

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ert_remain_renew_time()

int dhcpv4c_get_ert_remain_renew_time ( unsigned int *  pValue)

@description Gets the E-Router Interface Remaining Time to Renew

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ert_remain_rebind_time()

int dhcpv4c_get_ert_remain_rebind_time ( unsigned int *  pValue)

@description Gets the E-Router Interface Remaining Time to Rebind

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ert_config_attempts()

int dhcpv4c_get_ert_config_attempts ( int *  pValue)

@description Gets the E-Router Number of Attemts to Configure.

Parameters
pValue- Count.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ert_ifname()

int dhcpv4c_get_ert_ifname ( char *  pName)

@description Gets the E-Router Interface Name.

Parameters
pName- Interface Name (e.g. ert0)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ert_fsm_state()

int dhcpv4c_get_ert_fsm_state ( int *  pValue)

@description Gets the E-Router DHCP State

Parameters
pValue- State of the DHCP (RENEW/ACQUIRED etc.)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ert_ip_addr()

int dhcpv4c_get_ert_ip_addr ( unsigned int *  pValue)

@description Gets the E-Router Interface IP Address

Parameters
pValue- IP Address (of the Interface)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ert_mask()

int dhcpv4c_get_ert_mask ( unsigned int *  pValue)

@description Gets the E-Router Subnet Mask.

Parameters
pValue- Subnet Mask (bitmask)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ert_gw()

int dhcpv4c_get_ert_gw ( unsigned int *  pValue)

@description Gets the E-Router Gateway IP Address

Parameters
pValue- IP Address (of the Gateway)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ert_dns_svrs()

int dhcpv4c_get_ert_dns_svrs ( dhcpv4c_ip_list_t *  pList)

@description Gets the E-Router List of DNS Servers

Parameters
pList- List of IP Address (of DNS Servers)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ert_dhcp_svr()

int dhcpv4c_get_ert_dhcp_svr ( unsigned int *  pValue)

@description Gets the E-Router DHCP Server IP Address

Parameters
pValue- IP Address (of DHCP Server)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ecm_lease_time()

int dhcpv4c_get_ecm_lease_time ( unsigned int *  pValue)

@description Gets the ECM Offered Lease Time.

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ecm_remain_lease_time()

int dhcpv4c_get_ecm_remain_lease_time ( unsigned int *  pValue)

@description Gets the ECM Remaining Lease Time

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ecm_remain_renew_time()

int dhcpv4c_get_ecm_remain_renew_time ( unsigned int *  pValue)

@description Gets the ECM Interface Remaining time to Renew.

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ecm_remain_rebind_time()

int dhcpv4c_get_ecm_remain_rebind_time ( unsigned int *  pValue)

@description Gets the ECM Interface Remaining time to Rebind.

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ecm_config_attempts()

int dhcpv4c_get_ecm_config_attempts ( int *  pValue)

@description Gets the ECM Configuration Number of Attemts.

Parameters
pValue- Count.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ecm_ifname()

int dhcpv4c_get_ecm_ifname ( char *  pName)

@description Gets the ECM Interface Name.

Parameters
pName- Name of the Interface (e.g doc0)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ecm_fsm_state()

int dhcpv4c_get_ecm_fsm_state ( int *  pValue)

@description Gets the ECM DHCP State

Parameters
pValue- State of the DHCP (RENEW/ACQUIRED etc)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ecm_ip_addr()

int dhcpv4c_get_ecm_ip_addr ( unsigned int *  pValue)

@description Gets the ECM Interface IP Address

Parameters
pValue- IP Address of the Interface.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ecm_mask()

int dhcpv4c_get_ecm_mask ( unsigned int *  pValue)

@description Gets the ECM Interface Subnet Mask.

Parameters
pValue- Subnet Mask (bitmask).
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ecm_gw()

int dhcpv4c_get_ecm_gw ( unsigned int *  pValue)

@description Gets the ECM Gateway IP Address

Parameters
pValue- IP Address of Gateway
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ecm_dns_svrs()

int dhcpv4c_get_ecm_dns_svrs ( dhcpv4c_ip_list_t *  pList)

@description Gets the ECM List of DNS Servers

Parameters
pList- List of IP Addresses (of DNS Servers)
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_ecm_dhcp_svr()

int dhcpv4c_get_ecm_dhcp_svr ( unsigned int *  pValue)

@description Gets the ECM DHCP Server IP Address

Parameters
pValue- IP Address
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_emta_remain_lease_time()

int dhcpv4c_get_emta_remain_lease_time ( unsigned int *  pValue)

@description Gets the E-MTA interface Least Time

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_emta_remain_renew_time()

int dhcpv4c_get_emta_remain_renew_time ( unsigned int *  pValue)

@description Gets the E-MTA interface Remaining Time to Renew

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ dhcpv4c_get_emta_remain_rebind_time()

int dhcpv4c_get_emta_remain_rebind_time ( unsigned int *  pValue)

@description Gets the E-MTA interface Remaining Time to Rebind

Parameters
pValue- Value in Seconds.
Returns
The status of the operation.
Return values
STATUS_SUCCESSif successful.
STATUS_FAILUREif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.