Document return values
[ACE_TAO.git] / ACE / ace / Timer_Queue.h
blobc48e6e37b53b433436aadc7887a462e619480ba1
1 // -*- C++ -*-
3 //=============================================================================
4 /**
5 * @file Timer_Queue.h
7 * @author Douglas C. Schmidt <d.schmidt@vanderbilt.edu>
8 * @author Irfan Pyarali <irfan@cs.wustl.edu>
9 */
10 //=============================================================================
12 #ifndef ACE_TIMER_QUEUE_H
13 #define ACE_TIMER_QUEUE_H
15 #include /**/ "ace/pre.h"
17 #include "ace/Synch_Traits.h"
19 #if !defined (ACE_LACKS_PRAGMA_ONCE)
20 # pragma once
21 #endif /* ACE_LACKS_PRAGMA_ONCE */
23 #include "ace/Timer_Queuefwd.h"
24 #include "ace/Timer_Queue_T.h"
25 #if defined (ACE_HAS_THREADS)
26 # include "ace/Recursive_Thread_Mutex.h"
27 #else
28 # include "ace/Null_Mutex.h"
29 #endif /* ACE_HAS_THREADS */
31 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
33 // The following typedef are here for ease of use and backward
34 // compatibility.
35 typedef ACE_Timer_Node_Dispatch_Info_T<ACE_Event_Handler *>
36 ACE_Timer_Node_Dispatch_Info;
38 typedef ACE_Timer_Node_T<ACE_Event_Handler *>
39 ACE_Timer_Node;
41 typedef ACE_Timer_Queue_Iterator_T<ACE_Event_Handler *>
42 ACE_Timer_Queue_Iterator;
44 ACE_END_VERSIONED_NAMESPACE_DECL
46 #include /**/ "ace/post.h"
48 #endif /* ACE_TIMER_QUEUE_H */