iPXE
Data Fields
EFI_DHCP4_CONFIG_DATA Struct Reference

#include <Dhcp4.h>

Data Fields

UINT32 DiscoverTryCount
 The number of times to try sending a packet during the Dhcp4SendDiscover event and waiting for a response during the Dhcp4RcvdOffer event.
UINT32DiscoverTimeout
 The maximum amount of time (in seconds) to wait for returned packets in each of the retries.
UINT32 RequestTryCount
 The number of times to try sending a packet during the Dhcp4SendRequest event and waiting for a response during the Dhcp4RcvdAck event before accepting failure.
UINT32RequestTimeout
 The maximum amount of time (in seconds) to wait for return packets in each of the retries.
EFI_IPv4_ADDRESS ClientAddress
 For a DHCPDISCOVER, setting this parameter to the previously allocated IP address will cause the EFI DHCPv4 Protocol driver to enter the Dhcp4InitReboot state.
EFI_DHCP4_CALLBACK Dhcp4Callback
 The callback function to intercept various events that occurred in the DHCP configuration process.
VOIDCallbackContext
 The pointer to the context that will be passed to Dhcp4Callback when it is called.
UINT32 OptionCount
 Number of DHCP options in the OptionList.
EFI_DHCP4_PACKET_OPTION ** OptionList
 List of DHCP options to be included in every packet that is sent during the Dhcp4SendDiscover event.

Detailed Description

Definition at line 254 of file Dhcp4.h.


Field Documentation

The number of times to try sending a packet during the Dhcp4SendDiscover event and waiting for a response during the Dhcp4RcvdOffer event.

Set to zero to use the default try counts and timeout values.

Definition at line 260 of file Dhcp4.h.

The maximum amount of time (in seconds) to wait for returned packets in each of the retries.

Timeout values of zero will default to a timeout value of one second. Set to NULL to use default timeout values.

Definition at line 266 of file Dhcp4.h.

The number of times to try sending a packet during the Dhcp4SendRequest event and waiting for a response during the Dhcp4RcvdAck event before accepting failure.

Set to zero to use the default try counts and timeout values.

Definition at line 272 of file Dhcp4.h.

The maximum amount of time (in seconds) to wait for return packets in each of the retries.

Timeout values of zero will default to a timeout value of one second. Set to NULL to use default timeout values.

Definition at line 278 of file Dhcp4.h.

For a DHCPDISCOVER, setting this parameter to the previously allocated IP address will cause the EFI DHCPv4 Protocol driver to enter the Dhcp4InitReboot state.

And set this field to 0.0.0.0 to enter the Dhcp4Init state. For a DHCPINFORM this parameter should be set to the client network address which was assigned to the client during a DHCPDISCOVER.

Definition at line 286 of file Dhcp4.h.

The callback function to intercept various events that occurred in the DHCP configuration process.

Set to NULL to ignore all those events.

Definition at line 291 of file Dhcp4.h.

The pointer to the context that will be passed to Dhcp4Callback when it is called.

Definition at line 295 of file Dhcp4.h.

Number of DHCP options in the OptionList.

Definition at line 299 of file Dhcp4.h.

List of DHCP options to be included in every packet that is sent during the Dhcp4SendDiscover event.

Pad options are appended automatically by DHCP driver in outgoing DHCP packets. If OptionList itself contains pad option, they are ignored by the driver. OptionList can be freed after EFI_DHCP4_PROTOCOL.Configure() returns. Ignored if OptionCount is zero.

Definition at line 307 of file Dhcp4.h.


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