MdePkg/Include/Protocol/HttpUtilities.h File Reference


Data Structures

struct  _EFI_HTTP_UTILITIES_PROTOCOL

Defines

#define EFI_HTTP_UTILITIES_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_HTTP_UTILITIES_PROTOCOL 
EFI_HTTP_UTILITIES_PROTOCOL
typedef IN UINTN SeedMessageSize
typedef IN UINTN IN VOID * SeedMessage
typedef IN UINTN IN VOID IN UINTN DeleteCount
typedef IN UINTN IN VOID IN
UINTN IN CHAR8
DeleteList []
typedef IN UINTN IN VOID IN
UINTN IN CHAR8 IN UINTN 
AppendCount
typedef IN UINTN IN VOID IN
UINTN IN CHAR8 IN UINTN IN
EFI_HTTP_HEADER
AppendList []
typedef IN UINTN IN VOID IN
UINTN IN CHAR8 IN UINTN IN
EFI_HTTP_HEADER OUT UINTN * 
NewMessageSize
typedef IN UINTN IN VOID IN
UINTN IN CHAR8 IN UINTN IN
EFI_HTTP_HEADER OUT UINTN OUT
VOID ** 
NewMessage
typedef IN CHAR8HttpMessage
typedef IN CHAR8 IN UINTN HttpMessageSize
typedef IN CHAR8 IN UINTN OUT
EFI_HTTP_HEADER ** 
HeaderFields
typedef IN CHAR8 IN UINTN OUT
EFI_HTTP_HEADER OUT UINTN * 
FieldCount

Functions

typedef EFI_STATUS (EFIAPI *EFI_HTTP_UTILS_BUILD)(IN EFI_HTTP_UTILITIES_PROTOCOL *This

Variables

EFI_GUID gEfiHttpUtilitiesProtocolGuid

Detailed Description

EFI HTTP Utilities protocol provides a platform independent abstraction for HTTP message comprehension.

Copyright (c) 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:
This Protocol is introduced in UEFI Specification 2.5

Define Documentation

#define EFI_HTTP_UTILITIES_PROTOCOL_GUID

Value:

{ \
    0x3e35c163, 0x4074, 0x45dd, {0x43, 0x1e, 0x23, 0x98, 0x9d, 0xd8, 0x6b, 0x32 } \
  }


Typedef Documentation

typedef IN UINTN IN VOID IN UINTN IN CHAR8 IN UINTN AppendCount

typedef IN UINTN IN VOID IN UINTN IN CHAR8 IN UINTN IN EFI_HTTP_HEADER* AppendList[]

typedef IN UINTN IN VOID IN UINTN DeleteCount

typedef IN UINTN IN VOID IN UINTN IN CHAR8* DeleteList[]

typedef IN CHAR8 IN UINTN OUT EFI_HTTP_HEADER OUT UINTN* FieldCount

typedef IN CHAR8 IN UINTN OUT EFI_HTTP_HEADER** HeaderFields

typedef IN CHAR8* HttpMessage

typedef IN CHAR8 IN UINTN HttpMessageSize

typedef IN UINTN IN VOID IN UINTN IN CHAR8 IN UINTN IN EFI_HTTP_HEADER OUT UINTN OUT VOID** NewMessage

typedef IN UINTN IN VOID IN UINTN IN CHAR8 IN UINTN IN EFI_HTTP_HEADER OUT UINTN* NewMessageSize

typedef IN UINTN IN VOID* SeedMessage

typedef IN UINTN SeedMessageSize


Function Documentation

typedef EFI_STATUS ( EFIAPI EFI_HTTP_UTILS_PARSE  ) 

Create HTTP header based on a combination of seed header, fields to delete, and fields to append.

The Build() function is used to manage the headers portion of an HTTP message by providing the ability to add, remove, or replace HTTP headers.

Parameters:
[in] This Pointer to EFI_HTTP_UTILITIES_PROTOCOL instance.
[in] SeedMessageSize Size of the initial HTTP header. This can be zero.
[in] SeedMessage Initial HTTP header to be used as a base for building a new HTTP header. If NULL, SeedMessageSize is ignored.
[in] DeleteCount Number of null-terminated HTTP header field names in DeleteList.
[in] DeleteList List of null-terminated HTTP header field names to remove from SeedMessage. Only the field names are in this list because the field values are irrelevant to this operation.
[in] AppendCount Number of header fields in AppendList.
[in] AppendList List of HTTP headers to populate NewMessage with. If SeedMessage is not NULL, AppendList will be appended to the existing list from SeedMessage in NewMessage.
[out] NewMessageSize Pointer to number of header fields in NewMessage.
[out] NewMessage Pointer to a new list of HTTP headers based on.
Return values:
EFI_SUCCESS Add, remove, and replace operations succeeded.
EFI_OUT_OF_RESOURCES Could not allocate memory for NewMessage.
EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: This is NULL.
Parses HTTP header and produces an array of key/value pairs.

The Parse() function is used to transform data stored in HttpHeader into a list of fields paired with their corresponding values.

Parameters:
[in] This Pointer to EFI_HTTP_UTILITIES_PROTOCOL instance.
[in] HttpMessage Contains raw unformatted HTTP header string.
[in] HttpMessageSize Size of HTTP header.
[out] HeaderFields Array of key/value header pairs.
[out] FieldCount Number of headers in HeaderFields.
Return values:
EFI_SUCCESS Allocation succeeded.
EFI_NOT_STARTED This EFI HTTP Protocol instance has not been initialized.
EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: This is NULL. HttpMessage is NULL. HeaderFields is NULL. FieldCount is NULL.


Variable Documentation


Generated on Thu Sep 24 23:14:20 2015 for MdePkg[ALL] by  doxygen 1.5.7.1