TianoCore EDK2 master
Loading...
Searching...
No Matches
Data Fields
_EFI_MTFTP4_TOKEN Struct Reference

Data Fields

EFI_STATUS Status
 
EFI_EVENT Event
 
EFI_MTFTP4_OVERRIDE_DATA * OverrideData
 
UINT8 * Filename
 
UINT8 * ModeStr
 
UINT32 OptionCount
 
EFI_MTFTP4_OPTION * OptionList
 
UINT64 BufferSize
 
VOID * Buffer
 
VOID * Context
 
EFI_MTFTP4_CHECK_PACKET CheckPacket
 
EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback
 
EFI_MTFTP4_PACKET_NEEDED PacketNeeded
 

Detailed Description

Definition at line 510 of file Mtftp4.h.

Field Documentation

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

◆ BufferSize

UINT64 _EFI_MTFTP4_TOKEN::BufferSize

The size of the data buffer.

Definition at line 547 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 562 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 558 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 523 of file Mtftp4.h.

◆ Filename

UINT8* _EFI_MTFTP4_TOKEN::Filename

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

Definition at line 531 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 535 of file Mtftp4.h.

◆ OptionCount

UINT32 _EFI_MTFTP4_TOKEN::OptionCount

Number of option/value string pairs.

Definition at line 539 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 543 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 527 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 570 of file Mtftp4.h.

◆ 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 515 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 566 of file Mtftp4.h.

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