diff options
author | Johnny Willemsen <jwillemsen@remedy.nl> | 2002-04-18 09:36:51 +0000 |
---|---|---|
committer | Johnny Willemsen <jwillemsen@remedy.nl> | 2002-04-18 09:36:51 +0000 |
commit | 9c1a3603f8104719623a49973bb6335eaa0d3b4b (patch) | |
tree | 42de5e5088ea11461a4a3dc95411791dcef36964 | |
parent | 4563598bdf3f38f2353d39be2ce88d37d16e338d (diff) | |
download | ATCD-9c1a3603f8104719623a49973bb6335eaa0d3b4b.tar.gz |
ChangeLogTag: Tue Apr 18 11:32:12 2002 Johnny Willemsen <jwillemsen@remedy.nl>
-rw-r--r-- | ChangeLog | 23 | ||||
-rw-r--r-- | ChangeLogs/ChangeLog-02a | 23 | ||||
-rw-r--r-- | ChangeLogs/ChangeLog-03a | 23 | ||||
-rw-r--r-- | ace/ATM_Params.h | 45 | ||||
-rw-r--r-- | ace/ATM_Stream.h | 3 | ||||
-rw-r--r-- | ace/Asynch_IO.h | 32 | ||||
-rw-r--r-- | ace/Caching_Strategies_T.h | 20 | ||||
-rw-r--r-- | ace/Event_Handler.h | 5 | ||||
-rw-r--r-- | ace/MEM_Acceptor.h | 6 | ||||
-rw-r--r-- | ace/MEM_Connector.h | 6 | ||||
-rw-r--r-- | ace/MEM_SAP.h | 12 | ||||
-rw-r--r-- | ace/Memory_Pool.h | 7 | ||||
-rw-r--r-- | ace/Message_Block.h | 3 | ||||
-rw-r--r-- | ace/Message_Queue_T.h | 4 | ||||
-rw-r--r-- | ace/Pair_T.h | 8 | ||||
-rw-r--r-- | ace/Parse_Node.h | 6 | ||||
-rw-r--r-- | ace/Select_Reactor_Base.h | 6 | ||||
-rw-r--r-- | ace/Thread_Adapter.h | 2 | ||||
-rw-r--r-- | ace/Thread_Manager.h | 30 | ||||
-rw-r--r-- | ace/WIN32_Asynch_IO.h | 61 | ||||
-rw-r--r-- | ace/WIN32_Proactor.h | 6 |
21 files changed, 237 insertions, 94 deletions
diff --git a/ChangeLog b/ChangeLog index f8a75688c59..a3a20c130d3 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,26 @@ +Tue Apr 18 11:34:12 UTC 2002 Johnny Willemsen <jwillemsen@remedy.nl> + + * ace/Asynch_IO.h: + * ace/ATM_Params.h: + * ace/ATM_Stream.h: + * ace/Caching_Strategies_T.h: + * ace/Event_Handler.h: + * ace/MEM_Acceptor.h: + * ace/MEM_Connector.h: + * ace/MEM_SAP.h: + * ace/Memory_Pool.h: + * ace/Message_Block.h: + * ace/Message_Queue_T.h: + * ace/Pair_T.h: + * ace/Parse_Node.h: + * ace/Select_Reactor_Base.h: + * ace/Thread_Adapter.h: + * ace/Thread_Adapter.h: + * ace/Thread_Manager.h: + * ace/WIN32_Asynch_IO.h: + * ace/WIN32_Proactor.h: + Doxygen-ized some of the comments + Tue Apr 18 07:39:12 UTC 2002 Johnny Willemsen <jwillemsen@remedy.nl> * performance-tests/Synch-Benchmarks/Base_Test/Baseline_Test.h: diff --git a/ChangeLogs/ChangeLog-02a b/ChangeLogs/ChangeLog-02a index f8a75688c59..a3a20c130d3 100644 --- a/ChangeLogs/ChangeLog-02a +++ b/ChangeLogs/ChangeLog-02a @@ -1,3 +1,26 @@ +Tue Apr 18 11:34:12 UTC 2002 Johnny Willemsen <jwillemsen@remedy.nl> + + * ace/Asynch_IO.h: + * ace/ATM_Params.h: + * ace/ATM_Stream.h: + * ace/Caching_Strategies_T.h: + * ace/Event_Handler.h: + * ace/MEM_Acceptor.h: + * ace/MEM_Connector.h: + * ace/MEM_SAP.h: + * ace/Memory_Pool.h: + * ace/Message_Block.h: + * ace/Message_Queue_T.h: + * ace/Pair_T.h: + * ace/Parse_Node.h: + * ace/Select_Reactor_Base.h: + * ace/Thread_Adapter.h: + * ace/Thread_Adapter.h: + * ace/Thread_Manager.h: + * ace/WIN32_Asynch_IO.h: + * ace/WIN32_Proactor.h: + Doxygen-ized some of the comments + Tue Apr 18 07:39:12 UTC 2002 Johnny Willemsen <jwillemsen@remedy.nl> * performance-tests/Synch-Benchmarks/Base_Test/Baseline_Test.h: diff --git a/ChangeLogs/ChangeLog-03a b/ChangeLogs/ChangeLog-03a index f8a75688c59..a3a20c130d3 100644 --- a/ChangeLogs/ChangeLog-03a +++ b/ChangeLogs/ChangeLog-03a @@ -1,3 +1,26 @@ +Tue Apr 18 11:34:12 UTC 2002 Johnny Willemsen <jwillemsen@remedy.nl> + + * ace/Asynch_IO.h: + * ace/ATM_Params.h: + * ace/ATM_Stream.h: + * ace/Caching_Strategies_T.h: + * ace/Event_Handler.h: + * ace/MEM_Acceptor.h: + * ace/MEM_Connector.h: + * ace/MEM_SAP.h: + * ace/Memory_Pool.h: + * ace/Message_Block.h: + * ace/Message_Queue_T.h: + * ace/Pair_T.h: + * ace/Parse_Node.h: + * ace/Select_Reactor_Base.h: + * ace/Thread_Adapter.h: + * ace/Thread_Adapter.h: + * ace/Thread_Manager.h: + * ace/WIN32_Asynch_IO.h: + * ace/WIN32_Proactor.h: + Doxygen-ized some of the comments + Tue Apr 18 07:39:12 UTC 2002 Johnny Willemsen <jwillemsen@remedy.nl> * performance-tests/Synch-Benchmarks/Base_Test/Baseline_Test.h: diff --git a/ace/ATM_Params.h b/ace/ATM_Params.h index 0b76afc0e38..59e8858ab22 100644 --- a/ace/ATM_Params.h +++ b/ace/ATM_Params.h @@ -84,53 +84,76 @@ public: | ACE_FLAG_MULTIPOINT_D_ROOT, // connector by default int reuse_addr = 0); + /// Destructor. ~ACE_ATM_Params (); - /// Get/set protocol family. + /// Get protocol family. int get_protocol_family (void) const; + + /// Set protocol family. void set_protocol_family (int); - /// Get/set protocol. + /// Get protocol. int get_protocol (void) const; + + /// Set protocol. void set_protocol (int); - /// Get/set type. + /// Get type. int get_type (void) const; + + /// Set type. void set_type (int); - /// Get/set protocol info. + /// Get protocol info. ACE_Protocol_Info *get_protocol_info( void ); + + /// Set protocol info. void set_protocol_info( ACE_Protocol_Info *); - /// Get/set socket group. + /// Get socket group. ACE_SOCK_GROUP get_sock_group( void ); + + /// Set socket group. void set_sock_group( ACE_SOCK_GROUP ); - /// Get/set socket flags. + /// Get socket flags. u_long get_flags( void ); + + /// Set socket flags. void set_flags( u_long ); - /// Get/set reuse_addr flag. + /// Get reuse_addr flag. int get_reuse_addr (void) const; + + /// Set reuse_addr flag. void set_reuse_addr (int); /// Get device. const char* get_device (void) const; - /// Get/set info. + /// Get info. Param_Info* get_info (void) const; + + /// Set info. void set_info (Param_Info *); - /// Get/set r/w flag. + /// Get r/w flag. int get_rw_flag (void) const; + + /// Set r/w flag. void set_rw_flag (int); - /// Get/set user data. + /// Get user data. Param_Udata* get_user_data (void) const; + + /// Set user data. void set_user_data (Param_Udata*); - /// /set open flag. + /// Get open flag. int get_oflag (void) const; + + /// Set open flag. void set_oflag (int); /// Dump the state of an object. diff --git a/ace/ATM_Stream.h b/ace/ATM_Stream.h index 0267b095f5d..4024cfb917b 100644 --- a/ace/ATM_Stream.h +++ b/ace/ATM_Stream.h @@ -48,8 +48,9 @@ public: // = ATM-specific open and shutdown operations. /// open the stream. - /// Close down and release resources. int open (ACE_ATM_Params params = ACE_ATM_Params()); + + /// Close down and release resources. int close (void); /// Get the underlying handle. diff --git a/ace/Asynch_IO.h b/ace/Asynch_IO.h index 6976955fc84..ef9171b88c7 100644 --- a/ace/Asynch_IO.h +++ b/ace/Asynch_IO.h @@ -420,7 +420,7 @@ protected: public: /** - * @class + * @class Result * * @brief This is that class which will be passed back to the * <handler> when the asynchronous write completes. This class @@ -453,7 +453,7 @@ public: ACE_Asynch_Write_Stream_Result_Impl *implementation (void) const; protected: - /// Constrcutor. + /// Constructor. Result (ACE_Asynch_Write_Stream_Result_Impl *implementation); /// Destructor. @@ -861,7 +861,7 @@ public: ACE_Proactor *proactor = 0); /** - * This starts off an asynchronous Connect. + * This starts off an asynchronous Connect. */ int connect (ACE_HANDLE connect_handle, const ACE_Addr & remote_sap, @@ -1089,20 +1089,28 @@ public: ACE_Message_Block *trailer = 0, u_long trailer_bytes = 0); - /// Header which goes before the file data. + /// Get header which goes before the file data. ACE_Message_Block *header (void) const; + + /// Set header which goes before the file data. void header (ACE_Message_Block *message_block); - /// Size of the header data. + /// Get size of the header data. u_long header_bytes (void) const; + + /// Set size of the header data. void header_bytes (u_long bytes); - /// Trailer which goes after the file data. + /// Get trailer which goes after the file data. ACE_Message_Block *trailer (void) const; + + /// Set trailer which goes after the file data. void trailer (ACE_Message_Block *message_block); - /// Size of the trailer data. + /// Get size of the trailer data. u_long trailer_bytes (void) const; + + /// Set size of the trailer data. void trailer_bytes (u_long bytes); /// Conversion routine. @@ -1177,10 +1185,10 @@ public: * errno to get the error code. * * Scatter/gather is supported on WIN32 by using the <message_block->cont()> - * method. Up to ACE_IOV_MAX <message_block>'s are supported. Upto + * method. Up to ACE_IOV_MAX <message_block>'s are supported. Upto * <message_block->size()> bytes will be read into each <message block> for * a total of <message_block->total_size()> bytes. All <message_block>'s - * <wr_ptr>'s will be updated to reflect the added bytes for each + * <wr_ptr>'s will be updated to reflect the added bytes for each * <message_block> * * Priority of the operation is specified by <priority>. On POSIX4-Unix, @@ -1302,7 +1310,7 @@ public: ACE_Proactor *proactor = 0); /** This starts off an asynchronous send. Upto - * <message_block->total_length()> will be sent. <message_block>'s + * <message_block->total_length()> will be sent. <message_block>'s * <rd_ptr> will be updated to reflect the sent bytes if the send operation * is successfully completed. * Return code of 1 means immediate success and <number_of_bytes_sent> @@ -1312,7 +1320,7 @@ public: * errno to get the error code. * * Scatter/gather is supported on WIN32 by using the <message_block->cont()> - * method. Up to ACE_IOV_MAX <message_block>'s are supported. Upto + * method. Up to ACE_IOV_MAX <message_block>'s are supported. Upto * <message_block->length()> bytes will be sent from each <message block> * for a total of <message_block->total_length()> bytes. All * <message_block>'s <rd_ptr>'s will be updated to reflect the bytes sent @@ -1384,7 +1392,7 @@ public: ACE_Asynch_Write_Dgram_Result_Impl *implementation (void) const; protected: - /// Constrcutor. + /// Constructor. Result (ACE_Asynch_Write_Dgram_Result_Impl *implementation); /// Destructor. diff --git a/ace/Caching_Strategies_T.h b/ace/Caching_Strategies_T.h index 6129f4d0e1d..c637119087c 100644 --- a/ace/Caching_Strategies_T.h +++ b/ace/Caching_Strategies_T.h @@ -48,8 +48,10 @@ public: /// Accessor method for the timer attributes. virtual ATTRIBUTES attributes (void) = 0; - // = Accessor methods for the percentage of entries to purge. + /// Get the percentage of entries to purge. virtual double purge_percent (void) = 0; + + /// Set the percentage of entries to purge. virtual void purge_percent (double percentage) = 0; // = Strategy related Operations @@ -118,8 +120,10 @@ public: /// Accessor method for the timer attributes. ATTRIBUTES attributes (void); - // = Accessor methods for the percentage of entries to purge. + /// Get the percentage of entries to purge. double purge_percent (void); + + /// Set the percentage of entries to purge. void purge_percent (double percentage); // = Strategy related Operations @@ -213,9 +217,10 @@ public: /// Accessor method for the timer attributes. ATTRIBUTES attributes (void); - // = Accessor methods for the percentage of entries to purge. + /// Get the percentage of entries to purge. double purge_percent (void); + /// Set the percentage of entries to purge. void purge_percent (double percentage); // = Strategy related Operations @@ -313,9 +318,10 @@ public: /// Access the attributes. ATTRIBUTES attributes (void); - // = Accessor methods for the percentage of entries to purge. + /// Get the percentage of entries to purge. double purge_percent (void); + /// Set the percentage of entries to purge. void purge_percent (double percentage); // = Strategy related Operations @@ -404,9 +410,10 @@ public: /// Accessor method. ATTRIBUTES attributes (void); - // = Accessor methods for the percentage of entries to purge. + /// Get the percentage of entries to purge. double purge_percent (void); + /// Set the percentage of entries to purge. void purge_percent (double percentage); // = Strategy related Operations @@ -480,9 +487,10 @@ public: /// Accessor method. ATTRIBUTES attributes (void); - // = Accessor methods for the percentage of entries to purge. + /// Get the percentage of entries to purge. double purge_percent (void); + /// Set the percentage of entries to purge. void purge_percent (double percentage); // = Strategy related Operations diff --git a/ace/Event_Handler.h b/ace/Event_Handler.h index 0aabfeb61eb..617be4ec849 100644 --- a/ace/Event_Handler.h +++ b/ace/Event_Handler.h @@ -140,7 +140,10 @@ public: virtual int handle_group_qos (ACE_HANDLE = ACE_INVALID_HANDLE); // = Accessors to set/get the various event demultiplexors. + /// Set the event demultiplexors. virtual void reactor (ACE_Reactor *reactor); + + /// Get the event demultiplexors. virtual ACE_Reactor *reactor (void) const; #if !defined (ACE_HAS_WINCE) @@ -181,7 +184,7 @@ private: /// Priority of this Event_Handler. int priority_; - // = Pointers to the various event demultiplexors. + /// Pointer to the various event demultiplexors. ACE_Reactor *reactor_; }; diff --git a/ace/MEM_Acceptor.h b/ace/MEM_Acceptor.h index 18b907349c4..944cd25db93 100644 --- a/ace/MEM_Acceptor.h +++ b/ace/MEM_Acceptor.h @@ -101,8 +101,10 @@ public: const ACE_TCHAR *mmap_prefix (void) const; void mmap_prefix (const ACE_TCHAR *prefix); - // Set/get the preferred signaling strategy. + /// Get the preferred signaling strategy. ACE_MEM_IO::Signal_Strategy preferred_strategy (void) const; + + /// Set the preferred signaling strategy. void preferred_strategy (ACE_MEM_IO::Signal_Strategy strategy); /// Return the local endpoint address in the referenced <ACE_Addr>. @@ -164,7 +166,7 @@ private: /// mamory malloc upon every incoming connection. ACE_MEM_SAP::MALLOC_OPTIONS malloc_options_; - // Preferred signaling strategy. + /// Preferred signaling strategy. ACE_MEM_IO::Signal_Strategy preferred_strategy_; }; diff --git a/ace/MEM_Connector.h b/ace/MEM_Connector.h index 6ecd70d5047..de83e8732aa 100644 --- a/ace/MEM_Connector.h +++ b/ace/MEM_Connector.h @@ -132,8 +132,10 @@ public: int flags = 0, int perms = 0); - // Set/get the preferred signaling strategy. + /// Get the preferred signaling strategy. ACE_MEM_IO::Signal_Strategy preferred_strategy (void) const; + + /// Set the preferred signaling strategy. void preferred_strategy (ACE_MEM_IO::Signal_Strategy strategy); /// Accessor to underlying malloc options. @@ -157,7 +159,7 @@ private: /// the shared memory malloc update connection establishment. ACE_MEM_SAP::MALLOC_OPTIONS malloc_options_; - // Preferred signaling strategy. + /// Preferred signaling strategy. ACE_MEM_IO::Signal_Strategy preferred_strategy_; }; diff --git a/ace/MEM_SAP.h b/ace/MEM_SAP.h index f3e7f4e91f5..5e17174297a 100644 --- a/ace/MEM_SAP.h +++ b/ace/MEM_SAP.h @@ -44,22 +44,22 @@ public: typedef ACE_Based_Pointer<ACE_MEM_SAP_Node> ACE_MEM_SAP_NODE_PTR; - // Initialize the node with its capacity. + /// Initialize the node with its capacity. ACE_MEM_SAP_Node (size_t cap); - // Get the size of the data we hold. + /// Get the size of the data we hold. size_t size (void) const; - // Get the capacity of this block of data. + /// Get the capacity of this block of data. size_t capacity (void) const; - // Get the pointer to the block of data we hold. + /// Get the pointer to the block of data we hold. void *data (void); - // The maximum size of this memory block. + /// The maximum size of this memory block. size_t capacity_; - // The actualy size used. + /// The actualy size used. size_t size_; ACE_MEM_SAP_NODE_PTR next_; diff --git a/ace/Memory_Pool.h b/ace/Memory_Pool.h index de4cc2759a9..2a0dfdf49a3 100644 --- a/ace/Memory_Pool.h +++ b/ace/Memory_Pool.h @@ -232,14 +232,14 @@ protected: // = Keeps track of all the segments being used. struct SHM_TABLE { + /// Shared memory segment key. key_t key_; - // Shared memory segment key. + /// Shared memory segment internal id. int shmid_; - // Shared memory segment internal id. + /// Is the segment currently used.; int used_; - // Is the segment currently used.; }; /** @@ -524,7 +524,6 @@ public: */ virtual int remap (void *addr); - /// Return the base address of this memory pool. virtual void *base_addr (void) const; diff --git a/ace/Message_Block.h b/ace/Message_Block.h index ecec3efe4df..2415a009da0 100644 --- a/ace/Message_Block.h +++ b/ace/Message_Block.h @@ -715,8 +715,9 @@ public: // = The locking strategy prevents race conditions. /// Get the locking strategy. - /// Set a new locking strategy and return the hold one. ACE_Lock *locking_strategy (void); + + /// Set a new locking strategy and return the hold one. ACE_Lock *locking_strategy (ACE_Lock *); /// Dump the state of an object. diff --git a/ace/Message_Queue_T.h b/ace/Message_Queue_T.h index cdf7f5c37b5..34a94720193 100644 --- a/ace/Message_Queue_T.h +++ b/ace/Message_Queue_T.h @@ -1129,8 +1129,10 @@ public: */ virtual int notify (void); - /// Get/set the notification strategy for the <Message_Queue> + /// Get the notification strategy for the <Message_Queue> virtual ACE_Notification_Strategy *notification_strategy (void); + + /// Set the notification strategy for the <Message_Queue> virtual void notification_strategy (ACE_Notification_Strategy *s); /// Returns a reference to the lock used by the <ACE_Message_Queue_Ex>. diff --git a/ace/Pair_T.h b/ace/Pair_T.h index 3d0a9a7575d..a19865cad7d 100644 --- a/ace/Pair_T.h +++ b/ace/Pair_T.h @@ -45,14 +45,18 @@ public: /// Default constructor. ACE_Pair (void); - /// Get/Set first. + /// Get first. T1 &first (void); const T1 &first (void) const; + + /// Set first. void first (const T1 &t1); - /// Access second. + /// Get second. T2 &second (void); const T2 &second (void) const; + + /// Set second. void second (const T2 &t2); protected: diff --git a/ace/Parse_Node.h b/ace/Parse_Node.h index 6df9def1915..d9ccba2aba8 100644 --- a/ace/Parse_Node.h +++ b/ace/Parse_Node.h @@ -332,11 +332,11 @@ private: #include "ace/Parse_Node.i" #endif /* __ACE_INLINE__ */ -// Keeps track of the number of errors encountered so far. +/// Keeps track of the number of errors encountered so far. extern int ace_yyerrno; -// Global variable used to communicate between the parser and the main -// program. +/// Global variable used to communicate between the parser and the main +/// program. extern ACE_Service_Config *ace_this_svc; #include "ace/post.h" diff --git a/ace/Select_Reactor_Base.h b/ace/Select_Reactor_Base.h index 9c088d1d1d9..0f04e51eeec 100644 --- a/ace/Select_Reactor_Base.h +++ b/ace/Select_Reactor_Base.h @@ -117,8 +117,10 @@ public: class ACE_Export ACE_Select_Reactor_Notify : public ACE_Reactor_Notify { public: - /// Default dtor. + /// Constructor. ACE_Select_Reactor_Notify (void); + + /// Destructor. ~ACE_Select_Reactor_Notify (void); // = Initialization and termination methods. @@ -275,7 +277,7 @@ public: /// Default "do-nothing" constructor. ACE_Select_Reactor_Handler_Repository (ACE_Select_Reactor_Impl &); - /// dtor. + /// Destructor. ~ACE_Select_Reactor_Handler_Repository (void); /// Initialize a repository of the appropriate <size>. diff --git a/ace/Thread_Adapter.h b/ace/Thread_Adapter.h index 355ef4eac30..8e18e6c230f 100644 --- a/ace/Thread_Adapter.h +++ b/ace/Thread_Adapter.h @@ -43,6 +43,7 @@ class ACE_Thread_Descriptor; class ACE_Export ACE_Thread_Adapter : public ACE_Base_Thread_Adapter { public: + /// Constructor. ACE_Thread_Adapter (ACE_THR_FUNC user_func, void *arg, ACE_THR_C_FUNC entry_point = (ACE_THR_C_FUNC) ace_thread_adapter, @@ -52,7 +53,6 @@ public: , ACE_SEH_EXCEPT_HANDLER selector = 0, ACE_SEH_EXCEPT_HANDLER handler = 0 # endif /* ACE_HAS_WIN32_STRUCTURAL_EXCEPTIONS */ - /// Constructor. ); /** diff --git a/ace/Thread_Manager.h b/ace/Thread_Manager.h index b3c6601cd62..f88edf7ccba 100644 --- a/ace/Thread_Manager.h +++ b/ace/Thread_Manager.h @@ -702,13 +702,22 @@ public: // = Cancel methods, which provides a cooperative thread-termination mechanism (will not block). /** * Cancel's all the threads. - * Cancel a single thread. - * Cancel a group of threads. - * True if <t_id> is cancelled, else false. */ int cancel_all (int async_cancel = 0); + + /** + * Cancel a single thread. + */ int cancel (ACE_thread_t, int async_cancel = 0); + + /** + * Cancel a group of threads. + */ int cancel_grp (int grp_id, int async_cancel = 0); + + /** + * True if <t_id> is cancelled, else false. + */ int testcancel (ACE_thread_t t_id); /// Set group ids for a particular thread id. @@ -730,13 +739,22 @@ public: * Block until there are no more threads running in <task>. Returns * 0 on success and -1 on failure. Note that <wait_task> will not * wait on detached threads. - * Suspend all threads in an ACE_Task. - * Resume all threads in an ACE_Task. - * Send a signal <signum> to all threads in an <ACE_Task>. */ int wait_task (ACE_Task_Base *task); + + /** + * Suspend all threads in an ACE_Task. + */ int suspend_task (ACE_Task_Base *task); + + /** + * Resume all threads in an ACE_Task. + */ int resume_task (ACE_Task_Base *task); + + /** + * Send a signal <signum> to all threads in an <ACE_Task>. + */ int kill_task (ACE_Task_Base *task, int signum); diff --git a/ace/WIN32_Asynch_IO.h b/ace/WIN32_Asynch_IO.h index 6b59020df0b..1dd981ac1f6 100644 --- a/ace/WIN32_Asynch_IO.h +++ b/ace/WIN32_Asynch_IO.h @@ -199,7 +199,7 @@ protected: /** * @class ACE_WIN32_Asynch_Read_Stream_Result * - * @brief This is class provides concrete implementation for + * @brief This class provides concrete implementation for * ACE_Asynch_Read_Stream::Result class. */ class ACE_Export ACE_WIN32_Asynch_Read_Stream_Result : public virtual ACE_Asynch_Read_Stream_Result_Impl, @@ -264,6 +264,8 @@ public: int post_completion (ACE_Proactor_Impl *proactor); protected: + /// Constructor is protected since creation is limited to + /// ACE_Asynch_Read_Stream factory. ACE_WIN32_Asynch_Read_Stream_Result (ACE_Handler &handler, ACE_HANDLE handle, ACE_Message_Block &message_block, @@ -272,8 +274,6 @@ protected: ACE_HANDLE event, int priority, int signal_number = 0); - // Constructor is protected since creation is limited to - // ACE_Asynch_Read_Stream factory. /// Proactor will call this method when the read completes. virtual void complete (u_long bytes_transferred, @@ -359,7 +359,7 @@ protected: /** * @class ACE_WIN32_Asynch_Write_Stream_Result * - * @brief This is class provides concrete implementation for + * @brief This class provides concrete implementation for * ACE_Asynch_Write_Stream::Result class. */ class ACE_Export ACE_WIN32_Asynch_Write_Stream_Result : public virtual ACE_Asynch_Write_Stream_Result_Impl, @@ -424,6 +424,8 @@ public: int post_completion (ACE_Proactor_Impl *proactor); protected: + /// Constructor is protected since creation is limited to + /// ACE_Asynch_Write_Stream factory. ACE_WIN32_Asynch_Write_Stream_Result (ACE_Handler &handler, ACE_HANDLE handle, ACE_Message_Block &message_block, @@ -432,8 +434,6 @@ protected: ACE_HANDLE event, int priority, int signal_number = 0); - // Constructor is protected since creation is limited to - // ACE_Asynch_Write_Stream factory. /// ACE_Proactor will call this method when the write completes. virtual void complete (u_long bytes_transferred, @@ -521,7 +521,7 @@ protected: /** * @class ACE_WIN32_Asynch_Read_File_Result * - * @brief This is class provides concrete implementation for + * @brief This class provides concrete implementation for * ACE_Asynch_Read_File::Result class. */ class ACE_Export ACE_WIN32_Asynch_Read_File_Result : public virtual ACE_Asynch_Read_File_Result_Impl, @@ -592,6 +592,8 @@ public: int post_completion (ACE_Proactor_Impl *proactor); protected: + /// Constructor is protected since creation is limited to + /// ACE_Asynch_Read_File factory. ACE_WIN32_Asynch_Read_File_Result (ACE_Handler &handler, ACE_HANDLE handle, ACE_Message_Block &message_block, @@ -602,8 +604,6 @@ protected: ACE_HANDLE event, int priority, int signal_number = 0); - // Constructor is protected since creation is limited to - // ACE_Asynch_Read_File factory. /// ACE_Proactor will call this method when the read completes. virtual void complete (u_long bytes_transferred, @@ -776,6 +776,8 @@ public: int post_completion (ACE_Proactor_Impl *proactor); protected: + /// Constructor is protected since creation is limited to + /// ACE_Asynch_Write_File factory. ACE_WIN32_Asynch_Write_File_Result (ACE_Handler &handler, ACE_HANDLE handle, ACE_Message_Block &message_block, @@ -786,8 +788,6 @@ protected: ACE_HANDLE event, int priority, int signal_number = 0); - // Constructor is protected since creation is limited to - // ACE_Asynch_Write_File factory. /// ACE_Proactor will call this method when the write completes. virtual void complete (u_long bytes_transferred, @@ -947,6 +947,8 @@ public: int post_completion (ACE_Proactor_Impl *proactor); protected: + /// Constructor is protected since creation is limited to + /// ACE_Asynch_Accept factory. ACE_WIN32_Asynch_Accept_Result (ACE_Handler &handler, ACE_HANDLE listen_handle, ACE_HANDLE accept_handle, @@ -956,8 +958,6 @@ protected: ACE_HANDLE event, int priority, int signal_number = 0); - // Constructor is protected since creation is limited to - // ACE_Asynch_Accept factory. /// ACE_Proactor will call this method when the accept completes. virtual void complete (u_long bytes_transferred, @@ -1232,35 +1232,34 @@ private: */ int cancel_uncompleted (int flg_notify, ACE_Handle_Set & set); - int flg_open_ ; /// 1 - Connect is registered in ACE_Asynch_Pseudo_Task /// 0 - Aceept is deregisted in ACE_Asynch_Pseudo_Task + int flg_open_ ; - - /// to prevent ACE_Asynch_Pseudo_Task from deletion - /// while we make a call to the ACE_Asynch_Pseudo_Task + /// To prevent ACE_Asynch_Pseudo_Task from deletion + /// while we make a call to the ACE_Asynch_Pseudo_Task /// This is extra cost !!! /// we could avoid them if all applications will follow the rule: /// Proactor should be deleted only after deletion all - /// AsynchOperation objects connected with it + /// AsynchOperation objects connected with it int task_lock_count_; - typedef ACE_Map_Manager<ACE_HANDLE, ACE_WIN32_Asynch_Connect_Result *, ACE_SYNCH_NULL_MUTEX> + typedef ACE_Map_Manager<ACE_HANDLE, ACE_WIN32_Asynch_Connect_Result *, ACE_SYNCH_NULL_MUTEX> MAP_MANAGER; - typedef ACE_Map_Iterator<ACE_HANDLE, ACE_WIN32_Asynch_Connect_Result *, ACE_SYNCH_NULL_MUTEX> + typedef ACE_Map_Iterator<ACE_HANDLE, ACE_WIN32_Asynch_Connect_Result *, ACE_SYNCH_NULL_MUTEX> MAP_ITERATOR; typedef ACE_Map_Entry<ACE_HANDLE, ACE_WIN32_Asynch_Connect_Result *> MAP_ENTRY; + /// Map of Result pointers that correspond to all the <accept>'s + /// pending. MAP_MANAGER result_map_; - // Map of Result pointers that correspond to all the <accept>'s - // pending. + /// The lock to protect the result queue which is shared. The queue + /// is updated by main thread in the register function call and + /// through the auxillary thread in the deregister fun. So let us + /// mutex it. ACE_SYNCH_MUTEX lock_; - // The lock to protect the result queue which is shared. The queue - // is updated by main thread in the register function call and - // through the auxillary thread in the deregister fun. So let us - // mutex it. }; /** @@ -1346,6 +1345,8 @@ public: int post_completion (ACE_Proactor_Impl *proactor); protected: + /// Constructor is protected since creation is limited to + /// ACE_Asynch_Transmit_File factory. ACE_WIN32_Asynch_Transmit_File_Result (ACE_Handler &handler, ACE_HANDLE socket, ACE_HANDLE file, @@ -1358,9 +1359,7 @@ protected: const void *act, ACE_HANDLE event, int priority, - int signal_number = 0); - // Constructor is protected since creation is limited to - // ACE_Asynch_Transmit_File factory. + int signal_number = 0); /// Proactor will call this method when the write completes. virtual void complete (u_long bytes_transferred, @@ -1472,7 +1471,7 @@ public: /** * @class ACE_WIN32_Asynch_Read_Dgram_Result * - * @brief This is class provides concrete implementation for + * @brief This class provides concrete implementation for * ACE_Asynch_Read_Dgram::Result class. */ class ACE_Export ACE_WIN32_Asynch_Read_Dgram_Result : public virtual ACE_Asynch_Read_Dgram_Result_Impl, @@ -1664,7 +1663,7 @@ protected: /** * @class ACE_WIN32_Asynch_Write_Dgram_Result * - * @brief This is class provides concrete implementation for + * @brief This class provides concrete implementation for * ACE_Asynch_Write_Dgram::Result class. */ class ACE_Export ACE_WIN32_Asynch_Write_Dgram_Result : public virtual ACE_Asynch_Write_Dgram_Result_Impl, diff --git a/ace/WIN32_Proactor.h b/ace/WIN32_Proactor.h index c363292f954..1fe63db4003 100644 --- a/ace/WIN32_Proactor.h +++ b/ace/WIN32_Proactor.h @@ -100,8 +100,10 @@ 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 the event handle. @@ -171,7 +173,7 @@ public: ACE_HANDLE event, int priority, int signal_number = 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, |