HttpCallback.h File Reference

Go to the source code of this file.

Data Structures
struct	_EDKII_HTTP_CALLBACK_PROTOCOL

Macros
#define	EDKII_HTTP_CALLBACK_PROTOCOL_GUID

Typedefs
typedef struct _EDKII_HTTP_CALLBACK_PROTOCOL	EDKII_HTTP_CALLBACK_PROTOCOL
typedef VOID(EFIAPI *	EDKII_HTTP_CALLBACK) (IN EDKII_HTTP_CALLBACK_PROTOCOL *This, IN EDKII_HTTP_CALLBACK_EVENT Event, IN EFI_STATUS EventStatus)

Enumerations
enum	EDKII_HTTP_CALLBACK_EVENT {   HttpEventDns , HttpEventConnectTcp , HttpEventTlsConnectSession , HttpEventInitSession ,   HttpEventTlsConfigured }

Variables
EFI_GUID	gEdkiiHttpCallbackProtocolGuid

Detailed Description

This file defines the EDKII HTTP Callback Protocol interface.

Copyright (c) 2021, Intel Corporation. All rights reserved.
Copyright (C) 2024 Advanced Micro Devices, Inc. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file HttpCallback.h.

Macro Definition Documentation

EDKII_HTTP_CALLBACK_PROTOCOL_GUID

#define EDKII_HTTP_CALLBACK_PROTOCOL_GUID

Value:

  { \
    0x611114f1, 0xa37b, 0x4468, {0xa4, 0x36, 0x5b, 0xdd, 0xa1, 0x6a, 0xa2, 0x40} \
  }

Definition at line 12 of file HttpCallback.h.

Typedef Documentation

EDKII_HTTP_CALLBACK

typedef VOID(EFIAPI * EDKII_HTTP_CALLBACK) (IN EDKII_HTTP_CALLBACK_PROTOCOL *This, IN EDKII_HTTP_CALLBACK_EVENT Event, IN EFI_STATUS EventStatus)

Callback function that is invoked when HTTP event occurs.

Parameters

[in]	This	Pointer to the EDKII_HTTP_CALLBACK_PROTOCOL instance.
[in]	Event	The event that occurs in the current state.
[in]	EventStatus	The Status of Event, EFI_SUCCESS or other errors.

Definition at line 81 of file HttpCallback.h.

EDKII_HTTP_CALLBACK_PROTOCOL

typedef struct _EDKII_HTTP_CALLBACK_PROTOCOL EDKII_HTTP_CALLBACK_PROTOCOL

Definition at line 17 of file HttpCallback.h.

Enumeration Type Documentation

EDKII_HTTP_CALLBACK_EVENT

enum EDKII_HTTP_CALLBACK_EVENT

EDKII_HTTP_CALLBACK_EVENT

Enumerator
HttpEventDns	The Status of DNS Event to retrieve the host address. EventStatus: EFI_SUCCESS Operation succeeded. EFI_OUT_OF_RESOURCES Failed to allocate needed resources. EFI_DEVICE_ERROR An unexpected network error occurred. Others Other errors as indicated.
HttpEventConnectTcp	The Status of Event to initiate a nonblocking TCP connection request. EventStatus: EFI_SUCCESS The connection request is successfully initiated. EFI_NOT_STARTED This EFI TCP Protocol instance has not been configured. EFI_DEVICE_ERROR An unexpected system or network error occurred. Others Other errors as indicated.
HttpEventTlsConnectSession	The Status of Event to connect one TLS session by finishing the TLS handshake process. EventStatus: EFI_SUCCESS The TLS session is established. EFI_OUT_OF_RESOURCES Can't allocate memory resources. EFI_ABORTED TLS session state is incorrect. Others Other error as indicated.
HttpEventInitSession	The Status of Event to initialize Http session EventStatus: EFI_SUCCESS The initialization of session is done. Others Other error as indicated.
HttpEventTlsConfigured	The Status of Event to configure TLS configuration data. EventStatus: EFI_SUCCESS The TLS is configured successfully with the default value. EFI_INVALID_PARAMETER One or more input parameters to SetSessionData() is invalid. EFI_NOT_READY Current TLS session state is NOT EfiTlsSessionStateNotStarted. EFI_NOT_FOUND Fail to get 'HttpTlsCipherList' variable. Others Other error as indicated.

Definition at line 22 of file HttpCallback.h.