_EFI_MTFTP6_TOKEN Struct Reference

Data Fields
EFI_STATUS	Status
EFI_EVENT	Event
EFI_MTFTP6_OVERRIDE_DATA *	OverrideData
UINT8 *	Filename
UINT8 *	ModeStr
UINT32	OptionCount
EFI_MTFTP6_OPTION *	OptionList
UINT64	BufferSize
VOID *	Buffer
VOID *	Context
EFI_MTFTP6_CHECK_PACKET	CheckPacket
EFI_MTFTP6_TIMEOUT_CALLBACK	TimeoutCallback
EFI_MTFTP6_PACKET_NEEDED	PacketNeeded

Field Documentation

VOID* _EFI_MTFTP6_TOKEN::Buffer

Pointer to the data buffer. Data that is downloaded from the MTFTPv6 server is stored here. Data that is uploaded to the MTFTPv6 server is read from here. Ignored if BufferSize is zero.

UINT64 _EFI_MTFTP6_TOKEN::BufferSize

On input, the size, in bytes, of Buffer. On output, the number of bytes transferred.

EFI_MTFTP6_CHECK_PACKET _EFI_MTFTP6_TOKEN::CheckPacket

Pointer to the callback function to check the contents of the received packet.

VOID* _EFI_MTFTP6_TOKEN::Context

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

EFI_EVENT _EFI_MTFTP6_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.

UINT8* _EFI_MTFTP6_TOKEN::Filename

Pointer to the null-terminated ASCII file name string.

UINT8* _EFI_MTFTP6_TOKEN::ModeStr

Pointer to the null-terminated ASCII mode string. If NULL, octet is used.

UINT32 _EFI_MTFTP6_TOKEN::OptionCount

Number of option/value string pairs.

EFI_MTFTP6_OPTION* _EFI_MTFTP6_TOKEN::OptionList

Pointer to an array of option/value string pairs. Ignored if OptionCount is zero. Both a remote server and this driver implementation should support these options. If one or more options are unrecognized by this implementation, it is sent to the remote server without being changed.

EFI_MTFTP6_OVERRIDE_DATA* _EFI_MTFTP6_TOKEN::OverrideData

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

EFI_MTFTP6_PACKET_NEEDED _EFI_MTFTP6_TOKEN::PacketNeeded

Pointer to the function to provide the needed packet contents. Only used in WriteFile() operation.

EFI_STATUS _EFI_MTFTP6_TOKEN::Status

The status that is returned to the caller at the end of the operation to indicate whether this operation completed successfully. Defined Status values are listed below.

EFI_MTFTP6_TIMEOUT_CALLBACK _EFI_MTFTP6_TOKEN::TimeoutCallback

Pointer to the function to be called when a timeout occurs.