EFI_UDP6_COMPLETION_TOKEN Struct Reference

Data Fields
EFI_EVENT	Event
EFI_STATUS	Status
union {
EFI_UDP6_RECEIVE_DATA *   RxData
EFI_UDP6_TRANSMIT_DATA *   TxData
}	Packet

Detailed Description

The EFI_UDP6_COMPLETION_TOKEN structures are used for both transmit and receive operations. When used for transmitting, the Event and TxData fields must be filled in by the EFI UDPv6 Protocol client. After the transmit operation completes, the Status field is updated by the EFI UDPv6 Protocol and the Event is signaled. When used for receiving, only the Event field must be filled in by the EFI UDPv6 Protocol client. After a packet is received, RxData and Status are filled in by the EFI UDPv6 Protocol and the Event is signaled.

Field Documentation

EFI_EVENT EFI_UDP6_COMPLETION_TOKEN::Event

This Event will be signaled after the Status field is updated by the EFI UDPv6 Protocol driver. The type of Event must be EVT_NOTIFY_SIGNAL.

union { ... } EFI_UDP6_COMPLETION_TOKEN::Packet

EFI_UDP6_RECEIVE_DATA* EFI_UDP6_COMPLETION_TOKEN::RxData

When this token is used for receiving, RxData is a pointer to EFI_UDP6_RECEIVE_DATA.

EFI_STATUS EFI_UDP6_COMPLETION_TOKEN::Status

Will be set to one of the following values:

• EFI_SUCCESS: The receive or transmit operation completed successfully.
• EFI_ABORTED: The receive or transmit was aborted.
• EFI_TIMEOUT: The transmit timeout expired.
• EFI_NETWORK_UNREACHABLE: The destination network is unreachable. RxData is set to NULL in this situation.
• EFI_HOST_UNREACHABLE: The destination host is unreachable. RxData is set to NULL in this situation.
• EFI_PROTOCOL_UNREACHABLE: The UDP protocol is unsupported in the remote system. RxData is set to NULL in this situation.
• EFI_PORT_UNREACHABLE: No service is listening on the remote port. RxData is set to NULL in this situation.
• EFI_ICMP_ERROR: Some other Internet Control Message Protocol (ICMP) error report was received. For example, packets are being sent too fast for the destination to receive them and the destination sent an ICMP source quench report. RxData is set to NULL in this situation.
• EFI_DEVICE_ERROR: An unexpected system or network error occurred.
• EFI_SECURITY_VIOLATION: The transmit or receive was failed because of IPsec policy check.
• EFI_NO_MEDIA: There was a media error.

EFI_UDP6_TRANSMIT_DATA* EFI_UDP6_COMPLETION_TOKEN::TxData

When this token is used for transmitting, TxData is a pointer to EFI_UDP6_TRANSMIT_DATA.