#include <Mtftp4.h>

Data Fields
EFI_STATUS	Status
	The status that is returned to the caller at the end of the operation to indicate whether this operation completed successfully. More...

EFI_EVENT	Event
	The event that will be signaled when the operation completes. More...

EFI_MTFTP4_OVERRIDE_DATA *	OverrideData
	If not NULL, the data that will be used to override the existing configure data. More...

UINT8 *	Filename
	The pointer to the null-terminated ASCII file name string. More...

UINT8 *	ModeStr
	The pointer to the null-terminated ASCII mode string. More...

UINT32	OptionCount
	Number of option/value string pairs. More...

EFI_MTFTP4_OPTION *	OptionList
	The pointer to an array of option/value string pairs. More...

UINT64	BufferSize
	The size of the data buffer. More...

VOID *	Buffer
	The pointer to the data buffer. More...

VOID *	Context
	The pointer to the context that will be used by CheckPacket, TimeoutCallback and PacketNeeded. More...

EFI_MTFTP4_CHECK_PACKET	CheckPacket
	The pointer to the callback function to check the contents of the received packet. More...

EFI_MTFTP4_TIMEOUT_CALLBACK	TimeoutCallback
	The pointer to the function to be called when a timeout occurs. More...

EFI_MTFTP4_PACKET_NEEDED	PacketNeeded
	The pointer to the function to provide the needed packet contents. More...

Detailed Description

Definition at line 512 of file Mtftp4.h.

Field Documentation

◆ Status

EFI_STATUS _EFI_MTFTP4_TOKEN::Status

The status that is returned to the caller at the end of the operation to indicate whether this operation completed successfully.

Definition at line 517 of file Mtftp4.h.

◆ Event

EFI_EVENT _EFI_MTFTP4_TOKEN::Event

The event that will be signaled when the operation completes.

If set to NULL, the corresponding function will wait until the read or write operation finishes. The type of Event must be EVT_NOTIFY_SIGNAL. The Task Priority Level (TPL) of Event must be lower than or equal to TPL_CALLBACK.

Definition at line 525 of file Mtftp4.h.

◆ OverrideData

EFI_MTFTP4_OVERRIDE_DATA* _EFI_MTFTP4_TOKEN::OverrideData

If not NULL, the data that will be used to override the existing configure data.

Definition at line 529 of file Mtftp4.h.

◆ Filename

UINT8* _EFI_MTFTP4_TOKEN::Filename

The pointer to the null-terminated ASCII file name string.

Definition at line 533 of file Mtftp4.h.

◆ ModeStr

UINT8* _EFI_MTFTP4_TOKEN::ModeStr

The pointer to the null-terminated ASCII mode string.

If NULL, "octet" is used.

Definition at line 537 of file Mtftp4.h.

◆ OptionCount

UINT32 _EFI_MTFTP4_TOKEN::OptionCount

Number of option/value string pairs.

Definition at line 541 of file Mtftp4.h.

◆ OptionList

EFI_MTFTP4_OPTION* _EFI_MTFTP4_TOKEN::OptionList

The pointer to an array of option/value string pairs.

Ignored if OptionCount is zero.

Definition at line 545 of file Mtftp4.h.

◆ BufferSize

UINT64 _EFI_MTFTP4_TOKEN::BufferSize

The size of the data buffer.

Definition at line 549 of file Mtftp4.h.

◆ Buffer

VOID* _EFI_MTFTP4_TOKEN::Buffer

The pointer to the data buffer.

Data that is downloaded from the MTFTPv4 server is stored here. Data that is uploaded to the MTFTPv4 server is read from here. Ignored if BufferSize is zero.

Definition at line 555 of file Mtftp4.h.

◆ Context

VOID* _EFI_MTFTP4_TOKEN::Context

The pointer to the context that will be used by CheckPacket, TimeoutCallback and PacketNeeded.

Definition at line 560 of file Mtftp4.h.

◆ CheckPacket

EFI_MTFTP4_CHECK_PACKET _EFI_MTFTP4_TOKEN::CheckPacket

The pointer to the callback function to check the contents of the received packet.

Definition at line 564 of file Mtftp4.h.

◆ TimeoutCallback

EFI_MTFTP4_TIMEOUT_CALLBACK _EFI_MTFTP4_TOKEN::TimeoutCallback

The pointer to the function to be called when a timeout occurs.

Definition at line 568 of file Mtftp4.h.

◆ PacketNeeded

EFI_MTFTP4_PACKET_NEEDED _EFI_MTFTP4_TOKEN::PacketNeeded

The pointer to the function to provide the needed packet contents.

Definition at line 572 of file Mtftp4.h.

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

include/ipxe/efi/Protocol/Mtftp4.h

Data Fields