ChangeLogTag:Wed Jun 5 13:54:03 UTC 2002 Don Hinton <dhinton@ieee.org>

1 files changed, 6 insertions, 1 deletions

diff --git a/ace/Timer_Queue_T.h b/ace/Timer_Queue_T.h
index 7a9cbc186a8..1cae4f56e8d 100644
--- a/ace/Timer_Queue_T.h
+++ b/ace/Timer_Queue_T.h
@@ -346,13 +346,18 @@ public:
 
   /// Determine the next event to timeout.  Returns <max> if there are
   /// no pending timers or if all pending timers are longer than max.
+  /// This method acquires a lock internally since it modifies internal state. 
   virtual ACE_Time_Value *calculate_timeout (ACE_Time_Value *max);
 
   /**
    * Determine the next event to timeout.  Returns <max> if there are
    * no pending timers or if all pending timers are longer than max.
    * <the_timeout> should be a pointer to storage for the timeout value,
-   * and this value is also returned.
+   * and this value is also returned.  This method does not acquire a
+   * lock internally since it doesn't modify internal state.  If you 
+   * need to call this method when the queue is being modified
+   * concurrently, however, you should make sure to acquire the <mutex()>
+   * externally before making the call.
    */
   virtual ACE_Time_Value *calculate_timeout (ACE_Time_Value *max,
                                              ACE_Time_Value *the_timeout);