| 1 | /** @file
|
|---|
| 2 | Definitions of RedfishHttpOperation
|
|---|
| 3 |
|
|---|
| 4 | Copyright (c) 2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
|---|
| 5 |
|
|---|
| 6 | SPDX-License-Identifier: BSD-2-Clause-Patent
|
|---|
| 7 |
|
|---|
| 8 | **/
|
|---|
| 9 |
|
|---|
| 10 | #ifndef EDKII_REDFISH_HTTP_OPERATION_H_
|
|---|
| 11 | #define EDKII_REDFISH_HTTP_OPERATION_H_
|
|---|
| 12 |
|
|---|
| 13 | #include "RedfishHttpDxe.h"
|
|---|
| 14 |
|
|---|
| 15 | #define REDFISH_CONTENT_LENGTH_SIZE 80
|
|---|
| 16 | #define REDFISH_COMMON_HEADER_SIZE 5
|
|---|
| 17 | #define REDFISH_HTTP_HEADER_ODATA_VERSION_STR "OData-Version"
|
|---|
| 18 | #define REDFISH_HTTP_HEADER_ODATA_VERSION_VALUE "4.0"
|
|---|
| 19 | #define REDFISH_HTTP_HEADER_USER_AGENT_VALUE "edk2redfish"
|
|---|
| 20 | #define REDFISH_HTTP_HEADER_CONNECTION_STR "Connection"
|
|---|
| 21 | #define REDFISH_HTTP_HEADER_CONNECTION_VALUE "Keep-Alive"
|
|---|
| 22 | #define REDFISH_HTTP_CONTENT_ENCODING_NONE "None"
|
|---|
| 23 | #define ASCII_STR_DUPLICATE(a) (AllocateCopyPool (AsciiStrSize ((a)), (a)))
|
|---|
| 24 |
|
|---|
| 25 | /**
|
|---|
| 26 | This function free resources in Request. Request is no longer available
|
|---|
| 27 | after this function returns successfully.
|
|---|
| 28 |
|
|---|
| 29 | @param[in] Request HTTP request to be released.
|
|---|
| 30 |
|
|---|
| 31 | @retval EFI_SUCCESS Resource is released successfully.
|
|---|
| 32 | @retval Others Errors occur.
|
|---|
| 33 |
|
|---|
| 34 | **/
|
|---|
| 35 | EFI_STATUS
|
|---|
| 36 | ReleaseRedfishRequest (
|
|---|
| 37 | IN REDFISH_REQUEST *Request
|
|---|
| 38 | );
|
|---|
| 39 |
|
|---|
| 40 | /**
|
|---|
| 41 | This function free resources in given Response.
|
|---|
| 42 |
|
|---|
| 43 | @param[in] Response HTTP response to be released.
|
|---|
| 44 |
|
|---|
| 45 | @retval EFI_SUCCESS Resource is released successfully.
|
|---|
| 46 | @retval Others Errors occur.
|
|---|
| 47 |
|
|---|
| 48 | **/
|
|---|
| 49 | EFI_STATUS
|
|---|
| 50 | ReleaseRedfishResponse (
|
|---|
| 51 | IN REDFISH_RESPONSE *Response
|
|---|
| 52 | );
|
|---|
| 53 |
|
|---|
| 54 | /**
|
|---|
| 55 | This function send Redfish request to Redfish service by calling
|
|---|
| 56 | Rest Ex protocol.
|
|---|
| 57 |
|
|---|
| 58 | @param[in] Service Pointer to Redfish service.
|
|---|
| 59 | @param[in] Uri Uri of Redfish service.
|
|---|
| 60 | @param[in] Method HTTP method.
|
|---|
| 61 | @param[in] Request Request data. This is optional.
|
|---|
| 62 | @param[out] Response Redfish response data.
|
|---|
| 63 |
|
|---|
| 64 | @retval EFI_SUCCESS Request is sent and received successfully.
|
|---|
| 65 | @retval Others Errors occur.
|
|---|
| 66 |
|
|---|
| 67 | **/
|
|---|
| 68 | EFI_STATUS
|
|---|
| 69 | HttpSendReceive (
|
|---|
| 70 | IN REDFISH_SERVICE Service,
|
|---|
| 71 | IN EFI_STRING Uri,
|
|---|
| 72 | IN EFI_HTTP_METHOD Method,
|
|---|
| 73 | IN REDFISH_REQUEST *Request OPTIONAL,
|
|---|
| 74 | OUT REDFISH_RESPONSE *Response
|
|---|
| 75 | );
|
|---|
| 76 |
|
|---|
| 77 | #endif
|
|---|
