NetworkPkg/HttpDxe/HttpImpl.h

   1 /** @file
   2   The header files of implementation of EFI_HTTP_PROTOCOL protocol interfaces.
   3
   4   Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
   5   (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
   6
   7   This program and the accompanying materials
   8   are licensed and made available under the terms and conditions of the BSD License
   9   which accompanies this distribution.  The full text of the license may be found at
  10   http://opensource.org/licenses/bsd-license.php.
  11
  12   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef __EFI_HTTP_IMPL_H__
  18 #define __EFI_HTTP_IMPL_H__
  19
  20 #define HTTP_DEFAULT_PORT        80
  21 #define HTTP_END_OF_HDR_STR      "\r\n\r\n"
  22 #define HTTP_CRLF_STR            "\r\n"
  23 #define HTTP_VERSION_STR         HTTP_VERSION
  24 #define HTTP_VERSION_CRLF_STR    " HTTP/1.1\r\n"
  25 #define HTTP_ERROR_OR_NOT_SUPPORT_STATUS_CODE         300
  26
  27
  28 /**
  29   Returns the operational parameters for the current HTTP child instance.
  30
  31   The GetModeData() function is used to read the current mode data (operational
  32   parameters) for this HTTP protocol instance.
  33
  34   @param[in]  This                Pointer to EFI_HTTP_PROTOCOL instance.
  35   @param[out] HttpConfigData      Point to buffer for operational parameters of this
  36                                   HTTP instance. It is the responsibility of the caller
  37                                   to allocate the memory for HttpConfigData and
  38                                   HttpConfigData->AccessPoint.IPv6Node/IPv4Node. In fact,
  39                                   it is recommended to allocate sufficient memory to record
  40                                   IPv6Node since it is big enough for all possibilities.
  41
  42   @retval EFI_SUCCESS             Operation succeeded.
  43   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:
  44                                   This is NULL.
  45                                   HttpConfigData is NULL.
  46                                   HttpConfigData->AccessPoint.IPv4Node or
  47                                   HttpConfigData->AccessPoint.IPv6Node is NULL.
  48   @retval EFI_NOT_STARTED         This EFI HTTP Protocol instance has not been started.
  49
  50 **/
  51 EFI_STATUS
  52 EFIAPI
  53 EfiHttpGetModeData (
  54   IN  EFI_HTTP_PROTOCOL         *This,
  55   OUT EFI_HTTP_CONFIG_DATA      *HttpConfigData
  56   );
  57
  58 /**
  59   Initialize or brutally reset the operational parameters for this EFI HTTP instance.
  60
  61   The Configure() function does the following:
  62   When HttpConfigData is not NULL Initialize this EFI HTTP instance by configuring
  63   timeout, local address, port, etc.
  64   When HttpConfigData is NULL, reset this EFI HTTP instance by closing all active
  65   connections with remote hosts, canceling all asynchronous tokens, and flush request
  66   and response buffers without informing the appropriate hosts.
  67
  68   No other EFI HTTP function can be executed by this instance until the Configure()
  69   function is executed and returns successfully.
  70
  71   @param[in]  This                Pointer to EFI_HTTP_PROTOCOL instance.
  72   @param[in]  HttpConfigData      Pointer to the configure data to configure the instance.
  73
  74   @retval EFI_SUCCESS             Operation succeeded.
  75   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:
  76                                   This is NULL.
  77                                   HttpConfigData->LocalAddressIsIPv6 is FALSE and
  78                                   HttpConfigData->AccessPoint.IPv4Node is NULL.
  79                                   HttpConfigData->LocalAddressIsIPv6 is TRUE and
  80                                   HttpConfigData->AccessPoint.IPv6Node is NULL.
  81   @retval EFI_ALREADY_STARTED     Reinitialize this HTTP instance without calling
  82                                   Configure() with NULL to reset it.
  83   @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred.
  84   @retval EFI_OUT_OF_RESOURCES    Could not allocate enough system resources when
  85                                   executing Configure().
  86   @retval EFI_UNSUPPORTED         One or more options in ConfigData are not supported
  87                                   in the implementation.
  88 **/
  89 EFI_STATUS
  90 EFIAPI
  91 EfiHttpConfigure (
  92   IN  EFI_HTTP_PROTOCOL         *This,
  93   IN  EFI_HTTP_CONFIG_DATA      *HttpConfigData
  94   );
  95
  96 /**
  97   The Request() function queues an HTTP request to this HTTP instance.
  98
  99   Similar to Transmit() function in the EFI TCP driver. When the HTTP request is sent
 100   successfully, or if there is an error, Status in token will be updated and Event will
 101   be signaled.
 102
 103   @param[in]  This                Pointer to EFI_HTTP_PROTOCOL instance.
 104   @param[in]  Token               Pointer to storage containing HTTP request token.
 105
 106   @retval EFI_SUCCESS             Outgoing data was processed.
 107   @retval EFI_NOT_STARTED         This EFI HTTP Protocol instance has not been started.
 108   @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred.
 109   @retval EFI_TIMEOUT             Data was dropped out of the transmit or receive queue.
 110   @retval EFI_OUT_OF_RESOURCES    Could not allocate enough system resources.
 111   @retval EFI_UNSUPPORTED         The HTTP method is not supported in current
 112                                   implementation.
 113   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:
 114                                   This is NULL.
 115                                   Token is NULL.
 116                                   Token->Message is NULL.
 117                                   Token->Message->Body is not NULL,
 118                                   Token->Message->BodyLength is non-zero, and
 119                                   Token->Message->Data is NULL, but a previous call to
 120                                   Request()has not been completed successfully.
 121 **/
 122 EFI_STATUS
 123 EFIAPI
 124 EfiHttpRequest (
 125   IN  EFI_HTTP_PROTOCOL         *This,
 126   IN  EFI_HTTP_TOKEN            *Token
 127   );
 128
 129 /**
 130   Abort an asynchronous HTTP request or response token.
 131
 132   The Cancel() function aborts a pending HTTP request or response transaction. If
 133   Token is not NULL and the token is in transmit or receive queues when it is being
 134   cancelled, its Token->Status will be set to EFI_ABORTED and then Token->Event will
 135   be signaled. If the token is not in one of the queues, which usually means that the
 136   asynchronous operation has completed, EFI_NOT_FOUND is returned. If Token is NULL,
 137   all asynchronous tokens issued by Request() or Response() will be aborted.
 138
 139   @param[in]  This                Pointer to EFI_HTTP_PROTOCOL instance.
 140   @param[in]  Token               Point to storage containing HTTP request or response
 141                                   token.
 142
 143   @retval EFI_SUCCESS             Request and Response queues are successfully flushed.
 144   @retval EFI_INVALID_PARAMETER   This is NULL.
 145   @retval EFI_NOT_STARTED         This instance hasn't been configured.
 146   @retval EFI_NOT_FOUND           The asynchronous request or response token is not
 147                                   found.
 148   @retval EFI_UNSUPPORTED         The implementation does not support this function.
 149 **/
 150 EFI_STATUS
 151 EFIAPI
 152 EfiHttpCancel (
 153   IN  EFI_HTTP_PROTOCOL         *This,
 154   IN  EFI_HTTP_TOKEN            *Token
 155   );
 156
 157 /**
 158   The Response() function queues an HTTP response to this HTTP instance, similar to
 159   Receive() function in the EFI TCP driver. When the HTTP response is received successfully,
 160   or if there is an error, Status in token will be updated and Event will be signaled.
 161
 162   The HTTP driver will queue a receive token to the underlying TCP instance. When data
 163   is received in the underlying TCP instance, the data will be parsed and Token will
 164   be populated with the response data. If the data received from the remote host
 165   contains an incomplete or invalid HTTP header, the HTTP driver will continue waiting
 166   (asynchronously) for more data to be sent from the remote host before signaling
 167   Event in Token.
 168
 169   It is the responsibility of the caller to allocate a buffer for Body and specify the
 170   size in BodyLength. If the remote host provides a response that contains a content
 171   body, up to BodyLength bytes will be copied from the receive buffer into Body and
 172   BodyLength will be updated with the amount of bytes received and copied to Body. This
 173   allows the client to download a large file in chunks instead of into one contiguous
 174   block of memory. Similar to HTTP request, if Body is not NULL and BodyLength is
 175   non-zero and all other fields are NULL or 0, the HTTP driver will queue a receive
 176   token to underlying TCP instance. If data arrives in the receive buffer, up to
 177   BodyLength bytes of data will be copied to Body. The HTTP driver will then update
 178   BodyLength with the amount of bytes received and copied to Body.
 179
 180   If the HTTP driver does not have an open underlying TCP connection with the host
 181   specified in the response URL, Request() will return EFI_ACCESS_DENIED. This is
 182   consistent with RFC 2616 recommendation that HTTP clients should attempt to maintain
 183   an open TCP connection between client and host.
 184
 185   @param[in]  This                Pointer to EFI_HTTP_PROTOCOL instance.
 186   @param[in]  Token               Pointer to storage containing HTTP response token.
 187
 188   @retval EFI_SUCCESS             Allocation succeeded.
 189   @retval EFI_NOT_STARTED         This EFI HTTP Protocol instance has not been
 190                                   initialized.
 191   @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:
 192                                   This is NULL.
 193                                   Token is NULL.
 194                                   Token->Message->Headers is NULL.
 195                                   Token->Message is NULL.
 196                                   Token->Message->Body is not NULL,
 197                                   Token->Message->BodyLength is non-zero, and
 198                                   Token->Message->Data is NULL, but a previous call to
 199                                   Response() has not been completed successfully.
 200   @retval EFI_OUT_OF_RESOURCES    Could not allocate enough system resources.
 201   @retval EFI_ACCESS_DENIED       An open TCP connection is not present with the host
 202                                   specified by response URL.
 203 **/
 204 EFI_STATUS
 205 EFIAPI
 206 EfiHttpResponse (
 207   IN  EFI_HTTP_PROTOCOL         *This,
 208   IN  EFI_HTTP_TOKEN            *Token
 209   );
 210
 211 /**
 212   The Poll() function can be used by network drivers and applications to increase the
 213   rate that data packets are moved between the communication devices and the transmit
 214   and receive queues.
 215
 216   In some systems, the periodic timer event in the managed network driver may not poll
 217   the underlying communications device fast enough to transmit and/or receive all data
 218   packets without missing incoming packets or dropping outgoing packets. Drivers and
 219   applications that are experiencing packet loss should try calling the Poll() function
 220   more often.
 221
 222   @param[in]  This                Pointer to EFI_HTTP_PROTOCOL instance.
 223
 224   @retval EFI_SUCCESS             Incoming or outgoing data was processed.
 225   @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred.
 226   @retval EFI_INVALID_PARAMETER   This is NULL.
 227   @retval EFI_NOT_READY           No incoming or outgoing data is processed.
 228   @retval EFI_NOT_STARTED         This EFI HTTP Protocol instance has not been started.
 229
 230 **/
 231 EFI_STATUS
 232 EFIAPI
 233 EfiHttpPoll (
 234   IN  EFI_HTTP_PROTOCOL         *This
 235   );
 236
 237 extern EFI_HTTP_PROTOCOL  mEfiHttpTemplate;
 238
 239 #endif