_EFI_FTP4_COMMAND_TOKEN Struct Reference

Data Fields
EFI_EVENT	Event
UINT8 *	Pathname
UINT64	DataBufferSize
VOID *	DataBuffer
EFI_FTP4_DATA_CALLBACK	DataCallback
VOID *	Context
EFI_STATUS	Status

Detailed Description

EFI_FTP4_COMMAND_TOKEN

Field Documentation

VOID* _EFI_FTP4_COMMAND_TOKEN::Context

Pointer to the parameter for DataCallback.

VOID* _EFI_FTP4_COMMAND_TOKEN::DataBuffer

Pointer to the data buffer. Data downloaded from FTP server through connection is downloaded here.

UINT64 _EFI_FTP4_COMMAND_TOKEN::DataBufferSize

The size of data buffer in bytes.

EFI_FTP4_DATA_CALLBACK _EFI_FTP4_COMMAND_TOKEN::DataCallback

Pointer to a callback function. If it is receiving function that leads to inbound data, the callback function is called when databuffer is full. Then, old data in the data buffer should be flushed and new data is stored from the beginning of data buffer. If it is a transmit function that lead to outbound data and DataBufferSize of Data in DataBuffer has been transmitted, this callback function is called to supply additional data to be transmitted. The size of additional data to be transmitted is indicated in DataBufferSize, again. If there is no data remained, DataBufferSize should be set to 0.

EFI_EVENT _EFI_FTP4_COMMAND_TOKEN::Event

The Event to signal after request is finished and Status field is updated by the EFI FTP v4 Protocol driver. The type of Event must be EVT_NOTIFY_SIGNAL, and its Task Priority Level (TPL) must be lower than or equal to TPL_CALLBACK. If it is set to NULL, related function must wait until the function completes.

UINT8* _EFI_FTP4_COMMAND_TOKEN::Pathname

Pointer to a null-terminated ASCII name string.

EFI_STATUS _EFI_FTP4_COMMAND_TOKEN::Status

The variable to receive the result of the completed operation. EFI_SUCCESS: The FTP command is completed successfully. EFI_ACCESS_DENIED: The FTP server denied the access to the requested file. EFI_CONNECTION_RESET: The connect fails because the connection is reset either by instance itself or communication peer. EFI_TIMEOUT: The connection establishment timer expired and no more specific information is available. EFI_NETWORK_UNREACHABLE: The active open fails because an ICMP network unreachable error is received. EFI_HOST_UNREACHABLE: The active open fails because an ICMP host unreachable error is received. EFI_PROTOCOL_UNREACHABLE: The active open fails because an ICMP protocol unreachable error is received. EFI_PORT_UNREACHABLE: The connection establishment timer times out and an ICMP port unreachable error is received. EFI_ICMP_ERROR: The connection establishment timer timeout and some other ICMP error is received. EFI_DEVICE_ERROR: An unexpected system or network error occurred.