Rest.h File Reference

#include <Protocol/Http.h>

Go to the source code of this file.

Data Structures
struct	_EFI_REST_PROTOCOL

Macros
#define	EFI_REST_PROTOCOL_GUID

Typedefs
typedef struct _EFI_REST_PROTOCOL	EFI_REST_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_REST_SEND_RECEIVE) (IN EFI_REST_PROTOCOL *This, IN EFI_HTTP_MESSAGE *RequestMessage, OUT EFI_HTTP_MESSAGE *ResponseMessage)
typedef EFI_STATUS(EFIAPI *	EFI_REST_GET_TIME) (IN EFI_REST_PROTOCOL *This, OUT EFI_TIME *Time)

Variables
EFI_GUID	gEfiRestProtocolGuid

Detailed Description

This file defines the EFI REST Protocol interface.

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

Revision Reference:

This Protocol is introduced in UEFI Specification 2.5

Definition in file Rest.h.

Macro Definition Documentation

EFI_REST_PROTOCOL_GUID

#define EFI_REST_PROTOCOL_GUID

Value:

  { \
    0x0db48a36, 0x4e54, 0xea9c, {0x9b, 0x09, 0x1e, 0xa5, 0xbe, 0x3a, 0x66, 0x0b } \
  }

Definition at line 17 of file Rest.h.

Typedef Documentation

EFI_REST_GET_TIME

typedef EFI_STATUS(EFIAPI * EFI_REST_GET_TIME) (IN EFI_REST_PROTOCOL *This, OUT EFI_TIME *Time)

The GetServiceTime() function is an optional interface to obtain the current time from this REST service instance. If this REST service does not support retrieving the time, this function returns EFI_UNSUPPORTED.

Parameters

[in]	This	Pointer to EFI_REST_PROTOCOL instance.
[out]	Time	A pointer to storage to receive a snapshot of the current time of the REST service.

Return values

EFI_SUCCESS	Operation succeeded
EFI_INVALID_PARAMETER	This or Time are NULL.
EFI_UNSUPPORTED	The RESTful service does not support returning the time.
EFI_DEVICE_ERROR	An unexpected system or network error occurred.

Definition at line 68 of file Rest.h.

EFI_REST_PROTOCOL

typedef struct _EFI_REST_PROTOCOL EFI_REST_PROTOCOL

Definition at line 22 of file Rest.h.

EFI_REST_SEND_RECEIVE

typedef EFI_STATUS(EFIAPI * EFI_REST_SEND_RECEIVE) (IN EFI_REST_PROTOCOL *This, IN EFI_HTTP_MESSAGE *RequestMessage, OUT EFI_HTTP_MESSAGE *ResponseMessage)

Provides a simple HTTP-like interface to send and receive resources from a REST service.

The SendReceive() function sends an HTTP request to this REST service, and returns a response when the data is retrieved from the service. RequestMessage contains the HTTP request to the REST resource identified by RequestMessage.Request.Url. The ResponseMessage is the returned HTTP response for that request, including any HTTP status.

Parameters

[in]	This	Pointer to EFI_REST_PROTOCOL instance for a particular REST service.
[in]	RequestMessage	Pointer to the HTTP request data for this resource.
[out]	ResponseMessage	Pointer to the HTTP response data obtained for this requested.

Return values

EFI_SUCCESS	Operation succeeded.
EFI_INVALID_PARAMETER	This, RequestMessage, or ResponseMessage are NULL.
EFI_DEVICE_ERROR	An unexpected system or network error occurred.

Definition at line 45 of file Rest.h.