iPXE
Data Fields
EFI_HTTP_MESSAGE Struct Reference

EFI_HTTP_MESSAGE. More...

#include <Http.h>

Data Fields

union {
   EFI_HTTP_REQUEST_DATA *   Request
 When the token is used to send a HTTP request, Request is a pointer to storage that contains such data as URL and HTTP method. More...
 
   EFI_HTTP_RESPONSE_DATA *   Response
 When used to await a response, Response points to storage containing HTTP response status code. More...
 
Data
 HTTP message data. More...
 
UINTN HeaderCount
 Number of HTTP header structures in Headers list. More...
 
EFI_HTTP_HEADERHeaders
 Array containing list of HTTP headers. More...
 
UINTN BodyLength
 Length in bytes of the HTTP body. More...
 
VOIDBody
 Body associated with the HTTP request or response. More...
 

Detailed Description

EFI_HTTP_MESSAGE.

Definition at line 227 of file Http.h.

Field Documentation

◆ Request

EFI_HTTP_REQUEST_DATA* EFI_HTTP_MESSAGE::Request

When the token is used to send a HTTP request, Request is a pointer to storage that contains such data as URL and HTTP method.

Definition at line 236 of file Http.h.

◆ Response

EFI_HTTP_RESPONSE_DATA* EFI_HTTP_MESSAGE::Response

When used to await a response, Response points to storage containing HTTP response status code.

Definition at line 241 of file Http.h.

◆ Data

union { ... } EFI_HTTP_MESSAGE::Data

HTTP message data.

◆ HeaderCount

UINTN EFI_HTTP_MESSAGE::HeaderCount

Number of HTTP header structures in Headers list.

On request, this count is provided by the caller. On response, this count is provided by the HTTP driver.

Definition at line 247 of file Http.h.

◆ Headers

EFI_HTTP_HEADER* EFI_HTTP_MESSAGE::Headers

Array containing list of HTTP headers.

On request, this array is populated by the caller. On response, this array is allocated and populated by the HTTP driver. It is the responsibility of the caller to free this memory on both request and response.

Definition at line 254 of file Http.h.

◆ BodyLength

UINTN EFI_HTTP_MESSAGE::BodyLength

Length in bytes of the HTTP body.

This can be zero depending on the HttpMethod type.

Definition at line 258 of file Http.h.

◆ Body

VOID* EFI_HTTP_MESSAGE::Body

Body associated with the HTTP request or response.

This can be NULL depending on the HttpMethod type.

Definition at line 263 of file Http.h.


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