/**
Receive the HTTP response by processing the associated HTTP token.
@param[in] Map The container of RxToken.
@param[in] Item Current item to check against.
@param[in] Context The Token to check againist.
@retval EFI_SUCCESS The HTTP response is queued into TCP receive
queue.
@retval Others Other error as indicated.
**/
EFI_STATUS
EFIAPI
HttpTcpReceive (
IN NET_MAP *Map,
IN NET_MAP_ITEM *Item,
IN VOID *Context
)
{
//
// Process the queued HTTP response.
//
return HttpResponseWorker ((HTTP_TOKEN_WRAP *) Item->Value);
}
/**
The Response() function queues an HTTP response to this HTTP instance, similar to
Receive() function in the EFI TCP driver. When the HTTP request is sent successfully,
or if there is an error, Status in token will be updated and Event will be signaled.
The HTTP driver will queue a receive token to the underlying TCP instance. When data
is received in the underlying TCP instance, the data will be parsed and Token will
be populated with the response data. If the data received from the remote host
contains an incomplete or invalid HTTP header, the HTTP driver will continue waiting
(asynchronously) for more data to be sent from the remote host before signaling
Event in Token.
It is the responsibility of the caller to allocate a buffer for Body and specify the
size in BodyLength. If the remote host provides a response that contains a content
body, up to BodyLength bytes will be copied from the receive buffer into Body and
BodyLength will be updated with the amount of bytes received and copied to Body. This
allows the client to download a large file in chunks instead of into one contiguous
block of memory. Similar to HTTP request, if Body is not NULL and BodyLength is
non-zero and all other fields are NULL or 0, the HTTP driver will queue a receive
token to underlying TCP instance. If data arrives in the receive buffer, up to
BodyLength bytes of data will be copied to Body. The HTTP driver will then update
BodyLength with the amount of bytes received and copied to Body.
If the HTTP driver does not have an open underlying TCP connection with the host
specified in the response URL, Request() will return EFI_ACCESS_DENIED. This is
consistent with RFC 2616 recommendation that HTTP clients should attempt to maintain
an open TCP connection between client and host.
@param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
@param[in] Token Pointer to storage containing HTTP response token.
@retval EFI_SUCCESS Allocation succeeded.
@retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been
initialized.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
This is NULL.
Token is NULL.
Token->Message->Headers is NULL.
Token->Message is NULL.
Token->Message->Body is not NULL,
Token->Message->BodyLength is non-zero, and
Token->Message->Data is NULL, but a previous call to
Response() has not been completed successfully.
@retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources.
@retval EFI_ACCESS_DENIED An open TCP connection is not present with the host
specified by response URL.
**/
EFI_STATUS
EFIAPI
EfiHttpResponse (
IN EFI_HTTP_PROTOCOL *This,
IN EFI_HTTP_TOKEN *Token
)
{
EFI_STATUS Status;
EFI_HTTP_MESSAGE *HttpMsg;
HTTP_PROTOCOL *HttpInstance;
HTTP_TOKEN_WRAP *Wrap;
if ((This == NULL) || (Token == NULL)) {
return EFI_INVALID_PARAMETER;
}
HttpMsg = Token->Message;
if (HttpMsg == NULL) {
return EFI_INVALID_PARAMETER;
}
HttpInstance = HTTP_INSTANCE_FROM_PROTOCOL (This);
ASSERT (HttpInstance != NULL);
if (HttpInstance->State != HTTP_STATE_TCP_CONNECTED) {
return EFI_NOT_STARTED;
}
if (HttpInstance->LocalAddressIsIPv6) {
return EFI_UNSUPPORTED;
}
//
// Check whether the token already existed.
//
if (EFI_ERROR (NetMapIterate (&HttpInstance->RxTokens, HttpTokenExist, Token))) {
return EFI_ACCESS_DENIED;
}
Wrap = AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP));
if (Wrap == NULL) {
return EFI_OUT_OF_RESOURCES;
}
Wrap->HttpInstance = HttpInstance;
Wrap->HttpToken = Token;
Status = HttpCreateTcp4RxEvent (Wrap);
if (EFI_ERROR (Status)) {
goto Error;
}
Status = NetMapInsertTail (&HttpInstance->RxTokens, Token, Wrap);
if (EFI_ERROR (Status)) {
goto Error;
}
//
// If already have pending RxTokens, return directly.
//
if (NetMapGetCount (&HttpInstance->RxTokens) > 1) {
return EFI_SUCCESS;
}
return HttpResponseWorker (Wrap);
Error:
if (Wrap != NULL) {
if (Wrap->TcpWrap.RxToken.CompletionToken.Event != NULL) {
gBS->CloseEvent (Wrap->TcpWrap.RxToken.CompletionToken.Event);
}
FreePool (Wrap);
}
return Status;
}
