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