#include "RedfishHttpDxe.h"

Data Structures
struct	REDFISH_SERVICE_PRIVATE

struct	REDFISH_PAYLOAD_PRIVATE

struct	REDFISH_HTTP_CACHE_DATA

struct	REDFISH_HTTP_CACHE_LIST

struct	REDFISH_HTTP_RETRY_SETTING

struct	REDFISH_HTTP_CACHE_PRIVATE

Macros
#define	REDFISH_HTTP_DRIVER_SIGNATURE SIGNATURE_32 ('r', 'f', 'h', 'p')

#define	REDFISH_HTTP_CACHE_SIGNATURE SIGNATURE_32 ('r', 'f', 'c', 'h')

#define	REDFISH_HTTP_SERVICE_SIGNATURE SIGNATURE_32 ('r', 'f', 's', 'v')

#define	REDFISH_HTTP_PAYLOAD_SIGNATURE SIGNATURE_32 ('r', 'f', 'p', 'l')

#define	REDFISH_HTTP_BASIC_AUTH_STR "Basic "

#define	REDFISH_HTTP_CACHE_FROM_LIST(a) CR (a, REDFISH_HTTP_CACHE_DATA, List, REDFISH_HTTP_CACHE_SIGNATURE)

#define	REDFISH_HTTP_CACHE_PRIVATE_FROM_THIS(a) CR (a, REDFISH_HTTP_CACHE_PRIVATE, Protocol, REDFISH_HTTP_DRIVER_SIGNATURE)

Functions
REDFISH_HTTP_CACHE_DATA *	FindHttpCacheData (IN LIST_ENTRY *ListHeader, IN EFI_STRING Uri)

EFI_STATUS	CopyRedfishResponse (IN REDFISH_RESPONSE SrcResponse, OUT REDFISH_RESPONSE DstResponse)

EFI_STATUS	ReleaseCacheList (IN REDFISH_HTTP_CACHE_LIST *CacheList)

EFI_STATUS	AddHttpCacheData (IN REDFISH_HTTP_CACHE_LIST List, IN EFI_STRING Uri, IN REDFISH_RESPONSE Response)

EFI_STATUS	DeleteHttpCacheData (IN REDFISH_HTTP_CACHE_LIST List, IN REDFISH_HTTP_CACHE_DATA Data)

EFI_STATUS	ReleaseRedfishPayload (IN REDFISH_PAYLOAD_PRIVATE *Payload)

REDFISH_PAYLOAD_PRIVATE *	CreateRedfishPayload (IN REDFISH_SERVICE_PRIVATE *Service, IN EDKII_JSON_VALUE JsonValue)

EFI_STATUS	ReleaseRedfishService (IN REDFISH_SERVICE_PRIVATE *Service)

REDFISH_SERVICE_PRIVATE *	CreateRedfishService (IN CHAR8 Host, IN CHAR8 HostName, IN CHAR8 BasicAuth OPTIONAL, IN CHAR8 SessionToken OPTIONAL, IN EFI_REST_EX_PROTOCOL *RestEx)

EFI_STATUS	UpdateSessionToken (IN REDFISH_SERVICE_PRIVATE Service, IN CHAR8 Token)

Detailed Description

Definitions of RedfishHttpData

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file RedfishHttpData.h.

Macro Definition Documentation

◆ REDFISH_HTTP_BASIC_AUTH_STR

#define REDFISH_HTTP_BASIC_AUTH_STR "Basic "

Definition at line 19 of file RedfishHttpData.h.

◆ REDFISH_HTTP_CACHE_FROM_LIST

#define REDFISH_HTTP_CACHE_FROM_LIST ( a ) CR (a, REDFISH_HTTP_CACHE_DATA, List, REDFISH_HTTP_CACHE_SIGNATURE)

Definition at line 53 of file RedfishHttpData.h.

◆ REDFISH_HTTP_CACHE_PRIVATE_FROM_THIS

