From 2b8966563de7a229aed4eddd0f5d15027c5f9ef7 Mon Sep 17 00:00:00 2001 From: coryan Date: Mon, 11 Dec 2000 23:39:25 +0000 Subject: ChangeLogTag:Mon Dec 11 15:36:54 2000 Carlos O'Ryan --- TAO/tao/IORTable/IORTable.cpp | 19 ++++---- TAO/tao/IORTable/IORTable.h | 27 +++++------ TAO/tao/IORTable/IORTable.pidl | 92 +++++++++++++++++++++---------------- TAO/tao/IORTable/IOR_Table_Impl.cpp | 10 +++- TAO/tao/IORTable/IOR_Table_Impl.h | 35 +++++++------- TAO/tao/IORTable/Table_Adapter.cpp | 9 +++- TAO/tao/IORTable/Table_Adapter.h | 35 +++++++------- 7 files changed, 120 insertions(+), 107 deletions(-) (limited to 'TAO/tao/IORTable') diff --git a/TAO/tao/IORTable/IORTable.cpp b/TAO/tao/IORTable/IORTable.cpp index 07fdcc5a053..11ab729a526 100644 --- a/TAO/tao/IORTable/IORTable.cpp +++ b/TAO/tao/IORTable/IORTable.cpp @@ -1,17 +1,14 @@ /* -*- C++ -*- */ -// $Id$ // ================================================================= -// -// = LIBRARY -// TAO -// -// = FILENAME -// IORTable.cpp -// -// = AUTHOR -// Carlos O'Ryan -// +/** + * @file IORTable.cpp + * + * $Id$ + * + * @author Carlos O'Ryan + * + */ // ================================================================= #include "IORTable.h" diff --git a/TAO/tao/IORTable/IORTable.h b/TAO/tao/IORTable/IORTable.h index ca51a05c8a3..7bfadb160aa 100644 --- a/TAO/tao/IORTable/IORTable.h +++ b/TAO/tao/IORTable/IORTable.h @@ -1,19 +1,16 @@ /* -*- C++ -*- */ -// $Id$ - -// ========================================================================= -// -// = LIBRARY -// TAO -// -// = FILENAME -// IORTable.h -// -// = AUTHOR -// Carlos O'Ryan -// -// ========================================================================= + +//============================================================================= +/** + * @file IORTable.h + * + * $Id$ + * + * @author Carlos O'Ryan + */ +//============================================================================= + #ifndef TAO_IORTABLE_H #define TAO_IORTABLE_H @@ -29,8 +26,8 @@ class TAO_IORTable_Export TAO_IORTable_Initializer { public: + /// Used to force the initialization of the ORB code. static int init (void); - // Used to force the initialization of the ORB code. }; #if defined(ACE_HAS_BROKEN_STATIC_CONSTRUCTORS) diff --git a/TAO/tao/IORTable/IORTable.pidl b/TAO/tao/IORTable/IORTable.pidl index 33aa08da858..c02ff888306 100644 --- a/TAO/tao/IORTable/IORTable.pidl +++ b/TAO/tao/IORTable/IORTable.pidl @@ -1,71 +1,83 @@ -// $Id$ -// // ================================================================ -// -// = DESCRIPTION -// This file was used to generate the code in IORTable{C,S,S_T}.{h,i,cpp} -// -// The command used to generate code from this file is: -// -// tao_idl.exe -o orig -Ge 1 -Sa -St \ -// -Wb,export_macro=TAO_IORTable_Export \ -// -Wb,export_include=iortable_export.h \ -// -Wb,pre_include="ace/pre.h" \ -// -Wb,post_include="ace/post.h" \ -// IORTable.pidl -// -// after the file is generated a patch must be applied. The patch -// disables the code under certain configurations, and eliminates -// cycles in the include dependencies. Those changes are required -// because the generated code is part of the TAO library, it hardly -// makes any sense to change the IDL compiler to support changes -// that are very occasional. -// +/** + * @file IORTable.pidl + * + * $Id$ + * + * @author Carlos O'Ryan + * + * @brief This file was used to generate the code in + * IORTable{C,S,S_T}.{h,i,cpp} + * + * The command used to generate code from this file is: + * + * tao_idl.exe -o orig -Ge 1 -Sa -St \ + * -Wb,export_macro=TAO_IORTable_Export \ + * -Wb,export_include=iortable_export.h \ + * -Wb,pre_include="ace/pre.h" \ + * -Wb,post_include="ace/post.h" \ + * IORTable.pidl + * + * after the file is generated a patch must be applied. The patch + * disables the code under certain configurations, and eliminates + * cycles in the include dependencies. Those changes are required + * because the generated code is part of the TAO library, it hardly + * makes any sense to change the IDL compiler to support changes + * that are very occasional. + */ // ================================================================ +/// Define a module to avoid namespace pollution module IORTable { local interface Locator; + /// The object key is already in the IORTable exception AlreadyBound {}; + + /// Cannot find the object key in the IORTable exception NotFound {}; + /// Define the IORTable interface + /** + * + * Any TAO server can be configured as an corbaloc agent. + * Such agents forward requests generated using a simple + * ObjectKey in a corbaloc specifcation to the real location + * of the object. + * In TAO we implement this feature by dynamically (or + * statically) adding a new Object Adapter to the ORB, that + * handles any sort of request. + */ local interface Table { - // = TITLE - // Define the IOR Table interface. - // - // = DESCRIPTION - // Any TAO server can be configured as an corbaloc agent. - // Such agents forward requests generated using a simple - // ObjectKey in a corbaloc specifcation to the real location - // of the object. - // In TAO we implement this feature by dynamically (or - // statically) adding a new Object Adapter to the ORB, that - // handles any sort of request. - + /// Bind to the void bind (in string object_key, in string IOR) raises (AlreadyBound); - // Bind to the + /// Bind to the void rebind (in string object_key, in string IOR); - // Bind to the + /// Remove the binding for void unbind (in string object_key) raises (NotFound); - // Remove the binding for + /// Set the locator, if no binding is set for an object_key we try + /// to use the locator to resolve it void set_locator (in Locator the_locator); - // Set the locator, if no binding is set for an object_key we try - // to use the locator to resolve it }; + /// Callback interface to locate object keys dynamically + /** + * The application can provide a callback interface to locate object + * keys dynamically. + */ local interface Locator { + /// Returns an IOR to use for string locate (in string object_key) raises (NotFound); - // Returns an IOR to use for }; }; diff --git a/TAO/tao/IORTable/IOR_Table_Impl.cpp b/TAO/tao/IORTable/IOR_Table_Impl.cpp index c48afdd5e32..0b40536072c 100644 --- a/TAO/tao/IORTable/IOR_Table_Impl.cpp +++ b/TAO/tao/IORTable/IOR_Table_Impl.cpp @@ -1,5 +1,11 @@ -// $Id$ - +/** + * @file IOR_Table_Impl.cpp + * + * $Id$ + * + * @author Carlos O'Ryan + * + */ #include "IOR_Table_Impl.h" ACE_RCSID(IORTable, IOR_Table_Impl, "$Id$") diff --git a/TAO/tao/IORTable/IOR_Table_Impl.h b/TAO/tao/IORTable/IOR_Table_Impl.h index a3f12c2d94c..dc2d7e9c25f 100644 --- a/TAO/tao/IORTable/IOR_Table_Impl.h +++ b/TAO/tao/IORTable/IOR_Table_Impl.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// IORTable -// -// = FILENAME -// Object_Adapter.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@uci.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file IOR_Table_Impl.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@uci.edu) + */ +//============================================================================= + #ifndef TAO_IOR_TABLE_IMPL_H #define TAO_IOR_TABLE_IMPL_H @@ -37,9 +34,10 @@ class TAO_IORTable_Export TAO_IOR_Table_Impl : public virtual IORTable::Table, public virtual TAO_Local_RefCounted_Object { public: + /// Constructor TAO_IOR_Table_Impl (void); - // Constructor + /// Find the object, using the locator if it is not on the table. char *find ( const char *object_key, CORBA::Environment &ACE_TRY_ENV @@ -48,7 +46,6 @@ public: CORBA::SystemException, IORTable::NotFound )); - // Find the object, using the locator if it is not on the table. // = The IORTable::Table methods, check the IORTable.pidl file for // details. @@ -95,14 +92,14 @@ public: private: typedef ACE_Hash_Map_Manager Map; + /// The map Map map_; - // The map + /// The locator IORTable::Locator_var locator_; - // The locator + /// Synchronization ACE_SYNCH_MUTEX lock_; - // Synchronization }; #if defined(_MSC_VER) && (_MSC_VER >= 1200) diff --git a/TAO/tao/IORTable/Table_Adapter.cpp b/TAO/tao/IORTable/Table_Adapter.cpp index 8c2a6283c73..169c326943e 100644 --- a/TAO/tao/IORTable/Table_Adapter.cpp +++ b/TAO/tao/IORTable/Table_Adapter.cpp @@ -1,4 +1,11 @@ -// $Id$ +/** + * @file IORTable.cpp + * + * $Id$ + * + * @author Carlos O'Ryan + * + */ #include "Table_Adapter.h" #include "IOR_Table_Impl.h" diff --git a/TAO/tao/IORTable/Table_Adapter.h b/TAO/tao/IORTable/Table_Adapter.h index 0298568ca94..5d2240decaa 100644 --- a/TAO/tao/IORTable/Table_Adapter.h +++ b/TAO/tao/IORTable/Table_Adapter.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// IORTable -// -// = FILENAME -// Object_Adapter.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@uci.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file Table_Adapter.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@uci.edu) + */ +//============================================================================= + #ifndef TAO_TABLE_ADAPTER_H #define TAO_TABLE_ADAPTER_H @@ -32,11 +29,11 @@ class TAO_IOR_Table_Impl; class TAO_IORTable_Export TAO_Table_Adapter : public TAO_Adapter { public: + /// Constructor TAO_Table_Adapter (TAO_ORB_Core *orb_core); - // Constructor + /// Destructor virtual ~TAO_Table_Adapter (void); - // Destructor // = The TAO_Adapter methods, please check tao/Adapter.h for the // documentation @@ -58,11 +55,11 @@ public: const TAO_MProfile &); private: + /// The ORB Core we belong to TAO_ORB_Core *orb_core_; - // The ORB Core we belong to + /// The table implementation TAO_IOR_Table_Impl *root_; - // The table implementation }; // **************************************************************** @@ -70,8 +67,8 @@ private: class TAO_IORTable_Export TAO_Table_Adapter_Factory : public TAO_Adapter_Factory { public: + /// Constructor TAO_Table_Adapter_Factory (void); - // Constructor // = The TAO_Adapter_Factory methods, please read tao/Adapter.h for // details. -- cgit v1.2.1