Data Structures
struct	_EFI_HTTP_BOOT_CALLBACK_PROTOCOL

Macros
#define	EFI_HTTP_BOOT_CALLBACK_PROTOCOL_GUID

Typedefs
typedef struct _EFI_HTTP_BOOT_CALLBACK_PROTOCOL	EFI_HTTP_BOOT_CALLBACK_PROTOCOL

typedef EFI_STATUS(EFIAPI *	EFI_HTTP_BOOT_CALLBACK) (IN EFI_HTTP_BOOT_CALLBACK_PROTOCOL This, IN EFI_HTTP_BOOT_CALLBACK_DATA_TYPE DataType, IN BOOLEAN Received, IN UINT32 DataLength, IN VOID Data OPTIONAL)

Enumerations
enum	EFI_HTTP_BOOT_CALLBACK_DATA_TYPE { HttpBootDhcp4 , HttpBootDhcp6 , HttpBootHttpRequest , HttpBootHttpResponse , HttpBootHttpEntityBody , HttpBootHttpAuthInfo , HttpBootTypeMax }

Variables
EFI_GUID	gEfiHttpBootCallbackProtocolGuid

Detailed Description

This file defines the EFI HTTP Boot Callback Protocol interface.

Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:: This Protocol is introduced in UEFI Specification 2.7

Definition in file HttpBootCallback.h.

Macro Definition Documentation

◆ EFI_HTTP_BOOT_CALLBACK_PROTOCOL_GUID

#define EFI_HTTP_BOOT_CALLBACK_PROTOCOL_GUID

Value:

  { \
    0xba23b311, 0x343d, 0x11e6, {0x91, 0x85, 0x58, 0x20, 0xb1, 0xd6, 0x52, 0x99} \
  }

Definition at line 15 of file HttpBootCallback.h.

Typedef Documentation

◆ EFI_HTTP_BOOT_CALLBACK

typedef EFI_STATUS(EFIAPI * EFI_HTTP_BOOT_CALLBACK) (IN EFI_HTTP_BOOT_CALLBACK_PROTOCOL *This, IN EFI_HTTP_BOOT_CALLBACK_DATA_TYPE DataType, IN BOOLEAN Received, IN UINT32 DataLength, IN VOID *Data OPTIONAL)

Callback function that is invoked when the HTTP Boot driver is about to transmit or has received a packet.

This function is invoked when the HTTP Boot driver is about to transmit or has received packet. Parameters DataType and Received specify the type of event and the format of the buffer pointed to by Data. Due to the polling nature of UEFI device drivers, this callback function should not execute for more than 5 ms. The returned status code determines the behavior of the HTTP Boot driver.

Parameters

[in]	This	Pointer to the EFI_HTTP_BOOT_CALLBACK_PROTOCOL instance.
[in]	DataType	The event that occurs in the current state.
[in]	Received	TRUE if the callback is being invoked due to a receive event. FALSE if the callback is being invoked due to a transmit event.
[in]	DataLength	The length in bytes of the buffer pointed to by Data.
[in]	Data	A pointer to the buffer of data, the data type is specified by DataType.

Return values

EFI_SUCCESS	Tells the HTTP Boot driver to continue the HTTP Boot process.
EFI_ABORTED	Tells the HTTP Boot driver to abort the current HTTP Boot process.

Definition at line 78 of file HttpBootCallback.h.

◆ EFI_HTTP_BOOT_CALLBACK_PROTOCOL

typedef struct _EFI_HTTP_BOOT_CALLBACK_PROTOCOL EFI_HTTP_BOOT_CALLBACK_PROTOCOL

Definition at line 20 of file HttpBootCallback.h.

Enumeration Type Documentation

◆ EFI_HTTP_BOOT_CALLBACK_DATA_TYPE

enum EFI_HTTP_BOOT_CALLBACK_DATA_TYPE

EFI_HTTP_BOOT_CALLBACK_DATA_TYPE

Enumerator
HttpBootDhcp4	Data points to a DHCP4 packet which is about to transmit or has received.
HttpBootDhcp6	Data points to a DHCP6 packet which is about to be transmit or has received.
HttpBootHttpRequest	Data points to an EFI_HTTP_MESSAGE structure, which contains a HTTP request message to be transmitted.
HttpBootHttpResponse	Data points to an EFI_HTTP_MESSAGE structure, which contians a received HTTP response message.
HttpBootHttpEntityBody	Part of the entity body has been received from the HTTP server. Data points to the buffer of the entity body data.
HttpBootHttpAuthInfo	Data points to the authentication information to provide to the HTTP server.

Definition at line 25 of file HttpBootCallback.h.

Data Structures

Macros

Typedefs

Enumerations

Variables