#define REDFISH_HTTP_CACHE_PRIVATE_FROM_THIS ( a ) CR (a, REDFISH_HTTP_CACHE_PRIVATE, Protocol, REDFISH_HTTP_DRIVER_SIGNATURE)

Definition at line 90 of file RedfishHttpData.h.

◆ REDFISH_HTTP_CACHE_SIGNATURE

#define REDFISH_HTTP_CACHE_SIGNATURE SIGNATURE_32 ('r', 'f', 'c', 'h')

Definition at line 16 of file RedfishHttpData.h.

◆ REDFISH_HTTP_DRIVER_SIGNATURE

#define REDFISH_HTTP_DRIVER_SIGNATURE SIGNATURE_32 ('r', 'f', 'h', 'p')

Definition at line 15 of file RedfishHttpData.h.

◆ REDFISH_HTTP_PAYLOAD_SIGNATURE

#define REDFISH_HTTP_PAYLOAD_SIGNATURE SIGNATURE_32 ('r', 'f', 'p', 'l')

Definition at line 18 of file RedfishHttpData.h.

◆ REDFISH_HTTP_SERVICE_SIGNATURE

#define REDFISH_HTTP_SERVICE_SIGNATURE SIGNATURE_32 ('r', 'f', 's', 'v')

Definition at line 17 of file RedfishHttpData.h.

Function Documentation

◆ AddHttpCacheData()

EFI_STATUS AddHttpCacheData	(	IN REDFISH_HTTP_CACHE_LIST *	List,
		IN EFI_STRING	Uri,
		IN REDFISH_RESPONSE *	Response
	)

Add new cache by given URI and HTTP response to specify List.

Parameters

[in]	List	Target cache list to add.
[in]	Uri	The URI string matching to this cache data.
[in]	Response	HTTP response.

Return values

EFI_SUCCESS	Cache data is added.
Others	Fail to add cache data.

Definition at line 571 of file RedfishHttpData.c.

◆ CopyRedfishResponse()

EFI_STATUS CopyRedfishResponse	(	IN REDFISH_RESPONSE *	SrcResponse,
		OUT REDFISH_RESPONSE *	DstResponse
	)

This function copy the data in SrcResponse to DstResponse.

Parameters

[in]	SrcResponse	Source Response to copy.
[out]	DstResponse	Destination Response.

Return values

EFI_SUCCESS	Response is copied successfully.
Others	Error occurs.

Definition at line 250 of file RedfishHttpData.c.

◆ CreateRedfishPayload()

REDFISH_PAYLOAD_PRIVATE * CreateRedfishPayload	(	IN REDFISH_SERVICE_PRIVATE *	Service,
		IN EDKII_JSON_VALUE	JsonValue
	)

This function creat new payload. Server and JsonObj are copied to newly created payload.

Parameters

[in]	Service	Pointer to Service instance.
[in]	JsonObj	Pointer to JSON object.

Return values

REDFISH_PAYLOAD_PRIVATE	Newly created payload.
NULL	Error occurs.

This function creat new payload. Server and JsonObj are copied to newly created payload.

Parameters

[in]	Service	Pointer to Service instance.
[in]	JsonValue	Pointer to JSON value.

Return values

REDFISH_PAYLOAD_PRIVATE	Newly created payload.
NULL	Error occurs.

Definition at line 203 of file RedfishHttpData.c.

◆ CreateRedfishService()

REDFISH_SERVICE_PRIVATE * CreateRedfishService	(	IN CHAR8 *	Host,
		IN CHAR8 *	HostName,
		IN CHAR8 *BasicAuth	OPTIONAL,
		IN CHAR8 *SessionToken	OPTIONAL,
		IN EFI_REST_EX_PROTOCOL *	RestEx
	)

This function creat new service. Host and HostName are copied to newly created service instance.

Parameters

