DhcpObject Class Reference

DHCP client class. More...

#include <dhcpclient.h>

Inherits TimeOutElement.

Public Member Functions
void	StartDHCP ()
	Manually start the DHCP Client.
void	StopDHCP ()
	Manually stop the DHCP client and release the DHCP lease.
void	RestartDHCP ()
	Manually stop are resetart the DHCP client.
bool	bDoFallBack ()
	Returns true if a DHCP fallback event has occurred.
void	RenewDHCP ()
	Manually force a DHCP renew of a lease.
void	RebindDHCP ()
	Manually force a DHCP rebind of a lease.
BOOL	ValidDhcpLease ()
	Returns the status of a DHCP lease.
uint32_t	GetRemainingDhcpLeaseTime ()
	Returns number of seconds remaining for current lease.
uint32_t	GetDhcpRenewTime ()
	Returns number of seconds remaining before the lease will be renewed.
uint32_t	GetDhcpRebindTime ()
	Returns number of seconds remaining before the current lease will have to rebind.
uint32_t	GetDhcpExpirationTime ()
	Returns number of seconds remaining before the current lease will expire.
int32_t	GetDHCPState ()
	Returns current state of the DHCP lease.

Detailed Description

DHCP client class.

Member Function Documentation

bDoFallBack()

bool DhcpObject::bDoFallBack

(

)

Returns true if a DHCP fallback event has occurred.

The init() function called at the beginning of an application will handle DHCP client services for all network interfaces. It is rare that you would need to call these functions manually.

If the fallback functionality has been enabled in the device configuration, this function can be used to determine if a fallback to a static IP settings has occurred.

Returns

True if a fallback condition has occurred.

GetDhcpExpirationTime()

uint32_t DhcpObject::GetDhcpExpirationTime ( )

inline

Returns number of seconds remaining before the current lease will expire.

Returns

The number of seconds remaining before the current lease will expire.

See also

GetRemainingDhcpLeaseTime(), GetDhcpRenewTime(), GetDhcpRebindTime()

GetDhcpRebindTime()

uint32_t DhcpObject::GetDhcpRebindTime ( )

inline

Returns number of seconds remaining before the current lease will have to rebind.

Returns

The number of seconds remaining before the current lease will have to rebind.

See also

GetRemainingDhcpLeaseTime(), GetDhcpRenewTime(), GetDhcpExpirationTime()

GetDhcpRenewTime()

uint32_t DhcpObject::GetDhcpRenewTime ( )

inline

Returns number of seconds remaining before the lease will be renewed.

Returns

The number of seconds remaining before the lease will be renewed.

See also

GetRemainingDhcpLeaseTime(), GetDhcpRebindTime(), GetDhcpExpirationTime()

GetDHCPState()

int32_t DhcpObject::GetDHCPState

(

)

Returns current state of the DHCP lease.

Returns

DHCP State

See also

ValidDhcpLease()

GetRemainingDhcpLeaseTime()

uint32_t DhcpObject::GetRemainingDhcpLeaseTime

(

)

Returns number of seconds remaining for current lease.

Returns

The number of seconds remaining for current lease.

See also

GetDhcpRenewTime(), GetDhcpRebindTime(), GetDhcpExpirationTime()

RebindDHCP()

void DhcpObject::RebindDHCP

(

)

Manually force a DHCP rebind of a lease.

The init() function called at the beginning of an application will handle DHCP client services for all network interfaces. It is rare that you would need to call these functions manually.

See also

RenewDHCP()

RenewDHCP()

void DhcpObject::RenewDHCP

(

)

Manually force a DHCP renew of a lease.

The init() function called at the beginning of an application will handle DHCP client services for all network interfaces. It is rare that you would need to call these functions manually.

See also

RebindDHCP()

RestartDHCP()

void DhcpObject::RestartDHCP

(

)

Manually stop are resetart the DHCP client.

The init() function called at the beginning of an application will handle DHCP client services for all network interfaces. It is rare that you would need to call these functions manually.

See also

DhcpObject::StartDHCP(), DhcpObject::StopDHCP()

StartDHCP()

void DhcpObject::StartDHCP

(

)

Manually start the DHCP Client.

The init() function called at the beginning of an application will handle DHCP client services for all network interfaces. It is rare that you would need to call these functions manually.

This function will start the DHCP client and return immediately. Check the DHCP status to verify you have successfully obtained a lease via GetDHCPState()

See also

DhcpObject::StopDHCP()

StopDHCP()

void DhcpObject::StopDHCP

(

)

Manually stop the DHCP client and release the DHCP lease.

The init() function called at the beginning of an application will handle DHCP client services for all network interfaces. It is rare that you would need to call these functions manually.

See also

DhcpObject::StartDHCP()

ValidDhcpLease()

BOOL DhcpObject::ValidDhcpLease

(

)

Returns the status of a DHCP lease.

Returns

True if the interface has a valid lease.

See also

RenewDHCP()

---

The documentation for this class was generated from the following file:

• dhcpclient.h