diff --git a/src/ca/CAref.html b/src/ca/CAref.html index 231b3be07..64d124c80 100644 --- a/src/ca/CAref.html +++ b/src/ca/CAref.html @@ -2957,11 +2957,15 @@ activity is processed for TIMEOUT seconds.
When ca_poll is invoked the send buffer is flushed and any outstanding CA background activity is processed.
-This routine will not return before the specified time-out
-expires and all unfinished channel access labor has been processed, and
-unlike ca_pend_io it does not
-indicate anything about the status of pending IO requests when it
-returns ECA_NORMAL.
The ca_pend_event function will not return before the specified
+time-out expires and all unfinished channel access labor has been processed,
+and unlike ca_pend_io returning from
+the function does not indicate anything about the status of pending
+IO requests.
Both ca_pend_event and ca_poll return
+ECA_TIMEOUT when successful. This behavior probably isn't intuitive, but it
+is preserved to insure backwards compatibility.
See also Thread Safety and Preemptive Callback to User Code.
@@ -2975,8 +2979,6 @@ Code.ECA_NORMAL - Normal successful completion
-ECA_TIMEOUT - The operation timed out
ECA_EVDISALLOW - Function inappropriate for use within a call back