iPXE
Data Fields
EFI_DNS4_CONFIG_DATA Struct Reference

EFI_DNS4_CONFIG_DATA. More...

#include <Dns4.h>

Data Fields

UINTN DnsServerListCount
 Count of the DNS servers. More...
 
EFI_IPv4_ADDRESSDnsServerList
 Pointer to DNS server list containing DnsServerListCount entries or NULL if DnsServerListCountis 0. More...
 
BOOLEAN UseDefaultSetting
 Set to TRUE to use the default IP address/subnet mask and default routing table. More...
 
BOOLEAN EnableDnsCache
 If TRUE, enable DNS cache function for this DNS instance. More...
 
UINT8 Protocol
 Use the protocol number defined in "Links to UEFI-Related Documents"(http://uefi.org/uefi) under the heading "IANA Protocol Numbers". More...
 
EFI_IPv4_ADDRESS StationIp
 If UseDefaultSetting is FALSE indicates the station address to use. More...
 
EFI_IPv4_ADDRESS SubnetMask
 If UseDefaultSetting is FALSE indicates the subnet mask to use. More...
 
UINT16 LocalPort
 Local port number. More...
 
UINT32 RetryCount
 Retry number if no response received after RetryInterval. More...
 
UINT32 RetryInterval
 Minimum interval of retry is 2 second. More...
 

Detailed Description

EFI_DNS4_CONFIG_DATA.

Definition at line 35 of file Dns4.h.

Field Documentation

◆ DnsServerListCount

UINTN EFI_DNS4_CONFIG_DATA::DnsServerListCount

Count of the DNS servers.

When used with GetModeData(), this field is the count of originally configured servers when Configure() was called for this instance. When used with Configure() this is the count of caller-supplied servers. If the DnsServerListCount is zero, the DNS server configuration will be retrieved from DHCP server automatically.

Definition at line 44 of file Dns4.h.

◆ DnsServerList

EFI_IPv4_ADDRESS* EFI_DNS4_CONFIG_DATA::DnsServerList

Pointer to DNS server list containing DnsServerListCount entries or NULL if DnsServerListCountis 0.

For Configure(), this will be NULL when there are no caller supplied server addresses, and, the DNS instance will retrieve DNS server from DHCP Server. The provided DNS server list is recommended to be filled up in the sequence of preference. When used with GetModeData(), the buffer containing the list will be allocated by the driver implementing this protocol and must be freed by the caller. When used with Configure(), the buffer containing the list will be allocated and released by the caller.

Definition at line 56 of file Dns4.h.

◆ UseDefaultSetting

BOOLEAN EFI_DNS4_CONFIG_DATA::UseDefaultSetting

Set to TRUE to use the default IP address/subnet mask and default routing table.

Definition at line 60 of file Dns4.h.

◆ EnableDnsCache

BOOLEAN EFI_DNS4_CONFIG_DATA::EnableDnsCache

If TRUE, enable DNS cache function for this DNS instance.

If FALSE, all DNS query will not lookup local DNS cache.

Definition at line 65 of file Dns4.h.

◆ Protocol

UINT8 EFI_DNS4_CONFIG_DATA::Protocol

Use the protocol number defined in "Links to UEFI-Related Documents"(http://uefi.org/uefi) under the heading "IANA Protocol Numbers".

Only TCP or UDP are supported, and other protocol values are invalid. An implementation can choose to support only UDP, or both TCP and UDP.

Definition at line 73 of file Dns4.h.

◆ StationIp

EFI_IPv4_ADDRESS EFI_DNS4_CONFIG_DATA::StationIp

If UseDefaultSetting is FALSE indicates the station address to use.

Definition at line 77 of file Dns4.h.

◆ SubnetMask

EFI_IPv4_ADDRESS EFI_DNS4_CONFIG_DATA::SubnetMask

If UseDefaultSetting is FALSE indicates the subnet mask to use.

Definition at line 81 of file Dns4.h.

◆ LocalPort

UINT16 EFI_DNS4_CONFIG_DATA::LocalPort

Local port number.

Set to zero to use the automatically assigned port number.

Definition at line 85 of file Dns4.h.

◆ RetryCount

UINT32 EFI_DNS4_CONFIG_DATA::RetryCount

Retry number if no response received after RetryInterval.

Definition at line 89 of file Dns4.h.

◆ RetryInterval

UINT32 EFI_DNS4_CONFIG_DATA::RetryInterval

Minimum interval of retry is 2 second.

If the retry interval is less than 2 seconds, then use the 2 seconds.

Definition at line 94 of file Dns4.h.


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