summaryrefslogtreecommitdiffstats
path: root/MdeModulePkg/Include/Library
diff options
context:
space:
mode:
authorFu Siyuan <siyuan.fu@intel.com>2017-12-05 14:10:40 +0800
committerFu Siyuan <siyuan.fu@intel.com>2017-12-12 15:48:09 +0800
commitb5035efab4c44dea1769034f1f9b23a49fe86f85 (patch)
tree821aebaebc9199ac8b2247620de70f2507b9a40e /MdeModulePkg/Include/Library
parentaf9743ef44f282a66c02998ac39e98d9826d16c5 (diff)
downloadedk2-b5035efab4c44dea1769034f1f9b23a49fe86f85.tar.gz
edk2-b5035efab4c44dea1769034f1f9b23a49fe86f85.tar.bz2
edk2-b5035efab4c44dea1769034f1f9b23a49fe86f85.zip
MdeModulePkg/TcpIoLib: Check input Timeout before calling CheckEvent() service.
For TcpIoConnect() and TcpIoAccept(), this patch adds the check for Timeout event before calling CheckEvent() service so as to avoid the unnecessary function call. Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Fu Siyuan <siyuan.fu@intel.com> Reviewed-by: Wu Jiaxin <jiaxin.wu@intel.com> Reviewed-by: Ye Ting <ting.ye@intel.com>
Diffstat (limited to 'MdeModulePkg/Include/Library')
-rw-r--r--MdeModulePkg/Include/Library/TcpIoLib.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/MdeModulePkg/Include/Library/TcpIoLib.h b/MdeModulePkg/Include/Library/TcpIoLib.h
index 2871f6747e..22629dbcd5 100644
--- a/MdeModulePkg/Include/Library/TcpIoLib.h
+++ b/MdeModulePkg/Include/Library/TcpIoLib.h
@@ -2,7 +2,7 @@
This library is used to share code between UEFI network stack modules.
It provides the helper routines to access TCP service.
-Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at<BR>
@@ -144,7 +144,7 @@ TcpIoDestroySocket (
Connect to the other endpoint of the TCP socket.
@param[in, out] TcpIo The TcpIo wrapping the TCP socket.
- @param[in] Timeout The time to wait for connection done.
+ @param[in] Timeout The time to wait for connection done. Set to NULL for infinite wait.
@retval EFI_SUCCESS Connect to the other endpoint of the TCP socket
successfully.
@@ -160,14 +160,14 @@ EFI_STATUS
EFIAPI
TcpIoConnect (
IN OUT TCP_IO *TcpIo,
- IN EFI_EVENT Timeout
+ IN EFI_EVENT Timeout OPTIONAL
);
/**
Accept the incomding request from the other endpoint of the TCP socket.
@param[in, out] TcpIo The TcpIo wrapping the TCP socket.
- @param[in] Timeout The time to wait for connection done.
+ @param[in] Timeout The time to wait for connection done. Set to NULL for infinite wait.
@retval EFI_SUCCESS Connect to the other endpoint of the TCP socket
@@ -185,7 +185,7 @@ EFI_STATUS
EFIAPI
TcpIoAccept (
IN OUT TCP_IO *TcpIo,
- IN EFI_EVENT Timeout
+ IN EFI_EVENT Timeout OPTIONAL
);
/**
@@ -229,7 +229,7 @@ TcpIoTransmit (
@param[in] Packet The buffer to hold the data copy from the socket rx buffer.
@param[in] AsyncMode Is this receive asyncronous or not.
@param[in] Timeout The time to wait for receiving the amount of data the Packet
- can hold.
+ can hold. Set to NULL for infinite wait.
@retval EFI_SUCCESS The required amount of data is received from the socket.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@@ -246,7 +246,7 @@ TcpIoReceive (
IN OUT TCP_IO *TcpIo,
IN NET_BUF *Packet,
IN BOOLEAN AsyncMode,
- IN EFI_EVENT Timeout
+ IN EFI_EVENT Timeout OPTIONAL
);
#endif