diff options
| -rw-r--r-- | ChangeLog | 17 | ||||
| -rw-r--r-- | ChangeLogs/ChangeLog-02a | 17 | ||||
| -rw-r--r-- | ChangeLogs/ChangeLog-03a | 17 | ||||
| -rw-r--r-- | ace/Proactor.h | 8 | ||||
| -rw-r--r-- | ace/Proactor_Impl.h | 6 | ||||
| -rw-r--r-- | ace/RB_Tree.h | 16 | ||||
| -rw-r--r-- | ace/Reactor_Notification_Strategy.h | 5 | ||||
| -rw-r--r-- | ace/Recyclable.h | 4 | ||||
| -rw-r--r-- | ace/Registry.h | 28 | ||||
| -rw-r--r-- | ace/Service_Types.h | 4 | ||||
| -rw-r--r-- | ace/Signal.h | 16 | ||||
| -rw-r--r-- | ace/Token_Request_Reply.h | 83 | ||||
| -rw-r--r-- | ace/Typed_SV_Message.h | 16 | ||||
| -rw-r--r-- | ace/config-doxygen.h | 3 |
14 files changed, 176 insertions, 64 deletions
diff --git a/ChangeLog b/ChangeLog index cd3c720d05e..4c570ef8eaf 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,20 @@ +Wed Apr 17 14:30:12 UTC 2002 Johnny Willemsen <jwillemsen@remedy.nl> + + * ace/config-doxygen.h: + Added define UNICODE to generate ACE_Registry_Name_Space + + * ace/Proactor.h: + * ace/Proactor_Impl.h: + * ace/RB_Tree.h: + * ace/Reactor_Notification_Strategy.h: + * ace/Recyclable.h: + * ace/Registry.h: + * ace/Service_Types.h: + * ace/Signal.h: + * ace/Token_Request_Reply.h: + * ace/Typed_SV_Message.h: + Doxygen-ized some of the comments + Wed Apr 17 12:27:23 UTC 2002 Johnny Willemsen <jwillemsen@remedy.nl> * etc/ace.doxygen: diff --git a/ChangeLogs/ChangeLog-02a b/ChangeLogs/ChangeLog-02a index cd3c720d05e..4c570ef8eaf 100644 --- a/ChangeLogs/ChangeLog-02a +++ b/ChangeLogs/ChangeLog-02a @@ -1,3 +1,20 @@ +Wed Apr 17 14:30:12 UTC 2002 Johnny Willemsen <jwillemsen@remedy.nl> + + * ace/config-doxygen.h: + Added define UNICODE to generate ACE_Registry_Name_Space + + * ace/Proactor.h: + * ace/Proactor_Impl.h: + * ace/RB_Tree.h: + * ace/Reactor_Notification_Strategy.h: + * ace/Recyclable.h: + * ace/Registry.h: + * ace/Service_Types.h: + * ace/Signal.h: + * ace/Token_Request_Reply.h: + * ace/Typed_SV_Message.h: + Doxygen-ized some of the comments + Wed Apr 17 12:27:23 UTC 2002 Johnny Willemsen <jwillemsen@remedy.nl> * etc/ace.doxygen: diff --git a/ChangeLogs/ChangeLog-03a b/ChangeLogs/ChangeLog-03a index cd3c720d05e..4c570ef8eaf 100644 --- a/ChangeLogs/ChangeLog-03a +++ b/ChangeLogs/ChangeLog-03a @@ -1,3 +1,20 @@ +Wed Apr 17 14:30:12 UTC 2002 Johnny Willemsen <jwillemsen@remedy.nl> + + * ace/config-doxygen.h: + Added define UNICODE to generate ACE_Registry_Name_Space + + * ace/Proactor.h: + * ace/Proactor_Impl.h: + * ace/RB_Tree.h: + * ace/Reactor_Notification_Strategy.h: + * ace/Recyclable.h: + * ace/Registry.h: + * ace/Service_Types.h: + * ace/Signal.h: + * ace/Token_Request_Reply.h: + * ace/Typed_SV_Message.h: + Doxygen-ized some of the comments + Wed Apr 17 12:27:23 UTC 2002 Johnny Willemsen <jwillemsen@remedy.nl> * etc/ace.doxygen: diff --git a/ace/Proactor.h b/ace/Proactor.h index 65cc7cef5ee..b64795c2ee1 100644 --- a/ace/Proactor.h +++ b/ace/Proactor.h @@ -339,12 +339,16 @@ public: /// Close all dispatch threads. int close_dispatch_threads (int wait); - /// Number of thread used as a parameter to CreatIoCompletionPort. + /// Get number of thread used as a parameter to CreatIoCompletionPort. size_t number_of_threads (void) const; + + /// Set number of thread used as a parameter to CreatIoCompletionPort. void number_of_threads (size_t threads); - /// Get/Set timer queue. + /// Get timer queue. TIMER_QUEUE *timer_queue (void) const; + + /// Set timer queue. void timer_queue (TIMER_QUEUE *timer_queue); /** diff --git a/ace/Proactor_Impl.h b/ace/Proactor_Impl.h index d5de76dbb0a..0a03a32462b 100644 --- a/ace/Proactor_Impl.h +++ b/ace/Proactor_Impl.h @@ -75,8 +75,10 @@ public: /// Close all dispatch threads. virtual int close_dispatch_threads (int wait) = 0; - /// Number of thread used as a parameter to CreatIoCompletionPort. + /// Get number of thread used as a parameter to CreatIoCompletionPort. virtual size_t number_of_threads (void) const = 0; + + /// Set number of thread used as a parameter to CreatIoCompletionPort. virtual void number_of_threads (size_t threads) = 0; /// Get the event handle. @@ -178,7 +180,7 @@ public: ACE_HANDLE event = ACE_INVALID_HANDLE, int priority = 0, int signal_number = ACE_SIGRTMIN) = 0; - + /// Create the correct implementation class for ACE_Asynch_Write_Dgram::Result. virtual ACE_Asynch_Write_Dgram_Result_Impl *create_asynch_write_dgram_result (ACE_Handler &handler, ACE_HANDLE handle, diff --git a/ace/RB_Tree.h b/ace/RB_Tree.h index 1c8c5553e63..c529df08b4f 100644 --- a/ace/RB_Tree.h +++ b/ace/RB_Tree.h @@ -390,8 +390,8 @@ public: */ int remove (const EXT_ID &k); - /// Destroys all nodes and sets the root pointer null. /// @deprecated + /// Destroys all nodes and sets the root pointer null. void clear (void); protected: @@ -677,34 +677,34 @@ public: // = DEPRECATED methods. Please migrate your code to use the new methods instead + /// @deprecated /// Accessor for key of node under iterator (if any). - /// DEPRECATED EXT_ID *key (void); + /// @deprecated /// Accessor for item of node under iterator (if any). - /// DEPRECATED INT_ID *item (void); + /// @deprecated /// Move to the first item in the iteration (and in the tree). - /// DEPRECATED int first (void); + /// @deprecated /// Move to the last item in the iteration (and in the tree). - /// DEPRECATED int last (void); + /// @deprecated /// Move to the next item in the iteration (and in the tree). - /// DEPRECATED int next (void); + /// @deprecated /// Move to the previous item in the iteration (and in the tree). - /// DEPRECATED int previous (void); /** + * @deprecated: use the base class <done> method instead. * Returns 0 if the iterator is positioned over a valid ACE_RB_Tree * node, returns 1 if not. - * DEPRECATED: use the base class <done> method instead. */ int is_done (void); diff --git a/ace/Reactor_Notification_Strategy.h b/ace/Reactor_Notification_Strategy.h index b6f5b45b28a..fdd6ecb48f5 100644 --- a/ace/Reactor_Notification_Strategy.h +++ b/ace/Reactor_Notification_Strategy.h @@ -42,11 +42,14 @@ public: virtual int notify (ACE_Event_Handler *, ACE_Reactor_Mask mask); - // Get/Set the reactor + /// Get the reactor ACE_Reactor *reactor (void); + + /// Set the reactor void reactor (ACE_Reactor *r); protected: + /// The Reactor ACE_Reactor *reactor_; }; diff --git a/ace/Recyclable.h b/ace/Recyclable.h index 87270a4cfc8..a269a3684bb 100644 --- a/ace/Recyclable.h +++ b/ace/Recyclable.h @@ -55,8 +55,10 @@ public: /// Destructor. virtual ~ACE_Recyclable (void); - // = Set/Get the recyclable bit + /// Get the recyclable bit ACE_Recyclable_State recycle_state (void) const; + + /// Set the recyclable bit void recycle_state (ACE_Recyclable_State new_state); protected: diff --git a/ace/Registry.h b/ace/Registry.h index c1fc45c5a19..2504f155086 100644 --- a/ace/Registry.h +++ b/ace/Registry.h @@ -56,7 +56,7 @@ public: // The <id_> field is used, // but the <kind_> field is currently ignored - // A Name is an ordered collections of components (ids) + /// A Name is an ordered collections of components (ids) typedef ACE_Unbounded_Set<Name_Component> Name; /// Separator for components in a name @@ -94,9 +94,10 @@ public: /// (Name version) void name (Name &name); - /// Name accessors - /// (String version) + /// Set Name (String version) void name (ACE_TString &name); + + /// Get Name (String version) ACE_TString name (void); /// Type accessor @@ -139,16 +140,22 @@ public: u_long size = 0, u_long type = REG_NONE); - /// Set/Get data + /// Set data void data (void *data); + + /// Get data void *data (void) const; - /// Set/Get size + /// Set size void size (u_long size); + + /// Get size u_long size (void) const; - /// Set/Get type + /// Set type void type (u_long type); + + /// Get type u_long type (void) const; private: @@ -366,9 +373,10 @@ public: /// (Name version) void name (Name &name); - /// Get name - /// (String version) + /// Set name (String version) void name (ACE_TString &name); + + /// Get name (String version) ACE_TString name (void); protected: @@ -515,8 +523,10 @@ public: /// Pointer to current state Iteration_State *current_enumeration_; - /// Set/Get current_enumeration + /// Set current_enumeration void current_enumeration (Iteration_State& current_enumeration); + + /// Get current_enumeration Iteration_State ¤t_enumeration (void); }; }; diff --git a/ace/Service_Types.h b/ace/Service_Types.h index 54cac6e4604..47c77e9f195 100644 --- a/ace/Service_Types.h +++ b/ace/Service_Types.h @@ -130,8 +130,10 @@ public: virtual int fini (void) const; virtual int info (ACE_TCHAR **str, size_t len) const; - // Get/set the link pointer. + // Get the link pointer. ACE_Module_Type *link (void) const; + + // Set the link pointer. void link (ACE_Module_Type *); /// Dump the state of an object. diff --git a/ace/Signal.h b/ace/Signal.h index d51347e7322..2f2c920f26a 100644 --- a/ace/Signal.h +++ b/ace/Signal.h @@ -184,22 +184,30 @@ public: /// Retrieve the current disposition into <this>. int retrieve_action (int signum); - // = Set/get current signal action. + /// Set current signal action. void set (struct sigaction *); + + /// Get current signal action. struct sigaction *get (void); operator ACE_SIGACTION *(); - // = Set/get current signal flags. + /// Set current signal flags. void flags (int); + + /// Get current signal flags. int flags (void); - // = Set/get current signal mask. + /// Set current signal mask. void mask (sigset_t *); void mask (ACE_Sig_Set &); + + /// Get current signal mask. sigset_t *mask (void); - // = Set/get current signal handler (pointer to function). + /// Set current signal handler (pointer to function). void handler (ACE_SignalHandler); + + /// Get current signal handler (pointer to function). ACE_SignalHandler handler (void); /// Dump the state of an object. diff --git a/ace/Token_Request_Reply.h b/ace/Token_Request_Reply.h index 1c3aa88d09c..b21f4457c24 100644 --- a/ace/Token_Request_Reply.h +++ b/ace/Token_Request_Reply.h @@ -78,29 +78,42 @@ public: const ACE_TCHAR client_id[], const ACE_Synch_Options &options); - // = Set/get the length of the encoded/decoded message. + /// Get the length of the encoded/decoded message. ACE_UINT32 length (void) const; + + /// Set the length of the encoded/decoded message. void length (ACE_UINT32); - // = Set/get the type of proxy + /// Get the type of proxy int proxy_type (void) const; + + /// Set the type of proxy void proxy_type (int proxy_type); - // = Set/get the type of token + /// Get the type of token int token_type (void) const; + + /// Set the type of token void token_type (int token_type); - // = Set/get the type of the operation. + /// Get the type of the operation. ACE_UINT32 operation_type (void) const; + + /// Set the type of the operation. void operation_type (ACE_UINT32); - // = Set/get the requeue position. These should be used when renew - // is the operation type. + /// Get the requeue position. These should be used when renew + /// is the operation type. ACE_UINT32 requeue_position (void) const; + + /// Set the requeue position. These should be used when renew + /// is the operation type. void requeue_position (ACE_UINT32); - // = Set/get notify. These should be used when acquire is the operation type. + /// Get notify. These should be used when acquire is the operation type. ACE_UINT32 notify (void) const; + + /// Set notify. These should be used when acquire is the operation type. void notify (ACE_UINT32); // = Set/get the timeout. @@ -131,43 +144,43 @@ private: struct Transfer { + /// Length of entire request. ACE_UINT32 length_; - // Length of entire request. + /// Type of the request (i.e., MUTEX, RLOCK, WLOCK... ACE_UINT32 token_type_; - // Type of the request (i.e., MUTEX, RLOCK, WLOCK... + /// Type of the request (i.e., MUTEX, RLOCK, WLOCK... ACE_UINT32 proxy_type_; - // Type of the request (i.e., MUTEX, RLOCK, WLOCK... + /// Type of the request (i.e., <ACQUIRE>, <RELEASE>, <RENEW>, and <REMOVE>). ACE_UINT32 operation_type_; - // Type of the request (i.e., <ACQUIRE>, <RELEASE>, <RENEW>, and <REMOVE>). + /// this only makes sense when operation type is renew ACE_UINT32 requeue_position_; - // this only makes sense when operation type is renew + /// this only makes sense when operation type is renew ACE_UINT32 notify_; - // this only makes sense when operation type is renew // = ACE_Synch_Options stuff + /// Indicates if we should block forever. If 1, then <secTimeout_> + /// and <usecTimeout_> indicates how long we should wait. If 0, + /// then we block forever. ACE_UINT32 use_timeout_; - // Indicates if we should block forever. If 1, then <secTimeout_> - // and <usecTimeout_> indicates how long we should wait. If 0, - // then we block forever. + /// Max seconds willing to wait for token if not blocking forever. ACE_UINT32 sec_; - // Max seconds willing to wait for token if not blocking forever. + /// Max micro seconds to wait for token if not blocking forever. ACE_UINT32 usec_; - // Max micro seconds to wait for token if not blocking forever. + /// value returned in <Token_Reply::arg>; ACE_UINT32 arg_; - // value returned in <Token_Reply::arg>; + /// The data portion contains the <tokenName_> including a 0 terminator, + /// a ':', then the <clientId> including a 0 terminator ACE_TCHAR data_[ACE_MAXTOKENNAMELEN + ACE_MAXCLIENTIDLEN + 3]; - // The data portion contains the <tokenName_> including a 0 terminator, - // a ':', then the <clientId> including a 0 terminator } transfer_; /// Pointer to the beginning of the token name in this->data_. @@ -194,16 +207,22 @@ public: /// Default constructor. ACE_Token_Reply (void); - // = Set/get the length of the encoded/decoded message. + /// Get the length of the encoded/decoded message. ACE_UINT32 length (void) const; + + /// Set the length of the encoded/decoded message. void length (ACE_UINT32); - // = Set/get the errno of a reply. + /// Get the errno of a reply. ACE_UINT32 errnum (void) const; + + /// Set the errno of a reply. void errnum (ACE_UINT32); - // = Set/get the arg of a reply. + /// Get the arg of a reply. ACE_UINT32 arg (void) const; + + /// Set the arg of a reply. void arg (ACE_UINT32); /// Encode the message before transfer. @@ -220,19 +239,19 @@ private: struct Transfer { + /// Length of entire reply. ACE_UINT32 length_; - // Length of entire reply. + /// Indicates why error occurred if <this->type_> == <FAILURE>. + /// Typical reasons include: + /// <EWOULDBLOCK> (if client requested a non-blocking check for the token). + /// <ETIME> (if the client timed out after waiting for the token). + /// <ENOLCK> (if the token lock was removed out from underneath a waiter). + /// <EACCES> (attempt to renew a token that isn't owned by the client). ACE_UINT32 errno_; - // Indicates why error occurred if <this->type_> == <FAILURE>. - // Typical reasons include: - // <EWOULDBLOCK> (if client requested a non-blocking check for the token). - // <ETIME> (if the client timed out after waiting for the token). - // <ENOLCK> (if the token lock was removed out from underneath a waiter). - // <EACCES> (attempt to renew a token that isn't owned by the client). + /// magic cookie ACE_UINT32 arg_; - // magic cookie } transfer_; }; diff --git a/ace/Typed_SV_Message.h b/ace/Typed_SV_Message.h index 36c5137b80e..475084c177a 100644 --- a/ace/Typed_SV_Message.h +++ b/ace/Typed_SV_Message.h @@ -42,20 +42,28 @@ public: int max_size = sizeof (T)); ~ACE_Typed_SV_Message (void); - // = Get/set the type of the message. + /// Get the type of the message. long type (void) const; + + /// Set the type of the message. void type (long type); - // = Get/set the length of the message. + /// Get the length of the message. int length (void) const; + + /// Set the length of the message. void length (int l); - // = Get/set the maximum size of the message. + /// Get the maximum size of the message. int max_size (void) const; + + /// Set the maximum size of the message. void max_size (int m); - // = Get/set a pointer to the data in the message. + /// Get a pointer to the data in the message. T &data (void); + + /// Set a pointer to the data in the message. void data (const T &data); /// Dump the state of an object. diff --git a/ace/config-doxygen.h b/ace/config-doxygen.h index 9c5bfdd58a0..4b7700b5c57 100644 --- a/ace/config-doxygen.h +++ b/ace/config-doxygen.h @@ -68,6 +68,9 @@ /// Enable timeprobes #define ACE_COMPILE_TIMEPROBES +/// Enable unicode to generate ACE_Registry_Name_Space +#define UNICODE + /// TAO features that should be documented too #define TAO_HAS_RT_CORBA 1 #define TAO_HAS_MINIMUM_CORBA 0 |