summaryrefslogtreecommitdiff
path: root/ACE/ace/ACE.h
diff options
context:
space:
mode:
Diffstat (limited to 'ACE/ace/ACE.h')
-rw-r--r--ACE/ace/ACE.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/ACE/ace/ACE.h b/ACE/ace/ACE.h
index 8894788b627..f945155b748 100644
--- a/ACE/ace/ACE.h
+++ b/ACE/ace/ACE.h
@@ -666,21 +666,33 @@ namespace ACE
const ACE_Time_Value *timeout = 0);
/// Timed wait for handle to get read ready.
+ /// @retval -1 for error
+ /// @retval 0 for timeout
+ /// @retval 1 the handle is ready
ACE_NAMESPACE_INLINE_FUNCTION
int handle_read_ready (ACE_HANDLE handle,
const ACE_Time_Value *timeout);
/// Timed wait for handle to get write ready.
+ /// @retval -1 for error
+ /// @retval 0 for timeout
+ /// @retval 1 the handle is ready
ACE_NAMESPACE_INLINE_FUNCTION
int handle_write_ready (ACE_HANDLE handle,
const ACE_Time_Value *timeout);
/// Timed wait for handle to get exception ready.
+ /// @retval -1 for error
+ /// @retval 0 for timeout
+ /// @retval 1 the handle is ready
ACE_NAMESPACE_INLINE_FUNCTION
int handle_exception_ready (ACE_HANDLE handle,
const ACE_Time_Value *timeout);
/// Timed wait for handle to get read, write, or exception ready.
+ /// @retval -1 for error
+ /// @retval 0 for timeout
+ /// @retval 1 the handle is ready
extern ACE_Export int handle_ready (ACE_HANDLE handle,
const ACE_Time_Value *timeout,
int read_ready,