NetworkPkg: Move Network library and drivers from MdeModulePkg to NetworkPkg

[mirror_edk2.git] / MdeModulePkg / Include / Library / HttpLib.h

diff --git a/MdeModulePkg/Include/Library/HttpLib.h b/MdeModulePkg/Include/Library/HttpLib.h
index 88b56ae1cebd3ce98b2c66840aaf1813c2ea4252..93100eb350e5eeb925dfc8f41363b6658fe40767 100644 (file)
--- a/MdeModulePkg/Include/Library/HttpLib.h
+++ b/MdeModulePkg/Include/Library/HttpLib.h
@@ -2,15 +2,9 @@
   This library is used to share code between UEFI network stack modules.\r
   It provides the helper routines to parse the HTTP message byte stream.\r
 \r
   This library is used to share code between UEFI network stack modules.\r
   It provides the helper routines to parse the HTTP message byte stream.\r
 \r

-Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r

 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r

-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution.  The full text of the license may be found at<BR>\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r

 \r
 **/\r
 \r
 \r
 **/\r
 \r


@@ -22,10 +16,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 /**\r
   Decode a percent-encoded URI component to the ASCII character.\r
 \r
 /**\r
   Decode a percent-encoded URI component to the ASCII character.\r

-  \r
-  Decode the input component in Buffer according to RFC 3986. The caller is responsible to make \r
+\r
+  Decode the input component in Buffer according to RFC 3986. The caller is responsible to make\r

   sure ResultBuffer points to a buffer with size equal or greater than ((AsciiStrSize (Buffer))\r
   sure ResultBuffer points to a buffer with size equal or greater than ((AsciiStrSize (Buffer))\r

-  in bytes. \r
+  in bytes.\r

 \r
   @param[in]    Buffer           The pointer to a percent-encoded URI component.\r
   @param[in]    BufferLength     Length of Buffer in bytes.\r
 \r
   @param[in]    Buffer           The pointer to a percent-encoded URI component.\r
   @param[in]    BufferLength     Length of Buffer in bytes.\r


@@ -34,7 +28,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   @retval EFI_SUCCESS            Successfully decoded the URI.\r
   @retval EFI_INVALID_PARAMETER  Buffer is not a valid percent-encoded string.\r
 \r
   @retval EFI_SUCCESS            Successfully decoded the URI.\r
   @retval EFI_INVALID_PARAMETER  Buffer is not a valid percent-encoded string.\r

-  \r
+\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -61,7 +55,7 @@ UriPercentDecode (
   @retval EFI_SUCCESS              Successfully dereferenced the HTTP URL.\r
   @retval EFI_INVALID_PARAMETER    UrlParser is NULL or Url is not a valid HTTP URL.\r
   @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r
   @retval EFI_SUCCESS              Successfully dereferenced the HTTP URL.\r
   @retval EFI_INVALID_PARAMETER    UrlParser is NULL or Url is not a valid HTTP URL.\r
   @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r

-  \r
+\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -86,7 +80,7 @@ HttpParseUrl (
   @retval EFI_INVALID_PARAMETER    Uri is NULL or HostName is NULL or UrlParser is invalid.\r
   @retval EFI_NOT_FOUND            No hostName component in the URL.\r
   @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r
   @retval EFI_INVALID_PARAMETER    Uri is NULL or HostName is NULL or UrlParser is invalid.\r
   @retval EFI_NOT_FOUND            No hostName component in the URL.\r
   @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r

-  \r
+\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -109,7 +103,7 @@ HttpUrlGetHostName (
   @retval EFI_INVALID_PARAMETER    Uri is NULL or Ip4Address is NULL or UrlParser is invalid.\r
   @retval EFI_NOT_FOUND            No IPv4 address component in the URL.\r
   @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r
   @retval EFI_INVALID_PARAMETER    Uri is NULL or Ip4Address is NULL or UrlParser is invalid.\r
   @retval EFI_NOT_FOUND            No IPv4 address component in the URL.\r
   @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r

-  \r
+\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -132,7 +126,7 @@ HttpUrlGetIp4 (
   @retval EFI_INVALID_PARAMETER    Uri is NULL or Ip6Address is NULL or UrlParser is invalid.\r
   @retval EFI_NOT_FOUND            No IPv6 address component in the URL.\r
   @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r
   @retval EFI_INVALID_PARAMETER    Uri is NULL or Ip6Address is NULL or UrlParser is invalid.\r
   @retval EFI_NOT_FOUND            No IPv6 address component in the URL.\r
   @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r

-  \r
+\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -155,7 +149,7 @@ HttpUrlGetIp6 (
   @retval EFI_INVALID_PARAMETER    Uri is NULL or Port is NULL or UrlParser is invalid.\r
   @retval EFI_NOT_FOUND            No port number in the URL.\r
   @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r
   @retval EFI_INVALID_PARAMETER    Uri is NULL or Port is NULL or UrlParser is invalid.\r
   @retval EFI_NOT_FOUND            No port number in the URL.\r
   @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r

-  \r
+\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -179,7 +173,7 @@ HttpUrlGetPort (
   @retval EFI_INVALID_PARAMETER    Uri is NULL or HostName is NULL or UrlParser is invalid.\r
   @retval EFI_NOT_FOUND            No hostName component in the URL.\r
   @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r
   @retval EFI_INVALID_PARAMETER    Uri is NULL or HostName is NULL or UrlParser is invalid.\r
   @retval EFI_NOT_FOUND            No hostName component in the URL.\r
   @retval EFI_OUT_OF_RESOURCES     Could not allocate needed resources.\r

-  \r
+\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -193,7 +187,7 @@ HttpUrlGetPath (
   Release the resource of the URL parser.\r
 \r
   @param[in]    UrlParser            Pointer to the parser.\r
   Release the resource of the URL parser.\r
 \r
   @param[in]    UrlParser            Pointer to the parser.\r

-  \r
+\r

 **/\r
 VOID\r
 EFIAPI\r
 **/\r
 VOID\r
 EFIAPI\r