[in]	Host	Host string.
[in]	HostName	Hostname string.
[in]	BasicAuth	Basic Authorization string.
[in]	SessionToken	Session token string.
[in]	RestEx	Rest EX protocol instance.

Return values

REDFISH_PAYLOAD_PRIVATE	Newly created service.
NULL	Error occurs.

Definition at line 101 of file RedfishHttpData.c.

◆ DeleteHttpCacheData()

EFI_STATUS DeleteHttpCacheData	(	IN REDFISH_HTTP_CACHE_LIST *	List,
		IN REDFISH_HTTP_CACHE_DATA *	Data
	)

Delete a cache data by given cache instance.

Parameters

[in]	List	Target cache list to be removed.
[in]	Data	Pointer to the instance to be deleted.

Return values

EFI_SUCCESS	Cache data is removed.
Others	Fail to remove cache data.

Definition at line 542 of file RedfishHttpData.c.

◆ FindHttpCacheData()

REDFISH_HTTP_CACHE_DATA * FindHttpCacheData	(	IN LIST_ENTRY *	ListHeader,
		IN EFI_STRING	Uri
	)

Search on given ListHeader for given URI string.

Parameters

[in]	ListHeader	Target list to search.
[in]	Uri	Target URI to search.

Return values

REDFISH_HTTP_CACHE_DATA	Target cache data is found.
NULL	No cache data with given URI is found.

Definition at line 453 of file RedfishHttpData.c.

◆ ReleaseCacheList()

EFI_STATUS ReleaseCacheList ( IN REDFISH_HTTP_CACHE_LIST * CacheList )

Release all cache from list.

Parameters

[in] CacheList The list to be released.

Return values

EFI_SUCCESS	All cache data are released.
EFI_INVALID_PARAMETER	CacheList is NULL.

Definition at line 638 of file RedfishHttpData.c.

◆ ReleaseRedfishPayload()

EFI_STATUS ReleaseRedfishPayload ( IN REDFISH_PAYLOAD_PRIVATE * Payload )

This function release Redfish Payload.

Parameters

[in] Payload Pointer to payload instance.

Return values

EFI_SUCCESS	Payload is released.
Others	Error occurs.

Definition at line 170 of file RedfishHttpData.c.

◆ ReleaseRedfishService()

EFI_STATUS ReleaseRedfishService ( IN REDFISH_SERVICE_PRIVATE * Service )

This function release Redfish Service.

Parameters

[in] Service Pointer to service instance.

Return values

EFI_SUCCESS	Service is released.
Others	Error occurs.

Definition at line 55 of file RedfishHttpData.c.

◆ UpdateSessionToken()

EFI_STATUS UpdateSessionToken	(	IN REDFISH_SERVICE_PRIVATE *	Service,
		IN CHAR8 *	Token
	)

This function update session token in Redfish Service.

Parameters

[in]	Service	Pointer to service instance.
[in]	Token	Session token.

Return values

EFI_SUCCESS	Session token is updated.
Others	Error occurs.

Definition at line 24 of file RedfishHttpData.c.

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ REDFISH_HTTP_BASIC_AUTH_STR

◆ REDFISH_HTTP_CACHE_FROM_LIST

◆ REDFISH_HTTP_CACHE_PRIVATE_FROM_THIS

◆ REDFISH_HTTP_CACHE_SIGNATURE

◆ REDFISH_HTTP_DRIVER_SIGNATURE

◆ REDFISH_HTTP_PAYLOAD_SIGNATURE

◆ REDFISH_HTTP_SERVICE_SIGNATURE

Function Documentation

◆ AddHttpCacheData()

◆ CopyRedfishResponse()

◆ CreateRedfishPayload()

◆ CreateRedfishService()

◆ DeleteHttpCacheData()

◆ FindHttpCacheData()

◆ ReleaseCacheList()

◆ ReleaseRedfishPayload()

◆ ReleaseRedfishService()

◆ UpdateSessionToken()