EdkIIRedfishHttpProtocol.h

Go to the documentation of this file.

 
#ifndef EDKII_REDFISH_HTTP_PROTOCOL_H_
#define EDKII_REDFISH_HTTP_PROTOCOL_H_
 
#include <RedfishServiceData.h>
#include <Library/JsonLib.h>
#include <Protocol/EdkIIRedfishConfigHandler.h>
 
typedef struct _EDKII_REDFISH_HTTP_PROTOCOL EDKII_REDFISH_HTTP_PROTOCOL;
 
typedef
REDFISH_SERVICE
(EFIAPI *REDFISH_HTTP_CREATE_SERVICE)(
  IN  EDKII_REDFISH_HTTP_PROTOCOL         *This,
  IN  REDFISH_CONFIG_SERVICE_INFORMATION  *RedfishConfigServiceInfo
  );
 
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_FREE_SERVICE)(
  IN  EDKII_REDFISH_HTTP_PROTOCOL         *This,
  IN  REDFISH_SERVICE                     RedfishService
  );
 
typedef
EDKII_JSON_VALUE
(EFIAPI *REDFISH_HTTP_JSON_IN_PAYLOAD)(
  IN  EDKII_REDFISH_HTTP_PROTOCOL         *This,
  IN  REDFISH_PAYLOAD                     RedfishPayload
  );
 
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_FREE_REQUEST)(
  IN  EDKII_REDFISH_HTTP_PROTOCOL *This,
  IN  REDFISH_REQUEST             *Request
  );
 
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_FREE_RESPONSE)(
  IN  EDKII_REDFISH_HTTP_PROTOCOL *This,
  IN  REDFISH_RESPONSE            *Response
  );
 
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_EXPIRE_RESPONSE)(
  IN  EDKII_REDFISH_HTTP_PROTOCOL *This,
  IN  EFI_STRING                  Uri
  );
 
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_GET_RESOURCE)(
  IN  EDKII_REDFISH_HTTP_PROTOCOL *This,
  IN  REDFISH_SERVICE             Service,
  IN  EFI_STRING                  Uri,
  IN  REDFISH_REQUEST             *Request OPTIONAL,
  OUT REDFISH_RESPONSE            *Response,
  IN  BOOLEAN                     UseCache
  );
 
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_PATCH_RESOURCE)(
  IN  EDKII_REDFISH_HTTP_PROTOCOL  *This,
  IN  REDFISH_SERVICE              Service,
  IN  EFI_STRING                   Uri,
  IN  CHAR8                        *Content,
  IN  UINTN                        ContentSize OPTIONAL,
  IN  CHAR8                        *ContentType OPTIONAL,
  OUT REDFISH_RESPONSE             *Response
  );
 
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_PUT_RESOURCE)(
  IN  EDKII_REDFISH_HTTP_PROTOCOL  *This,
  IN  REDFISH_SERVICE              Service,
  IN  EFI_STRING                   Uri,
  IN  CHAR8                        *Content,
  IN  UINTN                        ContentSize OPTIONAL,
  IN  CHAR8                        *ContentType OPTIONAL,
  OUT REDFISH_RESPONSE             *Response
  );
 
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_POST_RESOURCE)(
  IN  EDKII_REDFISH_HTTP_PROTOCOL  *This,
  IN  REDFISH_SERVICE              Service,
  IN  EFI_STRING                   Uri,
  IN  CHAR8                        *Content,
  IN  UINTN                        ContentSize OPTIONAL,
  IN  CHAR8                        *ContentType OPTIONAL,
  OUT REDFISH_RESPONSE             *Response
  );
 
typedef
EFI_STATUS
(EFIAPI *REDFISH_HTTP_DELETE_RESOURCE)(
  IN  EDKII_REDFISH_HTTP_PROTOCOL  *This,
  IN  REDFISH_SERVICE              Service,
  IN  EFI_STRING                   Uri,
  IN  CHAR8                        *Content OPTIONAL,
  IN  UINTN                        ContentSize OPTIONAL,
  IN  CHAR8                        *ContentType OPTIONAL,
  OUT REDFISH_RESPONSE             *Response
  );
 
struct _EDKII_REDFISH_HTTP_PROTOCOL {
  UINT32                          Version;
  REDFISH_HTTP_CREATE_SERVICE     CreateService;
  REDFISH_HTTP_FREE_SERVICE       FreeService;
  REDFISH_HTTP_JSON_IN_PAYLOAD    JsonInPayload;
  REDFISH_HTTP_GET_RESOURCE       GetResource;
  REDFISH_HTTP_PATCH_RESOURCE     PatchResource;
  REDFISH_HTTP_PUT_RESOURCE       PutResource;
  REDFISH_HTTP_POST_RESOURCE      PostResource;
  REDFISH_HTTP_DELETE_RESOURCE    DeleteResource;
  REDFISH_HTTP_FREE_REQUEST       FreeRequest;
  REDFISH_HTTP_FREE_RESPONSE      FreeResponse;
  REDFISH_HTTP_EXPIRE_RESPONSE    ExpireResponse;
};
 
#define EDKII_REDFISH_HTTP_PROTOCOL_REVISION  0x00001000
 
extern EFI_GUID  gEdkIIRedfishHttpProtocolGuid;
 
#endif