DHCPv4 Client

Topics
	DHCP State

Classes
class	DhcpObject
	DHCP client class. More...

Functions
int32_t	GetIntefaceDHCPState (int interface=0)
	Returns current state of the DHCP lease, with optional interface parameter.
int32_t	WaitForDHCPInterface (int interface=0, uint16_t TicksToWait=10 *TICKS_PER_SECOND)
	Wait until a DHCP lease is obtained, or the timeout occurs.

Detailed Description

#include< dhcpclient.h >

Function Documentation

GetIntefaceDHCPState()

int32_t GetIntefaceDHCPState

(

int

interface = 0

)

#include <dhcpclient.h>

Returns current state of the DHCP lease, with optional interface parameter.

The DhcpObject::GetDHCPState() function is a member function of the DHCP client class.

Returns

DHCP State

See also

DhcpObject::GetDHCPState

WaitForDHCPInterface()

int32_t WaitForDHCPInterface	(	int	interface = 0,
		uint16_t	TicksToWait = 10 *TICKS_PER_SECOND )

#include <dhcpclient.h>

Wait until a DHCP lease is obtained, or the timeout occurs.

Parameters

interface	The network interface to wait on.
TicksToWait	The number of system Time Ticks to wait. The TICKS_PER_SECOND constant can be used to more easily specify a number of seconds. If not specified, the default timeout is 10 seconds.

Returns

DHCP State

See also

DhcpObject::GetDHCPState