@@ -231,7 +225,7 @@ typedef enum {
 \r
   @retval EFI_SUCCESS              Continue to parser the message body.\r
   @retval Others                   Abort the parse.\r
 \r
   @retval EFI_SUCCESS              Continue to parser the message body.\r
   @retval Others                   Abort the parse.\r

- \r
+\r

 **/\r
 typedef\r
 EFI_STATUS\r
 **/\r
 typedef\r
 EFI_STATUS\r


@@ -286,7 +280,8 @@ HttpInitMsgParser (
 \r
   @retval EFI_SUCCESS                Successfully parse the message-body.\r
   @retval EFI_INVALID_PARAMETER      MsgParser is NULL or Body is NULL or BodyLength is 0.\r
 \r
   @retval EFI_SUCCESS                Successfully parse the message-body.\r
   @retval EFI_INVALID_PARAMETER      MsgParser is NULL or Body is NULL or BodyLength is 0.\r

-  @retval Others                     Operation aborted.\r
+  @retval EFI_ABORTED                Operation aborted.\r
+  @retval Other                      Error happened while parsing message body.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -323,7 +318,7 @@ HttpIsMessageComplete (
   @retval EFI_SUCCESS                Successfully to get the entity length.\r
   @retval EFI_NOT_READY              Entity length is not valid yet.\r
   @retval EFI_INVALID_PARAMETER      MsgParser is NULL or ContentLength is NULL.\r
   @retval EFI_SUCCESS                Successfully to get the entity length.\r
   @retval EFI_NOT_READY              Entity length is not valid yet.\r
   @retval EFI_INVALID_PARAMETER      MsgParser is NULL or ContentLength is NULL.\r

-  \r
+\r

 **/\r
 EFI_STATUS\r
 EFIAPI\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r


@@ -336,7 +331,7 @@ HttpGetEntityLength (
   Release the resource of the message parser.\r
 \r
   @param[in]    MsgParser            Pointer to the message parser.\r
   Release the resource of the message parser.\r
 \r
   @param[in]    MsgParser            Pointer to the message parser.\r

-  \r
+\r

 **/\r
 VOID\r
 EFIAPI\r
 **/\r
 VOID\r
 EFIAPI\r


@@ -433,9 +428,9 @@ HttpFreeHeaderFields (
                                   NULL if any error occured.\r
   @param[out]  RequestMsgSize     Size of the RequestMsg (in bytes).\r
 \r
                                   NULL if any error occured.\r
   @param[out]  RequestMsgSize     Size of the RequestMsg (in bytes).\r
 \r

-  @return EFI_SUCCESS             If HTTP request string was created successfully\r
+  @retval EFI_SUCCESS             If HTTP request string was created successfully.\r

   @retval EFI_OUT_OF_RESOURCES    Failed to allocate resources.\r
   @retval EFI_OUT_OF_RESOURCES    Failed to allocate resources.\r

-  @retval EFI_INVALID_PARAMETER   The input arguments are invalid\r
+  @retval EFI_INVALID_PARAMETER   The input arguments are invalid.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r