2 Implementation of EFI_HTTP_PROTOCOL protocol interfaces.
4 Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
7 SPDX-License-Identifier: BSD-2-Clause-Patent
11 #include "HttpDriver.h"
13 EFI_HTTP_PROTOCOL mEfiHttpTemplate
= {
23 Returns the operational parameters for the current HTTP child instance.
25 The GetModeData() function is used to read the current mode data (operational
26 parameters) for this HTTP protocol instance.
28 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
29 @param[out] HttpConfigData Point to buffer for operational parameters of this
30 HTTP instance. It is the responsibility of the caller
31 to allocate the memory for HttpConfigData and
32 HttpConfigData->AccessPoint.IPv6Node/IPv4Node. In fact,
33 it is recommended to allocate sufficient memory to record
34 IPv6Node since it is big enough for all possibilities.
36 @retval EFI_SUCCESS Operation succeeded.
37 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
39 HttpConfigData is NULL.
40 HttpConfigData->AccessPoint.IPv4Node or
41 HttpConfigData->AccessPoint.IPv6Node is NULL.
42 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.
48 IN EFI_HTTP_PROTOCOL
*This
,
49 OUT EFI_HTTP_CONFIG_DATA
*HttpConfigData
52 HTTP_PROTOCOL
*HttpInstance
;
55 // Check input parameters.
57 if ((This
== NULL
) || (HttpConfigData
== NULL
)) {
58 return EFI_INVALID_PARAMETER
;
61 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
63 if ((HttpConfigData
->AccessPoint
.IPv6Node
== NULL
) ||
64 (HttpConfigData
->AccessPoint
.IPv4Node
== NULL
)) {
65 return EFI_INVALID_PARAMETER
;
68 if (HttpInstance
->State
< HTTP_STATE_HTTP_CONFIGED
) {
69 return EFI_NOT_STARTED
;
72 HttpConfigData
->HttpVersion
= HttpInstance
->HttpVersion
;
73 HttpConfigData
->TimeOutMillisec
= HttpInstance
->TimeOutMillisec
;
74 HttpConfigData
->LocalAddressIsIPv6
= HttpInstance
->LocalAddressIsIPv6
;
76 if (HttpInstance
->LocalAddressIsIPv6
) {
78 HttpConfigData
->AccessPoint
.IPv6Node
,
79 &HttpInstance
->Ipv6Node
,
80 sizeof (HttpInstance
->Ipv6Node
)
84 HttpConfigData
->AccessPoint
.IPv4Node
,
85 &HttpInstance
->IPv4Node
,
86 sizeof (HttpInstance
->IPv4Node
)
94 Initialize or brutally reset the operational parameters for this EFI HTTP instance.
96 The Configure() function does the following:
97 When HttpConfigData is not NULL Initialize this EFI HTTP instance by configuring
98 timeout, local address, port, etc.
99 When HttpConfigData is NULL, reset this EFI HTTP instance by closing all active
100 connections with remote hosts, canceling all asynchronous tokens, and flush request
101 and response buffers without informing the appropriate hosts.
103 No other EFI HTTP function can be executed by this instance until the Configure()
104 function is executed and returns successfully.
106 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
107 @param[in] HttpConfigData Pointer to the configure data to configure the instance.
109 @retval EFI_SUCCESS Operation succeeded.
110 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
112 HttpConfigData->LocalAddressIsIPv6 is FALSE and
113 HttpConfigData->AccessPoint.IPv4Node is NULL.
114 HttpConfigData->LocalAddressIsIPv6 is TRUE and
115 HttpConfigData->AccessPoint.IPv6Node is NULL.
116 @retval EFI_ALREADY_STARTED Reinitialize this HTTP instance without calling
117 Configure() with NULL to reset it.
118 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
119 @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources when
120 executing Configure().
121 @retval EFI_UNSUPPORTED One or more options in HttpConfigData are not supported
122 in the implementation.
127 IN EFI_HTTP_PROTOCOL
*This
,
128 IN EFI_HTTP_CONFIG_DATA
*HttpConfigData OPTIONAL
131 HTTP_PROTOCOL
*HttpInstance
;
135 // Check input parameters.
138 (HttpConfigData
!= NULL
&&
139 ((HttpConfigData
->LocalAddressIsIPv6
&& HttpConfigData
->AccessPoint
.IPv6Node
== NULL
) ||
140 (!HttpConfigData
->LocalAddressIsIPv6
&& HttpConfigData
->AccessPoint
.IPv4Node
== NULL
)))) {
141 return EFI_INVALID_PARAMETER
;
144 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
145 ASSERT (HttpInstance
->Service
!= NULL
);
147 if (HttpConfigData
!= NULL
) {
149 if (HttpConfigData
->HttpVersion
>= HttpVersionUnsupported
) {
150 return EFI_UNSUPPORTED
;
154 // Now configure this HTTP instance.
156 if (HttpInstance
->State
!= HTTP_STATE_UNCONFIGED
) {
157 return EFI_ALREADY_STARTED
;
160 HttpInstance
->HttpVersion
= HttpConfigData
->HttpVersion
;
161 HttpInstance
->TimeOutMillisec
= HttpConfigData
->TimeOutMillisec
;
162 HttpInstance
->LocalAddressIsIPv6
= HttpConfigData
->LocalAddressIsIPv6
;
164 if (HttpConfigData
->LocalAddressIsIPv6
) {
166 &HttpInstance
->Ipv6Node
,
167 HttpConfigData
->AccessPoint
.IPv6Node
,
168 sizeof (HttpInstance
->Ipv6Node
)
172 &HttpInstance
->IPv4Node
,
173 HttpConfigData
->AccessPoint
.IPv4Node
,
174 sizeof (HttpInstance
->IPv4Node
)
181 Status
= HttpInitProtocol (HttpInstance
, HttpInstance
->LocalAddressIsIPv6
);
182 if (EFI_ERROR (Status
)) {
186 HttpInstance
->State
= HTTP_STATE_HTTP_CONFIGED
;
191 // Reset all the resources related to HttpInsance.
193 HttpCleanProtocol (HttpInstance
);
194 HttpInstance
->State
= HTTP_STATE_UNCONFIGED
;
201 The Request() function queues an HTTP request to this HTTP instance.
203 Similar to Transmit() function in the EFI TCP driver. When the HTTP request is sent
204 successfully, or if there is an error, Status in token will be updated and Event will
207 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
208 @param[in] Token Pointer to storage containing HTTP request token.
210 @retval EFI_SUCCESS Outgoing data was processed.
211 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.
212 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
213 @retval EFI_TIMEOUT Data was dropped out of the transmit or receive queue.
214 @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources.
215 @retval EFI_UNSUPPORTED The HTTP method is not supported in current
217 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
220 Token->Message is NULL.
221 Token->Message->Body is not NULL,
222 Token->Message->BodyLength is non-zero, and
223 Token->Message->Data is NULL, but a previous call to
224 Request()has not been completed successfully.
229 IN EFI_HTTP_PROTOCOL
*This
,
230 IN EFI_HTTP_TOKEN
*Token
233 EFI_HTTP_MESSAGE
*HttpMsg
;
234 EFI_HTTP_REQUEST_DATA
*Request
;
240 HTTP_PROTOCOL
*HttpInstance
;
243 BOOLEAN TlsConfigure
;
248 HTTP_TOKEN_WRAP
*Wrap
;
250 UINTN RequestMsgSize
;
251 EFI_HANDLE ImageHandle
;
264 TlsConfigure
= FALSE
;
266 if ((This
== NULL
) || (Token
== NULL
)) {
267 return EFI_INVALID_PARAMETER
;
270 HttpMsg
= Token
->Message
;
271 if (HttpMsg
== NULL
) {
272 return EFI_INVALID_PARAMETER
;
275 Request
= HttpMsg
->Data
.Request
;
278 // Only support GET, HEAD, DELETE, PATCH, PUT and POST method in current implementation.
280 if ((Request
!= NULL
) && (Request
->Method
!= HttpMethodGet
) &&
281 (Request
->Method
!= HttpMethodHead
) && (Request
->Method
!= HttpMethodDelete
) &&
282 (Request
->Method
!= HttpMethodPut
) && (Request
->Method
!= HttpMethodPost
) &&
283 (Request
->Method
!= HttpMethodPatch
)) {
284 return EFI_UNSUPPORTED
;
287 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
290 // Capture the method into HttpInstance.
292 if (Request
!= NULL
) {
293 HttpInstance
->Method
= Request
->Method
;
296 if (HttpInstance
->State
< HTTP_STATE_HTTP_CONFIGED
) {
297 return EFI_NOT_STARTED
;
300 if (Request
== NULL
) {
302 // Request would be NULL only for PUT/POST/PATCH operation (in the current implementation)
304 if ((HttpInstance
->Method
!= HttpMethodPut
) &&
305 (HttpInstance
->Method
!= HttpMethodPost
) &&
306 (HttpInstance
->Method
!= HttpMethodPatch
)) {
307 return EFI_INVALID_PARAMETER
;
311 // For PUT/POST/PATCH, we need to have the TCP already configured. Bail out if it is not!
313 if (HttpInstance
->State
< HTTP_STATE_TCP_CONFIGED
) {
314 return EFI_INVALID_PARAMETER
;
318 // We need to have the Message Body for sending the HTTP message across in these cases.
320 if (HttpMsg
->Body
== NULL
|| HttpMsg
->BodyLength
== 0) {
321 return EFI_INVALID_PARAMETER
;
325 // Use existing TCP instance to transmit the packet.
331 // Check whether the token already existed.
333 if (EFI_ERROR (NetMapIterate (&HttpInstance
->TxTokens
, HttpTokenExist
, Token
))) {
334 return EFI_ACCESS_DENIED
;
338 // Parse the URI of the remote host.
340 Url
= HttpInstance
->Url
;
341 UrlLen
= StrLen (Request
->Url
) + 1;
342 if (UrlLen
> HTTP_URL_BUFFER_LEN
) {
343 Url
= AllocateZeroPool (UrlLen
);
345 return EFI_OUT_OF_RESOURCES
;
347 FreePool (HttpInstance
->Url
);
348 HttpInstance
->Url
= Url
;
352 UnicodeStrToAsciiStrS (Request
->Url
, Url
, UrlLen
);
355 // From the information in Url, the HTTP instance will
356 // be able to determine whether to use http or https.
358 HttpInstance
->UseHttps
= IsHttpsUrl (Url
);
361 // HTTP is disabled, return directly if the URI is not HTTPS.
363 if (!PcdGetBool (PcdAllowHttpConnections
) && !(HttpInstance
->UseHttps
)) {
365 DEBUG ((EFI_D_ERROR
, "EfiHttpRequest: HTTP is disabled.\n"));
367 return EFI_ACCESS_DENIED
;
371 // Check whether we need to create Tls child and open the TLS protocol.
373 if (HttpInstance
->UseHttps
&& HttpInstance
->TlsChildHandle
== NULL
) {
375 // Use TlsSb to create Tls child and open the TLS protocol.
377 if (HttpInstance
->LocalAddressIsIPv6
) {
378 ImageHandle
= HttpInstance
->Service
->Ip6DriverBindingHandle
;
380 ImageHandle
= HttpInstance
->Service
->Ip4DriverBindingHandle
;
383 HttpInstance
->TlsChildHandle
= TlsCreateChild (
385 &(HttpInstance
->TlsSb
),
386 &(HttpInstance
->Tls
),
387 &(HttpInstance
->TlsConfiguration
)
389 if (HttpInstance
->TlsChildHandle
== NULL
) {
390 return EFI_DEVICE_ERROR
;
397 Status
= HttpParseUrl (Url
, (UINT32
) AsciiStrLen (Url
), FALSE
, &UrlParser
);
398 if (EFI_ERROR (Status
)) {
402 Status
= HttpUrlGetHostName (Url
, UrlParser
, &HostName
);
403 if (EFI_ERROR (Status
)) {
407 if (HttpInstance
->LocalAddressIsIPv6
) {
408 HostNameSize
= AsciiStrSize (HostName
);
410 if (HostNameSize
> 2 && HostName
[0] == '[' && HostName
[HostNameSize
- 2] == ']') {
412 // HostName format is expressed as IPv6, so, remove '[' and ']'.
415 CopyMem (HostName
, HostName
+ 1, HostNameSize
- 1);
416 HostName
[HostNameSize
- 1] = '\0';
420 Status
= HttpUrlGetPort (Url
, UrlParser
, &RemotePort
);
421 if (EFI_ERROR (Status
)) {
422 if (HttpInstance
->UseHttps
) {
423 RemotePort
= HTTPS_DEFAULT_PORT
;
425 RemotePort
= HTTP_DEFAULT_PORT
;
429 // If Configure is TRUE, it indicates the first time to call Request();
430 // If ReConfigure is TRUE, it indicates the request URL is not same
431 // with the previous call to Request();
436 if (HttpInstance
->RemoteHost
== NULL
) {
438 // Request() is called the first time.
442 if ((HttpInstance
->RemotePort
== RemotePort
) &&
443 (AsciiStrCmp (HttpInstance
->RemoteHost
, HostName
) == 0) &&
444 (!HttpInstance
->UseHttps
|| (HttpInstance
->UseHttps
&&
446 HttpInstance
->TlsSessionState
== EfiTlsSessionDataTransferring
))) {
448 // Host Name and port number of the request URL are the same with previous call to Request().
449 // If Https protocol used, the corresponding SessionState is EfiTlsSessionDataTransferring.
450 // Check whether previous TCP packet sent out.
453 if (EFI_ERROR (NetMapIterate (&HttpInstance
->TxTokens
, HttpTcpNotReady
, NULL
))) {
455 // Wrap the HTTP token in HTTP_TOKEN_WRAP
457 Wrap
= AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP
));
459 Status
= EFI_OUT_OF_RESOURCES
;
463 Wrap
->HttpToken
= Token
;
464 Wrap
->HttpInstance
= HttpInstance
;
466 Status
= HttpCreateTcpTxEvent (Wrap
);
467 if (EFI_ERROR (Status
)) {
471 Status
= NetMapInsertTail (&HttpInstance
->TxTokens
, Token
, Wrap
);
472 if (EFI_ERROR (Status
)) {
476 Wrap
->TcpWrap
.Method
= Request
->Method
;
480 HttpUrlFreeParser (UrlParser
);
483 // Queue the HTTP token and return.
488 // Use existing TCP instance to transmit the packet.
495 // Need close existing TCP instance and create a new TCP instance for data transmit.
497 if (HttpInstance
->RemoteHost
!= NULL
) {
498 FreePool (HttpInstance
->RemoteHost
);
499 HttpInstance
->RemoteHost
= NULL
;
500 HttpInstance
->RemotePort
= 0;
508 // Parse Url for IPv4 or IPv6 address, if failed, perform DNS resolution.
510 if (!HttpInstance
->LocalAddressIsIPv6
) {
511 Status
= NetLibAsciiStrToIp4 (HostName
, &HttpInstance
->RemoteAddr
);
513 Status
= HttpUrlGetIp6 (Url
, UrlParser
, &HttpInstance
->RemoteIpv6Addr
);
516 if (EFI_ERROR (Status
)) {
517 HostNameSize
= AsciiStrSize (HostName
);
518 HostNameStr
= AllocateZeroPool (HostNameSize
* sizeof (CHAR16
));
519 if (HostNameStr
== NULL
) {
520 Status
= EFI_OUT_OF_RESOURCES
;
524 AsciiStrToUnicodeStrS (HostName
, HostNameStr
, HostNameSize
);
525 if (!HttpInstance
->LocalAddressIsIPv6
) {
526 Status
= HttpDns4 (HttpInstance
, HostNameStr
, &HttpInstance
->RemoteAddr
);
528 Status
= HttpDns6 (HttpInstance
, HostNameStr
, &HttpInstance
->RemoteIpv6Addr
);
531 FreePool (HostNameStr
);
532 if (EFI_ERROR (Status
)) {
533 DEBUG ((EFI_D_ERROR
, "Error: Could not retrieve the host address from DNS server.\n"));
539 // Save the RemotePort and RemoteHost.
541 ASSERT (HttpInstance
->RemoteHost
== NULL
);
542 HttpInstance
->RemotePort
= RemotePort
;
543 HttpInstance
->RemoteHost
= HostName
;
549 // The request URL is different from previous calls to Request(), close existing TCP instance.
551 if (!HttpInstance
->LocalAddressIsIPv6
) {
552 ASSERT (HttpInstance
->Tcp4
!= NULL
);
554 ASSERT (HttpInstance
->Tcp6
!= NULL
);
557 if (HttpInstance
->UseHttps
&& !TlsConfigure
) {
558 Status
= TlsCloseSession (HttpInstance
);
559 if (EFI_ERROR (Status
)) {
563 TlsCloseTxRxEvent (HttpInstance
);
566 HttpCloseConnection (HttpInstance
);
567 EfiHttpCancel (This
, NULL
);
571 // Wrap the HTTP token in HTTP_TOKEN_WRAP
573 Wrap
= AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP
));
575 Status
= EFI_OUT_OF_RESOURCES
;
579 Wrap
->HttpToken
= Token
;
580 Wrap
->HttpInstance
= HttpInstance
;
581 if (Request
!= NULL
) {
582 Wrap
->TcpWrap
.Method
= Request
->Method
;
585 Status
= HttpInitSession (
588 Configure
|| ReConfigure
,
591 if (EFI_ERROR (Status
)) {
595 if (!Configure
&& !ReConfigure
&& !TlsConfigure
) {
597 // For the new HTTP token, create TX TCP token events.
599 Status
= HttpCreateTcpTxEvent (Wrap
);
600 if (EFI_ERROR (Status
)) {
606 // Create request message.
609 if (Url
!= NULL
&& *FileUrl
!= '/') {
611 // Convert the absolute-URI to the absolute-path
613 while (*FileUrl
!= ':') {
616 if ((*(FileUrl
+1) == '/') && (*(FileUrl
+2) == '/')) {
618 while (*FileUrl
!= '/') {
622 Status
= EFI_INVALID_PARAMETER
;
627 Status
= HttpGenRequestMessage (HttpMsg
, FileUrl
, &RequestMsg
, &RequestMsgSize
);
629 if (EFI_ERROR (Status
) || NULL
== RequestMsg
) {
634 // Every request we insert a TxToken and a response call would remove the TxToken.
635 // In cases of PUT/POST/PATCH, after an initial request-response pair, we would do a
636 // continuous request without a response call. So, in such cases, where Request
637 // structure is NULL, we would not insert a TxToken.
639 if (Request
!= NULL
) {
640 Status
= NetMapInsertTail (&HttpInstance
->TxTokens
, Token
, Wrap
);
641 if (EFI_ERROR (Status
)) {
647 // Transmit the request message.
649 Status
= HttpTransmitTcp (
655 if (EFI_ERROR (Status
)) {
661 if (HostName
!= NULL
) {
665 if (UrlParser
!= NULL
) {
666 HttpUrlFreeParser (UrlParser
);
673 // We would have inserted a TxToken only if Request structure is not NULL.
674 // Hence check before we do a remove in this error case.
676 if (Request
!= NULL
) {
677 NetMapRemoveTail (&HttpInstance
->TxTokens
, NULL
);
681 if (RequestMsg
!= NULL
) {
682 FreePool (RequestMsg
);
686 if (HttpInstance
->UseHttps
) {
687 TlsCloseSession (HttpInstance
);
688 TlsCloseTxRxEvent (HttpInstance
);
692 HttpCloseConnection (HttpInstance
);
694 HttpCloseTcpConnCloseEvent (HttpInstance
);
695 if (NULL
!= Wrap
->TcpWrap
.Tx4Token
.CompletionToken
.Event
) {
696 gBS
->CloseEvent (Wrap
->TcpWrap
.Tx4Token
.CompletionToken
.Event
);
697 Wrap
->TcpWrap
.Tx4Token
.CompletionToken
.Event
= NULL
;
699 if (NULL
!= Wrap
->TcpWrap
.Tx6Token
.CompletionToken
.Event
) {
700 gBS
->CloseEvent (Wrap
->TcpWrap
.Tx6Token
.CompletionToken
.Event
);
701 Wrap
->TcpWrap
.Tx6Token
.CompletionToken
.Event
= NULL
;
705 if (HostName
!= NULL
) {
711 if (UrlParser
!= NULL
) {
712 HttpUrlFreeParser (UrlParser
);
720 Cancel a user's Token.
722 @param[in] Map The HTTP instance's token queue.
723 @param[in] Item Object container for one HTTP token and token's wrap.
724 @param[in] Context The user's token to cancel.
726 @retval EFI_SUCCESS Continue to check the next Item.
727 @retval EFI_ABORTED The user's Token (Token != NULL) is cancelled.
734 IN NET_MAP_ITEM
*Item
,
738 EFI_HTTP_TOKEN
*Token
;
739 HTTP_TOKEN_WRAP
*Wrap
;
740 HTTP_PROTOCOL
*HttpInstance
;
742 Token
= (EFI_HTTP_TOKEN
*) Context
;
745 // Return EFI_SUCCESS to check the next item in the map if
746 // this one doesn't match.
748 if ((Token
!= NULL
) && (Token
!= Item
->Key
)) {
752 Wrap
= (HTTP_TOKEN_WRAP
*) Item
->Value
;
753 ASSERT (Wrap
!= NULL
);
754 HttpInstance
= Wrap
->HttpInstance
;
756 if (!HttpInstance
->LocalAddressIsIPv6
) {
757 if (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
!= NULL
) {
759 // Cancle the Token before close its Event.
761 HttpInstance
->Tcp4
->Cancel (HttpInstance
->Tcp4
, &Wrap
->TcpWrap
.Rx4Token
.CompletionToken
);
764 // Dispatch the DPC queued by the NotifyFunction of the canceled token's events.
769 if (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
!= NULL
) {
771 // Cancle the Token before close its Event.
773 HttpInstance
->Tcp6
->Cancel (HttpInstance
->Tcp6
, &Wrap
->TcpWrap
.Rx6Token
.CompletionToken
);
776 // Dispatch the DPC queued by the NotifyFunction of the canceled token's events.
783 // If only one item is to be cancel, return EFI_ABORTED to stop
784 // iterating the map any more.
794 Cancel the user's receive/transmit request. It is the worker function of
795 EfiHttpCancel API. If a matching token is found, it will call HttpCancelTokens to cancel the
798 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
799 @param[in] Token The token to cancel. If NULL, all token will be
802 @retval EFI_SUCCESS The token is cancelled.
803 @retval EFI_NOT_FOUND The asynchronous request or response token is not found.
804 @retval Others Other error as indicated.
809 IN HTTP_PROTOCOL
*HttpInstance
,
810 IN EFI_HTTP_TOKEN
*Token
816 // First check the tokens queued by EfiHttpRequest().
818 Status
= NetMapIterate (&HttpInstance
->TxTokens
, HttpCancelTokens
, Token
);
819 if (EFI_ERROR (Status
)) {
821 if (Status
== EFI_ABORTED
) {
829 if (!HttpInstance
->UseHttps
) {
831 // Then check the tokens queued by EfiHttpResponse(), except for Https.
833 Status
= NetMapIterate (&HttpInstance
->RxTokens
, HttpCancelTokens
, Token
);
834 if (EFI_ERROR (Status
)) {
836 if (Status
== EFI_ABORTED
) {
839 return EFI_NOT_FOUND
;
846 if (!HttpInstance
->LocalAddressIsIPv6
) {
847 HttpInstance
->Tcp4
->Cancel (HttpInstance
->Tcp4
, &HttpInstance
->Tcp4TlsRxToken
.CompletionToken
);
849 HttpInstance
->Tcp6
->Cancel (HttpInstance
->Tcp6
, &HttpInstance
->Tcp6TlsRxToken
.CompletionToken
);
858 Abort an asynchronous HTTP request or response token.
860 The Cancel() function aborts a pending HTTP request or response transaction. If
861 Token is not NULL and the token is in transmit or receive queues when it is being
862 cancelled, its Token->Status will be set to EFI_ABORTED and then Token->Event will
863 be signaled. If the token is not in one of the queues, which usually means that the
864 asynchronous operation has completed, EFI_NOT_FOUND is returned. If Token is NULL,
865 all asynchronous tokens issued by Request() or Response() will be aborted.
867 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
868 @param[in] Token Point to storage containing HTTP request or response
871 @retval EFI_SUCCESS Request and Response queues are successfully flushed.
872 @retval EFI_INVALID_PARAMETER This is NULL.
873 @retval EFI_NOT_STARTED This instance hasn't been configured.
874 @retval EFI_NOT_FOUND The asynchronous request or response token is not
876 @retval EFI_UNSUPPORTED The implementation does not support this function.
882 IN EFI_HTTP_PROTOCOL
*This
,
883 IN EFI_HTTP_TOKEN
*Token
886 HTTP_PROTOCOL
*HttpInstance
;
889 return EFI_INVALID_PARAMETER
;
892 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
894 if (HttpInstance
->State
!= HTTP_STATE_TCP_CONNECTED
) {
895 return EFI_NOT_STARTED
;
898 return HttpCancel (HttpInstance
, Token
);
903 A callback function to intercept events during message parser.
905 This function will be invoked during HttpParseMessageBody() with various events type. An error
906 return status of the callback function will cause the HttpParseMessageBody() aborted.
908 @param[in] EventType Event type of this callback call.
909 @param[in] Data A pointer to data buffer.
910 @param[in] Length Length in bytes of the Data.
911 @param[in] Context Callback context set by HttpInitMsgParser().
913 @retval EFI_SUCCESS Continue to parser the message body.
918 HttpBodyParserCallback (
919 IN HTTP_BODY_PARSE_EVENT EventType
,
925 HTTP_CALLBACK_DATA
*CallbackData
;
926 HTTP_TOKEN_WRAP
*Wrap
;
930 if (EventType
!= BodyParseEventOnComplete
) {
934 if (Data
== NULL
|| Length
!= 0 || Context
== NULL
) {
938 CallbackData
= (HTTP_CALLBACK_DATA
*) Context
;
940 Wrap
= (HTTP_TOKEN_WRAP
*) (CallbackData
->Wrap
);
941 Body
= CallbackData
->ParseData
;
942 BodyLength
= CallbackData
->ParseDataLength
;
944 if (Data
< Body
+ BodyLength
) {
945 Wrap
->HttpInstance
->NextMsg
= Data
;
947 Wrap
->HttpInstance
->NextMsg
= NULL
;
954 The work function of EfiHttpResponse().
956 @param[in] Wrap Pointer to HTTP token's wrap data.
958 @retval EFI_SUCCESS Allocation succeeded.
959 @retval EFI_OUT_OF_RESOURCES Failed to complete the opration due to lack of resources.
960 @retval EFI_NOT_READY Can't find a corresponding Tx4Token/Tx6Token or
961 the EFI_HTTP_UTILITIES_PROTOCOL is not available.
966 IN HTTP_TOKEN_WRAP
*Wrap
970 EFI_HTTP_MESSAGE
*HttpMsg
;
978 CHAR8
*StatusCodeStr
;
980 HTTP_PROTOCOL
*HttpInstance
;
981 EFI_HTTP_TOKEN
*Token
;
983 HTTP_TOKEN_WRAP
*ValueInItem
;
985 NET_FRAGMENT Fragment
;
987 if (Wrap
== NULL
|| Wrap
->HttpInstance
== NULL
) {
988 return EFI_INVALID_PARAMETER
;
991 HttpInstance
= Wrap
->HttpInstance
;
992 Token
= Wrap
->HttpToken
;
993 HttpMsg
= Token
->Message
;
995 HttpInstance
->EndofHeader
= NULL
;
996 HttpInstance
->HttpHeaders
= NULL
;
997 HttpMsg
->Headers
= NULL
;
1004 Fragment
.Bulk
= NULL
;
1006 if (HttpMsg
->Data
.Response
!= NULL
) {
1008 // Check whether we have cached header from previous call.
1010 if ((HttpInstance
->CacheBody
!= NULL
) && (HttpInstance
->NextMsg
!= NULL
)) {
1012 // The data is stored at [NextMsg, CacheBody + CacheLen].
1014 HdrLen
= HttpInstance
->CacheBody
+ HttpInstance
->CacheLen
- HttpInstance
->NextMsg
;
1015 HttpHeaders
= AllocateZeroPool (HdrLen
);
1016 if (HttpHeaders
== NULL
) {
1017 Status
= EFI_OUT_OF_RESOURCES
;
1021 CopyMem (HttpHeaders
, HttpInstance
->NextMsg
, HdrLen
);
1022 FreePool (HttpInstance
->CacheBody
);
1023 HttpInstance
->CacheBody
= NULL
;
1024 HttpInstance
->NextMsg
= NULL
;
1025 HttpInstance
->CacheOffset
= 0;
1026 SizeofHeaders
= HdrLen
;
1027 BufferSize
= HttpInstance
->CacheLen
;
1030 // Check whether we cached the whole HTTP headers.
1032 EndofHeader
= AsciiStrStr (HttpHeaders
, HTTP_END_OF_HDR_STR
);
1035 HttpInstance
->EndofHeader
= &EndofHeader
;
1036 HttpInstance
->HttpHeaders
= &HttpHeaders
;
1039 if (HttpInstance
->TimeoutEvent
== NULL
) {
1041 // Create TimeoutEvent for response
1043 Status
= gBS
->CreateEvent (
1048 &HttpInstance
->TimeoutEvent
1050 if (EFI_ERROR (Status
)) {
1056 // Start the timer, and wait Timeout seconds to receive the header packet.
1058 Status
= gBS
->SetTimer (HttpInstance
->TimeoutEvent
, TimerRelative
, HTTP_RESPONSE_TIMEOUT
* TICKS_PER_SECOND
);
1059 if (EFI_ERROR (Status
)) {
1063 Status
= HttpTcpReceiveHeader (HttpInstance
, &SizeofHeaders
, &BufferSize
, HttpInstance
->TimeoutEvent
);
1065 gBS
->SetTimer (HttpInstance
->TimeoutEvent
, TimerCancel
, 0);
1067 if (EFI_ERROR (Status
)) {
1071 ASSERT (HttpHeaders
!= NULL
);
1074 // Cache the part of body.
1076 BodyLen
= BufferSize
- (EndofHeader
- HttpHeaders
);
1078 if (HttpInstance
->CacheBody
!= NULL
) {
1079 FreePool (HttpInstance
->CacheBody
);
1082 HttpInstance
->CacheBody
= AllocateZeroPool (BodyLen
);
1083 if (HttpInstance
->CacheBody
== NULL
) {
1084 Status
= EFI_OUT_OF_RESOURCES
;
1088 CopyMem (HttpInstance
->CacheBody
, EndofHeader
, BodyLen
);
1089 HttpInstance
->CacheLen
= BodyLen
;
1093 // Search for Status Code.
1095 StatusCodeStr
= HttpHeaders
+ AsciiStrLen (HTTP_VERSION_STR
) + 1;
1096 if (StatusCodeStr
== NULL
) {
1097 Status
= EFI_NOT_READY
;
1101 StatusCode
= AsciiStrDecimalToUintn (StatusCodeStr
);
1104 // Remove the first line of HTTP message, e.g. "HTTP/1.1 200 OK\r\n".
1106 Tmp
= AsciiStrStr (HttpHeaders
, HTTP_CRLF_STR
);
1108 Status
= EFI_NOT_READY
;
1113 // We could have response with just a HTTP message and no headers. For Example,
1114 // "100 Continue". In such cases, we would not want to unnecessarily call a Parse
1115 // method. A "\r\n" following Tmp string again would indicate an end. Compare and
1116 // set SizeofHeaders to 0.
1118 Tmp
= Tmp
+ AsciiStrLen (HTTP_CRLF_STR
);
1119 if (CompareMem (Tmp
, HTTP_CRLF_STR
, AsciiStrLen (HTTP_CRLF_STR
)) == 0) {
1122 SizeofHeaders
= SizeofHeaders
- (Tmp
- HttpHeaders
);
1125 HttpMsg
->Data
.Response
->StatusCode
= HttpMappingToStatusCode (StatusCode
);
1126 HttpInstance
->StatusCode
= StatusCode
;
1128 Status
= EFI_NOT_READY
;
1132 // In cases of PUT/POST/PATCH, after an initial request-response pair, we would do a
1133 // continuous request without a response call. So, we would not do an insert of
1134 // TxToken. After we have sent the complete file, we will call a response to get
1135 // a final response from server. In such a case, we would not have any TxTokens.
1136 // Hence, check that case before doing a NetMapRemoveHead.
1138 if (!NetMapIsEmpty (&HttpInstance
->TxTokens
)) {
1139 NetMapRemoveHead (&HttpInstance
->TxTokens
, (VOID
**) &ValueInItem
);
1140 if (ValueInItem
== NULL
) {
1145 // The first Tx Token not transmitted yet, insert back and return error.
1147 if (!ValueInItem
->TcpWrap
.IsTxDone
) {
1152 if (SizeofHeaders
!= 0) {
1153 HeaderTmp
= AllocateZeroPool (SizeofHeaders
);
1154 if (HeaderTmp
== NULL
) {
1155 Status
= EFI_OUT_OF_RESOURCES
;
1159 CopyMem (HeaderTmp
, Tmp
, SizeofHeaders
);
1160 FreePool (HttpHeaders
);
1161 HttpHeaders
= HeaderTmp
;
1164 // Check whether the EFI_HTTP_UTILITIES_PROTOCOL is available.
1166 if (mHttpUtilities
== NULL
) {
1167 Status
= EFI_NOT_READY
;
1172 // Parse the HTTP header into array of key/value pairs.
1174 Status
= mHttpUtilities
->Parse (
1179 &HttpMsg
->HeaderCount
1181 if (EFI_ERROR (Status
)) {
1185 FreePool (HttpHeaders
);
1190 // Init message-body parser by header information.
1192 Status
= HttpInitMsgParser (
1193 HttpInstance
->Method
,
1194 HttpMsg
->Data
.Response
->StatusCode
,
1195 HttpMsg
->HeaderCount
,
1197 HttpBodyParserCallback
,
1198 (VOID
*) (&HttpInstance
->CallbackData
),
1199 &HttpInstance
->MsgParser
1201 if (EFI_ERROR (Status
)) {
1206 // Check whether we received a complete HTTP message.
1208 if (HttpInstance
->CacheBody
!= NULL
) {
1210 // Record the CallbackData data.
1212 HttpInstance
->CallbackData
.Wrap
= (VOID
*) Wrap
;
1213 HttpInstance
->CallbackData
.ParseData
= (VOID
*) HttpInstance
->CacheBody
;
1214 HttpInstance
->CallbackData
.ParseDataLength
= HttpInstance
->CacheLen
;
1217 // Parse message with CallbackData data.
1219 Status
= HttpParseMessageBody (HttpInstance
->MsgParser
, HttpInstance
->CacheLen
, HttpInstance
->CacheBody
);
1220 if (EFI_ERROR (Status
)) {
1225 if (HttpIsMessageComplete (HttpInstance
->MsgParser
)) {
1227 // Free the MsgParse since we already have a full HTTP message.
1229 HttpFreeMsgParser (HttpInstance
->MsgParser
);
1230 HttpInstance
->MsgParser
= NULL
;
1234 if ((HttpMsg
->Body
== NULL
) || (HttpMsg
->BodyLength
== 0)) {
1235 Status
= EFI_SUCCESS
;
1241 // Receive the response body.
1246 // First check whether we cached some data.
1248 if (HttpInstance
->CacheBody
!= NULL
) {
1250 // Calculate the length of the cached data.
1252 if (HttpInstance
->NextMsg
!= NULL
) {
1254 // We have a cached HTTP message which includes a part of HTTP header of next message.
1256 BodyLen
= HttpInstance
->NextMsg
- (HttpInstance
->CacheBody
+ HttpInstance
->CacheOffset
);
1258 BodyLen
= HttpInstance
->CacheLen
- HttpInstance
->CacheOffset
;
1263 // We have some cached data. Just copy the data and return.
1265 if (HttpMsg
->BodyLength
< BodyLen
) {
1266 CopyMem (HttpMsg
->Body
, HttpInstance
->CacheBody
+ HttpInstance
->CacheOffset
, HttpMsg
->BodyLength
);
1267 HttpInstance
->CacheOffset
= HttpInstance
->CacheOffset
+ HttpMsg
->BodyLength
;
1270 // Copy all cached data out.
1272 CopyMem (HttpMsg
->Body
, HttpInstance
->CacheBody
+ HttpInstance
->CacheOffset
, BodyLen
);
1273 HttpInstance
->CacheOffset
= BodyLen
+ HttpInstance
->CacheOffset
;
1274 HttpMsg
->BodyLength
= BodyLen
;
1276 if (HttpInstance
->NextMsg
== NULL
) {
1278 // There is no HTTP header of next message. Just free the cache buffer.
1280 FreePool (HttpInstance
->CacheBody
);
1281 HttpInstance
->CacheBody
= NULL
;
1282 HttpInstance
->NextMsg
= NULL
;
1283 HttpInstance
->CacheOffset
= 0;
1287 // Return since we aready received required data.
1289 Status
= EFI_SUCCESS
;
1293 if (BodyLen
== 0 && HttpInstance
->MsgParser
== NULL
) {
1295 // We received a complete HTTP message, and we don't have more data to return to caller.
1297 HttpMsg
->BodyLength
= 0;
1298 Status
= EFI_SUCCESS
;
1303 ASSERT (HttpInstance
->MsgParser
!= NULL
);
1306 // We still need receive more data when there is no cache data and MsgParser is not NULL;
1308 if (!HttpInstance
->UseHttps
) {
1309 Status
= HttpTcpReceiveBody (Wrap
, HttpMsg
);
1311 if (EFI_ERROR (Status
)) {
1316 if (HttpInstance
->TimeoutEvent
== NULL
) {
1318 // Create TimeoutEvent for response
1320 Status
= gBS
->CreateEvent (
1325 &HttpInstance
->TimeoutEvent
1327 if (EFI_ERROR (Status
)) {
1333 // Start the timer, and wait Timeout seconds to receive the body packet.
1335 Status
= gBS
->SetTimer (HttpInstance
->TimeoutEvent
, TimerRelative
, HTTP_RESPONSE_TIMEOUT
* TICKS_PER_SECOND
);
1336 if (EFI_ERROR (Status
)) {
1340 Status
= HttpsReceive (HttpInstance
, &Fragment
, HttpInstance
->TimeoutEvent
);
1342 gBS
->SetTimer (HttpInstance
->TimeoutEvent
, TimerCancel
, 0);
1344 if (EFI_ERROR (Status
)) {
1349 // Process the received the body packet.
1351 HttpMsg
->BodyLength
= MIN (Fragment
.Len
, (UINT32
) HttpMsg
->BodyLength
);
1353 CopyMem (HttpMsg
->Body
, Fragment
.Bulk
, HttpMsg
->BodyLength
);
1356 // Record the CallbackData data.
1358 HttpInstance
->CallbackData
.Wrap
= (VOID
*) Wrap
;
1359 HttpInstance
->CallbackData
.ParseData
= HttpMsg
->Body
;
1360 HttpInstance
->CallbackData
.ParseDataLength
= HttpMsg
->BodyLength
;
1363 // Parse Body with CallbackData data.
1365 Status
= HttpParseMessageBody (
1366 HttpInstance
->MsgParser
,
1367 HttpMsg
->BodyLength
,
1370 if (EFI_ERROR (Status
)) {
1374 if (HttpIsMessageComplete (HttpInstance
->MsgParser
)) {
1376 // Free the MsgParse since we already have a full HTTP message.
1378 HttpFreeMsgParser (HttpInstance
->MsgParser
);
1379 HttpInstance
->MsgParser
= NULL
;
1383 // Check whether there is the next message header in the HttpMsg->Body.
1385 if (HttpInstance
->NextMsg
!= NULL
) {
1386 HttpMsg
->BodyLength
= HttpInstance
->NextMsg
- (CHAR8
*) HttpMsg
->Body
;
1389 HttpInstance
->CacheLen
= Fragment
.Len
- HttpMsg
->BodyLength
;
1390 if (HttpInstance
->CacheLen
!= 0) {
1391 if (HttpInstance
->CacheBody
!= NULL
) {
1392 FreePool (HttpInstance
->CacheBody
);
1395 HttpInstance
->CacheBody
= AllocateZeroPool (HttpInstance
->CacheLen
);
1396 if (HttpInstance
->CacheBody
== NULL
) {
1397 Status
= EFI_OUT_OF_RESOURCES
;
1401 CopyMem (HttpInstance
->CacheBody
, Fragment
.Bulk
+ HttpMsg
->BodyLength
, HttpInstance
->CacheLen
);
1402 HttpInstance
->CacheOffset
= 0;
1403 if (HttpInstance
->NextMsg
!= NULL
) {
1404 HttpInstance
->NextMsg
= HttpInstance
->CacheBody
;
1408 if (Fragment
.Bulk
!= NULL
) {
1409 FreePool (Fragment
.Bulk
);
1410 Fragment
.Bulk
= NULL
;
1419 Item
= NetMapFindKey (&Wrap
->HttpInstance
->RxTokens
, Wrap
->HttpToken
);
1421 NetMapRemoveItem (&Wrap
->HttpInstance
->RxTokens
, Item
, NULL
);
1424 if (HttpInstance
->StatusCode
>= HTTP_ERROR_OR_NOT_SUPPORT_STATUS_CODE
) {
1425 Token
->Status
= EFI_HTTP_ERROR
;
1427 Token
->Status
= Status
;
1430 gBS
->SignalEvent (Token
->Event
);
1431 HttpCloseTcpRxEvent (Wrap
);
1436 if (ValueInItem
!= NULL
) {
1437 NetMapInsertHead (&HttpInstance
->TxTokens
, ValueInItem
->HttpToken
, ValueInItem
);
1441 Item
= NetMapFindKey (&Wrap
->HttpInstance
->RxTokens
, Wrap
->HttpToken
);
1443 NetMapRemoveItem (&Wrap
->HttpInstance
->RxTokens
, Item
, NULL
);
1446 if (!HttpInstance
->UseHttps
) {
1447 HttpTcpTokenCleanup (Wrap
);
1452 if (HttpHeaders
!= NULL
) {
1453 FreePool (HttpHeaders
);
1457 if (Fragment
.Bulk
!= NULL
) {
1458 FreePool (Fragment
.Bulk
);
1459 Fragment
.Bulk
= NULL
;
1462 if (HttpMsg
->Headers
!= NULL
) {
1463 FreePool (HttpMsg
->Headers
);
1464 HttpMsg
->Headers
= NULL
;
1467 if (HttpInstance
->CacheBody
!= NULL
) {
1468 FreePool (HttpInstance
->CacheBody
);
1469 HttpInstance
->CacheBody
= NULL
;
1472 if (HttpInstance
->StatusCode
>= HTTP_ERROR_OR_NOT_SUPPORT_STATUS_CODE
) {
1473 Token
->Status
= EFI_HTTP_ERROR
;
1475 Token
->Status
= Status
;
1478 gBS
->SignalEvent (Token
->Event
);
1486 The Response() function queues an HTTP response to this HTTP instance, similar to
1487 Receive() function in the EFI TCP driver. When the HTTP response is received successfully,
1488 or if there is an error, Status in token will be updated and Event will be signaled.
1490 The HTTP driver will queue a receive token to the underlying TCP instance. When data
1491 is received in the underlying TCP instance, the data will be parsed and Token will
1492 be populated with the response data. If the data received from the remote host
1493 contains an incomplete or invalid HTTP header, the HTTP driver will continue waiting
1494 (asynchronously) for more data to be sent from the remote host before signaling
1497 It is the responsibility of the caller to allocate a buffer for Body and specify the
1498 size in BodyLength. If the remote host provides a response that contains a content
1499 body, up to BodyLength bytes will be copied from the receive buffer into Body and
1500 BodyLength will be updated with the amount of bytes received and copied to Body. This
1501 allows the client to download a large file in chunks instead of into one contiguous
1502 block of memory. Similar to HTTP request, if Body is not NULL and BodyLength is
1503 non-zero and all other fields are NULL or 0, the HTTP driver will queue a receive
1504 token to underlying TCP instance. If data arrives in the receive buffer, up to
1505 BodyLength bytes of data will be copied to Body. The HTTP driver will then update
1506 BodyLength with the amount of bytes received and copied to Body.
1508 If the HTTP driver does not have an open underlying TCP connection with the host
1509 specified in the response URL, Request() will return EFI_ACCESS_DENIED. This is
1510 consistent with RFC 2616 recommendation that HTTP clients should attempt to maintain
1511 an open TCP connection between client and host.
1513 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
1514 @param[in] Token Pointer to storage containing HTTP response token.
1516 @retval EFI_SUCCESS Allocation succeeded.
1517 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been
1519 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1522 Token->Message->Headers is NULL.
1523 Token->Message is NULL.
1524 Token->Message->Body is not NULL,
1525 Token->Message->BodyLength is non-zero, and
1526 Token->Message->Data is NULL, but a previous call to
1527 Response() has not been completed successfully.
1528 @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources.
1529 @retval EFI_ACCESS_DENIED An open TCP connection is not present with the host
1530 specified by response URL.
1535 IN EFI_HTTP_PROTOCOL
*This
,
1536 IN EFI_HTTP_TOKEN
*Token
1540 EFI_HTTP_MESSAGE
*HttpMsg
;
1541 HTTP_PROTOCOL
*HttpInstance
;
1542 HTTP_TOKEN_WRAP
*Wrap
;
1544 if ((This
== NULL
) || (Token
== NULL
)) {
1545 return EFI_INVALID_PARAMETER
;
1548 HttpMsg
= Token
->Message
;
1549 if (HttpMsg
== NULL
) {
1550 return EFI_INVALID_PARAMETER
;
1553 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
1555 if (HttpInstance
->State
!= HTTP_STATE_TCP_CONNECTED
) {
1556 return EFI_NOT_STARTED
;
1560 // Check whether the token already existed.
1562 if (EFI_ERROR (NetMapIterate (&HttpInstance
->RxTokens
, HttpTokenExist
, Token
))) {
1563 return EFI_ACCESS_DENIED
;
1566 Wrap
= AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP
));
1568 return EFI_OUT_OF_RESOURCES
;
1571 Wrap
->HttpInstance
= HttpInstance
;
1572 Wrap
->HttpToken
= Token
;
1575 // Notes: For Https, receive token wrapped in HTTP_TOKEN_WRAP is not used to
1576 // receive the https response. A special TlsRxToken is used for receiving TLS
1577 // related messages. It should be a blocking response.
1579 if (!HttpInstance
->UseHttps
) {
1580 Status
= HttpCreateTcpRxEvent (Wrap
);
1581 if (EFI_ERROR (Status
)) {
1586 Status
= NetMapInsertTail (&HttpInstance
->RxTokens
, Token
, Wrap
);
1587 if (EFI_ERROR (Status
)) {
1592 // If already have pending RxTokens, return directly.
1594 if (NetMapGetCount (&HttpInstance
->RxTokens
) > 1) {
1598 return HttpResponseWorker (Wrap
);
1602 if (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
!= NULL
) {
1603 gBS
->CloseEvent (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
);
1606 if (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
!= NULL
) {
1607 gBS
->CloseEvent (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
);
1616 The Poll() function can be used by network drivers and applications to increase the
1617 rate that data packets are moved between the communication devices and the transmit
1620 In some systems, the periodic timer event in the managed network driver may not poll
1621 the underlying communications device fast enough to transmit and/or receive all data
1622 packets without missing incoming packets or dropping outgoing packets. Drivers and
1623 applications that are experiencing packet loss should try calling the Poll() function
1626 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
1628 @retval EFI_SUCCESS Incoming or outgoing data was processed.
1629 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
1630 @retval EFI_INVALID_PARAMETER This is NULL.
1631 @retval EFI_NOT_READY No incoming or outgoing data is processed.
1632 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.
1638 IN EFI_HTTP_PROTOCOL
*This
1642 HTTP_PROTOCOL
*HttpInstance
;
1645 return EFI_INVALID_PARAMETER
;
1648 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
1650 if (HttpInstance
->State
!= HTTP_STATE_TCP_CONNECTED
) {
1651 return EFI_NOT_STARTED
;
1654 if (HttpInstance
->LocalAddressIsIPv6
) {
1655 if (HttpInstance
->Tcp6
== NULL
) {
1656 return EFI_NOT_STARTED
;
1658 Status
= HttpInstance
->Tcp6
->Poll (HttpInstance
->Tcp6
);
1660 if (HttpInstance
->Tcp4
== NULL
) {
1661 return EFI_NOT_STARTED
;
1663 Status
= HttpInstance
->Tcp4
->Poll (HttpInstance
->Tcp4
);