diff options
Diffstat (limited to 'examples/Callback_Quoter/Consumer_Signal_Handler.h')
-rw-r--r-- | examples/Callback_Quoter/Consumer_Signal_Handler.h | 67 |
1 files changed, 34 insertions, 33 deletions
diff --git a/examples/Callback_Quoter/Consumer_Signal_Handler.h b/examples/Callback_Quoter/Consumer_Signal_Handler.h index 8a288c117e2..43865faf4b0 100644 --- a/examples/Callback_Quoter/Consumer_Signal_Handler.h +++ b/examples/Callback_Quoter/Consumer_Signal_Handler.h @@ -1,21 +1,18 @@ /* -*- C++ -*- */ -// $Id$ -// =========================================================== -// -// = LIBRARY -// TAO/examples/Callback_Quoter -// -// = FILENAME -// Consumer_Input_Handler.h -// -// = DESCRIPTION -// Definition of the Consumer_Signal_Handler class. -// -// = AUTHOR -// Kirthika Parameswaran <kirthika@cs.wustl.edu> -// -// =========================================================== +//============================================================================= +/** + * @file Consumer_Signal_Handler.h + * + * $Id$ + * + * Definition of the Consumer_Signal_Handler class. + * + * + * @author Kirthika Parameswaran <kirthika@cs.wustl.edu> + */ +//============================================================================= + #ifndef CONSUMER_SIGNAL_HANDLER_H #define CONSUMER_SIGNAL_HANDLER_H @@ -26,43 +23,47 @@ class Consumer_Handler; +/** + * @class Consumer_Signal_Handler + * + * @brief Creating a class to handle signal events. + * + * Since only signals need to be handled, only the <handle_signal> method + * is overlaoded. + */ class Consumer_Signal_Handler : public ACE_Event_Handler { - // = TITLE - // Creating a class to handle signal events. - // - // = DESCRIPTION - // Since only signals need to be handled, only the <handle_signal> method - // is overlaoded. public: + /// The consumer_handler refernce will be used to access the servant + /// methods. Consumer_Signal_Handler (Consumer_Handler *consumer_handler); - // The consumer_handler refernce will be used to access the servant - // methods. + /// This method takes action on an signal event. int handle_signal (int signum, siginfo_t*, ucontext_t*); - // This method takes action on an signal event. + /** + * For removal of the signal handler from the dispatch tables. When + * the handle_signal () returns < 0 this method will be executed + * automatically. + */ int handle_close (ACE_HANDLE handle, ACE_Reactor_Mask close_mask); - // For removal of the signal handler from the dispatch tables. When - // the handle_signal () returns < 0 this method will be executed - // automatically. protected: + /// Protected destructor so that the signal handler is always created + /// dynamically and hence the heap doesnt get corrupted. ~Consumer_Signal_Handler (void); - // Protected destructor so that the signal handler is always created - // dynamically and hence the heap doesnt get corrupted. private: + /// Exit gracefully on a signal. int quit_on_signal (void); - // Exit gracefully on a signal. + /// Reference to the Consumer_Handler which is used in accessing the + /// servant methods. Consumer_Handler *consumer_handler_; - // Reference to the Consumer_Handler which is used in accessing the - // servant methods. }; #endif /* CONSUMER_SIGNAL_HANDLER_H */ |