iPXE
EFI_DNS4_COMPLETION_TOKEN Struct Reference

EFI_DNS4_COMPLETION_TOKEN. More...

#include <Dns4.h>

Data Fields

EFI_EVENT Event
 This Event will be signaled after the Status field is updated by the EFI DNS protocol driver.
EFI_STATUS Status
 Will be set to one of the following values: EFI_SUCCESS: The host name to address translation completed successfully.
UINT32 RetryCount
 Retry number if no response received after RetryInterval.
UINT32 RetryInterval
 Minimum interval of retry is 2 second.
union { 
   DNS_HOST_TO_ADDR_DATA *   H2AData 
 When the Token is used for host name to address translation, H2AData is a pointer to the DNS_HOST_TO_ADDR_DATA. More...
   DNS_ADDR_TO_HOST_DATA *   A2HData 
 When the Token is used for host address to host name translation, A2HData is a pointer to the DNS_ADDR_TO_HOST_DATA. More...
   DNS_GENERAL_LOOKUP_DATA *   GLookupData 
 When the Token is used for a general lookup function, GLookupDATA is a pointer to the DNS_GENERAL_LOOKUP_DATA. More...
RspData
 DNSv4 completion token data.

Detailed Description

EFI_DNS4_COMPLETION_TOKEN.

Definition at line 229 of file Dns4.h.

Field Documentation

◆ Event

EFI_EVENT EFI_DNS4_COMPLETION_TOKEN::Event

This Event will be signaled after the Status field is updated by the EFI DNS protocol driver.

The type of Event must be EFI_NOTIFY_SIGNAL.

Definition at line 234 of file Dns4.h.

◆ Status

EFI_STATUS EFI_DNS4_COMPLETION_TOKEN::Status

Will be set to one of the following values: EFI_SUCCESS: The host name to address translation completed successfully.

EFI_NOT_FOUND: No matching Resource Record (RR) is found. EFI_TIMEOUT: No DNS server reachable, or RetryCount was exhausted without response from all specified DNS servers. EFI_DEVICE_ERROR: An unexpected system or network error occurred. EFI_NO_MEDIA: There was a media error.

Definition at line 244 of file Dns4.h.

◆ RetryCount

UINT32 EFI_DNS4_COMPLETION_TOKEN::RetryCount

Retry number if no response received after RetryInterval.

If zero, use the parameter configured through Dns.Configure() interface.

Definition at line 249 of file Dns4.h.

◆ RetryInterval

UINT32 EFI_DNS4_COMPLETION_TOKEN::RetryInterval

Minimum interval of retry is 2 second.

If the retry interval is less than 2 seconds, then use the 2 seconds. If zero, use the parameter configured through Dns.Configure() interface.

Definition at line 254 of file Dns4.h.

◆ H2AData

DNS_HOST_TO_ADDR_DATA* EFI_DNS4_COMPLETION_TOKEN::H2AData

When the Token is used for host name to address translation, H2AData is a pointer to the DNS_HOST_TO_ADDR_DATA.

Definition at line 263 of file Dns4.h.

◆ A2HData

DNS_ADDR_TO_HOST_DATA* EFI_DNS4_COMPLETION_TOKEN::A2HData

When the Token is used for host address to host name translation, A2HData is a pointer to the DNS_ADDR_TO_HOST_DATA.

Definition at line 268 of file Dns4.h.

◆ GLookupData

DNS_GENERAL_LOOKUP_DATA* EFI_DNS4_COMPLETION_TOKEN::GLookupData

When the Token is used for a general lookup function, GLookupDATA is a pointer to the DNS_GENERAL_LOOKUP_DATA.

Definition at line 273 of file Dns4.h.

◆ [union]

union { ... } EFI_DNS4_COMPLETION_TOKEN::RspData

DNSv4 completion token data.


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