iPXE
Data Fields
EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN Struct Reference

#include <Dhcp4.h>

Data Fields

EFI_STATUS Status
 The completion status of transmitting and receiving. More...
 
EFI_EVENT CompletionEvent
 If not NULL, the event that will be signaled when the collection process completes. More...
 
EFI_IPv4_ADDRESS RemoteAddress
 The pointer to the server IP address. More...
 
UINT16 RemotePort
 The server listening port number. More...
 
EFI_IPv4_ADDRESS GatewayAddress
 The pointer to the gateway address to override the existing setting. More...
 
UINT32 ListenPointCount
 The number of entries in ListenPoints. More...
 
EFI_DHCP4_LISTEN_POINTListenPoints
 An array of station address and port number pairs that are used as receiving filters. More...
 
UINT32 TimeoutValue
 The number of seconds to collect responses. More...
 
EFI_DHCP4_PACKETPacket
 The pointer to the packet to be transmitted. More...
 
UINT32 ResponseCount
 Number of received packets. More...
 
EFI_DHCP4_PACKETResponseList
 The pointer to the allocated list of received packets. More...
 

Detailed Description

Definition at line 359 of file Dhcp4.h.

Field Documentation

◆ Status

EFI_STATUS EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN::Status

The completion status of transmitting and receiving.

Definition at line 363 of file Dhcp4.h.

◆ CompletionEvent

EFI_EVENT EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN::CompletionEvent

If not NULL, the event that will be signaled when the collection process completes.

If NULL, this function will busy-wait until the collection process competes.

Definition at line 368 of file Dhcp4.h.

◆ RemoteAddress

EFI_IPv4_ADDRESS EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN::RemoteAddress

The pointer to the server IP address.

This address may be a unicast, multicast, or broadcast address.

Definition at line 372 of file Dhcp4.h.

◆ RemotePort

UINT16 EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN::RemotePort

The server listening port number.

If zero, the default server listening port number (67) will be used.

Definition at line 376 of file Dhcp4.h.

◆ GatewayAddress

EFI_IPv4_ADDRESS EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN::GatewayAddress

The pointer to the gateway address to override the existing setting.

Definition at line 380 of file Dhcp4.h.

◆ ListenPointCount

UINT32 EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN::ListenPointCount

The number of entries in ListenPoints.

If zero, the default station address and port number 68 are used.

Definition at line 384 of file Dhcp4.h.

◆ ListenPoints

EFI_DHCP4_LISTEN_POINT* EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN::ListenPoints

An array of station address and port number pairs that are used as receiving filters.

The first entry is also used as the source address and source port of the outgoing packet.

Definition at line 389 of file Dhcp4.h.

◆ TimeoutValue

UINT32 EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN::TimeoutValue

The number of seconds to collect responses.

Zero is invalid.

Definition at line 393 of file Dhcp4.h.

◆ Packet

EFI_DHCP4_PACKET* EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN::Packet

The pointer to the packet to be transmitted.

Definition at line 397 of file Dhcp4.h.

◆ ResponseCount

UINT32 EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN::ResponseCount

Number of received packets.

Definition at line 401 of file Dhcp4.h.

◆ ResponseList

EFI_DHCP4_PACKET* EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN::ResponseList

The pointer to the allocated list of received packets.

Definition at line 405 of file Dhcp4.h.


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