iPXE
Data Fields
_EFI_MTFTP4_TOKEN Struct Reference

#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.
EFI_EVENT Event
 The event that will be signaled when the operation completes.
EFI_MTFTP4_OVERRIDE_DATAOverrideData
 If not NULL, the data that will be used to override the existing configure data.
UINT8Filename
 The pointer to the null-terminated ASCII file name string.
UINT8ModeStr
 The pointer to the null-terminated ASCII mode string.
UINT32 OptionCount
 Number of option/value string pairs.
EFI_MTFTP4_OPTIONOptionList
 The pointer to an array of option/value string pairs.
UINT64 BufferSize
 The size of the data buffer.
VOIDBuffer
 The pointer to the data buffer.
VOIDContext
 The pointer to the context that will be used by CheckPacket, TimeoutCallback and PacketNeeded.
EFI_MTFTP4_CHECK_PACKET CheckPacket
 The pointer to the callback function to check the contents of the received packet.
EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback
 The pointer to the function to be called when a timeout occurs.
EFI_MTFTP4_PACKET_NEEDED PacketNeeded
 The pointer to the function to provide the needed packet contents.

Detailed Description

Definition at line 528 of file Mtftp4.h.


Field Documentation

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

Definition at line 533 of file Mtftp4.h.

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 541 of file Mtftp4.h.

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

Definition at line 545 of file Mtftp4.h.

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

Definition at line 549 of file Mtftp4.h.

The pointer to the null-terminated ASCII mode string.

If NULL, "octet" is used.

Definition at line 553 of file Mtftp4.h.

Number of option/value string pairs.

Definition at line 557 of file Mtftp4.h.

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

Ignored if OptionCount is zero.

Definition at line 561 of file Mtftp4.h.

The size of the data buffer.

Definition at line 565 of file Mtftp4.h.

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 571 of file Mtftp4.h.

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

Definition at line 576 of file Mtftp4.h.

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

Definition at line 580 of file Mtftp4.h.

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

Definition at line 584 of file Mtftp4.h.

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

Definition at line 588 of file Mtftp4.h.


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