summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Huston <shuston@riverace.com>2005-12-15 13:09:50 +0000
committerSteve Huston <shuston@riverace.com>2005-12-15 13:09:50 +0000
commit39d20f3e3777907df8e87fe5906ebbfc966951a8 (patch)
treeb0edcfcc48092e8fe4747780a4f5e94fdc9e7c02
parent7f9a00ced8e3e84753cad3cd589337eaf7f812b2 (diff)
downloadATCD-39d20f3e3777907df8e87fe5906ebbfc966951a8.tar.gz
ChangeLogTag:Thu Dec 15 08:08:31 2005 Steve Huston <shuston@riverace.com>
-rw-r--r--ChangeLog5
-rw-r--r--ace/Asynch_IO.h14
2 files changed, 16 insertions, 3 deletions
diff --git a/ChangeLog b/ChangeLog
index e4cf35bdde7..f12ad2fc628 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Thu Dec 15 08:08:31 2005 Steve Huston <shuston@riverace.com>
+
+ * ace/Asynch_IO.h: Clarified arguments and return value for
+ ACE_Asynch_Read_Stream::open.
+
Thu Dec 15 08:06:29 2005 Steve Huston <shuston@riverace.com>
* ace/Service_Templates.cpp: Only #include headers if we need to
diff --git a/ace/Asynch_IO.h b/ace/Asynch_IO.h
index 82f5c85c3d9..a68f73551fd 100644
--- a/ace/Asynch_IO.h
+++ b/ace/Asynch_IO.h
@@ -301,9 +301,17 @@ public:
/**
* Initializes the factory with information which will be used with
- * each asynchronous call. If ({handle} == ACE_INVALID_HANDLE),
- * {ACE_Handler::handle} will be called on the {handler} to get the
- * correct handle.
+ * each asynchronous call.
+ *
+ * @arg handler The ACE_Handler that will be called to handle completions
+ * for operations initiated using this factory.
+ * @arg handle The handle that future read operations will use.
+ * If handle == @c ACE_INVALID_HANDLE,
+ * ACE_Handler::handle() will be called on @ handler
+ * to get the correct handle.
+ *
+ * @retval 0 for success.
+ * @retval -1 for failure; consult @c errno for further information.
*/
int open (ACE_Handler &handler,
ACE_HANDLE handle = ACE_INVALID_HANDLE,