diff options
| author | Steve Huston <shuston@riverace.com> | 2010-09-01 21:02:28 +0000 |
|---|---|---|
| committer | Steve Huston <shuston@riverace.com> | 2010-09-01 21:02:28 +0000 |
| commit | 74a8ffda3b866a763ca5c0d54b2ab4cf41ce206a (patch) | |
| tree | 98110cfd6fcc2d4a5ebd1553065ea95d1dd4e9b1 /ACE/ace/ACE.h | |
| parent | efcd1ba0a60f6f796c2ea482bc46162c5c518333 (diff) | |
| download | ATCD-74a8ffda3b866a763ca5c0d54b2ab4cf41ce206a.tar.gz | |
Add correct docs on ACE::handle_ready et all return values
Diffstat (limited to 'ACE/ace/ACE.h')
| -rw-r--r-- | ACE/ace/ACE.h | 12 |
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, |