diff options
Diffstat (limited to 'ace/Handle_Gobbler.h')
| -rw-r--r-- | ace/Handle_Gobbler.h | 59 |
1 files changed, 30 insertions, 29 deletions
diff --git a/ace/Handle_Gobbler.h b/ace/Handle_Gobbler.h index 6cf11614e76..69b298e18ee 100644 --- a/ace/Handle_Gobbler.h +++ b/ace/Handle_Gobbler.h @@ -1,18 +1,15 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// Handle_Gobbler.h -// -// = AUTHOR -// Kirthika Parameswaran <kirthika@cs.wustl.edu> -// Irfan Pyarali <irfan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Handle_Gobbler.h + * + * $Id$ + * + * @author Kirthika Parameswaran <kirthika@cs.wustl.edu> + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_HANDLE_GOBBLER_H #define ACE_HANDLE_GOBBLER_H @@ -26,37 +23,41 @@ #include "ace/Containers_T.h" +/** + * @class ACE_Handle_Gobbler + * + * @brief This class gobbles up handles. + * + * This is useful when we need to control the number of handles + * available for a process. This class is mostly used for + * testing purposes. + */ class ACE_Handle_Gobbler { - // = TITLE - // This class gobbles up handles. - // - // = DESCRIPTION - // This is useful when we need to control the number of handles - // available for a process. This class is mostly used for - // testing purposes. public: + /// Destructor. Cleans up any remaining handles. inline ~ACE_Handle_Gobbler (void); - // Destructor. Cleans up any remaining handles. + /** + * Handles are opened continously until the process runs out of + * them, and then <n_handles_to_keep_available> handles are closed + * (freed) thereby making them usable in the future. + */ inline int consume_handles (size_t n_handles_to_keep_available); - // Handles are opened continously until the process runs out of - // them, and then <n_handles_to_keep_available> handles are closed - // (freed) thereby making them usable in the future. + /// Free up <n_handles>. inline int free_handles (size_t n_handles); - // Free up <n_handles>. + /// All remaining handles are closed. inline void close_remaining_handles (void); - // All remaining handles are closed. private: typedef ACE_Unbounded_Set<ACE_HANDLE> HANDLE_SET; + /// The container which holds the open descriptors. HANDLE_SET handle_set_; - // The container which holds the open descriptors. }; #include "ace/Handle_Gobbler.i" |