iPXE
Data Fields
EFI_UDP6_CONFIG_DATA Struct Reference

#include <Udp6.h>

Data Fields

BOOLEAN AcceptPromiscuous
 Set to TRUE to accept UDP packets that are sent to any address. More...
 
BOOLEAN AcceptAnyPort
 Set to TRUE to accept UDP packets that are sent to any port. More...
 
BOOLEAN AllowDuplicatePort
 Set to TRUE to allow this EFI UDPv6 Protocol child instance to open a port number that is already being used by another EFI UDPv6 Protocol child instance. More...
 
UINT8 TrafficClass
 TrafficClass field in transmitted IPv6 packets. More...
 
UINT8 HopLimit
 HopLimit field in transmitted IPv6 packets. More...
 
UINT32 ReceiveTimeout
 The receive timeout value (number of microseconds) to be associated with each incoming packet. More...
 
UINT32 TransmitTimeout
 The transmit timeout value (number of microseconds) to be associated with each outgoing packet. More...
 
EFI_IPv6_ADDRESS StationAddress
 The station IP address that will be assigned to this EFI UDPv6 Protocol instance. More...
 
UINT16 StationPort
 The port number to which this EFI UDPv6 Protocol instance is bound. More...
 
EFI_IPv6_ADDRESS RemoteAddress
 The IP address of remote host to which this EFI UDPv6 Protocol instance is connecting. More...
 
UINT16 RemotePort
 The port number of the remote host to which this EFI UDPv6 Protocol instance is connecting. More...
 

Detailed Description

Definition at line 120 of file Udp6.h.

Field Documentation

◆ AcceptPromiscuous

BOOLEAN EFI_UDP6_CONFIG_DATA::AcceptPromiscuous

Set to TRUE to accept UDP packets that are sent to any address.

Definition at line 124 of file Udp6.h.

◆ AcceptAnyPort

BOOLEAN EFI_UDP6_CONFIG_DATA::AcceptAnyPort

Set to TRUE to accept UDP packets that are sent to any port.

Definition at line 128 of file Udp6.h.

◆ AllowDuplicatePort

BOOLEAN EFI_UDP6_CONFIG_DATA::AllowDuplicatePort

Set to TRUE to allow this EFI UDPv6 Protocol child instance to open a port number that is already being used by another EFI UDPv6 Protocol child instance.

Definition at line 133 of file Udp6.h.

◆ TrafficClass

UINT8 EFI_UDP6_CONFIG_DATA::TrafficClass

TrafficClass field in transmitted IPv6 packets.

Definition at line 137 of file Udp6.h.

◆ HopLimit

UINT8 EFI_UDP6_CONFIG_DATA::HopLimit

HopLimit field in transmitted IPv6 packets.

Definition at line 141 of file Udp6.h.

◆ ReceiveTimeout

UINT32 EFI_UDP6_CONFIG_DATA::ReceiveTimeout

The receive timeout value (number of microseconds) to be associated with each incoming packet.

Zero means do not drop incoming packets.

Definition at line 146 of file Udp6.h.

◆ TransmitTimeout

UINT32 EFI_UDP6_CONFIG_DATA::TransmitTimeout

The transmit timeout value (number of microseconds) to be associated with each outgoing packet.

Zero means do not drop outgoing packets.

Definition at line 151 of file Udp6.h.

◆ StationAddress

EFI_IPv6_ADDRESS EFI_UDP6_CONFIG_DATA::StationAddress

The station IP address that will be assigned to this EFI UDPv6 Protocol instance.

The EFI UDPv6 and EFI IPv6 Protocol drivers will only deliver incoming packets whose destination matches this IP address exactly. Address 0::/128 is also accepted as a special case. Under this situation, underlying IPv6 driver is responsible for binding a source address to this EFI IPv6 protocol instance according to source address selection algorithm. Only incoming packet from the selected source address is delivered. This field can be set and changed only when the EFI IPv6 driver is transitioning from the stopped to the started states. If no address is available for selecting, the EFI IPv6 Protocol driver will use EFI_IP6_CONFIG_PROTOCOL to retrieve the IPv6 address.

Definition at line 163 of file Udp6.h.

◆ StationPort

UINT16 EFI_UDP6_CONFIG_DATA::StationPort

The port number to which this EFI UDPv6 Protocol instance is bound.

If a client of the EFI UDPv6 Protocol does not care about the port number, set StationPort to zero. The EFI UDPv6 Protocol driver will assign a random port number to transmitted UDP packets. Ignored it if AcceptAnyPort is TRUE.

Definition at line 170 of file Udp6.h.

◆ RemoteAddress

EFI_IPv6_ADDRESS EFI_UDP6_CONFIG_DATA::RemoteAddress

The IP address of remote host to which this EFI UDPv6 Protocol instance is connecting.

If RemoteAddress is not 0::/128, this EFI UDPv6 Protocol instance will be connected to RemoteAddress; i.e., outgoing packets of this EFI UDPv6 Protocol instance will be sent to this address by default and only incoming packets from this address will be delivered to client. Ignored for incoming filtering if AcceptPromiscuous is TRUE.

Definition at line 177 of file Udp6.h.

◆ RemotePort

UINT16 EFI_UDP6_CONFIG_DATA::RemotePort

The port number of the remote host to which this EFI UDPv6 Protocol instance is connecting.

If it is not zero, outgoing packets of this EFI UDPv6 Protocol instance will be sent to this port number by default and only incoming packets from this port will be delivered to client. Ignored if RemoteAddress is 0::/128 and ignored for incoming filtering if AcceptPromiscuous is TRUE.

Definition at line 184 of file Udp6.h.


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