]>
Commit | Line | Data |
---|---|---|
47f51a06 YT |
1 | /** @file\r |
2 | The header files of miscellaneous routines for HttpDxe driver.\r | |
3 | \r | |
f75a7f56 | 4 | Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r |
f58554fc | 5 | (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r |
47f51a06 YT |
6 | This program and the accompanying materials\r |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | **/\r | |
15 | \r | |
16 | #ifndef __EFI_HTTP_PROTO_H__\r | |
17 | #define __EFI_HTTP_PROTO_H__\r | |
18 | \r | |
19 | #define DEF_BUF_LEN 2048\r | |
20 | \r | |
21 | #define HTTP_SERVICE_SIGNATURE SIGNATURE_32('H', 't', 't', 'S')\r | |
22 | \r | |
23 | #define HTTP_SERVICE_FROM_PROTOCOL(a) \\r | |
24 | CR ( \\r | |
25 | (a), \\r | |
26 | HTTP_SERVICE, \\r | |
27 | ServiceBinding, \\r | |
28 | HTTP_SERVICE_SIGNATURE \\r | |
29 | )\r | |
30 | \r | |
b659408b | 31 | \r |
47f51a06 YT |
32 | //\r |
33 | // The state of HTTP protocol. It starts from UNCONFIGED.\r | |
34 | //\r | |
35 | #define HTTP_STATE_UNCONFIGED 0\r | |
36 | #define HTTP_STATE_HTTP_CONFIGED 1\r | |
37 | #define HTTP_STATE_TCP_CONFIGED 2\r | |
38 | #define HTTP_STATE_TCP_UNCONFIGED 3\r | |
39 | #define HTTP_STATE_TCP_CONNECTED 4\r | |
40 | #define HTTP_STATE_TCP_CLOSED 5\r | |
41 | \r | |
42 | //\r | |
43 | // TCP configured data.\r | |
44 | //\r | |
45 | #define HTTP_TOS_DEAULT 8\r | |
46 | #define HTTP_TTL_DEAULT 255\r | |
47 | #define HTTP_BUFFER_SIZE_DEAULT 65535\r | |
48 | #define HTTP_MAX_SYN_BACK_LOG 5\r | |
49 | #define HTTP_CONNECTION_TIMEOUT 60\r | |
b347a22a | 50 | #define HTTP_RESPONSE_TIMEOUT 5\r |
47f51a06 YT |
51 | #define HTTP_DATA_RETRIES 12\r |
52 | #define HTTP_FIN_TIMEOUT 2\r | |
53 | #define HTTP_KEEP_ALIVE_PROBES 6\r | |
54 | #define HTTP_KEEP_ALIVE_TIME 7200\r | |
55 | #define HTTP_KEEP_ALIVE_INTERVAL 30\r | |
56 | \r | |
51b0450e FS |
57 | #define HTTP_URL_BUFFER_LEN 4096\r |
58 | \r | |
47f51a06 YT |
59 | typedef struct _HTTP_SERVICE {\r |
60 | UINT32 Signature;\r | |
61 | EFI_SERVICE_BINDING_PROTOCOL ServiceBinding;\r | |
7cf59c85 ZL |
62 | EFI_HANDLE Ip4DriverBindingHandle;\r |
63 | EFI_HANDLE Ip6DriverBindingHandle;\r | |
47f51a06 | 64 | EFI_HANDLE ControllerHandle;\r |
b659408b ZL |
65 | EFI_HANDLE Tcp4ChildHandle;\r |
66 | EFI_HANDLE Tcp6ChildHandle;\r | |
47f51a06 YT |
67 | LIST_ENTRY ChildrenList;\r |
68 | UINTN ChildrenNumber;\r | |
47f51a06 YT |
69 | INTN State;\r |
70 | } HTTP_SERVICE;\r | |
71 | \r | |
72 | typedef struct {\r | |
b659408b ZL |
73 | EFI_TCP4_IO_TOKEN Tx4Token;\r |
74 | EFI_TCP4_TRANSMIT_DATA Tx4Data;\r | |
75 | EFI_TCP6_IO_TOKEN Tx6Token;\r | |
76 | EFI_TCP6_TRANSMIT_DATA Tx6Data;\r | |
77 | EFI_TCP4_IO_TOKEN Rx4Token;\r | |
78 | EFI_TCP4_RECEIVE_DATA Rx4Data;\r | |
79 | EFI_TCP6_IO_TOKEN Rx6Token;\r | |
80 | EFI_TCP6_RECEIVE_DATA Rx6Data;\r | |
47f51a06 | 81 | BOOLEAN IsTxDone;\r |
47f51a06 YT |
82 | BOOLEAN IsRxDone;\r |
83 | UINTN BodyLen;\r | |
84 | EFI_HTTP_METHOD Method;\r | |
85 | } HTTP_TCP_TOKEN_WRAP;\r | |
86 | \r | |
dac45de3 JW |
87 | typedef struct {\r |
88 | EFI_TLS_VERSION Version;\r | |
89 | EFI_TLS_CONNECTION_END ConnectionEnd;\r | |
90 | EFI_TLS_VERIFY VerifyMethod;\r | |
91 | EFI_TLS_SESSION_STATE SessionState;\r | |
92 | } TLS_CONFIG_DATA;\r | |
93 | \r | |
895b87e3 JW |
94 | //\r |
95 | // Callback data for HTTP_PARSER_CALLBACK()\r | |
96 | //\r | |
97 | typedef struct {\r | |
98 | UINTN ParseDataLength;\r | |
99 | VOID *ParseData;\r | |
100 | VOID *Wrap;\r | |
101 | } HTTP_CALLBACK_DATA;\r | |
102 | \r | |
47f51a06 YT |
103 | typedef struct _HTTP_PROTOCOL {\r |
104 | UINT32 Signature;\r | |
105 | EFI_HTTP_PROTOCOL Http;\r | |
106 | EFI_HANDLE Handle;\r | |
107 | HTTP_SERVICE *Service;\r | |
108 | LIST_ENTRY Link; // Link to all HTTP instance from the service.\r | |
109 | BOOLEAN InDestroy;\r | |
110 | INTN State;\r | |
d8293d31 | 111 | EFI_HTTP_METHOD Method;\r |
47f51a06 | 112 | \r |
072289f4 ZL |
113 | UINTN StatusCode;\r |
114 | \r | |
b347a22a JW |
115 | EFI_EVENT TimeoutEvent;\r |
116 | \r | |
b659408b | 117 | EFI_HANDLE Tcp4ChildHandle;\r |
47f51a06 YT |
118 | EFI_TCP4_PROTOCOL *Tcp4;\r |
119 | EFI_TCP4_CONFIG_DATA Tcp4CfgData;\r | |
120 | EFI_TCP4_OPTION Tcp4Option;\r | |
121 | \r | |
b659408b ZL |
122 | EFI_TCP4_CONNECTION_TOKEN Tcp4ConnToken;\r |
123 | BOOLEAN IsTcp4ConnDone;\r | |
124 | EFI_TCP4_CLOSE_TOKEN Tcp4CloseToken;\r | |
125 | BOOLEAN IsTcp4CloseDone;\r | |
47f51a06 YT |
126 | CHAR8 *RemoteHost;\r |
127 | UINT16 RemotePort;\r | |
128 | EFI_IPv4_ADDRESS RemoteAddr;\r | |
f75a7f56 | 129 | \r |
b659408b ZL |
130 | EFI_HANDLE Tcp6ChildHandle;\r |
131 | EFI_TCP6_PROTOCOL *Tcp6;\r | |
132 | EFI_TCP6_CONFIG_DATA Tcp6CfgData;\r | |
133 | EFI_TCP6_OPTION Tcp6Option;\r | |
f75a7f56 | 134 | \r |
b659408b ZL |
135 | EFI_TCP6_CONNECTION_TOKEN Tcp6ConnToken;\r |
136 | BOOLEAN IsTcp6ConnDone;\r | |
137 | EFI_TCP6_CLOSE_TOKEN Tcp6CloseToken;\r | |
138 | BOOLEAN IsTcp6CloseDone;\r | |
139 | EFI_IPv6_ADDRESS RemoteIpv6Addr;\r | |
f75a7f56 | 140 | \r |
47f51a06 | 141 | //\r |
b659408b | 142 | // Rx4Token or Rx6Token used for receiving HTTP header.\r |
47f51a06 | 143 | //\r |
b659408b ZL |
144 | EFI_TCP4_IO_TOKEN Rx4Token;\r |
145 | EFI_TCP4_RECEIVE_DATA Rx4Data;\r | |
146 | EFI_TCP6_IO_TOKEN Rx6Token;\r | |
147 | EFI_TCP6_RECEIVE_DATA Rx6Data;\r | |
47f51a06 YT |
148 | BOOLEAN IsRxDone;\r |
149 | \r | |
b659408b ZL |
150 | CHAR8 **EndofHeader;\r |
151 | CHAR8 **HttpHeaders;\r | |
47f51a06 YT |
152 | CHAR8 *CacheBody;\r |
153 | CHAR8 *NextMsg;\r | |
154 | UINTN CacheLen;\r | |
155 | UINTN CacheOffset;\r | |
156 | \r | |
157 | //\r | |
158 | // HTTP message-body parser.\r | |
159 | //\r | |
160 | VOID *MsgParser;\r | |
895b87e3 | 161 | HTTP_CALLBACK_DATA CallbackData;\r |
f75a7f56 | 162 | \r |
47f51a06 YT |
163 | EFI_HTTP_VERSION HttpVersion;\r |
164 | UINT32 TimeOutMillisec;\r | |
165 | BOOLEAN LocalAddressIsIPv6;\r | |
166 | \r | |
167 | EFI_HTTPv4_ACCESS_POINT IPv4Node;\r | |
b659408b | 168 | EFI_HTTPv6_ACCESS_POINT Ipv6Node;\r |
47f51a06 YT |
169 | \r |
170 | NET_MAP TxTokens;\r | |
171 | NET_MAP RxTokens;\r | |
51b0450e FS |
172 | \r |
173 | CHAR8 *Url;\r | |
dac45de3 JW |
174 | \r |
175 | //\r | |
176 | // Https Support\r | |
177 | //\r | |
178 | BOOLEAN UseHttps;\r | |
45ea8a0c JW |
179 | \r |
180 | EFI_SERVICE_BINDING_PROTOCOL *TlsSb;\r | |
dac45de3 JW |
181 | EFI_HANDLE TlsChildHandle; /// Tls ChildHandle\r |
182 | TLS_CONFIG_DATA TlsConfigData;\r | |
183 | EFI_TLS_PROTOCOL *Tls;\r | |
184 | EFI_TLS_CONFIGURATION_PROTOCOL *TlsConfiguration;\r | |
185 | EFI_TLS_SESSION_STATE TlsSessionState;\r | |
186 | \r | |
187 | //\r | |
188 | // TlsTxData used for transmitting TLS related messages.\r | |
189 | //\r | |
190 | EFI_TCP4_IO_TOKEN Tcp4TlsTxToken;\r | |
191 | EFI_TCP4_TRANSMIT_DATA Tcp4TlsTxData;\r | |
192 | EFI_TCP6_IO_TOKEN Tcp6TlsTxToken;\r | |
193 | EFI_TCP6_TRANSMIT_DATA Tcp6TlsTxData;\r | |
194 | BOOLEAN TlsIsTxDone;\r | |
195 | \r | |
196 | //\r | |
197 | // TlsRxData used for receiving TLS related messages.\r | |
198 | //\r | |
199 | EFI_TCP4_IO_TOKEN Tcp4TlsRxToken;\r | |
200 | EFI_TCP4_RECEIVE_DATA Tcp4TlsRxData;\r | |
201 | EFI_TCP6_IO_TOKEN Tcp6TlsRxToken;\r | |
202 | EFI_TCP6_RECEIVE_DATA Tcp6TlsRxData;\r | |
203 | BOOLEAN TlsIsRxDone;\r | |
47f51a06 YT |
204 | } HTTP_PROTOCOL;\r |
205 | \r | |
206 | typedef struct {\r | |
207 | EFI_HTTP_TOKEN *HttpToken;\r | |
208 | HTTP_PROTOCOL *HttpInstance;\r | |
209 | HTTP_TCP_TOKEN_WRAP TcpWrap;\r | |
210 | } HTTP_TOKEN_WRAP;\r | |
211 | \r | |
212 | \r | |
213 | #define HTTP_PROTOCOL_SIGNATURE SIGNATURE_32('H', 't', 't', 'P')\r | |
214 | \r | |
215 | #define HTTP_INSTANCE_FROM_PROTOCOL(a) \\r | |
216 | CR ( \\r | |
217 | (a), \\r | |
218 | HTTP_PROTOCOL, \\r | |
219 | Http, \\r | |
220 | HTTP_PROTOCOL_SIGNATURE \\r | |
221 | )\r | |
222 | \r | |
223 | /**\r | |
f75a7f56 | 224 | The common notify function used in HTTP driver.\r |
47f51a06 YT |
225 | \r |
226 | @param[in] Event The event signaled.\r | |
227 | @param[in] Context The context.\r | |
228 | \r | |
229 | **/\r | |
230 | VOID\r | |
231 | EFIAPI\r | |
232 | HttpCommonNotify (\r | |
233 | IN EFI_EVENT Event,\r | |
234 | IN VOID *Context\r | |
235 | );\r | |
236 | \r | |
237 | /**\r | |
b659408b | 238 | Create events for the TCP connection token and TCP close token.\r |
47f51a06 YT |
239 | \r |
240 | @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.\r | |
241 | \r | |
242 | @retval EFI_SUCCESS The events are created successfully.\r | |
243 | @retval others Other error as indicated.\r | |
244 | \r | |
245 | **/\r | |
246 | EFI_STATUS\r | |
b659408b | 247 | HttpCreateTcpConnCloseEvent (\r |
47f51a06 YT |
248 | IN HTTP_PROTOCOL *HttpInstance\r |
249 | );\r | |
250 | \r | |
251 | /**\r | |
b659408b | 252 | Close events in the TCP connection token and TCP close token.\r |
47f51a06 YT |
253 | \r |
254 | @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.\r | |
255 | \r | |
256 | **/\r | |
257 | VOID\r | |
b659408b | 258 | HttpCloseTcpConnCloseEvent (\r |
47f51a06 YT |
259 | IN HTTP_PROTOCOL *HttpInstance\r |
260 | );\r | |
261 | \r | |
262 | /**\r | |
b659408b | 263 | Create event for the TCP transmit token.\r |
47f51a06 YT |
264 | \r |
265 | @param[in] Wrap Point to HTTP token's wrap data.\r | |
266 | \r | |
267 | @retval EFI_SUCCESS The events is created successfully.\r | |
268 | @retval others Other error as indicated.\r | |
269 | \r | |
270 | **/\r | |
271 | EFI_STATUS\r | |
b659408b | 272 | HttpCreateTcpTxEvent (\r |
47f51a06 YT |
273 | IN HTTP_TOKEN_WRAP *Wrap\r |
274 | );\r | |
275 | \r | |
276 | /**\r | |
b659408b | 277 | Create event for the TCP receive token which is used to receive HTTP header.\r |
47f51a06 YT |
278 | \r |
279 | @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.\r | |
280 | \r | |
281 | @retval EFI_SUCCESS The events is created successfully.\r | |
282 | @retval others Other error as indicated.\r | |
283 | \r | |
284 | **/\r | |
285 | EFI_STATUS\r | |
b659408b | 286 | HttpCreateTcpRxEventForHeader (\r |
47f51a06 YT |
287 | IN HTTP_PROTOCOL *HttpInstance\r |
288 | );\r | |
289 | \r | |
290 | /**\r | |
b659408b | 291 | Create event for the TCP receive token which is used to receive HTTP body.\r |
47f51a06 YT |
292 | \r |
293 | @param[in] Wrap Point to HTTP token's wrap data.\r | |
294 | \r | |
295 | @retval EFI_SUCCESS The events is created successfully.\r | |
296 | @retval others Other error as indicated.\r | |
297 | \r | |
298 | **/\r | |
299 | EFI_STATUS\r | |
b659408b | 300 | HttpCreateTcpRxEvent (\r |
f75a7f56 | 301 | IN HTTP_TOKEN_WRAP *Wrap\r |
47f51a06 YT |
302 | );\r |
303 | \r | |
b659408b ZL |
304 | /**\r |
305 | Close Events for Tcp Receive Tokens for HTTP body and HTTP header.\r | |
306 | \r | |
307 | @param[in] Wrap Pointer to HTTP token's wrap data.\r | |
f75a7f56 | 308 | \r |
b659408b ZL |
309 | **/\r |
310 | VOID\r | |
311 | HttpCloseTcpRxEvent (\r | |
312 | IN HTTP_TOKEN_WRAP *Wrap\r | |
313 | );\r | |
314 | \r | |
47f51a06 YT |
315 | /**\r |
316 | Intiialize the HTTP_PROTOCOL structure to the unconfigured state.\r | |
317 | \r | |
47f51a06 | 318 | @param[in, out] HttpInstance Pointer to HTTP_PROTOCOL structure.\r |
b659408b | 319 | @param[in] IpVersion Indicate us TCP4 protocol or TCP6 protocol.\r |
47f51a06 | 320 | \r |
f75a7f56 | 321 | @retval EFI_SUCCESS HTTP_PROTOCOL structure is initialized successfully.\r |
47f51a06 YT |
322 | @retval Others Other error as indicated.\r |
323 | \r | |
324 | **/\r | |
325 | EFI_STATUS\r | |
326 | HttpInitProtocol (\r | |
b659408b ZL |
327 | IN OUT HTTP_PROTOCOL *HttpInstance,\r |
328 | IN BOOLEAN IpVersion\r | |
47f51a06 YT |
329 | );\r |
330 | \r | |
331 | /**\r | |
332 | Clean up the HTTP child, release all the resources used by it.\r | |
333 | \r | |
334 | @param[in] HttpInstance The HTTP child to clean up.\r | |
335 | \r | |
336 | **/\r | |
337 | VOID\r | |
338 | HttpCleanProtocol (\r | |
339 | IN HTTP_PROTOCOL *HttpInstance\r | |
340 | );\r | |
341 | \r | |
342 | /**\r | |
343 | Establish TCP connection with HTTP server.\r | |
344 | \r | |
345 | @param[in] HttpInstance The HTTP instance private data.\r | |
346 | \r | |
347 | @retval EFI_SUCCESS The TCP connection is established.\r | |
348 | @retval Others Other error as indicated.\r | |
349 | \r | |
350 | **/\r | |
351 | EFI_STATUS\r | |
352 | HttpCreateConnection (\r | |
353 | IN HTTP_PROTOCOL *HttpInstance\r | |
354 | );\r | |
355 | \r | |
356 | /**\r | |
357 | Close existing TCP connection.\r | |
358 | \r | |
359 | @param[in] HttpInstance The HTTP instance private data.\r | |
360 | \r | |
361 | @retval EFI_SUCCESS The TCP connection is closed.\r | |
362 | @retval Others Other error as indicated.\r | |
363 | \r | |
364 | **/\r | |
365 | EFI_STATUS\r | |
366 | HttpCloseConnection (\r | |
367 | IN HTTP_PROTOCOL *HttpInstance\r | |
368 | );\r | |
369 | \r | |
370 | /**\r | |
371 | Configure TCP4 protocol child.\r | |
372 | \r | |
373 | @param[in] HttpInstance The HTTP instance private data.\r | |
374 | @param[in] Wrap The HTTP token's wrap data.\r | |
375 | \r | |
376 | @retval EFI_SUCCESS The TCP4 protocol child is configured.\r | |
377 | @retval Others Other error as indicated.\r | |
378 | \r | |
379 | **/\r | |
380 | EFI_STATUS\r | |
381 | HttpConfigureTcp4 (\r | |
382 | IN HTTP_PROTOCOL *HttpInstance,\r | |
383 | IN HTTP_TOKEN_WRAP *Wrap\r | |
384 | );\r | |
385 | \r | |
b659408b ZL |
386 | /**\r |
387 | Configure TCP6 protocol child.\r | |
388 | \r | |
389 | @param[in] HttpInstance The HTTP instance private data.\r | |
390 | @param[in] Wrap The HTTP token's wrap data.\r | |
391 | \r | |
392 | @retval EFI_SUCCESS The TCP6 protocol child is configured.\r | |
393 | @retval Others Other error as indicated.\r | |
394 | \r | |
395 | **/\r | |
396 | EFI_STATUS\r | |
397 | HttpConfigureTcp6 (\r | |
398 | IN HTTP_PROTOCOL *HttpInstance,\r | |
399 | IN HTTP_TOKEN_WRAP *Wrap\r | |
400 | );\r | |
401 | \r | |
47f51a06 | 402 | /**\r |
f75a7f56 | 403 | Check existing TCP connection, if in error state, recover TCP4 connection. Then,\r |
dac45de3 | 404 | connect one TLS session if required.\r |
47f51a06 YT |
405 | \r |
406 | @param[in] HttpInstance The HTTP instance private data.\r | |
407 | \r | |
408 | @retval EFI_SUCCESS The TCP connection is established.\r | |
409 | @retval EFI_NOT_READY TCP4 protocol child is not created or configured.\r | |
410 | @retval Others Other error as indicated.\r | |
411 | \r | |
412 | **/\r | |
413 | EFI_STATUS\r | |
414 | HttpConnectTcp4 (\r | |
415 | IN HTTP_PROTOCOL *HttpInstance\r | |
416 | );\r | |
417 | \r | |
418 | /**\r | |
f75a7f56 | 419 | Check existing TCP connection, if in error state, recover TCP6 connection. Then,\r |
dac45de3 | 420 | connect one TLS session if required.\r |
b659408b ZL |
421 | \r |
422 | @param[in] HttpInstance The HTTP instance private data.\r | |
423 | \r | |
424 | @retval EFI_SUCCESS The TCP connection is established.\r | |
425 | @retval EFI_NOT_READY TCP6 protocol child is not created or configured.\r | |
426 | @retval Others Other error as indicated.\r | |
427 | \r | |
428 | **/\r | |
429 | EFI_STATUS\r | |
430 | HttpConnectTcp6 (\r | |
431 | IN HTTP_PROTOCOL *HttpInstance\r | |
432 | );\r | |
433 | \r | |
434 | /**\r | |
dac45de3 | 435 | Send the HTTP or HTTPS message through TCP4 or TCP6.\r |
47f51a06 YT |
436 | \r |
437 | @param[in] HttpInstance The HTTP instance private data.\r | |
438 | @param[in] Wrap The HTTP token's wrap data.\r | |
439 | @param[in] TxString Buffer containing the HTTP message string.\r | |
440 | @param[in] TxStringLen Length of the HTTP message string in bytes.\r | |
441 | \r | |
442 | @retval EFI_SUCCESS The HTTP message is queued into TCP transmit queue.\r | |
443 | @retval Others Other error as indicated.\r | |
444 | \r | |
445 | **/\r | |
446 | EFI_STATUS\r | |
b659408b | 447 | HttpTransmitTcp (\r |
47f51a06 YT |
448 | IN HTTP_PROTOCOL *HttpInstance,\r |
449 | IN HTTP_TOKEN_WRAP *Wrap,\r | |
450 | IN UINT8 *TxString,\r | |
451 | IN UINTN TxStringLen\r | |
452 | );\r | |
453 | \r | |
47f51a06 YT |
454 | /**\r |
455 | Check whether the user's token or event has already\r | |
b659408b | 456 | been enqueue on HTTP Tx or Rx Token list.\r |
47f51a06 YT |
457 | \r |
458 | @param[in] Map The container of either user's transmit or receive\r | |
459 | token.\r | |
460 | @param[in] Item Current item to check against.\r | |
461 | @param[in] Context The Token to check againist.\r | |
462 | \r | |
463 | @retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP\r | |
464 | @retval EFI_SUCCESS The current item isn't the same token/event as the\r | |
465 | context.\r | |
466 | \r | |
467 | **/\r | |
468 | EFI_STATUS\r | |
469 | EFIAPI\r | |
470 | HttpTokenExist (\r | |
471 | IN NET_MAP *Map,\r | |
472 | IN NET_MAP_ITEM *Item,\r | |
473 | IN VOID *Context\r | |
474 | );\r | |
475 | \r | |
476 | /**\r | |
b659408b | 477 | Check whether the HTTP message associated with TxToken or Tx6Token is already sent out.\r |
47f51a06 YT |
478 | \r |
479 | @param[in] Map The container of TxToken.\r | |
480 | @param[in] Item Current item to check against.\r | |
481 | @param[in] Context The Token to check againist.\r | |
482 | \r | |
483 | @retval EFI_NOT_READY The HTTP message is still queued in the list.\r | |
484 | @retval EFI_SUCCESS The HTTP message has been sent out.\r | |
485 | \r | |
486 | **/\r | |
487 | EFI_STATUS\r | |
488 | EFIAPI\r | |
489 | HttpTcpNotReady (\r | |
490 | IN NET_MAP *Map,\r | |
491 | IN NET_MAP_ITEM *Item,\r | |
492 | IN VOID *Context\r | |
493 | );\r | |
494 | \r | |
b659408b | 495 | /**\r |
dac45de3 | 496 | Initialize Http session.\r |
b659408b ZL |
497 | \r |
498 | @param[in] HttpInstance The HTTP instance private data.\r | |
499 | @param[in] Wrap The HTTP token's wrap data.\r | |
dac45de3 JW |
500 | @param[in] Configure The Flag indicates whether need to initialize session.\r |
501 | @param[in] TlsConfigure The Flag indicates whether it's the new Tls session.\r | |
b659408b | 502 | \r |
f75a7f56 | 503 | @retval EFI_SUCCESS The initialization of session is done.\r |
b659408b ZL |
504 | @retval Others Other error as indicated.\r |
505 | \r | |
506 | **/\r | |
507 | EFI_STATUS\r | |
dac45de3 | 508 | HttpInitSession (\r |
b659408b | 509 | IN HTTP_PROTOCOL *HttpInstance,\r |
a2e61982 | 510 | IN HTTP_TOKEN_WRAP *Wrap,\r |
dac45de3 JW |
511 | IN BOOLEAN Configure,\r |
512 | IN BOOLEAN TlsConfigure\r | |
b659408b ZL |
513 | );\r |
514 | \r | |
47f51a06 | 515 | /**\r |
dac45de3 | 516 | Transmit the HTTP or HTTPS mssage by processing the associated HTTP token.\r |
47f51a06 | 517 | \r |
b659408b | 518 | @param[in] Map The container of TxToken or Tx6Token.\r |
47f51a06 YT |
519 | @param[in] Item Current item to check against.\r |
520 | @param[in] Context The Token to check againist.\r | |
521 | \r | |
522 | @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.\r | |
523 | @retval EFI_SUCCESS The HTTP message is queued into TCP transmit\r | |
524 | queue.\r | |
525 | \r | |
526 | **/\r | |
527 | EFI_STATUS\r | |
528 | EFIAPI\r | |
529 | HttpTcpTransmit (\r | |
530 | IN NET_MAP *Map,\r | |
531 | IN NET_MAP_ITEM *Item,\r | |
532 | IN VOID *Context\r | |
533 | );\r | |
534 | \r | |
535 | /**\r | |
536 | Receive the HTTP response by processing the associated HTTP token.\r | |
537 | \r | |
b659408b | 538 | @param[in] Map The container of Rx4Token or Rx6Token.\r |
47f51a06 YT |
539 | @param[in] Item Current item to check against.\r |
540 | @param[in] Context The Token to check againist.\r | |
541 | \r | |
542 | @retval EFI_SUCCESS The HTTP response is queued into TCP receive\r | |
543 | queue.\r | |
544 | @retval Others Other error as indicated.\r | |
545 | \r | |
546 | **/\r | |
547 | EFI_STATUS\r | |
548 | EFIAPI\r | |
549 | HttpTcpReceive (\r | |
550 | IN NET_MAP *Map,\r | |
551 | IN NET_MAP_ITEM *Item,\r | |
552 | IN VOID *Context\r | |
553 | );\r | |
554 | \r | |
b659408b ZL |
555 | /**\r |
556 | Receive the HTTP header by processing the associated HTTP token.\r | |
557 | \r | |
558 | @param[in] HttpInstance The HTTP instance private data.\r | |
559 | @param[in, out] SizeofHeaders The HTTP header length.\r | |
560 | @param[in, out] BufferSize The size of buffer to cacahe the header message.\r | |
b347a22a | 561 | @param[in] Timeout The time to wait for receiving the header packet.\r |
b659408b | 562 | \r |
f75a7f56 | 563 | @retval EFI_SUCCESS The HTTP header is received.\r |
b659408b ZL |
564 | @retval Others Other errors as indicated.\r |
565 | \r | |
566 | **/\r | |
567 | EFI_STATUS\r | |
568 | HttpTcpReceiveHeader (\r | |
569 | IN HTTP_PROTOCOL *HttpInstance,\r | |
570 | IN OUT UINTN *SizeofHeaders,\r | |
b347a22a JW |
571 | IN OUT UINTN *BufferSize,\r |
572 | IN EFI_EVENT Timeout\r | |
b659408b ZL |
573 | );\r |
574 | \r | |
575 | /**\r | |
576 | Receive the HTTP body by processing the associated HTTP token.\r | |
577 | \r | |
578 | @param[in] Wrap The HTTP token's wrap data.\r | |
579 | @param[in] HttpMsg The HTTP message data.\r | |
580 | \r | |
f75a7f56 | 581 | @retval EFI_SUCCESS The HTTP body is received.\r |
b659408b ZL |
582 | @retval Others Other error as indicated.\r |
583 | \r | |
584 | **/\r | |
585 | EFI_STATUS\r | |
586 | HttpTcpReceiveBody (\r | |
587 | IN HTTP_TOKEN_WRAP *Wrap,\r | |
30526a51 | 588 | IN EFI_HTTP_MESSAGE *HttpMsg\r |
b659408b ZL |
589 | );\r |
590 | \r | |
591 | /**\r | |
592 | Clean up Tcp Tokens while the Tcp transmission error occurs.\r | |
593 | \r | |
594 | @param[in] Wrap Pointer to HTTP token's wrap data.\r | |
f75a7f56 | 595 | \r |
b659408b ZL |
596 | **/\r |
597 | VOID\r | |
598 | HttpTcpTokenCleanup (\r | |
599 | IN HTTP_TOKEN_WRAP *Wrap\r | |
600 | );\r | |
601 | \r | |
47f51a06 YT |
602 | /**\r |
603 | The work function of EfiHttpResponse().\r | |
604 | \r | |
605 | @param[in] Wrap Pointer to HTTP token's wrap data.\r | |
606 | \r | |
607 | @retval EFI_SUCCESS Allocation succeeded.\r | |
608 | @retval EFI_OUT_OF_RESOURCES Failed to complete the opration due to lack of resources.\r | |
609 | @retval EFI_NOT_READY Can't find a corresponding TxToken.\r | |
610 | \r | |
611 | **/\r | |
612 | EFI_STATUS\r | |
613 | HttpResponseWorker (\r | |
614 | IN HTTP_TOKEN_WRAP *Wrap\r | |
615 | );\r | |
616 | \r | |
617 | #endif\r |