ChangeLogTag: Fri Feb 2 13:35:19 2001 Frank Hunleth <fhunleth@cs.wustl.edu>

4 files changed, 56 insertions, 16 deletions

diff --git a/TAO/ChangeLogs/ChangeLog-02a b/TAO/ChangeLogs/ChangeLog-02a
index 35df6f0a294..8b874b58dd9 100644
--- a/TAO/ChangeLogs/ChangeLog-02a
+++ b/TAO/ChangeLogs/ChangeLog-02a
@@ -1,3 +1,10 @@
+Fri Feb  2 13:35:19 2001  Frank Hunleth  <fhunleth@cs.wustl.edu>
+
+	* tao/RT_ORB.h:
+	* tao/RT_Mutex.h: Updated method documentation.
+
+	* docs/rtcorba/status.html: Update RT Mutex status.
+
 Fri Feb  2 08:01:48 2001  Douglas C. Schmidt  <schmidt@ace.cs.wustl.edu>
 
 	* tao/IIOP_Profile.cpp (decode): Make sure to initialize the major
diff --git a/TAO/docs/rtcorba/status.html b/TAO/docs/rtcorba/status.html
index 31f0127dd6f..2c3a3f4e2a5 100644
--- a/TAO/docs/rtcorba/status.html
+++ b/TAO/docs/rtcorba/status.html
@@ -50,6 +50,7 @@ features see <a href="#supported">this section</a>).
   <li>New collocation scheme</li>
   <li>Private Connections</li>
   <li>Explicit Binding</li>
+  <li>RT Mutex</li>
 </ul>
 
 <h3><a name="in progress">In Progress</a></h3>
@@ -87,6 +88,7 @@ in progress</a>).
   <li>Explicit Binding</li>
   <li>Private Connections</li>
   <li>Invocation Timeout</li>
+  <li>RT Mutex</li>
 </ul>
 
 <h3><a name="unsupported">Unsupported Features</a></h3>
@@ -98,7 +100,6 @@ for their implementation:
   <li>POA Threadpool request buffering</li>
   <li>POA Threadpool thread borrowing </li>
   <li>Priority Transforms</li>
-  <li>RT Mutex</li>
   <li>ORBinit command-line option</li>
 </ul>
 
diff --git a/TAO/tao/RT_Mutex.h b/TAO/tao/RT_Mutex.h
index 535c05bc6c0..ecdc95aa905 100644
--- a/TAO/tao/RT_Mutex.h
+++ b/TAO/tao/RT_Mutex.h
@@ -90,7 +90,6 @@ class TAO_Export TAO_Named_RT_Mutex : public TAO_RT_Mutex
 {
 public:
   /// Constructor.
-  /// @@ Frank, can you please change this to be "Unicode friendly"?  Please ask Nanbor or Irfan about this.
   TAO_Named_RT_Mutex (const char *name,
                       TAO_Named_RT_Mutex_Manager &mutex_mgr);
 
@@ -101,7 +100,6 @@ protected:
   // Don't allow unnamed named mutexes
   TAO_Named_RT_Mutex (void);
 
-  /// @@ Frank, this will also need to be changed.
   char *name_;
 
   TAO_Named_RT_Mutex_Manager &mutex_mgr_;
diff --git a/TAO/tao/RT_ORB.h b/TAO/tao/RT_ORB.h
index 7fb5e998adc..ad9af35b67c 100644
--- a/TAO/tao/RT_ORB.h
+++ b/TAO/tao/RT_ORB.h
@@ -52,16 +52,14 @@ public:
   /// Destructor.
   ~TAO_Named_RT_Mutex_Manager (void);
 
-  /// @@ Frank, please make these APIs "Unicode friendly".  Irfan or Nanbor can help with this.
-
-  /// Looks up a mutex based on its name.
+  /// Look up a mutex based on its name.
   TAO_RT_Mutex *find_mutex (const char *name);
 
-  /// Registers a mutex based on its name.
+  /// Register a mutex based on its name.
   int register_mutex (const char *name,
                       TAO_RT_Mutex *mutex);
 
-  /// Unregisters a mutex based on its name
+  /// Unregister a mutex based on its name
   void unregister_mutex (const char *name);
 
 protected:
@@ -92,19 +90,32 @@ public:
   /// Destructor.
   virtual ~TAO_RT_ORB (void);
 
-  /// @@@ Frank, please add a comment here explaining what this doe.
+  /**
+   * Create a new mutex.  Mutexes returned by this method
+   * are the same as those used internally by the ORB, so that
+   * consistant priority inheritance/piority ceiling semantics
+   * can be guaranteed.
+   */
   virtual RTCORBA::Mutex_ptr create_mutex (CORBA::Environment
                                            &ACE_TRY_ENV =
                                            TAO_default_environment ())
     ACE_THROW_SPEC ((CORBA::SystemException));
 
-  /// @@@ Frank, please add a comment here explaining what this doe.
+  /**
+   * Destroy a mutex.  Currently this is a no-op since RTCORBA::Mutex
+   * instances are destroyed as soon as their reference counts go to
+   * 0.
+   */
   virtual void destroy_mutex (RTCORBA::Mutex_ptr the_mutex,
                               CORBA::Environment &ACE_TRY_ENV =
                               TAO_default_environment ())
     ACE_THROW_SPEC ((CORBA::SystemException));
 
-  /// @@@ Frank, please add a comment here explaining what this does.  Also, please make this operation "Unicode friendly". 
+  /**
+   * Create a mutex and assign a name to it.  If the
+   * mutex already exists, it is returned and the created_flag
+   * is set to 0.
+   */
   virtual RTCORBA::Mutex_ptr create_named_mutex (const char *name,
                                                  CORBA::Boolean_out created_flag,
                                                  CORBA::Environment
@@ -112,7 +123,7 @@ public:
                                                  TAO_default_environment ())
     ACE_THROW_SPEC ((CORBA::SystemException));
 
-  /// @@@ Frank, please add a comment here explaining what this does.  Also, please make this operation "Unicode friendly". 
+  /// Retrieve a previously created mutex.
    virtual RTCORBA::Mutex_ptr open_named_mutex (const char * name,
                                                 CORBA::Environment &ACE_TRY_ENV =
                                                 TAO_default_environment () )
@@ -120,7 +131,7 @@ public:
                       RTCORBA::RTORB::MutexNotFound
                       ));
 
