diff options
Diffstat (limited to 'ace/Method_Request.h')
| -rw-r--r-- | ace/Method_Request.h | 57 |
1 files changed, 28 insertions, 29 deletions
diff --git a/ace/Method_Request.h b/ace/Method_Request.h index 69739e39ffe..a6fff914a46 100644 --- a/ace/Method_Request.h +++ b/ace/Method_Request.h @@ -1,19 +1,16 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// Method_Request.h -// -// = AUTHOR -// Andres Kruse <Andres.Kruse@cern.ch> and Douglas C. Schmidt -// <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Method_Request.h + * + * $Id$ + * + * @author Andres Kruse <Andres.Kruse@cern.ch> + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_METHOD_REQUEST_H #define ACE_METHOD_REQUEST_H @@ -25,38 +22,40 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class ACE_Method_Request + * + * @brief Reifies a method into a request. Subclasses provide + * the necessary state and behavior. + * + * A <Method_Request> is inserted in the <Activation_Queue>, + * where it is subsequently removed by a <Scheduler>, which + * invokes the <call> method. + */ class ACE_Export ACE_Method_Request { - // = TITLE - // Reifies a method into a request. Subclasses provide - // the necessary state and behavior. - // - // = DESCRIPTION - // A <Method_Request> is inserted in the <Activation_Queue>, - // where it is subsequently removed by a <Scheduler>, which - // invokes the <call> method. public: // = Initialization and termination methods. + /// Constructor. ACE_Method_Request (u_long priority = 0); - // Constructor. + /// Destructor. virtual ~ACE_Method_Request (void); - // Destructor. // = Accessors. + /// Get priority. u_long priority (void); - // Get priority. + /// Set priority. void priority (u_long); - // Set priority. // = Invocation method (must be overridden by subclasses). + /// Invoked when the <Method_Request> is scheduled to run. virtual int call (void) = 0; - // Invoked when the <Method_Request> is scheduled to run. protected: + /// The priority of the request. u_long priority_; - // The priority of the request. }; #include "ace/post.h" |