NetworkPkg[all]  0.98
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
HttpCallback.h File Reference

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 IN
EDKII_HTTP_CALLBACK_EVENT 
Event
 
typedef IN
EDKII_HTTP_CALLBACK_EVENT IN
EFI_STATUS 
EventStatus
 

Enumerations

enum  EDKII_HTTP_CALLBACK_EVENT { HttpEventDns, HttpEventConnectTcp, HttpEventTlsConnectSession, HttpEventInitSession }
 

Functions

typedef VOID (EFIAPI *EDKII_HTTP_CALLBACK)(IN EDKII_HTTP_CALLBACK_PROTOCOL *This
 

Variables

EFI_GUID gEdkiiHttpCallbackProtocolGuid
 

Detailed Description

This file defines the EDKII HTTP Callback Protocol interface.

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

Macro Definition Documentation

#define EDKII_HTTP_CALLBACK_PROTOCOL_GUID
Value:
{ \
0x611114f1, 0xa37b, 0x4468, {0xa4, 0x36, 0x5b, 0xdd, 0xa1, 0x6a, 0xa2, 0x40} \
}

Typedef Documentation

Enumeration Type Documentation

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.

Function Documentation

typedef VOID ( EFIAPI *  EDKII_HTTP_CALLBACK)

Callback function that is invoked when HTTP event occurs.

Parameters
[in]ThisPointer to the EDKII_HTTP_CALLBACK_PROTOCOL instance.
[in]EventThe event that occurs in the current state.
[in]EventStatusThe Status of Event, EFI_SUCCESS or other errors.

Variable Documentation

EFI_GUID gEdkiiHttpCallbackProtocolGuid