tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

MdePkg/Http.h: Clarify the usage of HttpConfigData in HTTP protocol 

Cc: Ye Ting <ting.ye@intel.com>
Cc: Fu Siyuan <siyuan.fu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Wu Jiaxin <jiaxin.wu@intel.com>
Reviewed-by: Fu Siyuan <siyuan.fu@intel.com>
Reviewed-by: Ye Ting <ting.ye@intel.com>
This commit is contained in:
Jiaxin Wu 2017-09-28 13:22:29 +08:00
parent 69cc013ca5
commit bf06b383e6
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
MdePkg/Include/Protocol/Http.h
View File

@ -305,15 +305,17 @@ typedef struct {
@param[in] This Pointer to EFI_HTTP_PROTOCOL instance. @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
@param[out] HttpConfigData Point to buffer for operational parameters of this @param[out] HttpConfigData Point to buffer for operational parameters of this
HTTP instance. HTTP instance. It is the responsibility of the caller
to allocate the memory for HttpConfigData and
HttpConfigData->AccessPoint.IPv6Node/IPv4Node. In fact,
it is recommended to allocate sufficient memory to record
IPv6Node since it is big enough for all possibilities.
@retval EFI_SUCCESS Operation succeeded. @retval EFI_SUCCESS Operation succeeded.
@retval EFI_INVALID_PARAMETER This is NULL. @retval EFI_INVALID_PARAMETER This is NULL.
HttpConfigData is NULL. HttpConfigData is NULL.
HttpInstance->LocalAddressIsIPv6 is FALSE and HttpConfigData->AccessPoint.IPv4Node or
HttpConfigData->IPv4Node is NULL. HttpConfigData->AccessPoint.IPv6Node is NULL.
HttpInstance->LocalAddressIsIPv6 is TRUE and
HttpConfigData->IPv6Node is NULL.
@retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started. @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.
**/ **/
typedef typedef
@ -343,9 +345,9 @@ EFI_STATUS
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
This is NULL. This is NULL.
HttpConfigData->LocalAddressIsIPv6 is FALSE and HttpConfigData->LocalAddressIsIPv6 is FALSE and
HttpConfigData->IPv4Node is NULL. HttpConfigData->AccessPoint.IPv4Node is NULL.
HttpConfigData->LocalAddressIsIPv6 is TRUE and HttpConfigData->LocalAddressIsIPv6 is TRUE and
HttpConfigData->IPv6Node is NULL. HttpConfigData->AccessPoint.IPv6Node is NULL.
@retval EFI_ALREADY_STARTED Reinitialize this HTTP instance without calling @retval EFI_ALREADY_STARTED Reinitialize this HTTP instance without calling
Configure() with NULL to reset it. Configure() with NULL to reset it.
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.