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