-  /// @@@ Frank, please add a comment here explaining what this does.
+  /// Create a RTCORBA threadpool to manage a set of threads without lanes.
   virtual RTCORBA::ThreadpoolId
   create_threadpool (CORBA::ULong stacksize,
                      CORBA::ULong static_threads,
@@ -133,7 +144,10 @@ public:
                      &ACE_TRY_ENV = TAO_default_environment ())
     ACE_THROW_SPEC ((CORBA::SystemException));
 
-  /// @@@ Frank, please add a comment here explaining what this does.
+  /**
+   * Create a threadpool and separate it into subsets based on
+   * priorities.
+   */
   virtual RTCORBA::ThreadpoolId
   create_threadpool_with_lanes (CORBA::ULong stacksize,
                                 const RTCORBA::ThreadpoolLanes & lanes,
@@ -145,13 +159,14 @@ public:
                                 TAO_default_environment ())
     ACE_THROW_SPEC ((CORBA::SystemException));
 
-  /// @@@ Frank, please add a comment here explaining what this does.  Yadda/yadda
+  /// Free the resources associated with the specified threadpool.
   virtual void destroy_threadpool (RTCORBA::ThreadpoolId threadpool,
                                    CORBA::Environment &ACE_TRY_ENV =
                                    TAO_default_environment ())
     ACE_THROW_SPEC ((CORBA::SystemException,
                      RTCORBA::RTORB::InvalidThreadpool));
 
+  /// Create a priority model policy for use when configuring a POA.
   virtual RTCORBA::PriorityModelPolicy_ptr
   create_priority_model_policy (
                                 RTCORBA::PriorityModel priority_model,
@@ -160,12 +175,17 @@ public:
                                 TAO_default_environment ())
     ACE_THROW_SPEC ((CORBA::SystemException));
 
+  /// Create a ThreadpoolPolicy instance for POA creation
   virtual RTCORBA::ThreadpoolPolicy_ptr
   create_threadpool_policy (RTCORBA::ThreadpoolId threadpool,
                             CORBA::Environment &ACE_TRY_ENV =
                             TAO_default_environment ())
     ACE_THROW_SPEC ((CORBA::SystemException));
 
+  /**
+   * Create a PriorityBandedConnectionPolicy instance
+   * for use on either the client or server side
+   */
   virtual RTCORBA::PriorityBandedConnectionPolicy_ptr
   create_priority_banded_connection_policy (const RTCORBA::PriorityBands &
                                             priority_bands,
@@ -173,17 +193,30 @@ public:
                                             TAO_default_environment ())
     ACE_THROW_SPEC ((CORBA::SystemException));
 
+  /**
+   * Create a PrivateConnectionPolicy instance to use on client
+   * to request a private (non-multiplexed) transport connection
+   * to the server.
+   */
   virtual RTCORBA::PrivateConnectionPolicy_ptr
   create_private_connection_policy (CORBA::Environment &ACE_TRY_ENV =
                                     TAO_default_environment ())
     ACE_THROW_SPEC ((CORBA::SystemException));
 
+  /**
+   * Create a ServerProtocolPolicy instance to select and configure
+   * communication protocols on the server side.
+   */
   virtual RTCORBA::ServerProtocolPolicy_ptr
   create_server_protocol_policy (const RTCORBA::ProtocolList & protocols,
                                  CORBA::Environment &ACE_TRY_ENV =
                                  TAO_default_environment ())
     ACE_THROW_SPEC ((CORBA::SystemException));
 
+  /**
+   * Create a ClientProtocolPolicy instance to select and configure
+   * communication protocols on the client side.
+   */
   virtual RTCORBA::ClientProtocolPolicy_ptr
   create_client_protocol_policy (const RTCORBA::ProtocolList & protocols,
                                  CORBA::Environment &ACE_TRY_ENV =
@@ -191,7 +224,8 @@ public:
     ACE_THROW_SPEC ((CORBA::SystemException));
 
 protected:
-  /// @@@ Frank, please add a comment here explaining what this does.
+
+  /// mutex_mgr_ manages the names associated with named mutexes.
   TAO_Named_RT_Mutex_Manager mutex_mgr_;
 };