diff options
author | coryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795> | 2000-12-15 20:06:51 +0000 |
---|---|---|
committer | coryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795> | 2000-12-15 20:06:51 +0000 |
commit | 2f33b02d0037bc8ee6788c2840c7822922c0c952 (patch) | |
tree | dd9680e93d92ed55dcab63954c75283209681cb8 /TAO | |
parent | bb98ac0816b9558d489efbdf87833dbbbbb75b80 (diff) | |
download | ATCD-2f33b02d0037bc8ee6788c2840c7822922c0c952.tar.gz |
ChangeLogTag:Fri Dec 15 11:36:08 2000 Carlos O'Ryan <coryan@uci.edu>
Diffstat (limited to 'TAO')
150 files changed, 9658 insertions, 9276 deletions
diff --git a/TAO/ChangeLogs/ChangeLog-02a b/TAO/ChangeLogs/ChangeLog-02a index dd3cf3023d7..40a4395561f 100644 --- a/TAO/ChangeLogs/ChangeLog-02a +++ b/TAO/ChangeLogs/ChangeLog-02a @@ -1,3 +1,9 @@ +Fri Dec 15 11:36:08 2000 Carlos O'Ryan <coryan@uci.edu> + + * tao/*.h: + Change the comments that still were in old OSE-style to make + Doxygen happy. + Fri Dec 15 08:14:51 2000 Carlos O'Ryan <coryan@uci.edu> * orbsvcs/tests/LoadBalancing/Makefile: diff --git a/TAO/tao/Abstract_Servant_Base.h b/TAO/tao/Abstract_Servant_Base.h index 953a65497f1..387f58e7362 100644 --- a/TAO/tao/Abstract_Servant_Base.h +++ b/TAO/tao/Abstract_Servant_Base.h @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Abstract_Servant_Base.h -// -// = DESCRIPTION -// This files contains the TAO_Abstract_ServantBase, which is used -// as a way to decuple the PortableServer from the TAO Core, -// and make it possible to keep the reference to the servant in -// the CORBA::Object class. -// -// = AUTHOR -// Angelo Corsaro <corsaro@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Abstract_Servant_Base.h + * + * $Id$ + * + * This files contains the TAO_Abstract_ServantBase, which is used + * as a way to decuple the PortableServer from the TAO Core, + * and make it possible to keep the reference to the servant in + * the CORBA::Object class. + * + * + * @author Angelo Corsaro <corsaro@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_ABSTRACT_SERVANT_BASE_H_ #define TAO_ABSTRACT_SERVANT_BASE_H_ @@ -35,61 +32,68 @@ class TAO_ServerRequest; class TAO_Export TAO_Abstract_ServantBase { public: - // -- Ctor/Dtor -- + /// Destructor virtual ~TAO_Abstract_ServantBase (void); + /// Local implementation of the CORBA::Object::_is_a method. virtual CORBA::Boolean _is_a (const char* logical_type_id, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) = 0; - // Local implementation of the CORBA::Object::_is_a method. + /// Default <_non_existent>: always returns false. virtual CORBA::Boolean _non_existent (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) = 0; - // Default <_non_existent>: always returns false. - // = Reference counting hooks: no-ops by default. - virtual void _add_ref (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - virtual void _remove_ref (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); + //@{ + /// @name Reference counting hooks: no-ops by default. + virtual void _add_ref (CORBA_Environment &ACE_TRY_ENV = + TAO_default_environment ()); + virtual void _remove_ref (CORBA_Environment &ACE_TRY_ENV = + TAO_default_environment ()); + //@} + /// Get the correct vtable. virtual void *_downcast (const char *repository_id) = 0; - // Get the correct vtable. - virtual TAO_Stub *_create_stub (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) = 0; - // This is an auxiliar method for _this() and _narrow(). + /// This is an auxiliar method for _this() and _narrow(). + virtual TAO_Stub *_create_stub (CORBA_Environment &ACE_TRY_ENV = + TAO_default_environment ()) = 0; protected: + /// Default constructor, only derived classes can be created. TAO_Abstract_ServantBase (void); - // Default constructor, only derived classes can be created. + /// Copy constructor, protected so no instances can be created. TAO_Abstract_ServantBase (const TAO_Abstract_ServantBase &); - // Copy constructor, protected so no instances can be created. + /// assignment operator. TAO_Abstract_ServantBase &operator= (const TAO_Abstract_ServantBase &); - // assignment operator. + /// Dispatches a request to the object + /** + * Find the operation, cast the type to the most derived type, + * demarshall all the parameters from the request and finally + * invokes the operation, storing the results and out parameters (if + * any) or the exceptions thrown into <request>. + */ virtual void _dispatch (TAO_ServerRequest &request, void *context, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) = 0; - // Dispatches a request to the object: find the operation, cast the - // type to the most derived type, demarshall all the parameters from - // the request and finally invokes the operation, storing the - // results and out parameters (if any) or the exceptions thrown into - // <request>. virtual void synchronous_upcall_dispatch (TAO_ServerRequest &req, void *context, void *derived_this, CORBA::Environment &ACE_TRY_ENV) = 0; + /// Find an operation in the operation table. virtual int _find (const char *opname, TAO_Skeleton &skelfunc, const unsigned int length = 0) = 0; - // Find an operation in the operation table. + /// Register a CORBA IDL operation name. virtual int _bind (const char *opname, const TAO_Skeleton skel_ptr) = 0; - // Register a CORBA IDL operation name. + /// Get this interface's repository id (TAO specific). virtual const char *_interface_repository_id (void) const = 0; - // Get this interface's repository id (TAO specific). }; #include "ace/post.h" diff --git a/TAO/tao/Acceptor_Filter.h b/TAO/tao/Acceptor_Filter.h index 29a85190246..40c3680f482 100644 --- a/TAO/tao/Acceptor_Filter.h +++ b/TAO/tao/Acceptor_Filter.h @@ -1,19 +1,16 @@ /* -*- C++ -*- */ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Acceptor_Filter.h -// -// = AUTHOR -// Marina Spivak (marina@cs.wustl.edu) -// Carlos O'Ryan (coryan@uci.edu) -// -// ============================================================================ +//============================================================================= +/** + * @file Acceptor_Filter.h + * + * $Id$ + * + * @author Marina Spivak (marina@cs.wustl.edu) + * @author Carlos O'Ryan (coryan@uci.edu) + */ +//============================================================================= + #ifndef TAO_ACCEPTOR_FILTER_H #define TAO_ACCEPTOR_FILTER_H @@ -36,26 +33,29 @@ class TAO_MProfile; class TAO_Acceptor; +/** + * @class TAO_Acceptor_Filter + * + * @brief Interface for mprofile creation strategies. + * + * Concrete Acceptor_Filter encapsulates a strategy for populating + * mprofile with profiles: it decides which endpoints are included + * into mprofile and which ones are not. + */ class TAO_Export TAO_Acceptor_Filter { - // = TITLE - // Interface for mprofile creation strategies. - // - // = DESCRIPTION - // Concrete Acceptor_Filter encapsulates a strategy for populating - // mprofile with profiles: it decides which endpoints are included - // into mprofile and which ones are not. - // public: virtual ~TAO_Acceptor_Filter (void); + /** + * Populate <mprofile> with profiles. Profiles are created for + * selected acceptors (endpoints) from the array delimited by + * <acceptors_begin> and <acceptors_end>. + */ virtual int fill_mprofile (const TAO_ObjectKey &object_key, TAO_MProfile &mprofile, TAO_Acceptor **acceptors_begin, TAO_Acceptor **acceptors_end) = 0; - // Populate <mprofile> with profiles. Profiles are created for - // selected acceptors (endpoints) from the array delimited by - // <acceptors_begin> and <acceptors_end>. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/Acceptor_Impl.h b/TAO/tao/Acceptor_Impl.h index b193e783cef..37a6627f146 100644 --- a/TAO/tao/Acceptor_Impl.h +++ b/TAO/tao/Acceptor_Impl.h @@ -1,19 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Acceptor_Impl.h -// -// = AUTHOR -// Carlos O'Ryan <coryan@cs.wustl.edu> -// Ossama Othman <othman@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Acceptor_Impl.h + * + * $Id$ + * + * @author Carlos O'Ryan <coryan@cs.wustl.edu>Ossama Othman <othman@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_ACCEPTOR_IMPL_H #define TAO_ACCEPTOR_IMPL_H @@ -30,53 +26,63 @@ // Forward declarations. class TAO_ORB_Core; +/** + * @class TAO_Creation_Strategy + * + * @brief Creates a Svc_Handler and set the ORB_Core pointer on it. + */ template <class SVC_HANDLER> class TAO_Creation_Strategy : public ACE_Creation_Strategy<SVC_HANDLER> { - // = TITLE - // Creates a Svc_Handler and set the ORB_Core pointer on it. public: + /** + * Constructor. <arg> parameter is used to pass any special + * state/info to the service handler upon creation. Currently used + * by IIOP and UIOP to pass protocol configuration properties. + */ TAO_Creation_Strategy (TAO_ORB_Core *orb_core, void *arg = 0, CORBA::Boolean flag = 0); - // Constructor. <arg> parameter is used to pass any special - // state/info to the service handler upon creation. Currently used - // by IIOP and UIOP to pass protocol configuration properties. + /// Create a SVC_HANDLER and set the ORB_Core pointer on it. int make_svc_handler (SVC_HANDLER *&sh); - // Create a SVC_HANDLER and set the ORB_Core pointer on it. protected: + /// Pointer to the ORB Core. TAO_ORB_Core *orb_core_; - // Pointer to the ORB Core. + /// Some info/state to be passed to the service handler we create. void *arg_; - // Some info/state to be passed to the service handler we create. + /// Should we use the Lite version for any protocol? CORBA::Boolean lite_flag_; - // Should we use the Lite version for any protocol? }; +/** + * @class TAO_Concurrency_Strategy + * + * @brief Activates the Svc_Handler, and then if specified by the + * TAO_Server_Strategy_Factory, it activates the Svc_Handler to + * run in its own thread. + */ template <class SVC_HANDLER> class TAO_Concurrency_Strategy : public ACE_Concurrency_Strategy<SVC_HANDLER> { - // = TITLE - // Activates the Svc_Handler, and then if specified by the - // TAO_Server_Strategy_Factory, it activates the Svc_Handler to - // run in its own thread. public: + /// Constructor. TAO_Concurrency_Strategy (TAO_ORB_Core *orb_core); - // Constructor. + /** + * Activates the Svc_Handler, and then if specified by the + * TAO_Server_Strategy_Factory, it activates the Svc_Handler to run + * in its own thread. + */ int activate_svc_handler (SVC_HANDLER *svc_handler, void *arg); - // Activates the Svc_Handler, and then if specified by the - // TAO_Server_Strategy_Factory, it activates the Svc_Handler to run - // in its own thread. protected: + /// Pointer to the ORB Core. TAO_ORB_Core *orb_core_; - // Pointer to the ORB Core. }; template <class SVC_HANDLER, ACE_PEER_ACCEPTOR_1> @@ -84,29 +90,29 @@ class TAO_Accept_Strategy : public ACE_Accept_Strategy<SVC_HANDLER, ACE_PEER_ACC { public: + /// Constructor. TAO_Accept_Strategy (TAO_ORB_Core *orb_core); - // Constructor. + /// Initialize the <peer_acceptor_> with <local_addr>. If the + /// process runs out of handles, purge some "old" connections. int open (const ACE_PEER_ACCEPTOR_ADDR &local_addr, int restart = 0); - // Initialize the <peer_acceptor_> with <local_addr>. If the - // process runs out of handles, purge some "old" connections. + /// Delegates to the <accept> method of the PEER_ACCEPTOR. If the + /// process runs out of handles, purge some "old" connections. int accept_svc_handler (SVC_HANDLER *svc_handler); - // Delegates to the <accept> method of the PEER_ACCEPTOR. If the - // process runs out of handles, purge some "old" connections. protected: #if defined (TAO_USES_ROBUST_CONNECTION_MGMT) + /// Handler which deals with purging "old" connections. int out_of_sockets_handler (void); - // Handler which deals with purging "old" connections. #endif /* TAO_USES_ROBUST_CONNECTION_MGMT */ + /// Base class. typedef ACE_Accept_Strategy<SVC_HANDLER, ACE_PEER_ACCEPTOR_2> ACCEPT_STRATEGY_BASE; - // Base class. + /// Pointer to the ORB Core. TAO_ORB_Core *orb_core_; - // Pointer to the ORB Core. }; #if defined(__ACE_INLINE__) diff --git a/TAO/tao/Acceptor_Registry.h b/TAO/tao/Acceptor_Registry.h index 97c042e50bf..c64bb7cfa37 100644 --- a/TAO/tao/Acceptor_Registry.h +++ b/TAO/tao/Acceptor_Registry.h @@ -1,22 +1,18 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Acceptor_Registry.h -// -// = DESCRIPTION -// Interface for the TAO pluggable protocol framework. -// -// = AUTHOR -// Fred Kuhns <fredk@cs.wustl.edu> -// Ossama Othman <ossama@uci.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Acceptor_Registry.h + * + * $Id$ + * + * Interface for the TAO pluggable protocol framework. + * + * + * @author Fred Kuhns <fredk@cs.wustl.edu> Ossama Othman <ossama@uci.edu> + */ +//============================================================================= + #ifndef TAO_ACCEPTOR_REGISTRY_H #define TAO_ACCEPTOR_REGISTRY_H @@ -45,49 +41,53 @@ class TAO_MProfile; typedef TAO_Acceptor** TAO_AcceptorSetIterator; +/** + * @class TAO_Acceptor_Registry + * + * @brief Acceptor Registry and Generic Acceptor interface definitions. + * All loaded ESIOP or GIOP acceptor bridges must register with + * this object. + * + * This class maintains a list os acceptor factories + * for all loaded ORB protocols. + * There is one Acceptor_Registry per ORB_Core. + */ class TAO_Export TAO_Acceptor_Registry { - // = TITLE - // Acceptor Registry and Generic Acceptor interface definitions. - // All loaded ESIOP or GIOP acceptor bridges must register with - // this object. - // - // = DESCRIPTION - // This class maintains a list os acceptor factories - // for all loaded ORB protocols. - // There is one Acceptor_Registry per ORB_Core. public: // = Initialization and termination methods. + /// Default constructor. TAO_Acceptor_Registry (void); - // Default constructor. + /// Default destructor. ~TAO_Acceptor_Registry (void); - // Default destructor. + /// Initialize all registered acceptors. Return -1 on error. int open (TAO_ORB_Core *orb_core, CORBA::Environment &ACE_TRY_ENV) ACE_THROW_SPEC ((CORBA::SystemException)); - // Initialize all registered acceptors. Return -1 on error. + /// Close all open acceptors. int close_all (void); - // Close all open acceptors. + /// Returns the total number of endpoints in all of its acceptors. size_t endpoint_count (void); - // Returns the total number of endpoints in all of its acceptors. + /** + * Use <filter> to populate <mprofile> object with profiles. + * Different filters implement different strategies for selection + * of endpoints to be included into <mprofile>. + */ int make_mprofile (const TAO_ObjectKey& object_key, TAO_MProfile &mprofile, TAO_Acceptor_Filter *filter); - // Use <filter> to populate <mprofile> object with profiles. - // Different filters implement different strategies for selection - // of endpoints to be included into <mprofile>. + /// Check if there is at least one profile in <mprofile> that + /// corresponds to a collocated object. int is_collocated (const TAO_MProfile& mprofile); - // Check if there is at least one profile in <mprofile> that - // corresponds to a collocated object. + /// Return the acceptor bridges TAO_Acceptor *get_acceptor (CORBA::ULong tag); - // Return the acceptor bridges // = Iterator. TAO_AcceptorSetIterator begin (void); @@ -95,34 +95,34 @@ public: private: + /// Create a default acceptor for all loaded protocols. int open_default (TAO_ORB_Core *orb_core, const char *options); - // Create a default acceptor for all loaded protocols. + /// Create a default acceptor using the specified protocol factory. int open_default (TAO_ORB_Core *orb_core, int major, int minor, TAO_ProtocolFactorySetItor &factory, const char *options); - // Create a default acceptor using the specified protocol factory. + /// Extract endpoint-specific options from the endpoint string. void extract_endpoint_options (ACE_CString &addrs, ACE_CString &options, TAO_Protocol_Factory *factory); - // Extract endpoint-specific options from the endpoint string. + /// Extract endpoint/address specific version from the endpoint + /// string. void extract_endpoint_version (ACE_CString &address, int &major, int &minor); - // Extract endpoint/address specific version from the endpoint - // string. + /// Iterator through addrs in the string <iop>, and create an + /// acceptor for each one. int open_i (TAO_ORB_Core *orb_core, ACE_CString &address, TAO_ProtocolFactorySetItor &factory, CORBA::Environment &ACE_TRY_ENV); - // Iterator through addrs in the string <iop>, and create an - // acceptor for each one. private: // The acceptor registry should not be copied. @@ -130,11 +130,11 @@ private: ACE_UNIMPLEMENTED_FUNC (void operator= (const TAO_Acceptor_Registry&)) private: + /// List of acceptors that are currently open. TAO_Acceptor **acceptors_; - // List of acceptors that are currently open. + /// Number of acceptors that are currently open. size_t size_; - // Number of acceptors that are currently open. }; #if defined(__ACE_INLINE__) diff --git a/TAO/tao/Adapter.h b/TAO/tao/Adapter.h index 9f68fc9649d..ef59fa0720a 100644 --- a/TAO/tao/Adapter.h +++ b/TAO/tao/Adapter.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Adapter.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@uci.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file Adapter.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@uci.edu) + */ +//============================================================================= + #ifndef TAO_ADAPTER_H #define TAO_ADAPTER_H @@ -43,31 +40,33 @@ class TAO_Export TAO_Adapter public: virtual ~TAO_Adapter (void); + /// Initialize the Adapter virtual void open (CORBA::Environment &) = 0; - // Initialize the Adapter + /// The ORB is shutting down, destroy any resources attached to this + /// adapter. virtual void close (int wait_for_completion, CORBA::Environment &) = 0; - // The ORB is shutting down, destroy any resources attached to this - // adapter. + /// Check if the adapter can be closed in the current context, raise + /// an exception if not. virtual void check_close (int wait_for_completion, CORBA::Environment &) = 0; - // Check if the adapter can be closed in the current context, raise - // an exception if not. + /** + * Return the priority assigned to this adapter. + * Adapters at higher priority are used first, the first adapter + * that matches a key is used to dispatch a request. + */ virtual int priority (void) const = 0; - // Return the priority assigned to this adapter. - // Adapters at higher priority are used first, the first adapter - // that matches a key is used to dispatch a request. + /// Return the status.... virtual int dispatch (TAO_ObjectKey &key, TAO_ServerRequest &request, void *context, /* unused? */ CORBA::Object_out forward_to, CORBA::Environment &ACE_TRY_ENV) ACE_THROW_SPEC ((CORBA::SystemException)) = 0; - // Return the status.... enum { DS_OK, // The operation was successfully dispatched, an exception may @@ -85,18 +84,20 @@ public: // the ORB from the PortableServer::ForwardRequest exception }; + /// Return the name, i.e. the object id used to resolve it in the + /// ORB. virtual const char *name (void) const = 0; - // Return the name, i.e. the object id used to resolve it in the - // ORB. + /** + * Rerturn the root of the Object Adapter. + * Each adapter defines its own IDL interface accessed through the + * method above. + */ virtual CORBA::Object_ptr root (void) = 0; - // Rerturn the root of the Object Adapter. - // Each adapter defines its own IDL interface accessed through the - // method above. + /// Create a collocated object using the given profile and stub. virtual CORBA::Object_ptr create_collocated_object (TAO_Stub *, const TAO_MProfile &) = 0; - // Create a collocated object using the given profile and stub. }; // **************************************************************** @@ -108,51 +109,57 @@ class TAO_Export TAO_Adapter_Registry public: TAO_Adapter_Registry (TAO_ORB_Core *orb_core); + /// Close the ~TAO_Adapter_Registry (void); - // Close the + /** + * Close each of of the Adapters and then cleanup the Registry. + * It is possible that an Adapter will reject a close() call if it + * is invoked in an innapropriate context (think shutting down the + * POA while performing an upcall). + */ void close (int wait_for_completion, CORBA::Environment &ACE_TRY_ENV); - // Close each of of the Adapters and then cleanup the Registry. - // It is possible that an Adapter will reject a close() call if it - // is invoked in an innapropriate context (think shutting down the - // POA while performing an upcall). + /** + * Verify if the close() call can be invoked in the current + * context for *all* adapters. + * Raise the right exception if not. + */ void check_close (int wait_for_completion, CORBA::Environment &ACE_TRY_ENV); - // Verify if the close() call can be invoked in the current - // context for *all* adapters. - // Raise the right exception if not. + /// Insert a new adapter into the registry. void insert (TAO_Adapter *adapter, CORBA::Environment &ACE_TRY_ENV); - // Insert a new adapter into the registry. + /** + * Dispatch the request to all the adapters. + * It tries the adapters ordered by priority, stopping when the + * adapter returns a status different from DS_MISMATCHED_KEY + */ void dispatch (TAO_ObjectKey &key, TAO_ServerRequest &request, void *context, /* unused? */ CORBA::Object_out forward_to, CORBA::Environment &ACE_TRY_ENV) ACE_THROW_SPEC ((CORBA::SystemException)); - // Dispatch the request to all the adapters. - // It tries the adapters ordered by priority, stopping when the - // adapter returns a status different from DS_MISMATCHED_KEY + /// Create a collocated object using the given profile and stub. CORBA::Object_ptr create_collocated_object (TAO_Stub *, const TAO_MProfile &); - // Create a collocated object using the given profile and stub. + /// Fetch the adapter named <name> TAO_Adapter *find_adapter (const char *name) const; - // Fetch the adapter named <name> private: + /// The ORB Core TAO_ORB_Core *orb_core_; - // The ORB Core + /// A simple array of adapters. size_t adapters_capacity_; size_t adapters_count_; TAO_Adapter **adapters_; - // A simple array of adapters. }; // **************************************************************** @@ -160,11 +167,11 @@ private: class TAO_Export TAO_Adapter_Factory : public ACE_Service_Object { public: + /// Destructor virtual ~TAO_Adapter_Factory (void); - // Destructor + /// Create a new adapter virtual TAO_Adapter *create (TAO_ORB_Core *orb_core) = 0; - // Create a new adapter }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/Any.h b/TAO/tao/Any.h index 40a48e12427..90aa4997cac 100644 --- a/TAO/tao/Any.h +++ b/TAO/tao/Any.h @@ -1,19 +1,16 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Any.h -// -// = AUTHOR -// Copyright 1994-1995 by Sun Microsystems, Inc. -// and Aniruddha Gokhale. -// -// ============================================================================ + +//============================================================================= +/** + * @file Any.h + * + * $Id$ + * + * @author Copyright 1994-1995 by Sun Microsystems + * @author Inc. and Aniruddha Gokhale. + */ +//============================================================================= + #ifndef TAO_ANY_H #define TAO_ANY_H @@ -29,37 +26,36 @@ #include "tao/Object.h" #include "tao/Typecode.h" +/** + * @class CORBA_Any + * + * @brief Class "Any" can wrap values of any type, with the assistance + * of a TypeCode to describe that type. + * + * This includes three constructors, a destructor, and a "replace" + * method for the "Any" data type. "Any" values pair a pointer to + * a data structure in the native binary representation (e.g. C + * struct) with a TypeCode that describes that data structure. + * The copy constructor and the destructor each use the TypeCode + * interpreter with specialized "visit" callback routines. The + * "visit" routines are used respectively to make "deep copies" + * and perform "deep frees" of the aritrary values as described by + * the "Any" value's typecode. + * Note that these "visit" routines are called directly, and they + * choose whether or not to use the TypeCode interpreter to + * examine constituents. In the simple cases, the "visit" + * routines can do their work without any further calls; only for + * constructed types is the interpreter's knowledge really + * required. + * THREADING NOTE: "Any" is a data structure which must be + * protected by external critical sections. Like simpler numeric + * types, "Any" instances are accessed and modified atomically. + * This implementation is reentrant, so that independent "Any" + * values may be manipulated concurrently when the underlying + * programming environment is itself reentrant. + */ class TAO_Export CORBA_Any { - // = TITLE - // Class "Any" can wrap values of any type, with the assistance - // of a TypeCode to describe that type. - // - // = DESCRIPTION - // This includes three constructors, a destructor, and a "replace" - // method for the "Any" data type. "Any" values pair a pointer to - // a data structure in the native binary representation (e.g. C - // struct) with a TypeCode that describes that data structure. - // - // The copy constructor and the destructor each use the TypeCode - // interpreter with specialized "visit" callback routines. The - // "visit" routines are used respectively to make "deep copies" - // and perform "deep frees" of the aritrary values as described by - // the "Any" value's typecode. - // - // Note that these "visit" routines are called directly, and they - // choose whether or not to use the TypeCode interpreter to - // examine constituents. In the simple cases, the "visit" - // routines can do their work without any further calls; only for - // constructed types is the interpreter's knowledge really - // required. - // - // THREADING NOTE: "Any" is a data structure which must be - // protected by external critical sections. Like simpler numeric - // types, "Any" instances are accessed and modified atomically. - // This implementation is reentrant, so that independent "Any" - // values may be manipulated concurrently when the underlying - // programming environment is itself reentrant. public: // = Minor codes for exceptional returns @@ -72,128 +68,130 @@ public: // = Initialization and termination operations. + /// Default constructor. CORBA_Any (void); - // Default constructor. + /// Constructor. CORBA_Any (CORBA::TypeCode_ptr type, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Constructor. // = TAO extension + /** + * Constructor. Used by DynAny and others to optimize Any activities + * by using CDR. The dummy arg is to keep calls like CORBA_Any foo + * (CORBA::TypeCode_ptr bar (NULL), NULL) from being confused with + * the constructor above. + */ CORBA_Any (CORBA::TypeCode_ptr type, CORBA::UShort dummy, int byte_order, const ACE_Message_Block* mb); - // Constructor. Used by DynAny and others to optimize Any activities - // by using CDR. The dummy arg is to keep calls like CORBA_Any foo - // (CORBA::TypeCode_ptr bar (NULL), NULL) from being confused with - // the constructor above. + /// Copy constructor. CORBA_Any (const CORBA_Any &a); - // Copy constructor. + /// Destructor. ~CORBA_Any (void); - // Destructor. + /// assignment operator CORBA_Any &operator= (const CORBA_Any &); - // assignment operator // = NOTE: 94-9-14 has assignment operator plus many insertion, as // specified below. // =type safe insertion + /// Insert a short. void operator<<= (CORBA::Short); - // Insert a short. + /// Insert an unsigned short. void operator<<= (CORBA::UShort); - // Insert an unsigned short. + /// Insert a long. void operator<<= (CORBA::Long); - // Insert a long. + /// Insert an unsigned long. void operator<<= (CORBA::ULong); - // Insert an unsigned long. + /// Insert a long long. void operator<<= (CORBA::LongLong); - // Insert a long long. + /// Insert an unsigned long long. void operator<<= (CORBA::ULongLong); - // Insert an unsigned long long. + /// Insert a float. void operator<<= (CORBA::Float); - // Insert a float. + /// Insert a double. void operator<<= (CORBA::Double); - // Insert a double. + /// Insert a long double. void operator<<= (CORBA::LongDouble); - // Insert a long double. + /// Insert an Any, copying. void operator<<= (const CORBA_Any&); - // Insert an Any, copying. + /// Insert an Any, non-copying. void operator<<= (CORBA_Any_ptr); - // Insert an Any, non-copying. + /// Insert unbounded string void operator<<= (const char*); - // Insert unbounded string + /// Insert unbounded wide string. void operator<<= (const CORBA::WChar*); - // Insert unbounded wide string. + /// Insert a TypeCode. void operator<<= (CORBA::TypeCode_ptr); - // Insert a TypeCode. + /// Insert an object reference, copying. void operator<<= (const CORBA::Object_ptr); - // Insert an object reference, copying. + /// Insert an object reference, non-copying. Any assumes the ownership + /// of the object. void operator<<= (CORBA::Object_ptr *); - // Insert an object reference, non-copying. Any assumes the ownership - // of the object. // =Type safe extraction. + /// Extract a short. CORBA::Boolean operator>>= (CORBA::Short&) const; - // Extract a short. + /// Extract an unsigned short. CORBA::Boolean operator>>= (CORBA::UShort&) const; - // Extract an unsigned short. + /// Extract a long. CORBA::Boolean operator>>= (CORBA::Long&) const; - // Extract a long. + /// Extract an unsigned long. CORBA::Boolean operator>>= (CORBA::ULong&) const; - // Extract an unsigned long. + /// Extract a long long. CORBA::Boolean operator>>= (CORBA::LongLong&) const; - // Extract a long long. + /// Extract an unsigned long long. CORBA::Boolean operator>>= (CORBA::ULongLong&) const; - // Extract an unsigned long long. + /// Extract a float. CORBA::Boolean operator>>= (CORBA::Float&) const; - // Extract a float. + /// Extract a double. CORBA::Boolean operator>>= (CORBA::Double&) const; - // Extract a double. + /// Extract a long double. CORBA::Boolean operator>>= (CORBA::LongDouble&) const; - // Extract a long double. + /// Extract an Any. CORBA::Boolean operator>>= (CORBA_Any&) const; // non-spec CORBA::Boolean operator>>= (const CORBA_Any*&) const; - // Extract an Any. + /// Extract a TypeCode. CORBA::Boolean operator>>= (CORBA::TypeCode_ptr&) const; - // Extract a TypeCode. + /// Extract an unbounded string CORBA::Boolean operator>>= (const char*&) const; - // Extract an unbounded string + /// Extract an unbounded wide string. CORBA::Boolean operator>>= (const CORBA::WChar*&) const; - // Extract an unbounded wide string. // = Special types. @@ -209,29 +207,29 @@ public: typedef ACE_OutputCDR::from_string from_string; typedef ACE_OutputCDR::from_wstring from_wstring; + /// Insert a boolean. void operator<<= (from_boolean); - // Insert a boolean. + /// Insert a char. void operator<<= (from_char); - // Insert a char. + /// Insert a wchar. void operator<<= (from_wchar); - // Insert a wchar. + /// Insert an octet. void operator<<= (from_octet); - // Insert an octet. + /// Insert a bounded string. void operator<<= (from_string); - // Insert a bounded string. + /// Insert a bounded wide string. void operator<<= (from_wstring); - // Insert a bounded wide string. + /// Insert an exception into the Any (copying) void operator<<= (const CORBA_Exception &exception); - // Insert an exception into the Any (copying) + /// Insert an exception into the Any (non-copying). void operator<<= (CORBA_Exception *exception); - // Insert an exception into the Any (non-copying). // = Special types. @@ -256,90 +254,94 @@ public: // extraction of the special types + /// extract a boolean CORBA::Boolean operator>>= (to_boolean) const; - // extract a boolean + /// extract an octet CORBA::Boolean operator>>= (to_octet) const; - // extract an octet + /// extract a char CORBA::Boolean operator>>= (to_char) const; - // extract a char + /// extract a wchar CORBA::Boolean operator>>= (to_wchar) const; - // extract a wchar + /// extract a bounded string CORBA::Boolean operator>>= (to_string) const; - // extract a bounded string + /// extract a bounded wide string CORBA::Boolean operator>>= (to_wstring) const; - // extract a bounded wide string + /// extract an object reference CORBA::Boolean operator>>= (to_object) const; - // extract an object reference // the following are unsafe operations // ORBOS/90-01-11, pg 672: For C++ mapping using the CORBA_Environment // parameter, two forms of the replace method are provided. + /// Return TypeCode of the element stored in the Any. CORBA::TypeCode_ptr type (void) const; - // Return TypeCode of the element stored in the Any. + /// For use along with <<= of a value of aliased type when the alias must + /// be preserved. void type (CORBA::TypeCode_ptr type, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // For use along with <<= of a value of aliased type when the alias must - // be preserved. + /** + * Returns 0 if the Any has not been assigned a value, following the + * CORBA spec (ORBOS/98-01-11) it returns a non-zero value + * otherwise. TAO does *not* guarantee that this value may be casted + * to the contained type safely. + */ const void *value (void) const; - // Returns 0 if the Any has not been assigned a value, following the - // CORBA spec (ORBOS/98-01-11) it returns a non-zero value - // otherwise. TAO does *not* guarantee that this value may be casted - // to the contained type safely. // = TAO extensions + /** + * Reports whether the Any own the data or not. This is used by the + * >>= operators generated by the IDL compiler. The >>= operator + * checks if the Any owns the data. If it does, then it will simply + * retrieve the data from internal cache. Otherwise, the operator + * will have to decode the cdr string. + */ CORBA::Boolean any_owns_data (void) const; - // Reports whether the Any own the data or not. This is used by the - // >>= operators generated by the IDL compiler. The >>= operator - // checks if the Any owns the data. If it does, then it will simply - // retrieve the data from internal cache. Otherwise, the operator - // will have to decode the cdr string. + /// Message block accessor. + /// Get the byte order inside the CDR stream. ACE_Message_Block* _tao_get_cdr (void) const; - // Message block accessor. int _tao_byte_order (void) const; - // Get the byte order inside the CDR stream. + /// Generated data types define a 'destructor' function that + /// correctly destroys an object stored in the Any. typedef void (*_tao_destructor)(void*); - // Generated data types define a 'destructor' function that - // correctly destroys an object stored in the Any. + /// Replace via message block instead of <value_>. void _tao_replace (CORBA::TypeCode_ptr, int byte_order, const ACE_Message_Block *mb); - // Replace via message block instead of <value_>. + /// Replace all the contents of the any, used in the <<= operators. void _tao_replace (CORBA::TypeCode_ptr type, int byte_order, const ACE_Message_Block *mb, CORBA::Boolean any_owns_data, void* value, CORBA::Any::_tao_destructor destructor); - // Replace all the contents of the any, used in the <<= operators. + /// Replace the value of the Any, used in the >>= operators. void _tao_replace (CORBA::TypeCode_ptr type, CORBA::Boolean any_owns_data, void* value, CORBA::Any::_tao_destructor destructor); - // Replace the value of the Any, used in the >>= operators. + /// Encode the contents of the Any into <cdr> void _tao_encode (TAO_OutputCDR &cdr, TAO_ORB_Core *orb_core, CORBA::Environment &ACE_TRY_ENV); - // Encode the contents of the Any into <cdr> + /// Decode the <cdr> using the typecode in the Any object. void _tao_decode (TAO_InputCDR &cdr, CORBA::Environment &ACE_TRY_ENV); - // Decode the <cdr> using the typecode in the Any object. #if !defined(__GNUC__) || __GNUC__ > 2 || __GNUC_MINOR__ >= 8 typedef CORBA_Any_ptr _ptr_type; @@ -347,32 +349,32 @@ public: #endif /* __GNUC__ */ // Useful for template programming. + /// Used to release Anys contained into anys. static void _tao_any_destructor (void*); static void _tao_any_string_destructor (void*); static void _tao_any_wstring_destructor (void*); static void _tao_any_tc_destructor (void*); - // Used to release Anys contained into anys. protected: + /// Release the <value_>. void free_value (void); - // Release the <value_>. private: + /// Typecode for the <Any>. CORBA::TypeCode_var type_; - // Typecode for the <Any>. + /// encoded value. int byte_order_; ACE_Message_Block *cdr_; - // encoded value. + /// Flag that indicates the ORB is responsible for deleting the data. CORBA::Boolean any_owns_data_; - // Flag that indicates the ORB is responsible for deleting the data. + /// Value for the <Any>. void *value_; - // Value for the <Any>. + /// If not zero this is the function used to destroy objects. CORBA::Any::_tao_destructor destructor_; - // If not zero this is the function used to destroy objects. // 94-9-14 hides unsigned char insert/extract void operator<<= (unsigned char); @@ -382,102 +384,109 @@ private: friend class TAO_Marshal_Any; }; +/** + * @class CORBA_Any_var + * + * @brief Provide for automatic storage deallocation on going out of + * scope. + */ class TAO_Export CORBA_Any_var { - // = TITLE - // Provide for automatic storage deallocation on going out of - // scope. public: + /// default constructor CORBA_Any_var (void); - // default constructor + /// construct from an Any pointer CORBA_Any_var (CORBA_Any *a); - // construct from an Any pointer + /// copy constructor CORBA_Any_var (const CORBA_Any_var &a); - // copy constructor + /// destructor ~CORBA_Any_var (void); - // destructor + /// assignment from a pointer to Any CORBA_Any_var &operator= (CORBA_Any *a); - // assignment from a pointer to Any + /** + * assignment from an Any_var + * This operation requires memory allocation. + * If the allocation fails, *this is returned + * unmodified. + */ CORBA_Any_var &operator= (const CORBA_Any_var &a); - // assignment from an Any_var - // This operation requires memory allocation. - // If the allocation fails, *this is returned - // unmodified. + /// arrow operator (smart pointer) CORBA_Any *operator-> (void); - // arrow operator (smart pointer) + /// cast operator const CORBA_Any *() const; - // cast + /// cast operator CORBA_Any *&(); - // cast + /// for in Any parameter const CORBA_Any &in (void) const; - // for in Any parameter + /// for inout Any parameter CORBA_Any &inout (void); - // for inout Any parameter + /// for out Any parameter CORBA_Any *&out (void); - // for out Any parameter + /// for Any return types CORBA_Any *_retn (void); - // for Any return types private: + /// Holds the Any. CORBA_Any *ptr_; - // Holds the Any. }; +/** + * @class CORBA_Any_out + * + * @brief CORBA_Any_out + * + * The _out class for CORBA_Any. This is used to help in + * managing the out parameters. + */ class TAO_Export CORBA_Any_out { - // = TITLE - // CORBA_Any_out - // - // = DESCRIPTION - // The _out class for CORBA_Any. This is used to help in - // managing the out parameters. public: // = operations. + /// construction from a reference to a CORBA_Any CORBA_Any_out (CORBA_Any *&p); - // construction from a reference to a CORBA_Any + /// construction from a var CORBA_Any_out (CORBA_Any_var &p); - // construction from a var + /// copy constructor CORBA_Any_out (const CORBA_Any_out &s); - // copy constructor + /// assignment from a CORBA_Any_out CORBA_Any_out &operator= (const CORBA_Any_out &s); - // assignment from a CORBA_Any_out + /// assignment from a CORBA_Any CORBA_Any_out &operator= (CORBA_Any *p); - // assignment from a CORBA_Any + /// assignment from a const CORBA_Any CORBA_Any_out &operator= (const CORBA_Any *p); - // assignment from a const CORBA_Any + /// cast operator CORBA_Any *&(); - // cast + /// return underlying instance CORBA_Any *& ptr (void); - // return underlying instance CORBA_Any *operator-> (void); private: + /// Instance CORBA_Any *&ptr_; - // Instance + /// assignment from _var disallowed void operator= (const CORBA_Any_var &); - // assignment from _var disallowed }; // These operators are too complex to be inline.... diff --git a/TAO/tao/Asynch_Invocation.h b/TAO/tao/Asynch_Invocation.h index 215b92f45cf..c81a99b9ae1 100644 --- a/TAO/tao/Asynch_Invocation.h +++ b/TAO/tao/Asynch_Invocation.h @@ -1,20 +1,20 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = DESCRIPTION -// Encapsulate the logic for remote Asynchronous Invocations. -// -// = AUTHOR -// Carlos O'Ryan <coryan@cs.wustl.edu>, -// Alexander Babu Arulanthu <alex@cs.wustl.edu> -// Jeff Parsons <parsons@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Asynch_Invocation.h + * + * $Id$ + * + * Encapsulate the logic for remote Asynchronous Invocations. + * + * + * @author Carlos O'Ryan <coryan@cs.wustl.edu> + * @author Alexander Babu Arulanthu <alex@cs.wustl.edu> + * @author Jeff Parsons <parsons@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_ASYNCH_INVOCATION_H #define TAO_ASYNCH_INVOCATION_H @@ -43,35 +43,35 @@ class TAO_Export TAO_GIOP_Asynch_Invocation // TAO_GIOP_DII_Deferred_Invocation. // public: + /// Default constructor. This should never get called, it is here + /// only to appease older versions of g++. TAO_GIOP_Asynch_Invocation (void); - // Default constructor. This should never get called, it is here - // only to appease older versions of g++. + /// Constructor. TAO_GIOP_Asynch_Invocation (TAO_Stub *stub, const char *operation, CORBA::ULong opname_len, CORBA::Boolean argument_flag, TAO_ORB_Core *orb_core); - // Constructor. + /// Send request, without blocking until any reply comes back. virtual int invoke (CORBA_Environment &TAO_IN_ENV = TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); - // Send request, without blocking until any reply comes back. + /// Establishes a connection to the remote server, initializes + /// headers etc. void start (CORBA_Environment &TAO_IN_ENV = TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); - // Establishes a connection to the remote server, initializes - // headers etc. protected: + /// Must be overridden. virtual int invoke_i (CORBA::Environment &ACE_TRY_ENV) ACE_THROW_SPEC ((CORBA::SystemException)) = 0; - // Must be overridden. + /// Reply dispatcher for the current asynchronous invocation. TAO_Asynch_Reply_Dispatcher_Base *rd_; - // Reply dispatcher for the current asynchronous invocation. }; #if (TAO_HAS_AMI_CALLBACK == 1) || (TAO_HAS_AMI_POLLER == 1) @@ -89,6 +89,7 @@ class TAO_Export TAO_GIOP_Twoway_Asynch_Invocation // the CDR stream and returns. // public: + /// Constructor. TAO_GIOP_Twoway_Asynch_Invocation ( TAO_Stub *stub, const char *operation, @@ -98,13 +99,12 @@ public: const TAO_Reply_Handler_Skeleton &reply_handler_skel, Messaging::ReplyHandler_ptr reply_handler_ptr ); - // Constructor. protected: + /// Implementation of the invoke() methods, handles the basic + /// send/reply code and the system exceptions. virtual int invoke_i (CORBA::Environment &ACE_TRY_ENV) ACE_THROW_SPEC ((CORBA::SystemException)); - // Implementation of the invoke() methods, handles the basic - // send/reply code and the system exceptions. }; #endif /* (TAO_HAS_AMI_CALLBACK == 1) || (TAO_HAS_AMI_POLLER == 1) == 0 */ diff --git a/TAO/tao/Asynch_Reply_Dispatcher.h b/TAO/tao/Asynch_Reply_Dispatcher.h index b03986d30fe..71fd4cbd9ff 100644 --- a/TAO/tao/Asynch_Reply_Dispatcher.h +++ b/TAO/tao/Asynch_Reply_Dispatcher.h @@ -1,20 +1,17 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = DESCRIPTION -// Dispatch the reply appropriately. -// -// = AUTHOR -// Alexander Babu Arulanthu <alex@cs.wustl.edu> -// Jeff Parsons <parsons@cs.wustl.edu> -// -// ============================================================================ + + +//============================================================================= +/** + * @file Asynch_Reply_Dispatcher.h + * + * $Id$ + * + * @author Alexander Babu Arulanthu <alex@cs.wustl.edu> + * @author Jeff Parsons <parsons@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_ASYNCH_REPLY_DISPATCHER_H #define TAO_ASYNCH_REPLY_DISPATCHER_H @@ -37,24 +34,19 @@ class TAO_ORB_Core ; #include "tao/MessagingC.h" #endif /* (TAO_HAS_AMI_CALLBACK == 1) || (TAO_HAS_AMI_POLLER == 1) == 0 */ -class TAO_Export TAO_Asynch_Reply_Dispatcher_Base - : public TAO_Reply_Dispatcher +/// Base class for TAO_Asynch_Reply_Dispatcher and +/// TAO_DII_Deferred_Reply_Dispatcher +class TAO_Export TAO_Asynch_Reply_Dispatcher_Base : public TAO_Reply_Dispatcher { - // = TITLE - // TAO_Asynch_Reply_Dispatcher_Base - // - // = DESCRIPTION - // Base class for TAO_Asynch_Reply_Dispatcher and - // TAO_DII_Deferred_Reply_Dispatcher. public: + /// Default constructor. TAO_Asynch_Reply_Dispatcher_Base (TAO_ORB_Core *orb_core); - // Default constructor. + /// Destructor. virtual ~TAO_Asynch_Reply_Dispatcher_Base (void); - // Destructor. + /// Sets the transport for this invocation. void transport (TAO_Transport *t); - // Sets the transport for this invocation. // = The Reply Dispatcher methods virtual int dispatch_reply (TAO_Pluggable_Reply_Params ¶ms); @@ -66,46 +58,44 @@ public: virtual void connection_closed (void); protected: + /// The service context list. + /** + * Note, that this is not a reference as in + * the synchronous case. We own the reply_service_info + * because our TAO_Asynch_Invocation or TAO_DII_Deferred_Invocation + * will go out of scope before we are done. + */ IOP::ServiceContextList reply_service_info_; - // The service context list. - // Note, that this is not a reference as in - // the synchronous case. We own the reply_service_info - // because our TAO_Asynch_Invocation or TAO_DII_Deferred_Invocation - // will go out of scope before we are done. // TAO_GIOP_Message_State *message_state_; // CDR stream for reading the input. + /// CDR stream which has the reply information that needs to be + /// demarshalled by the stubs TAO_InputCDR reply_cdr_; - // CDR stream which has the reply information that needs to be - // demarshalled by the stubs + /// This invocation is using this transport, may change... TAO_Transport *transport_; - // This invocation is using this transport, may change... }; // ********************************************************************* #if (TAO_HAS_AMI_CALLBACK == 1) || (TAO_HAS_AMI_POLLER == 1) +/// Reply dispatcher for Asynchoronous Method Invocation (AMI)s. class TAO_Export TAO_Asynch_Reply_Dispatcher : public TAO_Asynch_Reply_Dispatcher_Base { - // = TITLE - // TAO_Asynch_Reply_Dispatcher - // - // = DESCRIPTION - // Reply dispatcher for Asynchoronous Method Invocation (AMI)s. public: + /// Constructor. TAO_Asynch_Reply_Dispatcher ( const TAO_Reply_Handler_Skeleton &reply_handler_skel, Messaging::ReplyHandler_ptr reply_handler_ptr, TAO_ORB_Core *orb_core ); - // Constructor. + /// Destructor. virtual ~TAO_Asynch_Reply_Dispatcher (void); - // Destructor. // = The Reply Dispatcher methods virtual int dispatch_reply (TAO_Pluggable_Reply_Params ¶ms); @@ -113,11 +103,11 @@ public: virtual void connection_closed (void); private: + /// Skeleton for the call back method in the Reply Handler. const TAO_Reply_Handler_Skeleton reply_handler_skel_; - // Skeleton for the call back method in the Reply Handler. + /// Reply Handler passed in the Asynchronous Invocation. Messaging::ReplyHandler_var reply_handler_; - // Reply Handler passed in the Asynchronous Invocation. }; #endif /* TAO_HAS_AMI_CALLBACK == 1 || TAO_HAS_AMI_POLLER == 1 */ diff --git a/TAO/tao/Bind_Dispatcher_Guard.h b/TAO/tao/Bind_Dispatcher_Guard.h index b5cdba4770f..29b9da86feb 100644 --- a/TAO/tao/Bind_Dispatcher_Guard.h +++ b/TAO/tao/Bind_Dispatcher_Guard.h @@ -1,16 +1,16 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// =========================================================================== -// -// = LIBRARY -// TAO -// -// = AUTHOR -// Carlos O'Ryan <coryan@uci.edu>, -// Chad Elliott <elliott_c@ociweb.com> -// -// =========================================================================== + +//============================================================================= +/** + * @file Bind_Dispatcher_Guard.h + * + * $Id$ + * + * @author Carlos O'Ryan <coryan@uci.edu> + * @author Chad Elliott <elliott_c@ociweb.com> + */ +//============================================================================= + #ifndef TAO_BIND_DISPATCHER_GUARD_H #define TAO_BIND_DISPATCHER_GUARD_H diff --git a/TAO/tao/Buffering_Constraint_Policy.h b/TAO/tao/Buffering_Constraint_Policy.h index c3a904ec5f9..5c16581ab60 100644 --- a/TAO/tao/Buffering_Constraint_Policy.h +++ b/TAO/tao/Buffering_Constraint_Policy.h @@ -1,21 +1,14 @@ /* -*- C++ -*- */ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = DESCRIPTION -// Implementation class for TAO-specific Buffering Constraint Policy. -// -// = FILENAME -// Buffering_Constraint_Policy.h -// -// = AUTHOR -// Irfan Pyarali (irfan@cs.wustl.edu) -// -// ============================================================================ +//============================================================================= +/** + * @file Buffering_Constraint_Policy.h + * + * $Id$ + * + * @author Irfan Pyarali (irfan@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_BUFFERING_CONSTRAINT_POLICY_H #define TAO_BUFFERING_CONSTRAINT_POLICY_H @@ -52,18 +45,18 @@ class TAO_Export TAO_Buffering_Constraint_Policy // the ORB. // public: + /// Constructor. TAO_Buffering_Constraint_Policy (const TAO::BufferingConstraint &buffering_constraint); - // Constructor. + /// Copy constructor. TAO_Buffering_Constraint_Policy (const TAO_Buffering_Constraint_Policy &rhs); - // Copy constructor. + /// Helper method for the implementation of CORBA::ORB::create_policy. static CORBA::Policy_ptr create (const CORBA::Any& val, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Helper method for the implementation of CORBA::ORB::create_policy. + /// Returns a copy of <this>. virtual TAO_Buffering_Constraint_Policy *clone (void) const; - // Returns a copy of <this>. // = The TAO::Buffering_Constraint_Policy methods @@ -81,8 +74,8 @@ public: ACE_THROW_SPEC ((CORBA::SystemException)); private: + /// The attribute TAO::BufferingConstraint buffering_constraint_; - // The attribute }; #if defined(_MSC_VER) && (_MSC_VER >= 1200) diff --git a/TAO/tao/CDR.h b/TAO/tao/CDR.h index 871deb3f2e7..724bb80e9f4 100644 --- a/TAO/tao/CDR.h +++ b/TAO/tao/CDR.h @@ -1,45 +1,42 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// CDR.h -// -// = DESCRIPTION -// Common Data Representation (CDR) marshaling streams. -// -// This implementation assumes that the native numeric -// representation is two's complement for integers, IEEE -// single/double for floats. Also that characters are in ISO -// Latin/1. -// -// Note that CDR itself makes no such assumptions, but this -// implementation makes such assumptions for reasons of -// efficiency. Careful enhancements could preserve that -// efficiency where the assumptions are true, yet still allow the -// code to work when they aren't true. -// -// The implementation expects that buffers are aligned according -// to the strongest CDR alignment restriction. -// -// NOTE: this does everything "CDR 1.1" does ... that is, it -// supports the five extended OMG-IDL data types in UNO Appendix -// A, which provide richer arithmetic types (64 bit integers, -// "quad precision" FP) and UNICODE-based characters and strings. -// Those types are not standard parts of OMG-IDL at this time. -// -// THREADING NOTE: CDR data structures must be protected against -// concurrent access by their owning thread. -// -// = AUTHOR -// Copyright 1994-1995 by Sun Microsystems, Inc. -// Many enhancements added by Aniruddha Gokhale and Carlos O'Ryan. -// -// ============================================================================ + +//============================================================================= +/** + * @file CDR.h + * + * $Id$ + * + * Common Data Representation (CDR) marshaling streams. + * + * This implementation assumes that the native numeric + * representation is two's complement for integers, IEEE + * single/double for floats. Also that characters are in ISO + * Latin/1. + * + * Note that CDR itself makes no such assumptions, but this + * implementation makes such assumptions for reasons of + * efficiency. Careful enhancements could preserve that + * efficiency where the assumptions are true, yet still allow the + * code to work when they aren't true. + * + * The implementation expects that buffers are aligned according + * to the strongest CDR alignment restriction. + * + * NOTE: this does everything "CDR 1.1" does ... that is, it + * supports the five extended OMG-IDL data types in UNO Appendix + * A, which provide richer arithmetic types (64 bit integers, + * "quad precision" FP) and UNICODE-based characters and strings. + * Those types are not standard parts of OMG-IDL at this time. + * + * THREADING NOTE: CDR data structures must be protected against + * concurrent access by their owning thread. + * + * + * @author Copyright 1994-1995 by Sun Microsystems + * @author Inc. Many enhancements added by Aniruddha Gokhale and Carlos O'Ryan. + */ +//============================================================================= + #ifndef TAO_CDR_H #define TAO_CDR_H @@ -55,36 +52,37 @@ class TAO_ORB_Core; +/** + * @class TAO_OutputCDR + * + * @brief A CDR stream for writing, i.e. for marshalling. + * + * This class is based on the the CORBA spec for Java (98-02-29), + * java class omg.org.CORBA.portable.OutputStream. + * It diverts in a few ways: + * + Operations taking arrays don't have offsets, because in C++ + * it is easier to describe an array starting from x+offset. + * + Operations return an error status, because exceptions are + * not widely available in C++ (yet). + * A particularly useful static member function for this buffer is + * an interpretive encoding routine, usable as a typecode + * interpreter callback. Ditto for decoding. These are used to + * support all OMG-IDL datatypes, even those not supported + * directly by put/get primitives. + */ class TAO_Export TAO_OutputCDR : public ACE_OutputCDR { - // - // = TITLE - // A CDR stream for writing, i.e. for marshalling. - // - // = DESCRIPTION - // This class is based on the the CORBA spec for Java (98-02-29), - // java class omg.org.CORBA.portable.OutputStream. - // It diverts in a few ways: - // + Operations taking arrays don't have offsets, because in C++ - // it is easier to describe an array starting from x+offset. - // + Operations return an error status, because exceptions are - // not widely available in C++ (yet). - // - // A particularly useful static member function for this buffer is - // an interpretive encoding routine, usable as a typecode - // interpreter callback. Ditto for decoding. These are used to - // support all OMG-IDL datatypes, even those not supported - // directly by put/get primitives. - // public: + /// For reading from a output CDR stream. friend class TAO_InputCDR; - // For reading from a output CDR stream. // The default values for the allocators and memcpy_tradeoff // in these constructors are not 0, but are generated by the // ORB. Refer to the constructor bodies in CDR.cpp for the // code that supplies these values to the base class constructor. + /// Default constructor, allocates <size> bytes in the internal + /// buffer, if <size> == 0 it allocates the default size. TAO_OutputCDR (size_t size = 0, int byte_order = ACE_CDR_BYTE_ORDER, ACE_Allocator* buffer_allocator = 0, @@ -92,9 +90,9 @@ public: size_t memcpy_tradeoff = 0, ACE_Char_Codeset_Translator *char_translator = 0, ACE_WChar_Codeset_Translator *wchar_translator = 0); - // Default constructor, allocates <size> bytes in the internal - // buffer, if <size> == 0 it allocates the default size. + /// Build a CDR stream with an initial buffer, it will *not* remove + /// <data>, since it did not allocated it. TAO_OutputCDR (char *data, size_t size, int byte_order = ACE_CDR_BYTE_ORDER, @@ -103,19 +101,17 @@ public: size_t memcpy_tradeoff = 0, ACE_Char_Codeset_Translator *char_translator = 0, ACE_WChar_Codeset_Translator *wchar_translator = 0); - // Build a CDR stream with an initial buffer, it will *not* remove - // <data>, since it did not allocated it. + /// Build a CDR stream with an initial Message_Block chain, it will *not* + /// remove <data>, since it did not allocate it. TAO_OutputCDR (ACE_Message_Block *data, int byte_order = ACE_CDR_BYTE_ORDER, size_t memcpy_tradeoff = 0, ACE_Char_Codeset_Translator *char_translator = 0, ACE_WChar_Codeset_Translator *wchar_translator = 0); - // Build a CDR stream with an initial Message_Block chain, it will *not* - // remove <data>, since it did not allocate it. + /// Destructor. ~TAO_OutputCDR (void); - // Destructor. // @@ TODO: do we want a special method to write an array of // strings and wstrings? @@ -123,103 +119,109 @@ public: // = TAO specific methods. private: + /// disallow copying... TAO_OutputCDR (const TAO_OutputCDR& rhs); TAO_OutputCDR& operator= (const TAO_OutputCDR& rhs); - // disallow copying... }; +/** + * @class TAO_InputCDR + * + * @brief A CDR stream for reading, i.e. for demarshalling. + * + * This class is based on the the CORBA spec for Java (98-02-29), + * java class omg.org.CORBA.portable.InputStream. + * It diverts in a few ways: + * + Operations to retrieve basic types take parameters by + * reference. + * + Operations taking arrays don't have offsets, because in C++ + * it is easier to describe an array starting from x+offset. + * + Operations return an error status, because exceptions are + * not widely available in C++ (yet). + * A particularly useful static member function for this buffer is + * an interpretive encoding routine, usable as a typecode + * interpreter callback. Ditto for decoding. These are used to + * support all OMG-IDL datatypes, even those not supported + * directly by put/get primitives. + */ class TAO_Export TAO_InputCDR : public ACE_InputCDR { - // - // = TITLE - // A CDR stream for reading, i.e. for demarshalling. - // - // = DESCRIPTION - // This class is based on the the CORBA spec for Java (98-02-29), - // java class omg.org.CORBA.portable.InputStream. - // It diverts in a few ways: - // + Operations to retrieve basic types take parameters by - // reference. - // + Operations taking arrays don't have offsets, because in C++ - // it is easier to describe an array starting from x+offset. - // + Operations return an error status, because exceptions are - // not widely available in C++ (yet). - // - // A particularly useful static member function for this buffer is - // an interpretive encoding routine, usable as a typecode - // interpreter callback. Ditto for decoding. These are used to - // support all OMG-IDL datatypes, even those not supported - // directly by put/get primitives. public: + /** + * Create an input stream from an arbitrary buffer, care must be + * exercised wrt alignment, because this contructor will *not* work + * if the buffer is unproperly aligned. + */ TAO_InputCDR (const char* buf, size_t bufsiz, int byte_order = ACE_CDR_BYTE_ORDER, TAO_ORB_Core* orb_core = 0); - // Create an input stream from an arbitrary buffer, care must be - // exercised wrt alignment, because this contructor will *not* work - // if the buffer is unproperly aligned. + /// Create an empty input stream. The caller is responsible for + /// putting the right data and providing the right alignment. TAO_InputCDR (size_t bufsiz, int byte_order = ACE_CDR_BYTE_ORDER, TAO_ORB_Core* orb_core = 0); - // Create an empty input stream. The caller is responsible for - // putting the right data and providing the right alignment. + /// Create an input stream from an ACE_Message_Block TAO_InputCDR (const ACE_Message_Block *data, int byte_order = ACE_CDR_BYTE_ORDER, TAO_ORB_Core* orb_core = 0); - // Create an input stream from an ACE_Message_Block + /// Create an input stream from an ACE_Data_Block TAO_InputCDR (ACE_Data_Block *data, int byte_order = ACE_CDR_BYTE_ORDER, TAO_ORB_Core* orb_core = 0); - // Create an input stream from an ACE_Data_Block + /** + * Make a copy of the current stream state, but does not copy the + * internal buffer; so the same stream can be read multiple times + * efficiently. + */ TAO_InputCDR (const TAO_InputCDR& rhs); - // Make a copy of the current stream state, but does not copy the - // internal buffer; so the same stream can be read multiple times - // efficiently. + /// When interpreting indirected TypeCodes it is useful to make a + /// "copy" of the stream starting in the new position. TAO_InputCDR (const TAO_InputCDR& rhs, size_t size, ACE_CDR::Long offset); - // When interpreting indirected TypeCodes it is useful to make a - // "copy" of the stream starting in the new position. + /** + * This creates an encapsulated stream, the first byte must be (per + * the spec) the byte order of the encapsulation. The default + * values for the allocators in this constructor are not 0, but are + * generated by the ORB. Refer to the constructor body in CDR.cpp + * for the code that supplies these values to the base class + * constructor. + */ TAO_InputCDR (const TAO_InputCDR& rhs, size_t size); - // This creates an encapsulated stream, the first byte must be (per - // the spec) the byte order of the encapsulation. The default - // values for the allocators in this constructor are not 0, but are - // generated by the ORB. Refer to the constructor body in CDR.cpp - // for the code that supplies these values to the base class - // constructor. + /// Create an input CDR from an output CDR. TAO_InputCDR (const TAO_OutputCDR& rhs, ACE_Allocator* buffer_allocator = 0, ACE_Allocator* data_block_allocator = 0, TAO_ORB_Core* orb_core = 0); - // Create an input CDR from an output CDR. + /// Initialize the contents of one CDR from another, without data + /// copying and with minimimum locking overhead. TAO_InputCDR (ACE_InputCDR::Transfer_Contents rhs, TAO_ORB_Core* orb_core = 0); - // Initialize the contents of one CDR from another, without data - // copying and with minimimum locking overhead. + /// destructor ~TAO_InputCDR (void); - // destructor // = TAO specific methods. + /// Accessor TAO_ORB_Core *orb_core (void) const; - // Accessor private: void init_translators (void); private: + /// The ORB_Core, required to extract object references. TAO_ORB_Core* orb_core_; - // The ORB_Core, required to extract object references. }; #if defined(__ACE_INLINE__) diff --git a/TAO/tao/CONV_FRAMEC.h b/TAO/tao/CONV_FRAMEC.h index 10740fe2d83..1c14690193e 100644 --- a/TAO/tao/CONV_FRAMEC.h +++ b/TAO/tao/CONV_FRAMEC.h @@ -1,21 +1,19 @@ -// $Id$ - -// -// ================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// CONV_FRAMEC.h -// -// = DESCRIPTION -// Generated from CONV_FRAME.pidl, that contains the OMG standarized -// CONV_FRAME module. -// The code was generated by the IDL compiler and then hand-crafted -// to reduce the includes interdependencies. -// -// ================================================================ + +//============================================================================= +/** + * @file CONV_FRAMEC.h + * + * $Id$ + * + * Generated from CONV_FRAME.pidl, that contains the OMG standarized + * CONV_FRAME module. + * The code was generated by the IDL compiler and then hand-crafted + * to reduce the includes interdependencies. + * + * + */ +//============================================================================= + #ifndef TAO_CONV_FRAMEC_H #define TAO_CONV_FRAMEC_H diff --git a/TAO/tao/CONV_FRAMES.h b/TAO/tao/CONV_FRAMES.h index 443f6f86d89..4baf2c665a9 100644 --- a/TAO/tao/CONV_FRAMES.h +++ b/TAO/tao/CONV_FRAMES.h @@ -1,20 +1,18 @@ -// $Id$ -// -// ================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// CONV_FRAME.cpp -// -// = DESCRIPTION -// Generated from CONV_FRAME.pidl, that contains the OMG standarized -// CONV_FRAME module. -// The code was generated by the IDL compiler and then hand-crafted -// to reduce the includes interdependencies. -// -// ================================================================ +//============================================================================= +/** + * @file CONV_FRAMES.h + * + * $Id$ + * + * Generated from CONV_FRAME.pidl, that contains the OMG standarized + * CONV_FRAME module. + * The code was generated by the IDL compiler and then hand-crafted + * to reduce the includes interdependencies. + * + * + */ +//============================================================================= + #ifndef TAO_CONV_FRAMES_H #define TAO_CONV_FRAMES_H diff --git a/TAO/tao/CONV_FRAMES_T.h b/TAO/tao/CONV_FRAMES_T.h index 0900021c353..32ed1b0f062 100644 --- a/TAO/tao/CONV_FRAMES_T.h +++ b/TAO/tao/CONV_FRAMES_T.h @@ -1,21 +1,18 @@ -// -// $Id$ -// -// ================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// CONV_FRAMES_T.h -// -// = DESCRIPTION -// Generated from CONV_FRAME.pidl, that contains the OMG standarized -// CONV_FRAME module. -// The code was generated by the IDL compiler and then hand-crafted -// to reduce the includes interdependencies. -// -// ================================================================ +//============================================================================= +/** + * @file CONV_FRAMES_T.h + * + * $Id$ + * + * Generated from CONV_FRAME.pidl, that contains the OMG standarized + * CONV_FRAME module. + * The code was generated by the IDL compiler and then hand-crafted + * to reduce the includes interdependencies. + * + * + */ +//============================================================================= + #ifndef TAO_CONV_FRAMES_T_H #define TAO_CONV_FRAMES_T_H diff --git a/TAO/tao/CORBALOC_Parser.h b/TAO/tao/CORBALOC_Parser.h index 6bef830524c..dbe869b9deb 100644 --- a/TAO/tao/CORBALOC_Parser.h +++ b/TAO/tao/CORBALOC_Parser.h @@ -1,18 +1,15 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// CORBALOC_Parser.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// Priyanka Gontla (pgontla@uci.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file CORBALOC_Parser.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + * @author Priyanka Gontla (pgontla@uci.edu) + */ +//============================================================================= + #ifndef TAO_CORBALOC_PARSER_H #define TAO_CORBALOC_PARSER_H @@ -33,99 +30,106 @@ #include "ace/Service_Config.h" +/** + * @class TAO_CORBALOC_Parser + * + * @brief Implements the <corbaloc:> IOR format + * + * This class implements the <corbaloc:> IOR format. + * It is dynamically loaded by the ORB and used to parse the + * string to separate the individual <obj_addr> from the list of object + * addresses <obj_addr_list>. + */ class TAO_Export TAO_CORBALOC_Parser : public TAO_IOR_Parser { - // = TITLE - // Implements the <corbaloc:> IOR format - // - // = DESCRIPTION - // This class implements the <corbaloc:> IOR format. - // It is dynamically loaded by the ORB and used to parse the - // string to separate the individual <obj_addr> from the list of object - // addresses <obj_addr_list>. - // public: + /// Constructor TAO_CORBALOC_Parser (void); - // Constructor + /// The destructor virtual ~TAO_CORBALOC_Parser (void); - // The destructor + /// = The IOR_Parser methods, please read the documentation in + /// IOR_Parser.h virtual int match_prefix (const char *ior_string) const; - // = The IOR_Parser methods, please read the documentation in - // IOR_Parser.h + /// Parse the ior-string that is passed. virtual CORBA::Object_ptr parse_string (const char *ior, CORBA::ORB_ptr orb, CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)); - // Parse the ior-string that is passed. private: // @@ Priyanka: do you really need this (see next comment)? BTW, in // general we put private data members *after* private methods. + /// ORB CORBA::ORB_var orb_; - // ORB // @@ Priyanka: this makes the class non-reentrant, only one thread // can parse a string at a time. The "Right Thing"[tm] is to // pass the MProfile to whatever helper methods you have, so they // can add stuff to it. That way there is no resource // contention. + /// One big mprofile which consists the profiles of all the endpoints. TAO_MProfile mprofile_; - // One big mprofile which consists the profiles of all the endpoints. + /// Checks the prefix to see if it is RIR. virtual int check_prefix (const char *endpoint); - // Checks the prefix to see if it is RIR. + /// Helps count the length of the <obj_addr_list> and the number of + /// individual <obj_addr> in the <obj_addr_list>. virtual void parse_string_count_helper (const char * &corbaloc_name, CORBA::ULong &addr_list_length, CORBA::ULong &count_addr, CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)); - // Helps count the length of the <obj_addr_list> and the number of - // individual <obj_addr> in the <obj_addr_list>. + /** + * Creates a MProfile for the endpoint passed and each such mprofile + * is added to the big mprofile <mprofile_> from which a pointer to + * the Object represented by the key_string is obtained and passed + * to the application. + */ virtual void parse_string_mprofile_helper (CORBA::String_var end_point, CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)); - // Creates a MProfile for the endpoint passed and each such mprofile - // is added to the big mprofile <mprofile_> from which a pointer to - // the Object represented by the key_string is obtained and passed - // to the application. + /** + * Make a stub from the MProfile that is created in + * parse_string_mprofile_helper. Using this stub, create an object + * reference which is sent to the application. + */ virtual CORBA::Object_ptr make_stub_from_mprofile (CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)); - // Make a stub from the MProfile that is created in - // parse_string_mprofile_helper. Using this stub, create an object - // reference which is sent to the application. + /// Gets the pointer to the key_string when the protocol used is RIR virtual CORBA::Object_ptr parse_string_rir_helper (const char * &corbaloc_name, CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)); - // Gets the pointer to the key_string when the protocol used is RIR + /// Tokenizes the <obj_addr_list> using "," as the seperator. Assigns + /// individual endpoints to the elements of the ACE_Array_Base. virtual void parse_string_assign_helper (CORBA::ULong &addr_list_length, ACE_CString &key_string, ACE_CString &cloc_name, CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)); - // Tokenizes the <obj_addr_list> using "," as the seperator. Assigns - // individual endpoints to the elements of the ACE_Array_Base. + /** + * Helps parse_string_assign_helper by assigning in the case when + * the protocol name is present and we have to append jsut the key + * string. + */ virtual void assign_key_string(char * &cloc_name_ptr, ACE_CString &key_string, CORBA::ULong &addr_list_length, CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)); - // Helps parse_string_assign_helper by assigning in the case when - // the protocol name is present and we have to append jsut the key - // string. }; diff --git a/TAO/tao/CORBANAME_Parser.h b/TAO/tao/CORBANAME_Parser.h index 1aec718d046..16ca242e6a4 100644 --- a/TAO/tao/CORBANAME_Parser.h +++ b/TAO/tao/CORBANAME_Parser.h @@ -1,17 +1,14 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// CORBANAME_Parser.h -// -// = AUTHOR -// Priyanka Gontla (pgontla@uci.edu) -// -// ============================================================================ +//============================================================================= +/** + * @file CORBANAME_Parser.h + * + * $Id$ + * + * @author Priyanka Gontla (pgontla@uci.edu) + */ +//============================================================================= + #ifndef TAO_CORBANAME_PARSER_H #define TAO_CORBANAME_PARSER_H @@ -25,23 +22,24 @@ #include "ace/Service_Config.h" +/** + * @class TAO_CORBANAME_Parser + * + * @brief Implements the <corbaname:> IOR format + * + * This class implements the <corbaname:> IOR format. + * It is dynamically loaded by the ORB and used to get reference + * to a naming service at the given address and port and then resolve an + * object in that context. + */ class TAO_Export TAO_CORBANAME_Parser : public TAO_IOR_Parser { - // = TITLE - // Implements the <corbaname:> IOR format - // - // = DESCRIPTION - // This class implements the <corbaname:> IOR format. - // It is dynamically loaded by the ORB and used to get reference - // to a naming service at the given address and port and then resolve an - // object in that context. - // public: + /// Constructor TAO_CORBANAME_Parser (void); - // Constructor + /// The destructor virtual ~TAO_CORBANAME_Parser (void); - // The destructor // = The IOR_Parser methods, please read the documentation in // IOR_Parser.h diff --git a/TAO/tao/CORBA_String.h b/TAO/tao/CORBA_String.h index 34e32cd352f..2b384b952b6 100644 --- a/TAO/tao/CORBA_String.h +++ b/TAO/tao/CORBA_String.h @@ -1,20 +1,18 @@ // -*- C++ -*- -// -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// CORBA_String.h -// -// = DESCRIPTION -// Header file for the CORBA string types. -// -// ============================================================================ +//============================================================================= +/** + * @file CORBA_String.h + * + * $Id$ + * + * Header file for the CORBA string types. + * + * + */ +//============================================================================= + #ifndef TAO_CORBA_STRING_H @@ -35,106 +33,111 @@ #endif /* ACE_HAS_MINIMUM_IOSTREAMH_INCLUSION */ +/** + * @class CORBA_String_var + * + * @brief CORBA_String var class. Provides automatic deallocation of storage + * for the string once it goes out of scope. + */ class TAO_Export CORBA_String_var { - // = TITLE - // CORBA_String var class. Provides automatic deallocation of storage - // for the string once it goes out of scope. public: + /// default constructor. CORBA_String_var (void); - // default constructor. + /// constructor, owns p. CORBA_String_var (char *p); - // constructor, owns p. + /// constructor. Makes a copy of p. CORBA_String_var (const char *p); - // constructor. Makes a copy of p. + /// copy constructor. CORBA_String_var (const CORBA_String_var &s); - // copy constructor. + /// destructor. ~CORBA_String_var (void); - // destructor. + /// assignment operator. CORBA_String_var &operator= (char *p); - // assignment operator. + /// assignment to a const char*. Makes a copy. CORBA_String_var &operator= (const char *p); - // assignment to a const char*. Makes a copy. + /// assignment operator. CORBA_String_var &operator= (const CORBA_String_var &s); - // assignment operator. + /// access and modify. operator char *(); - // access and modify. + /// only read privileges. operator const char *() const; - // only read privileges. + /// allows access and modification using an slot. char &operator[] (CORBA::ULong slot); - // allows access and modification using an slot. + /// allows only accessing thru an slot. char operator[] (CORBA::ULong slot) const; - // allows only accessing thru an slot. // = in, out, out, and _retn operations. // ORBOS/97-05-15, Appendix C.2 + /// for in parameter. const char *in (void) const; - // for in parameter. + /// for inout parameter. char *&inout (void); - // for inout parameter. + /// for out parameter. char *&out (void); - // for out parameter. + /// for string of return type. char *_retn (void); - // for string of return type. private: + /// instance. char *ptr_; - // instance. }; +/** + * @class CORBA_String_out + * + * @brief CORBA_String_out + * + * To support the memory management for "out" parameter passing + * mode. ORBOS/97-05-15, Appendix C.2 defines a CORBA_String_out class + */ class TAO_Export CORBA_String_out { - // = TITLE - // CORBA_String_out - // - // = DESCRIPTION - // To support the memory management for "out" parameter passing - // mode. ORBOS/97-05-15, Appendix C.2 defines a CORBA_String_out class public: // = operations. + /// Construction from a reference to a string. CORBA_String_out (char *&p); - // Construction from a reference to a string. + /// Construction from a var. CORBA_String_out (CORBA_String_var &p); - // Construction from a var. + /// Copy constructor. CORBA_String_out (const CORBA_String_out &s); - // Copy constructor. + /// Assignment from a string_out. CORBA_String_out &operator= (const CORBA_String_out &s); - // Assignment from a string_out. + /// Assignment from a string. CORBA_String_out &operator= (char *p); - // Assignment from a string. + /// Assignment from a constant char*. CORBA_String_out& operator= (const char* p); - // Assignment from a constant char*. + /// Cast. operator char *&(); - // Cast. + /// Return underlying instance. char *&ptr (void); - // Return underlying instance. private: + /// Instance. char *&ptr_; - // Instance. // assignment from _var disallowed void operator= (const CORBA_String_var &); @@ -142,106 +145,109 @@ private: // **************************************************************** +/** + * @class CORBA_WString_var + * + * @brief CORBA_WString var class. Provides automatic deallocation of + * storage for wide strings + */ class TAO_Export CORBA_WString_var { - // = TITLE - // CORBA_WString var class. Provides automatic deallocation of - // storage for wide strings - // public: + /// default constructor. CORBA_WString_var (void); - // default constructor. + /// constructor, owns p. CORBA_WString_var (CORBA::WChar *p); - // constructor, owns p. + /// constructor. Makes a copy of p. CORBA_WString_var (const CORBA::WChar *p); - // constructor. Makes a copy of p. + /// copy constructor. CORBA_WString_var (const CORBA_WString_var &s); - // copy constructor. + /// destructor. ~CORBA_WString_var (void); - // destructor. + /// assignment operator. CORBA_WString_var &operator= (CORBA::WChar *p); - // assignment operator. + /// assignment to a const char*. Makes a copy. CORBA_WString_var &operator= (const CORBA::WChar *p); - // assignment to a const char*. Makes a copy. + /// assignment operator. CORBA_WString_var &operator= (const CORBA_WString_var &s); - // assignment operator. + /// access and modify. operator CORBA::WChar *(); - // access and modify. + /// only read privileges. operator const CORBA::WChar *() const; - // only read privileges. + /// allows access and modification using an slot. CORBA::WChar &operator[] (CORBA::ULong slot); - // allows access and modification using an slot. + /// allows only accessing thru an slot. CORBA::WChar operator[] (CORBA::ULong slot) const; - // allows only accessing thru an slot. // = in, out, out, and _retn operations. // ORBOS/97-05-15, Appendix C.2 + /// for in parameter. const CORBA::WChar *in (void) const; - // for in parameter. + /// for inout parameter. CORBA::WChar *&inout (void); - // for inout parameter. + /// for out parameter. CORBA::WChar *&out (void); - // for out parameter. + /// for string of return type. CORBA::WChar *_retn (void); - // for string of return type. private: + /// instance. CORBA::WChar *ptr_; - // instance. }; +/** + * @class CORBA_WString_out + * + * @brief CORBA_WString_out + * + * To support the memory management for "out" parameter passing + * mode. ORBOS/97-05-15, Appendix C.2 defines a CORBA_WString_out + * class + */ class TAO_Export CORBA_WString_out { - // = TITLE - // CORBA_WString_out - // - // = DESCRIPTION - // To support the memory management for "out" parameter passing - // mode. ORBOS/97-05-15, Appendix C.2 defines a CORBA_WString_out - // class - // public: // = operations. + /// Construction from a reference to a string. CORBA_WString_out (CORBA::WChar *&p); - // Construction from a reference to a string. + /// Construction from a var. CORBA_WString_out (CORBA_WString_var &p); - // Construction from a var. + /// Copy constructor. CORBA_WString_out (const CORBA_WString_out &s); - // Copy constructor. + /// Assignment from a string_out. CORBA_WString_out &operator= (const CORBA_WString_out &s); - // Assignment from a string_out. + /// Assignment from a string. CORBA_WString_out &operator= (CORBA::WChar *p); - // Assignment from a string. + /// Cast. operator CORBA::WChar *&(); - // Cast. + /// Return underlying instance. CORBA::WChar *&ptr (void); - // Return underlying instance. private: + /// Instance. CORBA::WChar *&ptr_; - // Instance. // assignment from _var disallowed void operator= (const CORBA_WString_var &); diff --git a/TAO/tao/Cache_Entries.h b/TAO/tao/Cache_Entries.h index 4764049b1fe..a725698436e 100644 --- a/TAO/tao/Cache_Entries.h +++ b/TAO/tao/Cache_Entries.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Cache_Entries.h -// -// = AUTHOR -// Bala Natarajan <bala@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Cache_Entries.h + * + * $Id$ + * + * @author Bala Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_CACHE_ENTRIES_H #define TAO_CACHE_ENTRIES_H @@ -35,131 +32,136 @@ class TAO_Connection_Handler; class Tao_Base_Connection_Property; +/** + * @class TAO_Cache_IntId + * + * @brief Helper class for TAO_Connection_Cache_Manager + * + * Helper class that wraps the <value> part of the Map or + * table holding the Connection state.: unifies data items, so + * they can be stored together as a <value> for a <key> in a + * table holding the state of the Connection Cache. + */ class TAO_Export TAO_Cache_IntId { - // = TITLE - // Helper class for TAO_Connection_Cache_Manager - // - // = DESCRIPTION - // Helper class that wraps the <value> part of the Map or - // table holding the Connection state.: unifies data items, so - // they can be stored together as a <value> for a <key> in a - // table holding the state of the Connection Cache. public: // = Initialization and termination methods. + /// Constructor. TAO_Cache_IntId (void); - // Constructor. + /// Constructor. TAO_Cache_IntId (TAO_Connection_Handler *handler); - // Constructor. + /// Copy constructor. TAO_Cache_IntId (const TAO_Cache_IntId & rhs); - // Copy constructor. + /// Destructor. ~TAO_Cache_IntId (void); - // Destructor. + /// Assignment operator (does copy memory). void operator= (const TAO_Cache_IntId &rhs); - // Assignment operator (does copy memory). + /// Equality comparison operator (must match both id_ and kind_). int operator== (const TAO_Cache_IntId &rhs) const; - // Equality comparison operator (must match both id_ and kind_). + /// Inequality comparison operator. int operator!= (const TAO_Cache_IntId &rhs) const; - // Inequality comparison operator. + /// Return the underlying handler TAO_Connection_Handler *handler (void); - // Return the underlying handler + /// Return the underlying handler const TAO_Connection_Handler *handler (void) const; - // Return the underlying handler void recycle_state (ACE_Recyclable_State new_state); + /// Get/Set <recycle_state>. ACE_Recyclable_State recycle_state (void); - // Get/Set <recycle_state>. private: + /// The connection handler that needs to be cached. TAO_Connection_Handler *handler_; - // The connection handler that needs to be cached. + /// The state of the handle ACE_Recyclable_State recycle_state_; - // The state of the handle }; +/** + * @class TAO_Cache_ExtId + * + * @brief Helper class for TAO_Connection_Cache_Manager: unifies + * several data items, so they can be stored together as a + * <value> for a <key> in a hash table holding the state of the + * Connection Cache. + * + */ class TAO_Export TAO_Cache_ExtId { - // = TITLE - // Helper class for TAO_Connection_Cache_Manager: unifies - // several data items, so they can be stored together as a - // <value> for a <key> in a hash table holding the state of the - // Connection Cache. - // - // = DESCRIPTION - // public: // = Initialization and termination methods. + /// Constructor. TAO_Cache_ExtId (void); - // Constructor. + /// Constructor. TAO_Cache_ExtId (TAO_Connection_Descriptor_Interface *prop); - // Constructor. + /// Copy constructor. TAO_Cache_ExtId (const TAO_Cache_ExtId & rhs); - // Copy constructor. + /// Destructor. ~TAO_Cache_ExtId (void); - // Destructor. // = Assignment and comparison operators. + /// Assignment operator (does copy memory). void operator= (const TAO_Cache_ExtId &rhs); - // Assignment operator (does copy memory). + /// Equality comparison operator (must match both id_ and kind_). int operator== (const TAO_Cache_ExtId &rhs) const; - // Equality comparison operator (must match both id_ and kind_). + /// Inequality comparison operator. int operator!= (const TAO_Cache_ExtId &rhs) const; - // Inequality comparison operator. + /// <hash> function is required in order for this class to be usable by + /// ACE_Hash_Map_Manager. u_long hash (void) const; - // <hash> function is required in order for this class to be usable by - // ACE_Hash_Map_Manager. + /// Make a deep copy of the underlying pointer void duplicate (void); - // Make a deep copy of the underlying pointer + /// Return the index value CORBA::ULong index (void); CORBA::ULong index (void) const; - // Return the index value + /// Set the index value. This calls should not be used by any users + /// but for the TAO_Connection_Cache_Manager class. void index (CORBA::ULong index); - // Set the index value. This calls should not be used by any users - // but for the TAO_Connection_Cache_Manager class. // = Accessors + /// Get the underlying the property pointer TAO_Connection_Descriptor_Interface *property (void) const; - // Get the underlying the property pointer private: // = Data members. + /// A property object that we represent. TAO_Connection_Descriptor_Interface *connection_property_; - // A property object that we represent. + /// Do we need to delete connection_propert_? CORBA::Boolean is_delete_; - // Do we need to delete connection_propert_? + /** + * This is a supplementary index. Would be set to zero by + * default. Would be altered by the Connection_Cache of TAO. Please + * see the documentation of TAO_Connection_Cache_Manager for + * details. + */ CORBA::ULong index_; - // This is a supplementary index. Would be set to zero by - // default. Would be altered by the Connection_Cache of TAO. Please - // see the documentation of TAO_Connection_Cache_Manager for - // details. }; diff --git a/TAO/tao/Client_Priority_Policy.h b/TAO/tao/Client_Priority_Policy.h index da5796b4ae8..4e9c3725c7b 100644 --- a/TAO/tao/Client_Priority_Policy.h +++ b/TAO/tao/Client_Priority_Policy.h @@ -1,23 +1,16 @@ /* -*- C++ -*- */ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = DESCRIPTION -// Implementation class for TAO-specific Client Priority Policy. -// -// = FILENAME -// Client_Priority_Policy.h -// -// = AUTHOR -// Marina Spivak (marina@cs.wustl.edu) -// Carlos O'Ryan (coryan@cs.wustl.edu) -// Ossama Othman (othman@cs.wustl.edu) -// -// ============================================================================ +//============================================================================= +/** + * @file Client_Priority_Policy.h + * + * $Id$ + * + * @author Marina Spivak (marina@cs.wustl.edu) + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + * @author Ossama Othman (othman@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_CLIENT_PRIORITY_POLICY_H #define TAO_CLIENT_PRIORITY_POLICY_H @@ -52,21 +45,21 @@ class TAO_Export TAO_Client_Priority_Policy // // public: + /// Constructor. TAO_Client_Priority_Policy (const TAO::PrioritySpecification &priority_spec); - // Constructor. + /// Copy constructor. TAO_Client_Priority_Policy (const TAO_Client_Priority_Policy &rhs); - // Copy constructor. + /// Helper method for the implementation of CORBA::ORB::create_policy static CORBA::Policy_ptr create ( const CORBA::Any& val, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); - // Helper method for the implementation of CORBA::ORB::create_policy + /// Returns a copy of <this>. virtual TAO_Client_Priority_Policy *clone (void) const; - // Returns a copy of <this>. // = The TAO::Client_Priority_Policy methods virtual TAO::PrioritySpecification priority_specification ( @@ -88,8 +81,8 @@ public: ACE_THROW_SPEC ((CORBA::SystemException)); private: + /// The attribute TAO::PrioritySpecification priority_spec_; - // The attribute }; #if defined(_MSC_VER) && (_MSC_VER >= 1200) diff --git a/TAO/tao/Client_Strategy_Factory.h b/TAO/tao/Client_Strategy_Factory.h index 48760e2920a..735e48afa26 100644 --- a/TAO/tao/Client_Strategy_Factory.h +++ b/TAO/tao/Client_Strategy_Factory.h @@ -1,18 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Client_Strategy_Factory.h -// -// = AUTHOR -// Chris Cleeland <cleeland@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file Client_Strategy_Factory.h + * + * $Id$ + * + * @author Chris Cleeland <cleeland@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_CLIENT_STRATEGY_FACTORY_H #define TAO_CLIENT_STRATEGY_FACTORY_H @@ -32,33 +29,38 @@ class TAO_Wait_Strategy; class TAO_Transport; class TAO_ORB_Core; +/** + * @class TAO_Client_Strategy_Factory + * + * @brief Abstract factory used by the client to manufacture various + * strategies used on the client-side. + */ class TAO_Export TAO_Client_Strategy_Factory : public ACE_Service_Object { - // = TITLE - // Abstract factory used by the client to manufacture various - // strategies used on the client-side. public: // = Intialization and termination methods. + /// Constructor. TAO_Client_Strategy_Factory (void); - // Constructor. + /// Destructor virtual ~TAO_Client_Strategy_Factory (void); - // Destructor + /** + * Create the lock for the forwarding Profile used by the + * <TAO_GIOP_Invocation::location_forward> and the + * <TAO_GIOP_Invocation::start>. + */ virtual ACE_Lock* create_profile_lock (void); - // Create the lock for the forwarding Profile used by the - // <TAO_GIOP_Invocation::location_forward> and the - // <TAO_GIOP_Invocation::start>. + /// Create the correct client request muxing strategy. virtual TAO_Transport_Mux_Strategy *create_transport_mux_strategy (TAO_Transport *transport); - // Create the correct client request muxing strategy. + /// Create the correct client <wait_for_reply> strategy. virtual TAO_Wait_Strategy *create_wait_strategy (TAO_Transport *transport); - // Create the correct client <wait_for_reply> strategy. + /// Create a lock to be used by the TAO_Fault_Tolerant_Service class + /// to generate unique retention ids virtual ACE_Lock *create_ft_service_retention_id_lock (void); - // Create a lock to be used by the TAO_Fault_Tolerant_Service class - // to generate unique retention ids }; #include "ace/post.h" diff --git a/TAO/tao/Connection_Cache_Manager.h b/TAO/tao/Connection_Cache_Manager.h index 8e8a869d0d3..cc57d772f0c 100644 --- a/TAO/tao/Connection_Cache_Manager.h +++ b/TAO/tao/Connection_Cache_Manager.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Connection_Cache_Manager.h -// -// = AUTHOR -// Bala Natarajan <bala@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Connection_Cache_Manager.h + * + * $Id$ + * + * @author Bala Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_CONNECTION_CACHE_MANAGER_H #define TAO_CONNECTION_CACHE_MANAGER_H @@ -37,10 +34,13 @@ class TAO_ORB_Core; class ACE_Handle_Set; +/** + * @class TAO_Connection_Cache_Manager + * + * @brief The Connection Cache Manager for TAO + */ class TAO_Export TAO_Connection_Cache_Manager { - // = TITLE - // The Connection Cache Manager for TAO // = DESCRIPTION // This class provides interfaces associating a TAO_Cache_ExtId @@ -73,142 +73,152 @@ public: // == Public methods + /// Constructor TAO_Connection_Cache_Manager (void); - // Constructor + /// Destructor virtual ~TAO_Connection_Cache_Manager (void); - // Destructor + /// Add the handler to the cache. The handler has the property + /// definition based on which caching can be done int cache_handler (TAO_Connection_Descriptor_Interface *prop, TAO_Connection_Handler *handler); - // Add the handler to the cache. The handler has the property - // definition based on which caching can be done + /// Check the Connection Cache to check whether the connection exists + /// in the Cache and return the connection int find_handler (TAO_Connection_Descriptor_Interface *prop, TAO_Connection_Handler *&handler); - // Check the Connection Cache to check whether the connection exists - // in the Cache and return the connection + /// Initialize a <HASH_MAP> with <size> elements. int open (TAO_ORB_Core *orb_core, size_t size = ACE_DEFAULT_MAP_SIZE); - // Initialize a <HASH_MAP> with <size> elements. + /// Associate <ext_id> with <int_id>. Grabs the lock and calls the + /// implementation function bind_i. int bind (TAO_Cache_ExtId &ext_id, TAO_Cache_IntId &int_id); - // Associate <ext_id> with <int_id>. Grabs the lock and calls the - // implementation function bind_i. + /// Lookup entry<key,value> in the cache. Grabs the lock and calls the + /// implementation function find_i. int find (const TAO_Cache_ExtId &key, TAO_Cache_IntId &value); - // Lookup entry<key,value> in the cache. Grabs the lock and calls the - // implementation function find_i. + /// Reassociate the <key> with <value>. Grabs the lock and calls the + /// implementation function find_i. int rebind (const TAO_Cache_ExtId &key, const TAO_Cache_IntId &value); - // Reassociate the <key> with <value>. Grabs the lock and calls the - // implementation function find_i. + /** + * Associate <key> with <value> if and only if <key> is not in the + * cache. Grabs the lock and calls the implementation function + * find_i. + */ int trybind (const TAO_Cache_ExtId &key, TAO_Cache_IntId &value); - // Associate <key> with <value> if and only if <key> is not in the - // cache. Grabs the lock and calls the implementation function - // find_i. + /// Remove <key> from the cache. int unbind (const TAO_Cache_ExtId &key); - // Remove <key> from the cache. + /// Remove <key> from the cache, and return the <value> associated with + /// <key>. int unbind (const TAO_Cache_ExtId &key, TAO_Cache_IntId &value); - // Remove <key> from the cache, and return the <value> associated with - // <key>. + /// Remove entries from the cache depending upon the strategy. int purge (void); - // Remove entries from the cache depending upon the strategy. + /// Purge the entry from the Cache Map int purge_entry (HASH_MAP_ENTRY *&); - // Purge the entry from the Cache Map + /// Make the entry idle and ready for use. int make_idle (HASH_MAP_ENTRY *&entry); - // Make the entry idle and ready for use. + /// Close the underlying hash map manager and return the handle set + /// that have been registered with the reactor int close (ACE_Handle_Set &handle_set); - // Close the underlying hash map manager and return the handle set - // that have been registered with the reactor + /// Return the current size of the cache. size_t current_size (void) const; - // Return the current size of the cache. + /// Return the total size of the cache. size_t total_size (void) const; - // Return the total size of the cache. private: + /** + * Non-Locking version and actual implementation of bind () + * call. Calls bind on the Hash_Map_Manager that it holds. If the + * bind succeeds, it adds the Hash_Map_Entry in to the + * Connection_Handler for its reference. If the bind fails because + * of an exiting entry, this method calls the get_last_index_bind + * (). + */ int bind_i (TAO_Cache_ExtId &ext_id, TAO_Cache_IntId &int_id); - // Non-Locking version and actual implementation of bind () - // call. Calls bind on the Hash_Map_Manager that it holds. If the - // bind succeeds, it adds the Hash_Map_Entry in to the - // Connection_Handler for its reference. If the bind fails because - // of an exiting entry, this method calls the get_last_index_bind - // (). + /** + * Non-locking version and actual implementation of find () + * call. This calls the find () on the underlying + * Hash_Map_Manager. If the find succeeds, it calls the + * get_idle_handler (). + */ int find_i (const TAO_Cache_ExtId &key, TAO_Cache_IntId &value); - // Non-locking version and actual implementation of find () - // call. This calls the find () on the underlying - // Hash_Map_Manager. If the find succeeds, it calls the - // get_idle_handler (). + /// Non-locking version and actual implementation of rebind () call int rebind_i (const TAO_Cache_ExtId &key, const TAO_Cache_IntId &value); - // Non-locking version and actual implementation of rebind () call + /// Non-locking version and actual implementation of trybind () call int trybind_i (const TAO_Cache_ExtId &key, TAO_Cache_IntId &value); - // Non-locking version and actual implementation of trybind () call + /// Non-locking version and actual implementation of unbind () call int unbind_i (const TAO_Cache_ExtId &key); - // Non-locking version and actual implementation of unbind () call + /// Non-locking version and actual implementation of unbind () call int unbind_i (const TAO_Cache_ExtId &key, TAO_Cache_IntId &value); - // Non-locking version and actual implementation of unbind () call + /// Non-locking version and actual implementation of make_idle (). int make_idle_i (HASH_MAP_ENTRY *&entry); - // Non-locking version and actual implementation of make_idle (). + /// Non-locking version and actual implementation of close () int close_i (ACE_Handle_Set &handle_set); - // Non-locking version and actual implementation of close () + /// Purge the entry from the Cache Map int purge_entry_i (HASH_MAP_ENTRY *&entry); - // Purge the entry from the Cache Map private: + /** + * This is called by the bind () call when a bind fails with a + * available entry. When a new connection is created in TAO with an + * already existing endpoint, in addition to an exisitng one, we + * mark the connections with an index. This method, finds out the + * last highest index and binds the entry with an index = (last + * highest index + 1). + */ int get_last_index_bind (TAO_Cache_ExtId &key, TAO_Cache_IntId &val, HASH_MAP_ENTRY *&entry); - // This is called by the bind () call when a bind fails with a - // available entry. When a new connection is created in TAO with an - // already existing endpoint, in addition to an exisitng one, we - // mark the connections with an index. This method, finds out the - // last highest index and binds the entry with an index = (last - // highest index + 1). + /** + * Tries to find if the <int_id_> in entry is idle for use. If it is + * idle it is immediately markes as busy and returns a value of + * 1, else it returns a value of 0 + */ int is_entry_idle (HASH_MAP_ENTRY *&entry); - // Tries to find if the <int_id_> in entry is idle for use. If it is - // idle it is immediately markes as busy and returns a value of - // 1, else it returns a value of 0 private: + /// The hash map that has the connections HASH_MAP cache_map_; - // The hash map that has the connections + /// Lock for the map ACE_Lock *cache_lock_; - // Lock for the map }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/Connection_Handler.h b/TAO/tao/Connection_Handler.h index 0488a8b5c7e..5a20652833b 100644 --- a/TAO/tao/Connection_Handler.h +++ b/TAO/tao/Connection_Handler.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// tao -// -// = FILENAME -// Connection_Handler.h -// -// = AUTHOR -// Bala Natarajan <bala@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Connection_Handler.h + * + * $Id$ + * + * @author Bala Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_CONNECTION_HANDLER_H #define TAO_CONNECTION_HANDLER_H @@ -38,21 +35,23 @@ class TAO_ORB_Core_TSS_Resources; class ACE_Reactor; class ACE_Event_Handler; +/** + * @class TAO_Connection_Handler + * + * @brief TAO_Connection_Handler + * + * This class is an abstraction for the connection handlers. The + * connections handler in every protocol can derive from this + * class as well as the ACE_Svc_Handler specialised for the + * right protocol. This way, most of the common code for the + * different protocls would be in this implementation. Further, + * this class wold be of immense use in storing the handlers in + * the Cache for TAO. This would help in purging entries which + * is generally accompanied by closing the open handles and + * deleting memory associated with the handlers. + */ class TAO_Export TAO_Connection_Handler { - // = TITLE - // TAO_Connection_Handler - // - // = DESCRIPTION - // This class is an abstraction for the connection handlers. The - // connections handler in every protocol can derive from this - // class as well as the ACE_Svc_Handler specialised for the - // right protocol. This way, most of the common code for the - // different protocls would be in this implementation. Further, - // this class wold be of immense use in storing the handlers in - // the Cache for TAO. This would help in purging entries which - // is generally accompanied by closing the open handles and - // deleting memory associated with the handlers. // Note: This class has NOT abstracted the GIOP specific // details. It is just to be safe so that, we can reuse this @@ -62,79 +61,79 @@ class TAO_Export TAO_Connection_Handler public: + /// Constructor TAO_Connection_Handler (void); - // Constructor + /// Constructor TAO_Connection_Handler (TAO_ORB_Core *orb_core); - // Constructor + /// Destructor virtual ~TAO_Connection_Handler (void); - // Destructor void cache_map_entry ( TAO_Connection_Cache_Manager::HASH_MAP_ENTRY *entry); + /// Set/Get the Cache Map entry TAO_Connection_Cache_Manager::HASH_MAP_ENTRY *cache_map_entry (void); - // Set/Get the Cache Map entry + /// Make ourselves ready for use int make_idle (void); - // Make ourselves ready for use + /// Increment the reference count void incr_ref_count (void); - // Increment the reference count + /// Decrement the reference count void decr_ref_count (void); - // Decrement the reference count + /// Get and set method for the flag that indicates whether the + /// handler has been registered with the reactor or not. CORBA::Boolean is_registered (void); void is_registered (CORBA::Boolean); - // Get and set method for the flag that indicates whether the - // handler has been registered with the reactor or not. + /// Get the underlying handle virtual ACE_HANDLE fetch_handle (void) = 0; - // Get the underlying handle + /// Purge our entry from the Connection Cache int purge_entry (void); - // Purge our entry from the Connection Cache protected: + /// Return our TAO_ORB_Core pointer TAO_ORB_Core *orb_core (void); - // Return our TAO_ORB_Core pointer + /// Return our TSS Resources pointer TAO_ORB_Core_TSS_Resources* tss_resources (void); - // Return our TSS Resources pointer + /// Set options on the socket int set_socket_option (ACE_SOCK &sock, int snd_size, int rcv_size); - // Set options on the socket + /// This method is invoked from the svc () method of the Svc_Handler + /// Object. int svc_i (void); - // This method is invoked from the svc () method of the Svc_Handler - // Object. + /// Need to be implemented by the underlying protocol objects virtual int handle_input_i (ACE_HANDLE = ACE_INVALID_HANDLE, ACE_Time_Value *max_wait_time = 0) = 0; - // Need to be implemented by the underlying protocol objects private: + /// Pointer to the TAO_ORB_Core TAO_ORB_Core *orb_core_; - // Pointer to the TAO_ORB_Core + /// Cached tss resources of the ORB that activated this object. TAO_ORB_Core_TSS_Resources *tss_resources_; - // Cached tss resources of the ORB that activated this object. + /// Reference count to the number of external references -- ie. the + /// count of the number of places our references are being held. u_long ref_count_; - // Reference count to the number of external references -- ie. the - // count of the number of places our references are being held. + /// The cache map entry -- where we are in the Connection Cache TAO_Connection_Cache_Manager::HASH_MAP_ENTRY *cache_map_entry_; - // The cache map entry -- where we are in the Connection Cache + /// Are we registered with the reactor? CORBA::Boolean is_registered_; - // Are we registered with the reactor? }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/Connector_Registry.h b/TAO/tao/Connector_Registry.h index 3cee0a184a1..c0097cd1d22 100644 --- a/TAO/tao/Connector_Registry.h +++ b/TAO/tao/Connector_Registry.h @@ -1,21 +1,18 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Connector_Registry.h -// -// = DESCRIPTION -// Interface for the TAO Connector Registry -// -// = AUTHOR -// Fred Kuhns <fredk@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Connector_Registry.h + * + * $Id$ + * + * Interface for the TAO Connector Registry + * + * + * @author Fred Kuhns <fredk@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_CONNECTOR_REGISTRY_H #define TAO_CONNECTOR_REGISTRY_H @@ -42,82 +39,86 @@ class TAO_Resource_Factory; typedef TAO_Connector** TAO_ConnectorSetIterator; +/** + * @class TAO_Connector_Registry + * + * @brief Per ORB TAO Connector Registry + * + * Connector Registry and Generic Connector interface definitions. + * All loaded ESIOP or GIOP connector bridges must register with + * this object. + * This class is able to dynamically load a set of + * concrete protocol connectors which have registered with the service + * configurator and added their Factory name to the Resource_Factory + * line of the svc.comf file. + */ class TAO_Export TAO_Connector_Registry { - // = TITLE - // Per ORB TAO Connector Registry - // - // = DESCRIPTION - // Connector Registry and Generic Connector interface definitions. - // All loaded ESIOP or GIOP connector bridges must register with - // this object. - // This class is able to dynamically load a set of - // concrete protocol connectors which have registered with the service - // configurator and added their Factory name to the Resource_Factory - // line of the svc.comf file. public: + /// Default constructor. TAO_Connector_Registry (void); - // Default constructor. + /// Default destructor. ~TAO_Connector_Registry (void); - // Default destructor. + /// Return the connector bridges TAO_Connector *get_connector (CORBA::ULong tag); - // Return the connector bridges + /// Initialize all registered connectors. int open (TAO_ORB_Core *orb_core); - // Initialize all registered connectors. + /// Close all open connectors. int close_all (void); - // Close all open connectors. + /// For this list of preconnections call the connector specific + /// preconnect method for each preconnection. int preconnect (TAO_ORB_Core *orb_core, TAO_EndpointSet &preconnections); - // For this list of preconnections call the connector specific - // preconnect method for each preconnection. + /** + * This is where the transport protocol is selected based on some + * policy. This member will call the connect member of the + * TAO_Connector class which in turn will call the concrete + * connector. + */ int connect (TAO_Connection_Descriptor_Interface *desc, TAO_Transport *&transport, ACE_Time_Value *max_wait_time, CORBA::Environment &ACE_TRY_ENV); - // This is where the transport protocol is selected based on some - // policy. This member will call the connect member of the - // TAO_Connector class which in turn will call the concrete - // connector. + /// Parse a string containing a URL style IOR and return an + /// MProfile. int make_mprofile (const char *ior, TAO_MProfile &mprofile, CORBA::Environment &ACE_TRY_ENV); - // Parse a string containing a URL style IOR and return an - // MProfile. + /// Create a profile based on the contents of <cdr> TAO_Profile* create_profile (TAO_InputCDR& cdr); - // Create a profile based on the contents of <cdr> + /// Obtain the object key delimiter used by the protocol specified in + /// the provided URL style IOR. char object_key_delimiter (const char *ior); - // Obtain the object key delimiter used by the protocol specified in - // the provided URL style IOR. // = Iterator. TAO_ConnectorSetIterator begin (void); TAO_ConnectorSetIterator end (void); private: + /// Put the preconnects in a form that makes it simple for protocol + /// implementers to parse. int preprocess_preconnects (TAO_ORB_Core *orb_core, TAO_EndpointSet &preconnects); - // Put the preconnects in a form that makes it simple for protocol - // implementers to parse. // Prohibited ACE_UNIMPLEMENTED_FUNC (TAO_Connector_Registry (const TAO_Connector_Registry&)) ACE_UNIMPLEMENTED_FUNC (void operator= (const TAO_Connector_Registry&)) private: + /// List of connectors that are currently open. TAO_Connector** connectors_; - // List of connectors that are currently open. + /// Number of connectors that are currently open. size_t size_; - // Number of connectors that are currently open. }; #if defined(__ACE_INLINE__) diff --git a/TAO/tao/CurrentC.h b/TAO/tao/CurrentC.h index 072e3a57bf2..54320a8d600 100644 --- a/TAO/tao/CurrentC.h +++ b/TAO/tao/CurrentC.h @@ -59,17 +59,17 @@ class TAO_Export CORBA_Current_var : public TAO_Base_var { public: CORBA_Current_var (void); // default constructor - CORBA_Current_var (CORBA_Current_ptr p) : ptr_ (p) {} + CORBA_Current_var (CORBA_Current_ptr p) : ptr_ (p) {} CORBA_Current_var (const CORBA_Current_var &); // copy constructor ~CORBA_Current_var (void); // destructor - + CORBA_Current_var &operator= (CORBA_Current_ptr); CORBA_Current_var &operator= (const CORBA_Current_var &); CORBA_Current_ptr operator-> (void) const; - + operator const CORBA_Current_ptr &() const; operator CORBA_Current_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn CORBA_Current_ptr in (void) const; CORBA_Current_ptr &inout (void); CORBA_Current_ptr &out (void); @@ -102,7 +102,7 @@ public: operator CORBA_Current_ptr &(); CORBA_Current_ptr &ptr (void); CORBA_Current_ptr operator-> (void); - + private: CORBA_Current_ptr &ptr_; }; @@ -126,12 +126,12 @@ public: static CORBA_Current_ptr _duplicate (CORBA_Current_ptr obj); static CORBA_Current_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static CORBA_Current_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static CORBA_Current_ptr _nil (void) @@ -140,7 +140,7 @@ public: } virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; protected: diff --git a/TAO/tao/DLL_ORB.h b/TAO/tao/DLL_ORB.h index a6d5e856fe7..bd73e5f8192 100644 --- a/TAO/tao/DLL_ORB.h +++ b/TAO/tao/DLL_ORB.h @@ -1,22 +1,18 @@ // -*- C++ -*- -// -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// DLL_ORB.h -// -// = DESCRIPTION -// Header file for the TAO_DLL_ORB helper class. -// -// = AUTHOR -// Ossama Othman <ossama@uci.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file DLL_ORB.h + * + * $Id$ + * + * Header file for the TAO_DLL_ORB helper class. + * + * + * @author Ossama Othman <ossama@uci.edu> + */ +//============================================================================= + #ifndef TAO_DLL_ORB_H #define TAO_DLL_ORB_H @@ -31,48 +27,49 @@ #include "tao/ORB.h" +/** + * @class TAO_DLL_ORB + * + * @brief Manager for TAO library services and singleton cleanup. + * + * The <TAO_Singleton_Manager> is basically simplified version of + * the ACE_Object_Manager. It is designed specifically to + * manage singletons created by TAO. For example, Singleton + * instances created by TAO will be automatically registered + * with the Singleton instance of this Singleton Manager. + * This class is necessary to ensure that TAO-specific + * Singletons are centrally isolated. The idea is that + * destruction of the instance of the <TAO_Singleton_Manager> + * triggers destruction of all objects/services registered with + * it. + */ class TAO_Export TAO_DLL_ORB : public ACE_Task_Base { - // = TITLE - // Manager for TAO library services and singleton cleanup. - // - // = DESCRIPTION - // The <TAO_Singleton_Manager> is basically simplified version of - // the ACE_Object_Manager. It is designed specifically to - // manage singletons created by TAO. For example, Singleton - // instances created by TAO will be automatically registered - // with the Singleton instance of this Singleton Manager. - // - // This class is necessary to ensure that TAO-specific - // Singletons are centrally isolated. The idea is that - // destruction of the instance of the <TAO_Singleton_Manager> - // triggers destruction of all objects/services registered with - // it. public: + /// Constructor TAO_DLL_ORB (void); - // Constructor + /// Destructor ~TAO_DLL_ORB (void); - // Destructor + /// Initializes ORB when dynamic linking occurs. virtual int init (int argc, ACE_TCHAR *argv[]); - // Initializes ORB when dynamic linking occurs. + /// Terminates ORB when dynamic unlinking occurs. virtual int fini (void); - // Terminates ORB when dynamic unlinking occurs. + /// Run by a daemon thread to handle deferred processing. virtual int svc (void); - // Run by a daemon thread to handle deferred processing. + /// Returns a duplicate reference to the ORB. CORBA::ORB_ptr orb (void); - // Returns a duplicate reference to the ORB. private: + /// Reference to the ORB. CORBA::ORB_var orb_; - // Reference to the ORB. }; diff --git a/TAO/tao/DLL_Parser.h b/TAO/tao/DLL_Parser.h index f5e6827deaa..635f742665e 100644 --- a/TAO/tao/DLL_Parser.h +++ b/TAO/tao/DLL_Parser.h @@ -1,17 +1,14 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// DLL_Parser.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file DLL_Parser.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_DLL_PARSER_H #define TAO_DLL_PARSER_H @@ -24,23 +21,24 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class TAO_DLL_Parser + * + * @brief Defines the interface for the pluggable DLL parser components + * + * The ORB is able to dynamically load the list of DLL formats it + * understands. That allow us to integrate formats such as + * corbaname:, http: or ftp: only when required. + * This class provides a uniform interface for all the DLL parsers + */ class TAO_Export TAO_DLL_Parser : public TAO_IOR_Parser { - // = TITLE - // Defines the interface for the pluggable DLL parser components - // - // = DESCRIPTION - // The ORB is able to dynamically load the list of DLL formats it - // understands. That allow us to integrate formats such as - // corbaname:, http: or ftp: only when required. - // This class provides a uniform interface for all the DLL parsers - // public: + /// Constructor TAO_DLL_Parser (void); - // Constructor + /// The destructor virtual ~TAO_DLL_Parser (void); - // The destructor // = The IOR_Parser methods, please read the documentation in // IOR_Parser.h diff --git a/TAO/tao/DynamicC.h b/TAO/tao/DynamicC.h index 24a0e189bf0..2a5eea8318f 100644 --- a/TAO/tao/DynamicC.h +++ b/TAO/tao/DynamicC.h @@ -58,14 +58,14 @@ TAO_NAMESPACE Dynamic { PARAM_IN, PARAM_OUT, - PARAM_INOUT + PARAM_INOUT }; typedef ParameterMode &ParameterMode_out; TAO_NAMESPACE_STORAGE_CLASS CORBA::TypeCode_ptr _tc_ParameterMode; struct Parameter; class Parameter_var; - + struct TAO_Export Parameter { @@ -86,18 +86,18 @@ TAO_NAMESPACE Dynamic Parameter_var (Parameter *); Parameter_var (const Parameter_var &); // copy constructor ~Parameter_var (void); // destructor - + Parameter_var &operator= (Parameter *); Parameter_var &operator= (const Parameter_var &); Parameter *operator-> (void); const Parameter *operator-> (void) const; - + operator const Parameter &() const; operator Parameter &(); operator Parameter &() const; operator Parameter *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const Parameter &in (void) const; Parameter &inout (void); Parameter *&out (void); @@ -119,7 +119,7 @@ TAO_NAMESPACE Dynamic operator Parameter *&(); Parameter *&ptr (void); Parameter *operator-> (void); - + private: Parameter *&ptr_; // assignment from T_var not allowed @@ -130,7 +130,7 @@ TAO_NAMESPACE Dynamic #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + #if !defined (__TAO_UNBOUNDED_SEQUENCE_DYNAMIC_PARAMETERLIST_CH_) #define __TAO_UNBOUNDED_SEQUENCE_DYNAMIC_PARAMETERLIST_CH_ @@ -138,9 +138,9 @@ TAO_NAMESPACE Dynamic { public: // = Initialization and termination methods. - + _TAO_Unbounded_Sequence_Dynamic_ParameterList (void); // Default constructor. - _TAO_Unbounded_Sequence_Dynamic_ParameterList (CORBA::ULong maximum); + _TAO_Unbounded_Sequence_Dynamic_ParameterList (CORBA::ULong maximum); _TAO_Unbounded_Sequence_Dynamic_ParameterList (CORBA::ULong maximum, CORBA::ULong length, Parameter *data, @@ -157,7 +157,7 @@ TAO_NAMESPACE Dynamic virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); // Implement the TAO_Base_Sequence methods (see Sequence.h) - + Parameter *get_buffer (CORBA::Boolean orphan = 0); const Parameter *get_buffer (void) const; void replace (CORBA::ULong max, @@ -169,32 +169,32 @@ TAO_NAMESPACE Dynamic #endif /* end #if !defined */ -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ - +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ + #if !defined (_DYNAMIC_PARAMETERLIST_CH_) #define _DYNAMIC_PARAMETERLIST_CH_ class ParameterList; class ParameterList_var; - + // ************************************************************* // ParameterList // ************************************************************* - - class TAO_Export ParameterList : public + + class TAO_Export ParameterList : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Sequence_Dynamic_ParameterList #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Sequence<Parameter> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: ParameterList (void); // default ctor ParameterList (CORBA::ULong max); // uses max size ParameterList ( - CORBA::ULong max, - CORBA::ULong length, - Parameter *buffer, + CORBA::ULong max, + CORBA::ULong length, + Parameter *buffer, CORBA::Boolean release = 0 ); ParameterList (const ParameterList &); // copy ctor @@ -206,7 +206,7 @@ TAO_NAMESPACE Dynamic #endif /* ! __GNUC__ || g++ >= 2.8 */ }; - + #endif /* end #if !defined */ @@ -224,21 +224,21 @@ TAO_NAMESPACE Dynamic ParameterList_var (ParameterList *); ParameterList_var (const ParameterList_var &); // copy constructor ~ParameterList_var (void); // destructor - + ParameterList_var &operator= (ParameterList *); ParameterList_var &operator= (const ParameterList_var &); ParameterList *operator-> (void); const ParameterList *operator-> (void) const; - + operator const ParameterList &() const; operator ParameterList &(); operator ParameterList &() const; operator ParameterList *&(); // variable-size base types only - + Parameter & operator[] (CORBA::ULong index); const Parameter & operator[] (CORBA::ULong index) const; - - // in, inout, out, _retn + + // in, inout, out, _retn const ParameterList &in (void) const; ParameterList &inout (void); ParameterList *&out (void); @@ -268,7 +268,7 @@ TAO_NAMESPACE Dynamic ParameterList *&ptr (void); ParameterList *operator-> (void); Parameter & operator[] (CORBA::ULong index); - + private: ParameterList *&ptr_; // assignment from T_var not allowed @@ -293,7 +293,7 @@ TAO_NAMESPACE Dynamic #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + #if !defined (__TAO_UNBOUNDED_OBJECT_SEQUENCE_DYNAMIC_EXCEPTIONLIST_CH_) #define __TAO_UNBOUNDED_OBJECT_SEQUENCE_DYNAMIC_EXCEPTIONLIST_CH_ @@ -301,7 +301,7 @@ TAO_NAMESPACE Dynamic { public: // = Initialization and termination methods. - + _TAO_Unbounded_Object_Sequence_Dynamic_ExceptionList (void); _TAO_Unbounded_Object_Sequence_Dynamic_ExceptionList (CORBA::ULong maximum); _TAO_Unbounded_Object_Sequence_Dynamic_ExceptionList (CORBA::ULong maximum, @@ -320,38 +320,38 @@ TAO_NAMESPACE Dynamic CORBA::TypeCode* *get_buffer (CORBA::Boolean orphan = 0); const CORBA::TypeCode* *get_buffer (void) const; virtual void _shrink_buffer (CORBA::ULong nl, CORBA::ULong ol); - + }; #endif /* end #if !defined */ -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ - +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ + #if !defined (_DYNAMIC_EXCEPTIONLIST_CH_) #define _DYNAMIC_EXCEPTIONLIST_CH_ class ExceptionList; class ExceptionList_var; - + // ************************************************************* // ExceptionList // ************************************************************* - - class TAO_Export ExceptionList : public + + class TAO_Export ExceptionList : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Object_Sequence_Dynamic_ExceptionList #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Pseudo_Sequence<CORBA::TypeCode,CORBA::TypeCode_var> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: ExceptionList (void); // default ctor ExceptionList (CORBA::ULong max); // uses max size ExceptionList ( - CORBA::ULong max, - CORBA::ULong length, - CORBA::TypeCode_ptr *buffer, + CORBA::ULong max, + CORBA::ULong length, + CORBA::TypeCode_ptr *buffer, CORBA::Boolean release = 0 ); ExceptionList (const ExceptionList &); // copy ctor @@ -363,7 +363,7 @@ TAO_NAMESPACE Dynamic #endif /* ! __GNUC__ || g++ >= 2.8 */ }; - + #endif /* end #if !defined */ @@ -381,20 +381,20 @@ TAO_NAMESPACE Dynamic ExceptionList_var (ExceptionList *); ExceptionList_var (const ExceptionList_var &); // copy constructor ~ExceptionList_var (void); // destructor - + ExceptionList_var &operator= (ExceptionList *); ExceptionList_var &operator= (const ExceptionList_var &); ExceptionList *operator-> (void); const ExceptionList *operator-> (void) const; - + operator const ExceptionList &() const; operator ExceptionList &(); operator ExceptionList &() const; operator ExceptionList *&(); // variable-size base types only - + TAO_Pseudo_Object_Manager<TypeCode,TypeCode_var> operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const ExceptionList &in (void) const; ExceptionList &inout (void); ExceptionList *&out (void); @@ -424,7 +424,7 @@ TAO_NAMESPACE Dynamic ExceptionList *&ptr (void); ExceptionList *operator-> (void); TAO_Pseudo_Object_Manager<TypeCode,TypeCode_var> operator[] (CORBA::ULong index); - + private: ExceptionList *&ptr_; // assignment from T_var not allowed @@ -462,7 +462,7 @@ TAO_Export CORBA::Boolean operator>>= (const CORBA::Any &, const Dynamic::Except #ifndef __ACE_INLINE__ -TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const Dynamic::ParameterMode &); // +TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const Dynamic::ParameterMode &); // TAO_Export CORBA::Boolean operator>> (TAO_InputCDR &, Dynamic::ParameterMode &); TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const Dynamic::Parameter &); TAO_Export CORBA::Boolean operator>> (TAO_InputCDR &, Dynamic::Parameter &); diff --git a/TAO/tao/Dynamic_Adapter.h b/TAO/tao/Dynamic_Adapter.h index bc64655b53c..bc7d5be4474 100644 --- a/TAO/tao/Dynamic_Adapter.h +++ b/TAO/tao/Dynamic_Adapter.h @@ -1,18 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Dynamic_Adapter.h -// -// = AUTHOR -// Jeff Parsons <parsons@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Dynamic_Adapter.h + * + * $Id$ + * + * @author Jeff Parsons <parsons@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_DYNAMIC_ADAPTER_H #define TAO_DYNAMIC_ADAPTER_H @@ -28,17 +25,18 @@ class TAO_GIOP_Twoway_Invocation; +/** + * @class TAO_Dynamic_Adapter + * + * @brief TAO_Dynamic_Adapter. + * + * Class that adapts various functions in the CORBA namespace + * related to DII/DSI, which is no longer found in the TAO library. + * This is a base for the actual implementation in the DynamicInterface + * library. + */ class TAO_Export TAO_Dynamic_Adapter : public ACE_Service_Object { - // = TITLE - // TAO_Dynamic_Adapter. - // - // = DESCRIPTION - // Class that adapts various functions in the CORBA namespace - // related to DII/DSI, which is no longer found in the TAO library. - // This is a base for the actual implementation in the DynamicInterface - // library. - // public: virtual ~TAO_Dynamic_Adapter (void); diff --git a/TAO/tao/Encodable.h b/TAO/tao/Encodable.h index caf5a988ff1..fd25ba47e90 100644 --- a/TAO/tao/Encodable.h +++ b/TAO/tao/Encodable.h @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Encodable.h -// -// = DESCRIPTION -// Defines the interface for classes that wish to be -// encodable/decodable into/from a CDR representation. -// -// = AUTHOR -// Angelo Corsaro <corsaro@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Encodable.h + * + * $Id$ + * + * Defines the interface for classes that wish to be + * encodable/decodable into/from a CDR representation. + * + * + * @author Angelo Corsaro <corsaro@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_ENCODABLE_H_ #define TAO_ENCODABLE_H_ @@ -25,29 +22,30 @@ #if !defined (ACE_LACKS_PRAGMA_ONCE) # pragma once -#endif // ACE_LACKS_PRAGMA_ONCE - +#endif /* ACE_LACKS_PRAGMA_ONCE */ + +/** + * @class TAO_Encodable + * + * @brief TAO_Encodable Interface + * + * This interface should be inherited by classes that wish to be + * encoded/decoded into/from a CDR stream. Implementation of the + * streaming methods is deferred to the subclasses. + */ class TAO_Export TAO_Encodable { -// = TITLE -// TAO_Encodable Interface -// -// = DESCRIPTION -// This interface should be inherited by classes that wish to be -// encoded/decoded into/from a CDR stream. Implementation of the -// streaming methods is deferred to the subclasses. -// public: virtual ~TAO_Encodable (void); + /// Encodes the object implementing this method into a CDR stream. + /// Returns true on success and false on failure. virtual CORBA::Boolean _tao_encode (TAO_OutputCDR &out_cdr) = 0; - // Encodes the object implementing this method into a CDR stream. - // Returns true on success and false on failure. + /// Decodes the object implementing this method from a CDR stream. + /// Returns true on success and false on failure. virtual CORBA::Boolean _tao_decode (TAO_InputCDR &in_cdr) = 0; - // Decodes the object implementing this method from a CDR stream. - // Returns true on success and false on failure. }; #include "ace/post.h" diff --git a/TAO/tao/Endpoint.h b/TAO/tao/Endpoint.h index a97aa2eb0c3..e5602a279ca 100644 --- a/TAO/tao/Endpoint.h +++ b/TAO/tao/Endpoint.h @@ -1,21 +1,18 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Endpoint.h -// -// = DESCRIPTION -// Endpoint interface, part of TAO pluggable protocol framework. -// -// = AUTHOR -// Marina Spivak <marina@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Endpoint.h + * + * $Id$ + * + * Endpoint interface, part of TAO pluggable protocol framework. + * + * + * @author Marina Spivak <marina@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_ENDPOINT_H #define TAO_ENDPOINT_H @@ -27,79 +24,84 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class TAO_Endpoint + * + * @brief Defines the Endpoint interface in the Pluggable Protocol + * framework. + * + * Lightweight encapsulation of addressing information for a + * single acceptor endpoint. In other words, Endpoint represents + * a single point of contact for the server, and is the smallest + * unit of addressing information necessary for a client to connect + * to a server. + * A Profile contains one or more Endpoints, i.e., knows of + * one or more ways to contact server(s). + */ class TAO_Export TAO_Endpoint { - // = TITLE - // Defines the Endpoint interface in the Pluggable Protocol - // framework. - // - // = DESCRIPTION - // Lightweight encapsulation of addressing information for a - // single acceptor endpoint. In other words, Endpoint represents - // a single point of contact for the server, and is the smallest - // unit of addressing information necessary for a client to connect - // to a server. - // A Profile contains one or more Endpoints, i.e., knows of - // one or more ways to contact server(s). - // public: + /// Constructor. TAO_Endpoint (CORBA::ULong tag, CORBA::Short priority = -1); - // Constructor. + /// Destructor. virtual ~TAO_Endpoint (void); - // Destructor. + /// IOP protocol tag accessor. CORBA::ULong tag (void) const; - // IOP protocol tag accessor. + /// <priority_> attribute setter. void priority (CORBA::Short priority); - // <priority_> attribute setter. + /// <priority_> attribute getter. CORBA::Short priority (void) const; - // <priority_> attribute getter. // = Abstract methods to be implemented by concrete subclasses. + /// Return true if this endpoint is equivalent to <other_endpoint>. Two + /// endpoints are equivalent iff their port and host are the same. virtual CORBA::Boolean is_equivalent (const TAO_Endpoint *other_endpoint) = 0; - // Return true if this endpoint is equivalent to <other_endpoint>. Two - // endpoints are equivalent iff their port and host are the same. + /// Endpoints can be stringed in a list. Return the next endpoint in + /// the list, if any. virtual TAO_Endpoint *next (void) = 0; - // Endpoints can be stringed in a list. Return the next endpoint in - // the list, if any. + /** + * Return a string representation for the address. Returns + * -1 if buffer is too small. The purpose of this method is to + * provide a general interface to the underlying address object's + * addr_to_string method. This allows the protocol implementor to + * select the appropriate string format. + */ virtual int addr_to_string (char *buffer, size_t length) = 0; - // Return a string representation for the address. Returns - // -1 if buffer is too small. The purpose of this method is to - // provide a general interface to the underlying address object's - // addr_to_string method. This allows the protocol implementor to - // select the appropriate string format. + /// This method is used when a connection has been reset, requiring + /// the hint to be cleaned up and reset to NULL. virtual void reset_hint (void) = 0; - // This method is used when a connection has been reset, requiring - // the hint to be cleaned up and reset to NULL. + /// This method returns a copy of the corresponding endpoints by + /// allocation memory virtual TAO_Endpoint *duplicate (void) = 0; - // This method returns a copy of the corresponding endpoints by - // allocation memory + /// Return a hash value for this object. virtual CORBA::ULong hash (void) = 0; - // Return a hash value for this object. private: // Endpoints should not be copied. ACE_UNIMPLEMENTED_FUNC (TAO_Endpoint (const TAO_Endpoint&)) ACE_UNIMPLEMENTED_FUNC (void operator= (const TAO_Endpoint&)) + /// IOP tag, identifying the protocol for which this endpoint + /// contains addressing info. CORBA::ULong tag_; - // IOP tag, identifying the protocol for which this endpoint - // contains addressing info. + /** + * CORBA priority of the acceptor this Endpoint is representing. + * This is part of TAO 'prioritized endpoints' architecture, and is + * currently used for RTCORBA only. + */ CORBA::Short priority_; - // CORBA priority of the acceptor this Endpoint is representing. - // This is part of TAO 'prioritized endpoints' architecture, and is - // currently used for RTCORBA only. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/Environment.h b/TAO/tao/Environment.h index 189e0a8d71d..f3c24438f86 100644 --- a/TAO/tao/Environment.h +++ b/TAO/tao/Environment.h @@ -1,25 +1,22 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Environment.h -// -// = DESCRIPTION -// Declare the CORBA_Environment class. Note that this header file -// only requires a few forward declarations of CORBA classes, this -// is *very* important because even the ORB needs to know about it; -// make your changes with care. It is also a good idea trying to -// minimize cross dependencies between header files. -// -// = AUTHOR -// Carlos O'Ryan <coryan@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Environment.h + * + * $Id$ + * + * Declare the CORBA_Environment class. Note that this header file + * only requires a few forward declarations of CORBA classes, this + * is *very* important because even the ORB needs to know about it; + * make your changes with care. It is also a good idea trying to + * minimize cross dependencies between header files. + * + * + * @author Carlos O'Ryan <coryan@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_ENVIRONMENT_H #define TAO_ENVIRONMENT_H @@ -33,71 +30,72 @@ class TAO_ORB_Core; +/** + * @class CORBA_Environment + * + * @brief CORBA_Environment + * + * A CORBA_Environment is a way to automagically ensure that + * exception data is freed -- the "var" class for Exceptions. It + * adds just a bit of convenience function support, helping + * classify exceptions as well as reducing memory leakage. + * The thread has a default environment to simplify porting + * between platforms that support native C++ exceptions and those + * that don't. This is a TSS resource (always), but with a twist: + * if the user creates a new environment the old one is "pushed" + * (actually the new one remembers it), eventually the new + * environment destructor pops itself from the stack and we + * recover the old environment. This means that if the user + * create a new environment and somebody calls a function using + * the default one the exception will still be received in the + * environment created by the user. The only drawback is that + * environments life time must nest properly, this shouldn't be a + * problem because environments are usually created on the stack, + * but, the spec allows their creation on the heap and/or as class + * members; we need to investigate the tradeoffs and take a + * decision. + */ class TAO_Export CORBA_Environment { - // = TITLE - // CORBA_Environment - // - // = DESCRIPTION - // A CORBA_Environment is a way to automagically ensure that - // exception data is freed -- the "var" class for Exceptions. It - // adds just a bit of convenience function support, helping - // classify exceptions as well as reducing memory leakage. - // - // The thread has a default environment to simplify porting - // between platforms that support native C++ exceptions and those - // that don't. This is a TSS resource (always), but with a twist: - // if the user creates a new environment the old one is "pushed" - // (actually the new one remembers it), eventually the new - // environment destructor pops itself from the stack and we - // recover the old environment. This means that if the user - // create a new environment and somebody calls a function using - // the default one the exception will still be received in the - // environment created by the user. The only drawback is that - // environments life time must nest properly, this shouldn't be a - // problem because environments are usually created on the stack, - // but, the spec allows their creation on the heap and/or as class - // members; we need to investigate the tradeoffs and take a - // decision. public: // = Initialization and termination methods. + /// The default constructor, the environment will hold no exceptions. CORBA_Environment (void); - // The default constructor, the environment will hold no exceptions. + /// Copy constructor. CORBA_Environment (const CORBA_Environment &ACE_TRY_ENV); - // Copy constructor. + /// Assingment. CORBA_Environment &operator=(const CORBA_Environment &ACE_TRY_ENV); - // Assingment. + /// Destructor, release the exception. ~CORBA_Environment (void); - // Destructor, release the exception. + /// Some static methods that need to be defined in every pseudo object static CORBA_Environment * _duplicate (CORBA_Environment *); static CORBA_Environment * _nil (void); - // Some static methods that need to be defined in every pseudo object + /// Return the exception. Caller must call <_incr_refcnf> in order + /// to keep the ptr. CORBA_Exception* exception (void) const; - // Return the exception. Caller must call <_incr_refcnf> in order - // to keep the ptr. + /// Set the exception to <ex>, taking a reference on it. void exception (CORBA_Exception *ex); - // Set the exception to <ex>, taking a reference on it. + /// Return if the exception is a user exception or a system + /// exception. int exception_type (void) const; - // Return if the exception is a user exception or a system - // exception. + /// return the repository ID for the exception. const char *exception_id (void) const; - // return the repository ID for the exception. + /// Clear the exception. void clear (void); - // Clear the exception. + /// Print the exception to output determined by f. This function is + /// not CORBA compliant. void print_exception (const char *info, FILE *f=stdout) const; - // Print the exception to output determined by f. This function is - // not CORBA compliant. // = Obtain a default environment to use with TAO. static CORBA_Environment &default_environment (void); @@ -114,48 +112,52 @@ public: private: + /// Initialize using a well known ORB Core; this is intended for the + /// bootstraping of the ORB_Core, not for general consumption. friend class TAO_ORB_Core; CORBA_Environment (TAO_ORB_Core *orb_core); - // Initialize using a well known ORB Core; this is intended for the - // bootstraping of the ORB_Core, not for general consumption. + /// Pointer to the exception object contained in the environment. CORBA_Exception *exception_; - // Pointer to the exception object contained in the environment. + /// The previous environment on the "default environment stack". CORBA_Environment *previous_; - // The previous environment on the "default environment stack". + /// Reference counting. CORBA::ULong refcount_; - // Reference counting. + /// Protect the reference count. ACE_SYNCH_MUTEX refcount_lock_; - // Protect the reference count. }; +/** + * @class CORBA_Environment_var + * + * @brief CORBA_Environment_var + * + * Provide for automatic storage deallocation on going out of + * scope. + */ class TAO_Export CORBA_Environment_var { - // = TITLE - // CORBA_Environment_var - // - // = DESCRIPTION - // Provide for automatic storage deallocation on going out of - // scope. public: + /** + * default constructor + * copy constructor + * destructor + */ CORBA_Environment_var (void); - // default constructor CORBA_Environment_var (CORBA_Environment_ptr); CORBA_Environment_var (const CORBA_Environment_var &); - // copy constructor ~CORBA_Environment_var (void); - // destructor CORBA_Environment_var &operator= (CORBA_Environment_ptr); CORBA_Environment_var &operator= (const CORBA_Environment_var &); CORBA_Environment_ptr operator-> (void) const; + /// in, inout, out, _retn operator const CORBA_Environment_ptr &() const; operator CORBA_Environment_ptr &(); - // in, inout, out, _retn CORBA_Environment_ptr in (void) const; CORBA_Environment_ptr &inout (void); CORBA_Environment_ptr &out (void); @@ -166,14 +168,16 @@ private: CORBA_Environment_ptr ptr_; }; +/** + * @class CORBA_Environment_out + * + * @brief CORBA_Environment_out + * + * The _out class for CORBA_Environment. This is used to help in + * managing the out parameters. + */ class TAO_Export CORBA_Environment_out { - // = TITLE - // CORBA_Environment_out - // - // = DESCRIPTION - // The _out class for CORBA_Environment. This is used to help in - // managing the out parameters. public: CORBA_Environment_out (CORBA_Environment_ptr &); CORBA_Environment_out (CORBA_Environment_var &); @@ -187,8 +191,8 @@ public: private: CORBA_Environment_ptr &ptr_; + /// Assignment from _var not allowed. CORBA_Environment_out &operator= (const CORBA_Environment_var &); - // Assignment from _var not allowed. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/Exception.cpp b/TAO/tao/Exception.cpp index 8c0717d04f0..96353e54779 100644 --- a/TAO/tao/Exception.cpp +++ b/TAO/tao/Exception.cpp @@ -164,7 +164,7 @@ ostream& operator<< (ostream &os, return os; } -#endif // (ACE_LACKS_IOSTREAM_TOTALLY) +#endif /* (ACE_LACKS_IOSTREAM_TOTALLY) */ // Avoid zillions of not-quite-inlined copies of utilities. @@ -1149,7 +1149,7 @@ tao_insert_in_extractor_system_exception ( tmp, destructor ); - return 1; + return 1; } } ACE_CATCHANY diff --git a/TAO/tao/Exception.h b/TAO/tao/Exception.h index b11fc1d92b4..22dec1040b6 100644 --- a/TAO/tao/Exception.h +++ b/TAO/tao/Exception.h @@ -1,21 +1,18 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Exception.h -// -// = DESCRIPTION -// This file defines way in which CORBA exceptions are reported. -// -// = AUTHOR -// Copyright 1994-1995 by Sun Microsystems Inc. -// -// ============================================================================ +//============================================================================= +/** + * @file Exception.h + * + * $Id$ + * + * This file defines way in which CORBA exceptions are reported. + * + * + * @author Copyright 1994-1995 by Sun Microsystems Inc. + */ +//============================================================================= + #ifndef TAO_EXCEPTION_H #define TAO_EXCEPTION_H @@ -42,28 +39,30 @@ class CORBA_Any; class TAO_OutputCDR; class TAO_InputCDR; +/** + * @class CORBA_Exception + * + * @brief CORBA_Exception + * + * CORBA2-specified exception hierarchy. All exceptions have a + * type (represented by a TypeCode) and a widely scoped type ID + * (in the TypeCode) that generated by any OMG-IDL compiler and + * available through the Interface Repositories. Think of it as a + * "globally scoped" name distinguishing each exception. + */ class TAO_Export CORBA_Exception { - // = TITLE - // CORBA_Exception - // - // = DESCRIPTION - // CORBA2-specified exception hierarchy. All exceptions have a - // type (represented by a TypeCode) and a widely scoped type ID - // (in the TypeCode) that generated by any OMG-IDL compiler and - // available through the Interface Repositories. Think of it as a - // "globally scoped" name distinguishing each exception. public: // = Initialization and termination methods. + /// Copy constructor. CORBA_Exception (const CORBA_Exception &src); - // Copy constructor. + /// Assignment operator. CORBA_Exception &operator = (const CORBA_Exception &src); - // Assignment operator. + /// Destructor. virtual ~CORBA_Exception (void); - // Destructor. // = To throw the exception (when using the standard mapping). virtual void _raise (void) = 0; @@ -73,34 +72,34 @@ public: // = These are TAO-specific extensions. + /// Return the repository ID of the Exception. const char *_id (void) const; - // Return the repository ID of the Exception. + /// Will be overridden in the concrete derived classes. virtual CORBA::TypeCode_ptr _type (void) const; - // Will be overridden in the concrete derived classes. // = To implement the narrow method. virtual int _is_a (const char* repository_id) const; + /// Constructor from a respository id. CORBA_Exception (const char* repository_id); - // Constructor from a respository id. + /// Print the exception <ex> to output determined by <f>. This + /// function is not CORBA compliant. void _tao_print_exception (const char *info, FILE *f = stdout) const; - // Print the exception <ex> to output determined by <f>. This - // function is not CORBA compliant. + /// Returns a string containing information about the exception. This + /// function is not CORBA compliant. virtual ACE_CString _info (void) const = 0; - // Returns a string containing information about the exception. This - // function is not CORBA compliant. virtual void _tao_encode (TAO_OutputCDR &cdr, CORBA::Environment &) const = 0; virtual void _tao_decode (TAO_InputCDR &cdr, CORBA::Environment &) = 0; + /// Used in the non-copying Any insertion operator. static void _tao_any_destructor (void *); - // Used in the non-copying Any insertion operator. // = Methods required for memory management support. CORBA::ULong _incr_refcnt (void); @@ -111,17 +110,19 @@ protected: // Default constructor is protected. private: + /// Storage of our repository id. char *id_; - // Storage of our repository id. + /// Reference count to avoid copying overhead. CORBA::ULong refcount_; - // Reference count to avoid copying overhead. + /** + * Mutex to protect the reference count; though in most cases this + * class is used only in one thread adding a mutex here is *not* + * expensive, because uses of this class should never be on the + * critical path. + */ ACE_SYNCH_MUTEX refcount_lock_; - // Mutex to protect the reference count; though in most cases this - // class is used only in one thread adding a mutex here is *not* - // expensive, because uses of this class should never be on the - // critical path. }; #if !defined (ACE_LACKS_IOSTREAM_TOTALLY) @@ -130,122 +131,127 @@ private: TAO_Export ostream& operator<< (ostream &os, const CORBA_Exception &e); -#endif // (ACE_LACKS_IOSTREAM_TOTALLY) +#endif /* (ACE_LACKS_IOSTREAM_TOTALLY) */ +/** + * @class CORBA_UserException + * + * @brief User exceptions are those defined by application developers + * using OMG-IDL. + */ class TAO_Export CORBA_UserException : public CORBA_Exception { - // = TITLE - // User exceptions are those defined by application developers - // using OMG-IDL. public: // = Initialization and termination methods. + /// Copy constructor. CORBA_UserException (const CORBA_UserException &src); - // Copy constructor. + /// Destructor. ~CORBA_UserException (void); - // Destructor. + /// Assignment operator. CORBA_UserException &operator= (const CORBA_UserException &src); - // Assignment operator. + /// The narrow operation. static CORBA_UserException *_downcast (CORBA_Exception *exception); - // The narrow operation. // = TAO specific extension. + /// Constructor from a repository id. CORBA_UserException (const char* repository_id); - // Constructor from a repository id. virtual int _is_a (const char *interface_id) const; // Used for narrowing + /// Returns a string containing information about the exception. This + /// function is not CORBA compliant. virtual ACE_CString _info (void) const; - // Returns a string containing information about the exception. This - // function is not CORBA compliant. //protected: + /// Default constructor. CORBA_UserException (void); - // Default constructor. }; +/** + * @class CORBA_SystemException + * + * @brief CORBA_SystemException + * + * System exceptions are those defined in the CORBA spec; OMG-IDL + * defines these. + */ class TAO_Export CORBA_SystemException : public CORBA_Exception { - // = TITLE - // CORBA_SystemException - // - // = DESCRIPTION - // System exceptions are those defined in the CORBA spec; OMG-IDL - // defines these. public: // = Initialization and termination methods. + /// Default constructtor CORBA_SystemException (void); - // Default constructtor + /// Copy constructor. CORBA_SystemException (const CORBA_SystemException &src); - // Copy constructor. + /// Destructor. ~CORBA_SystemException (void); - // Destructor. + /// Assignment operator. CORBA_SystemException &operator= (const CORBA_SystemException &src); - // Assignment operator. + /// Get the minor status. CORBA::ULong minor (void) const; - // Get the minor status. + /// Set the minor status. void minor (CORBA::ULong m); - // Set the minor status. + /// Get the completion status. CORBA::CompletionStatus completed (void) const; - // Get the completion status. + /// Set the operation completion status. void completed (CORBA::CompletionStatus c); - // Set the operation completion status. + /// Narrow to a SystemException. static CORBA_SystemException *_downcast (CORBA_Exception *exception); - // Narrow to a SystemException. // = TAO-specific extension. + /// Helper for the _downcast operation. virtual int _is_a (const char *type_id) const; - // Helper for the _downcast operation. + /// Print the system exception <ex> to output determined by f. This + /// function is not CORBA compliant. void _tao_print_system_exception (FILE *f = stdout) const; - // Print the system exception <ex> to output determined by f. This - // function is not CORBA compliant. + /// Returns a string containing information about the exception. This + /// function is not CORBA compliant. virtual ACE_CString _info (void) const; - // Returns a string containing information about the exception. This - // function is not CORBA compliant. virtual void _tao_encode (TAO_OutputCDR &cdr, CORBA::Environment &) const; virtual void _tao_decode (TAO_InputCDR &cdr, CORBA::Environment &); + /// Helper to create a minor status value. static CORBA::ULong _tao_minor_code (u_int location, int errno_value); - // Helper to create a minor status value. + /// Helper to translate a platform-specific errno to a TAO errno + /// value. static CORBA::ULong _tao_errno (int errno_value); - // Helper to translate a platform-specific errno to a TAO errno - // value. protected: + /// Constructor using a repository id. CORBA_SystemException (const char *repository_id, CORBA::ULong code, CORBA::CompletionStatus completed); - // Constructor using a repository id. private: + /// Minor code. CORBA::ULong minor_; - // Minor code. + /// Completion status. CORBA::CompletionStatus completed_; - // Completion status. }; @@ -311,117 +317,129 @@ TAO_SYSTEM_EXCEPTION(INVALID_TRANSACTION); // invalid TP context passed #undef TAO_SYSTEM_EXCEPTION +/** + * @class CORBA_UnknownUserException + * + * @brief CORBA_UnknownUserException + * + * When user exceptions are received by a DII invocation the ORB + * is unable to create the exception with the right dynamic type; + * to workaround this problem it throws a + * <CORBA::UnknownUserException> that contains the exception inside + * an Any. + */ class TAO_Export CORBA_UnknownUserException : public CORBA_UserException { - // = TITLE - // CORBA_UnknownUserException - // - // = DESCRIPTION - // When user exceptions are received by a DII invocation the ORB - // is unable to create the exception with the right dynamic type; - // to workaround this problem it throws a - // <CORBA::UnknownUserException> that contains the exception inside - // an Any. public: // = Initialization and termination methods. + /// Constructor. CORBA_UnknownUserException (void); - // Constructor. + /// Constructor. CORBA_UnknownUserException (CORBA_Any& exception); - // Constructor. + /// Copy constructor. CORBA_UnknownUserException (const CORBA_UnknownUserException& e); - // Copy constructor. + /// Destructor. virtual ~CORBA_UnknownUserException (void); - // Destructor. + /// Return the any containing the user exception. CORBA_Any& exception (void); - // Return the any containing the user exception. + /// To throw an UnknownUserException of this type. virtual void _raise (void); - // To throw an UnknownUserException of this type. virtual void _tao_encode (TAO_OutputCDR &cdr, CORBA::Environment &) const; virtual void _tao_decode (TAO_InputCDR &cdr, CORBA::Environment &); + /// Narrow to an UnknowUserException. static CORBA_UnknownUserException *_downcast (CORBA_Exception *ex); - // Narrow to an UnknowUserException. // = TAO specific extension. + /// Helper method to implement _downcast. virtual int _is_a (const char *type_id) const; - // Helper method to implement _downcast. + /// This class has a specific typecode. virtual CORBA::TypeCode_ptr _type (void) const; - // This class has a specific typecode. private: + /// Holder for the actual exception. CORBA_Any *exception_; - // Holder for the actual exception. }; +/** + * @class TAO_Exceptions + * + * @brief This class is a namespace for exception-related static data and + * methods. + */ class TAO_Export TAO_Exceptions { - // = TITLE - // This class is a namespace for exception-related static data and - // methods. public: + /** + * Make the TypeCode for a standard exception. When used correctly, + * initializing system exceptions is only an exercise in CPU time; + * it allocates no new memory. + */ static void make_standard_typecode (CORBA::TypeCode_ptr &tcp, const char *name, char *buf, size_t buflen, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Make the TypeCode for a standard exception. When used correctly, - // initializing system exceptions is only an exercise in CPU time; - // it allocates no new memory. + /// Make the TypeCode for the CORBA::UnknownUserException standard + /// exception. static void make_unknown_user_typecode (CORBA::TypeCode_ptr &tcp, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Make the TypeCode for the CORBA::UnknownUserException standard - // exception. + /// Runtime initialization of all standard exception typecodes. + /// Called from <CORBA::ORB_init>. static void init (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Runtime initialization of all standard exception typecodes. - // Called from <CORBA::ORB_init>. + /// Runtime finalization of all standard exception typecodes. static void fini (void); - // Runtime finalization of all standard exception typecodes. + /// Create a CORBA::SystemException given the interface repository ID. static CORBA_SystemException *create_system_exception ( const char *id, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); - // Create a CORBA::SystemException given the interface repository ID. + /// List of system exceptions. static ACE_Unbounded_Queue<CORBA::TypeCode_ptr> *system_exceptions; - // List of system exceptions. private: + /** + * This global allocator is used to initialize system exception + * typecodes. Since at the time, the ORB is mostly still not + * available. Using a separate allocator prevent CDR routine from + * accessing the optimized allocators from the ORB. + */ static ACE_Allocator *global_allocator_; - // This global allocator is used to initialize system exception - // typecodes. Since at the time, the ORB is mostly still not - // available. Using a separate allocator prevent CDR routine from - // accessing the optimized allocators from the ORB. + /// Flag that denotes that the TAO's CORBA exceptions have been + /// initialized. static int initialized_; - // Flag that denotes that the TAO's CORBA exceptions have been - // initialized. }; #if defined (TAO_DONT_CATCH_DOT_DOT_DOT) +/** + * @class TAO_DONT_CATCH + * + * @brief This class is only used internally in TAO as an exception + * that never gets thrown. Never use this class anywhere. + */ class TAO_Export TAO_DONT_CATCH { - // = TITLE - // This class is only used internally in TAO as an exception - // that never gets thrown. Never use this class anywhere. public: TAO_DONT_CATCH (void); }; diff --git a/TAO/tao/Exclusive_TMS.h b/TAO/tao/Exclusive_TMS.h index 2aa9ef0f7a1..ef22858e9b2 100644 --- a/TAO/tao/Exclusive_TMS.h +++ b/TAO/tao/Exclusive_TMS.h @@ -1,15 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = AUTHOR -// Alexander Babu Arulanthu <alex@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Exclusive_TMS.h + * + * $Id$ + * + * @author Alexander Babu Arulanthu <alex@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_EXCLUSIVE_TMS_H #define TAO_EXCLUSIVE_TMS_H @@ -24,23 +24,25 @@ class TAO_Pluggable_Reply_Params; +/** + * @class TAO_Exclusive_TMS + * + * Using this strategy only one request can be pending at a time + * in a connection. This improves performance because the client + * does not have to demux the reply, and there is less need for + * synchronization. + * On the other hand, it does not scale well when you have + * multiple client threads or asynchronous messaging. + */ class TAO_Export TAO_Exclusive_TMS : public TAO_Transport_Mux_Strategy { - // = DESCRIPTION - // Using this strategy only one request can be pending at a time - // in a connection. This improves performance because the client - // does not have to demux the reply, and there is less need for - // synchronization. - // On the other hand, it does not scale well when you have - // multiple client threads or asynchronous messaging. - // public: + /// Constructor. TAO_Exclusive_TMS (TAO_Transport *transport); - // Constructor. + /// Destructor. virtual ~TAO_Exclusive_TMS (void); - // Destructor. // = Please read the documentation in the TAO_Transport_Mux_Strategy // class. @@ -60,19 +62,19 @@ public: virtual void connection_closed (void); protected: + /// Used to generate a different request_id on each call to + /// request_id(). CORBA::ULong request_id_generator_; - // Used to generate a different request_id on each call to - // request_id(). + /// If 0 then the request id and reply dispatcher below are + /// meaningless int has_request_; - // If 0 then the request id and reply dispatcher below are - // meaningless + /// Request id for the current request. CORBA::ULong request_id_; - // Request id for the current request. + /// Reply Dispatcher corresponding to the request. TAO_Reply_Dispatcher *rd_; - // Reply Dispatcher corresponding to the request. // @@ Commented for the time being, let the commented line stay for // sometime - Bala diff --git a/TAO/tao/FILE_Parser.h b/TAO/tao/FILE_Parser.h index 9f3a15f1e99..899f184682e 100644 --- a/TAO/tao/FILE_Parser.h +++ b/TAO/tao/FILE_Parser.h @@ -1,17 +1,14 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// FILE_Parser.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file FILE_Parser.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_FILE_PARSER_H #define TAO_FILE_PARSER_H @@ -24,23 +21,24 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class TAO_FILE_Parser + * + * @brief Implements the <file:> IOR format + * + * This class implements the <file:> IOR format. + * It is dynamically loaded by the ORB and used to open a file, + * read its contents and then interepret the file as an IOR (that + * can be in any valid format). + */ class TAO_Export TAO_FILE_Parser : public TAO_IOR_Parser { - // = TITLE - // Implements the <file:> IOR format - // - // = DESCRIPTION - // This class implements the <file:> IOR format. - // It is dynamically loaded by the ORB and used to open a file, - // read its contents and then interepret the file as an IOR (that - // can be in any valid format). - // public: + /// Constructor TAO_FILE_Parser (void); - // Constructor + /// The destructor virtual ~TAO_FILE_Parser (void); - // The destructor // = The IOR_Parser methods, please read the documentation in // IOR_Parser.h diff --git a/TAO/tao/Fault_Tolerance_Service.h b/TAO/tao/Fault_Tolerance_Service.h index 6a489b6c8fc..28abe861bae 100644 --- a/TAO/tao/Fault_Tolerance_Service.h +++ b/TAO/tao/Fault_Tolerance_Service.h @@ -1,22 +1,19 @@ //-*- C++ -*- -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Fault_Tolerance_Service.h -// -// = DESCRIPTION -// A collection of the ORB and ORB core related properties that are -// specific to FT service. The TAO_ORB_Core holds an instance of this -// class. -// -// = AUTHOR -// Bala Natarajan <bala@cs.wustl.edu> -// ============================================================================ +//============================================================================= +/** + * @file Fault_Tolerance_Service.h + * + * $Id$ + * + * A collection of the ORB and ORB core related properties that are + * specific to FT service. The TAO_ORB_Core holds an instance of this + * class. + * + * + * @author Bala Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_FAULT_TOLERANCE_SERVICE_H #define TAO_FAULT_TOLERANCE_SERVICE_H @@ -41,56 +38,60 @@ class TAO_Service_Callbacks; class TAO_ORB_Core; +/** + * @class TAO_Fault_Tolerance_Service + * + * @brief TAO_Fault_Tolerant_Service + * + * A collection of ORB & ORB_Core related stuff that is needed at + * the ORB level. The ORB Core would carry an instance of this + * class and invoke methods on this. + * Note: This collection would be really useful when we have + * logging in place. The contents of this class can be logged at + * regular check point intervals. + */ class TAO_Export TAO_Fault_Tolerance_Service { - // = TITLE - // TAO_Fault_Tolerant_Service - // - // = DESCRIPTION - // A collection of ORB & ORB_Core related stuff that is needed at - // the ORB level. The ORB Core would carry an instance of this - // class and invoke methods on this. - // Note: This collection would be really useful when we have - // logging in place. The contents of this class can be logged at - // regular check point intervals. public: + /// Ctor TAO_Fault_Tolerance_Service (void); - // Ctor + /// Dtor ~TAO_Fault_Tolerance_Service (void); - // Dtor + /// Initialise the internal data structures void init (TAO_ORB_Core *orb_core); - // Initialise the internal data structures + /// Return the underlying callback object TAO_Service_Callbacks *service_callback (void); - // Return the underlying callback object + /// Return the underlying <ft_object_id> const ACE_CString &client_id (void); - // Return the underlying <ft_object_id> + /// Set the client id void client_id (const char *id); - // Set the client id + /// Generate and return a new retention id CORBA::Long retention_id (void); - // Generate and return a new retention id private: + /// hook to callback on to the service TAO_Service_Callbacks *ft_service_callback_; - // hook to callback on to the service + /// The object id that would be used if the ft service is loaded. ACE_CString ft_object_id_; - // The object id that would be used if the ft service is loaded. + /** + * This and the <ft_object_id_> act as unique identifiers for the + * request sent from the source Object. Modification of this value + * is done by the loaded FT + */ CORBA::Long ft_object_retention_id_; - // This and the <ft_object_id_> act as unique identifiers for the - // request sent from the source Object. Modification of this value - // is done by the loaded FT + /// Lock for the retention id ACE_Lock *ft_object_retention_id_lock_; - // Lock for the retention id // NOTE: At a glance this retention id can be easily mistaken for a // request id in a GIOP request. But the purpose served are a lot diff --git a/TAO/tao/GIOPC.h b/TAO/tao/GIOPC.h index 18a98ff1c3b..1a1ce51244c 100644 --- a/TAO/tao/GIOPC.h +++ b/TAO/tao/GIOPC.h @@ -1,21 +1,22 @@ /* -*- C++ -*- $Id$ */ -// ================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// GIOPC.h -// -// = DESCRIPTION -// Generated from GIOP1_2.pidl, that contains a part of the new data -// type definitions for GIOP1.2 module. -// The code was generated by the IDL compiler and then hand-crafted -// to reduce the includes interdependencies. -// hand crafted by Balachandran Natarajan <bala@cs.wustl.edu> -// ================================================================ +//============================================================================= +/** + * @file GIOPC.h + * + * $Id$ + + * + * Generated from GIOP1_2.pidl, that contains a part of the new data + * type definitions for GIOP1.2 module. + * The code was generated by the IDL compiler and then hand-crafted + * to reduce the includes interdependencies. + * hand crafted by Balachandran Natarajan <bala@cs.wustl.edu> + * + */ +//============================================================================= + // ****** Code generated by the The ACE ORB (TAO) IDL Compiler ******* // TAO and the TAO IDL Compiler have been developed by the Center for // Distributed Object Computing at Washington University, St. Louis. diff --git a/TAO/tao/GIOPS.h b/TAO/tao/GIOPS.h index 306402d67d4..03f6c039f20 100644 --- a/TAO/tao/GIOPS.h +++ b/TAO/tao/GIOPS.h @@ -1,17 +1,17 @@ /* -*- C++ -*- $Id$ */ -// ================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// GIOPS.h -// -// = DESCRIPTION -// Generated from GIOP.pidl -// The file is almost empty and only present to keep other IDL files -// that include GIOP.pidl happy. -// ================================================================ +//============================================================================= +/** + * @file GIOPS.h + * + * $Id$ + * + * Generated from GIOP.pidl + * The file is almost empty and only present to keep other IDL files + * that include GIOP.pidl happy. + * + */ +//============================================================================= + #ifndef TAO_IDL_GIOP1_2S_H #define TAO_IDL_GIOP1_2S_H diff --git a/TAO/tao/GIOPS_T.h b/TAO/tao/GIOPS_T.h index 57ff5306e8e..8253a169eaa 100644 --- a/TAO/tao/GIOPS_T.h +++ b/TAO/tao/GIOPS_T.h @@ -1,17 +1,17 @@ /* -*- C++ -*- $Id$ */ -// ================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// GIOPS_T.h -// -// = DESCRIPTION -// Generated from GIOP.pidl -// The file is almost empty and only present to keep other IDL files -// that include GIOP.pidl happy. -// ================================================================ +//============================================================================= +/** + * @file GIOPS_T.h + * + * $Id$ + * + * Generated from GIOP.pidl + * The file is almost empty and only present to keep other IDL files + * that include GIOP.pidl happy. + * + */ +//============================================================================= + #ifndef TAO_IDL_GIOP1_2S_T_H #define TAO_IDL_GIOP1_2S_T_H diff --git a/TAO/tao/GIOP_Message_Headers.h b/TAO/tao/GIOP_Message_Headers.h index a93d90d49f4..9c9fbb3db0d 100644 --- a/TAO/tao/GIOP_Message_Headers.h +++ b/TAO/tao/GIOP_Message_Headers.h @@ -1,21 +1,18 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// GIOP_Message_Headers.h -// -// = DESCRIPTION -// Some assorted GIOP structure mappings -// -// = AUTHOR -// Balachandran Natarajan <bala@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file GIOP_Message_Headers.h + * + * $Id$ + * + * Some assorted GIOP structure mappings + * + * + * @author Balachandran Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_GIOP_MESSAGE_HEADERS_H #define TAO_GIOP_MESSAGE_HEADERS_H @@ -27,46 +24,49 @@ // @@ Bala: what goes in this file? All the message headers? A few of // @@ them? Only the Locate_Request header?! +/** + * @class TAO_GIOP_Locate_Request_Header + * + * @brief Location service support + */ class TAO_Export TAO_GIOP_Locate_Request_Header { - // = TITLE - // Location service support public: + /// Constructor TAO_GIOP_Locate_Request_Header (TAO_InputCDR &msg, TAO_ORB_Core *core); - // Constructor + /// Set the id void request_id (CORBA::ULong id); - // Set the id + /// Get the request id CORBA::ULong request_id (void); - // Get the request id + /// Get the object_key in read mode.. const TAO_ObjectKey &object_key (void) const; - // Get the object_key in read mode.. + /// Get the object_key in read/write mode.. TAO_ObjectKey &object_key (void); - // Get the object_key in read/write mode.. + /// Get the reference to the underlying profile TAO_Tagged_Profile &profile (void); - // Get the reference to the underlying profile + /// Get the CDR stream for read/write TAO_InputCDR &incoming_stream (void); - // Get the CDR stream for read/write private: + /// Request id CORBA::ULong request_id_; - // Request id + /// Profile info. TAO_Tagged_Profile profile_; - // Profile info. + /// Object Key TAO_ObjectKey object_key_; - // Object Key + /// Incoming CDR stream TAO_InputCDR *incoming_; - // Incoming CDR stream }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/GIOP_Message_Lite.h b/TAO/tao/GIOP_Message_Lite.h index 921b4ad4278..fe8f3220e10 100644 --- a/TAO/tao/GIOP_Message_Lite.h +++ b/TAO/tao/GIOP_Message_Lite.h @@ -6,8 +6,8 @@ * * $Id$ * - * @author Initially by Carlos <coryan@uci.edu> - * @author modified by Balachandran Natarajan <bala@cs.wustl.edu> + * @author Balachandran Natarajan <bala@cs.wustl.edu> + * @author Carlos O'Ryan <coryan@uci.edu> */ // =================================================================== #ifndef TAO_GIOP_MESSAGE_LITE_H diff --git a/TAO/tao/GIOP_Message_Locate_Header.h b/TAO/tao/GIOP_Message_Locate_Header.h index 392ec131b71..81311d766f7 100644 --- a/TAO/tao/GIOP_Message_Locate_Header.h +++ b/TAO/tao/GIOP_Message_Locate_Header.h @@ -1,21 +1,18 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// GIOP_Message_Headers.h -// -// = DESCRIPTION -// Some assorted GIOP structure mappings -// -// = AUTHOR -// Balachandran Natarajan <bala@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file GIOP_Message_Locate_Header.h + * + * $Id$ + * + * Some assorted GIOP structure mappings + * + * + * @author Balachandran Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_GIOP_MESSAGE_LOCATE_HEADER_H #define TAO_GIOP_MESSAGE_LOCATE_HEADER_H @@ -29,46 +26,49 @@ #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class TAO_GIOP_Locate_Request_Header + * + * @brief Location service support + */ class TAO_Export TAO_GIOP_Locate_Request_Header { - // = TITLE - // Location service support public: + /// Constructor TAO_GIOP_Locate_Request_Header (TAO_InputCDR &msg, TAO_ORB_Core *core); - // Constructor + /// Set the id void request_id (CORBA::ULong id); - // Set the id + /// Get the request id CORBA::ULong request_id (void); - // Get the request id + /// Get the object_key in read mode.. const TAO_ObjectKey &object_key (void) const; - // Get the object_key in read mode.. + /// Get the object_key in read/write mode.. TAO_ObjectKey &object_key (void); - // Get the object_key in read/write mode.. + /// Get the reference to the underlying profile TAO_Tagged_Profile &profile (void); - // Get the reference to the underlying profile + /// Get the CDR stream for read/write TAO_InputCDR &incoming_stream (void); - // Get the CDR stream for read/write private: + /// Request id CORBA::ULong request_id_; - // Request id + /// Profile info. TAO_Tagged_Profile profile_; - // Profile info. + /// Object Key TAO_ObjectKey object_key_; - // Object Key + /// Incoming CDR stream TAO_InputCDR *incoming_; - // Incoming CDR stream }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/GIOP_Message_State.h b/TAO/tao/GIOP_Message_State.h index 764ee4e5002..c4c492c56c0 100644 --- a/TAO/tao/GIOP_Message_State.h +++ b/TAO/tao/GIOP_Message_State.h @@ -1,22 +1,19 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// GIOP_Message.h -// -// = DESCRIPTION -// GIOP utility definitions -// -// = AUTHOR -// Chris Cleeland <cleeland@cs.wustl.edu> -// Carlos O' Ryan <coryan@uci.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file GIOP_Message_State.h + * + * $Id$ + * + * GIOP utility definitions + * + * + * @author Chris Cleeland <cleeland@cs.wustl.edu> + * @author Carlos O' Ryan <coryan@uci.edu> + */ +//============================================================================= + #ifndef TAO_GIOP_MESSAGE_STATE_H #define TAO_GIOP_MESSAGE_STATE_H @@ -33,121 +30,132 @@ class TAO_ORB_Core; +/** + * @class TAO_GIOP_Version + * + * @brief Major and Minor version number of the Inter-ORB Protocol. + */ class TAO_Export TAO_GIOP_Version { - // = TITLE - // Major and Minor version number of the Inter-ORB Protocol. public: + /// Major version number CORBA::Octet major; - // Major version number + /// Minor version number CORBA::Octet minor; - // Minor version number + /// Copy constructor TAO_GIOP_Version (const TAO_GIOP_Version &src); - // Copy constructor + /// Default constructor. TAO_GIOP_Version (CORBA::Octet maj = TAO_DEF_GIOP_MAJOR, CORBA::Octet min = TAO_DEF_GIOP_MINOR); - // Default constructor. + /// Destructor. ~TAO_GIOP_Version (void); - // Destructor. + /// Explicitly set the major and minor version. void set_version (CORBA::Octet maj, CORBA::Octet min); - // Explicitly set the major and minor version. + /// Copy operator. TAO_GIOP_Version &operator= (const TAO_GIOP_Version &src); - // Copy operator. + /// Equality operator int operator== (const TAO_GIOP_Version &src); int operator!= (const TAO_GIOP_Version &src); - // Equality operator }; +/** + * @class TAO_GIOP_Message_State + * + * @brief Generic definitions for Message States. + * + * This represents the state of the incoming GIOP message + * As the ORB processes incoming messages it needs to keep track of + * how much of the message has been read, if there are any + * fragments following this message etc. + */ class TAO_Export TAO_GIOP_Message_State { - // = TITLE - // Generic definitions for Message States. - // - // = DESCRIPTION - // This represents the state of the incoming GIOP message - // As the ORB processes incoming messages it needs to keep track of - // how much of the message has been read, if there are any - // fragments following this message etc. public: + /// Ctor TAO_GIOP_Message_State (TAO_ORB_Core *orb_core); - // Ctor + /// Dtor ~TAO_GIOP_Message_State (void); - // Dtor + ///Reset the message header state and prepare it to receive the next + /// event. void reset (int reset_contents = 1); - //Reset the message header state and prepare it to receive the next - // event. + /// Has the header been received? CORBA::Boolean header_received (void) const; - // Has the header been received? + /// Check if the current message is complete, adjusting the fragments + /// if required... int is_complete (void); - // Check if the current message is complete, adjusting the fragments - // if required... + /// Version info TAO_GIOP_Version giop_version; - // Version info + /// 0 = big, 1 = little CORBA::Octet byte_order; - // 0 = big, 1 = little + /// (Requests and Replys) CORBA::Octet more_fragments; - // (Requests and Replys) + /// MsgType above CORBA::Octet message_type; - // MsgType above + /// in byte_order! CORBA::ULong message_size; - // in byte_order! + /// How much of the payload has been received CORBA::ULong current_offset; - // How much of the payload has been received + /// This is the InputCDR that will be used to decode the message. TAO_InputCDR cdr; - // This is the InputCDR that will be used to decode the message. + /** + * The fragments are collected in a chain of message blocks (using + * the cont() field). When the complete message is received the + * chain is reassembled into <cdr> + */ ACE_Message_Block* fragments_begin; ACE_Message_Block* fragments_end; - // The fragments are collected in a chain of message blocks (using - // the cont() field). When the complete message is received the - // chain is reassembled into <cdr> + /** + * The byte order for the the first fragment + * @@ The current implementation cannot handle fragments with + * different byte orders, this should not be a major problem + * because: + * 1) It is unlikely that we are going to receive fragments. + * 2) The spec *seems* to allow different byte_orders, but it is + * unlikely that any ORB will do that. + * 3) Even if we allowed that at this layer the CDR classes are + * not prepared to handle that. + */ CORBA::Octet first_fragment_byte_order; - // The byte order for the the first fragment - // @@ The current implementation cannot handle fragments with - // different byte orders, this should not be a major problem - // because: - // 1) It is unlikely that we are going to receive fragments. - // 2) The spec *seems* to allow different byte_orders, but it is - // unlikely that any ORB will do that. - // 3) Even if we allowed that at this layer the CDR classes are - // not prepared to handle that. + /// The GIOP version for the first fragment + /// @@ Same as above, all GIOP versions must match. TAO_GIOP_Version first_fragment_giop_version; - // The GIOP version for the first fragment - // @@ Same as above, all GIOP versions must match. + /** + * If the messages are chained this represents the message type for + * the *complete* message (remember that the last message will be + * fragment and the upper level needs to know if it is a request, + * locate request or what). + */ CORBA::Octet first_fragment_message_type; - // If the messages are chained this represents the message type for - // the *complete* message (remember that the last message will be - // fragment and the upper level needs to know if it is a request, - // locate request or what). private: + /// Append <current> to the list of fragments + /// Also resets the state, because the current message was consumed. int append_fragment (ACE_Message_Block* current); - // Append <current> to the list of fragments - // Also resets the state, because the current message was consumed. }; diff --git a/TAO/tao/GIOP_Utils.h b/TAO/tao/GIOP_Utils.h index d9dfe1d325f..bcff3c92655 100644 --- a/TAO/tao/GIOP_Utils.h +++ b/TAO/tao/GIOP_Utils.h @@ -1,22 +1,18 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// GIOP_Message.h -// -// = DESCRIPTION -// GIOP utility definitions -// -// = AUTHOR -// Chris Cleeland <cleeland@cs.wustl.edu> -// Carlos O' Ryan <coryan@uci.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file GIOP_Utils.h + * + * $Id$ + * + * GIOP utility definitions + * + * + * @author Chris Cleeland <cleeland@cs.wustl.edu> Carlos O' Ryan <coryan@uci.edu> + */ +//============================================================================= + #ifndef TAO_GIOP_UTILS_H #define TAO_GIOP_UTILS_H #include "ace/pre.h" @@ -60,25 +56,26 @@ typedef enum GIOP_LocateStatusType TAO_GIOP_LOC_NEEDS_ADDRESSING_MODE //GIOP 1.2 }TAO_GIOP_Locate_Status_Type; +/** + * @class TAO_GIOP_Locate_Status_Msg + =TITLE + * Hold the relevant information for every type of Locate mesg. + * =DESCRIPTION + * This class is there to hold the relevant info for different + * types of locate status messages. As on date we dont know much + * about other mesg types other than OBJECT_FORWARD. This clss can + * be clearly defined as time progresses. + */ class TAO_Export TAO_GIOP_Locate_Status_Msg { - // =TITLE - // Hold the relevant information for every type of Locate mesg. - // - // =DESCRIPTION - // This class is there to hold the relevant info for different - // types of locate status messages. As on date we dont know much - // about other mesg types other than OBJECT_FORWARD. This clss can - // be clearly defined as time progresses. - // public: + /// The value will need to be used when the Message type is + /// TAO_GIOP_OBJECT_FORWARD CORBA::Object_var forward_location_var; - // The value will need to be used when the Message type is - // TAO_GIOP_OBJECT_FORWARD + /// Stype of Locate status message + ///@@ Other mesg types. TAO_GIOP_Locate_Status_Type status; - // Stype of Locate status message - //@@ Other mesg types. }; @@ -105,27 +102,33 @@ typedef enum GIOP_ReplyStatusType } TAO_GIOP_Reply_Status_Type; +/** + * @class TAO_GIOP_ReplyHeader + * + * @brief This class embodies the header of a GIOP reply. + * @@Not used. Could be used in future + */ class TAO_Export TAO_GIOP_ReplyHeader { - // = TITLE - // This class embodies the header of a GIOP reply. - // @@Not used. Could be used in future public: + /// Information IOP::ServiceContextList service_info; - // Information + /// Unique identifier of the request for which this is a reply. CORBA::ULong request_id; - // Unique identifier of the request for which this is a reply. + /// Status of the reply (see above enum). TAO_GIOP_Reply_Status_Type reply_status; - // Status of the reply (see above enum). }; +/** + * @class TAO_GIOP_Utils + * + * @brief Utility class that has some commonly used methods for both GIOP + * Base & GIOP lite + */ class TAO_Export TAO_GIOP_Utils { - // = TITLE - // Utility class that has some commonly used methods for both GIOP - // Base & GIOP lite // = DESCRIPTION public: diff --git a/TAO/tao/IIOP_Acceptor.h b/TAO/tao/IIOP_Acceptor.h index b5c0a01a530..bae66889a57 100644 --- a/TAO/tao/IIOP_Acceptor.h +++ b/TAO/tao/IIOP_Acceptor.h @@ -1,23 +1,20 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - - -//============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// IIOP_Acceptor.h -// -// = DESCRIPTION -// IIOP specific acceptor processing -// -// = AUTHOR -// Fred Kuhns <fredk@cs.wustl.edu> -// Ossama Othman <ossama@uci.edu> -// -//============================================================================ + + +//============================================================================= +/** + * @file IIOP_Acceptor.h + * + * $Id$ + * + * IIOP specific acceptor processing + * + * + * @author Fred Kuhns <fredk@cs.wustl.edu> + * @author Ossama Othman <ossama@uci.edu> + */ +//============================================================================= + #ifndef TAO_IIOP_ACCEPTOR_H #define TAO_IIOP_ACCEPTOR_H @@ -38,24 +35,25 @@ // TAO IIOP_Acceptor concrete call defination +/** + * @class TAO_IIOP_Acceptor + * + * @brief TAO_IIOP_Acceptor + * + * The IIOP-specific bridge class for the concrete acceptor. + */ class TAO_Export TAO_IIOP_Acceptor : public TAO_Acceptor { - // = TITLE - // TAO_IIOP_Acceptor - // - // = DESCRIPTION - // The IIOP-specific bridge class for the concrete acceptor. - // public: + /// Constructor. TAO_IIOP_Acceptor (CORBA::Boolean flag = 0); - // Constructor. + /// Destructor. ~TAO_IIOP_Acceptor (void); - // Destructor. + /// @@ Helper method for the implementation repository, should go + /// away const ACE_INET_Addr& address (void) const; - // @@ Helper method for the implementation repository, should go - // away typedef ACE_Strategy_Acceptor<TAO_IIOP_Connection_Handler, ACE_SOCK_ACCEPTOR> TAO_IIOP_BASE_ACCEPTOR; typedef TAO_Creation_Strategy<TAO_IIOP_Connection_Handler> TAO_IIOP_CREATION_STRATEGY; @@ -84,36 +82,42 @@ public: protected: + /** + * Implement the common part of the open*() methods. This method is + * virtual to allow a derived class implementation to be invoked + * instead. + */ virtual int open_i (const ACE_INET_Addr &addr); - // Implement the common part of the open*() methods. This method is - // virtual to allow a derived class implementation to be invoked - // instead. + /// Set the host name for the given addr. int hostname (TAO_ORB_Core *orb_core, ACE_INET_Addr &addr, char *&host); - // Set the host name for the given addr. + /** + * Probe the system for available network interfaces, and initialize + * the <addrs_> array with an ACE_INET_Addr for each network + * interface. The port for each initialized ACE_INET_Addr will be + * set in the open_i() method. This method only gets invoked when + * no explicit hostname is provided in the specified endpoint. + */ int probe_interfaces (TAO_ORB_Core *orb_core); - // Probe the system for available network interfaces, and initialize - // the <addrs_> array with an ACE_INET_Addr for each network - // interface. The port for each initialized ACE_INET_Addr will be - // set in the open_i() method. This method only gets invoked when - // no explicit hostname is provided in the specified endpoint. + /// Parse protocol specific options. virtual int parse_options (const char *options); - // Parse protocol specific options. + /// Obtain tcp properties that must be used by this acceptor, i.e., + /// initialize <tcp_properties_>. int init_tcp_properties (void); - // Obtain tcp properties that must be used by this acceptor, i.e., - // initialize <tcp_properties_>. + /** + * Rather than creating a separate profile for each endpoint, this + * version of <create_mprofile> method adds all endpoints to a + * single IIOP profile, i.e., <mprofile> will not contain more than + * one IIOP_Profile, no matter how many acceptors there are. + */ int create_rt_mprofile (const TAO_ObjectKey &object_key, TAO_MProfile &mprofile); - // Rather than creating a separate profile for each endpoint, this - // version of <create_mprofile> method adds all endpoints to a - // single IIOP profile, i.e., <mprofile> will not contain more than - // one IIOP_Profile, no matter how many acceptors there are. protected: @@ -121,41 +125,45 @@ protected: /// given network interface. ACE_INET_Addr *addrs_; + /** + * Cache the information about the endpoints serviced by this + * acceptor. + * There may in fact be multiple hostnames for this endpoint. For + * example, if the IP address is INADDR_ANY (0.0.0.0) then there + * will be possibly a different hostname for each interface. + */ char **hosts_; - // Cache the information about the endpoints serviced by this - // acceptor. - // There may in fact be multiple hostnames for this endpoint. For - // example, if the IP address is INADDR_ANY (0.0.0.0) then there - // will be possibly a different hostname for each interface. + /// The number of host names cached in the hosts_ array (equivalent + /// to the number of endpoints opened by this Acceptor). size_t endpoint_count_; - // The number of host names cached in the hosts_ array (equivalent - // to the number of endpoints opened by this Acceptor). + /** + * The GIOP version for this endpoint + * @@ Theoretically they shouldn't be here!! We need to look at a + * way to move this out + */ TAO_GIOP_Version version_; - // The GIOP version for this endpoint - // @@ Theoretically they shouldn't be here!! We need to look at a - // way to move this out + /// ORB Core. TAO_ORB_Core *orb_core_; - // ORB Core. + /// TCP configuration properties to be used for all + /// connections opened by this acceptor. TAO_IIOP_Properties tcp_properties_; - // TCP configuration properties to be used for all - // connections opened by this acceptor. + /// Should we use GIOP lite?? CORBA::Boolean lite_flag_; - // Should we use GIOP lite?? private: + /// the concrete acceptor, as a pointer to it's base class. TAO_IIOP_BASE_ACCEPTOR base_acceptor_; - // the concrete acceptor, as a pointer to it's base class. + /// Acceptor strategies. TAO_IIOP_CREATION_STRATEGY *creation_strategy_; TAO_IIOP_CONCURRENCY_STRATEGY *concurrency_strategy_; TAO_IIOP_ACCEPT_STRATEGY *accept_strategy_; - // Acceptor strategies. }; diff --git a/TAO/tao/IIOP_Connector.h b/TAO/tao/IIOP_Connector.h index 44dfa3b6b51..8218797d1ec 100644 --- a/TAO/tao/IIOP_Connector.h +++ b/TAO/tao/IIOP_Connector.h @@ -1,22 +1,19 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// IIOP_Connector.h -// -// = DESCRIPTION -// IIOP specific connector processing -// -// = AUTHOR -// Fred Kuhns <fredk@cs.wustl.edu> -// Modified by Balachandran Natarajan <bala@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file IIOP_Connector.h + * + * $Id$ + * + * IIOP specific connector processing + * + * + * @author Fred Kuhns <fredk@cs.wustl.edu> + * @author Balachandran Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_IIOP_CONNECTOR_H #define TAO_IIOP_CONNECTOR_H @@ -35,23 +32,24 @@ // **************************************************************** +/** + * @class TAO_IIOP_Connector + * + * @brief IIOP-specific Connector bridge for pluggable protocols. + * + * Concrete instance of the TAO_Connector class. Responsible + * for establishing a connection with a server and is called from the + * Connector_Registory. + */ class TAO_Export TAO_IIOP_Connector : public TAO_Connector { - // = TITLE - // IIOP-specific Connector bridge for pluggable protocols. - // - // = DESCRIPTION - // Concrete instance of the TAO_Connector class. Responsible - // for establishing a connection with a server and is called from the - // Connector_Registory. - // public: // = Initialization and termination methods. + /// Constructor. TAO_IIOP_Connector (CORBA::Boolean flag = 0); - // Constructor. + /// Destructor. ~TAO_IIOP_Connector (void); - // Destructor. // = The TAO_Connector methods, please check the documentation on // Pluggable.h diff --git a/TAO/tao/IIOP_Endpoint.h b/TAO/tao/IIOP_Endpoint.h index 4bb5672466d..688bddeea46 100644 --- a/TAO/tao/IIOP_Endpoint.h +++ b/TAO/tao/IIOP_Endpoint.h @@ -1,22 +1,19 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// IIOP_Endpoint.h -// -// = DESCRIPTION -// IIOP implementation of PP Framework Endpoint interface. -// -// = AUTHOR -// Marina Spivak <marina@cs.wustl.edu> -// -// ============================================================================ + + +//============================================================================= +/** + * @file IIOP_Endpoint.h + * + * $Id$ + * + * IIOP implementation of PP Framework Endpoint interface. + * + * + * @author Marina Spivak <marina@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_IIOP_ENDPOINT_H #define TAO_IIOP_ENDPOINT_H @@ -35,14 +32,15 @@ class TAO_IIOP_Connection_Handler; +/** + * @class TAO_IIOP_Endpoint + * + * @brief TAO_IIOP_Endpoint + * + * IIOP-specific implementation of PP Framework Endpoint interface. + */ class TAO_Export TAO_IIOP_Endpoint : public TAO_Endpoint { - // = TITLE - // TAO_IIOP_Endpoint - // - // = DESCRIPTION - // IIOP-specific implementation of PP Framework Endpoint interface. - // public: friend class TAO_IIOP_Profile; @@ -50,26 +48,26 @@ public: // = Initialization and termination methods. + /// Default constructor. TAO_IIOP_Endpoint (void); - // Default constructor. + /// Constructor. This is the most efficient constructor since it + /// does not require any address resolution processing. TAO_IIOP_Endpoint (const char *host, CORBA::UShort port, const ACE_INET_Addr &addr); - // Constructor. This is the most efficient constructor since it - // does not require any address resolution processing. + /// Constructor. TAO_IIOP_Endpoint (const ACE_INET_Addr &addr, int use_dotted_decimal_addresses); - // Constructor. + /// Constructor. This constructor is used when decoding endpoints. TAO_IIOP_Endpoint (const char *host, CORBA::UShort port, CORBA::Short priority); - // Constructor. This constructor is used when decoding endpoints. + /// Destructor. ~TAO_IIOP_Endpoint (void); - // Destructor. // = Implementation of abstract TAO_Endpoint methods. See // Endpoint.h for their documentation. @@ -78,55 +76,55 @@ public: virtual int addr_to_string (char *buffer, size_t length); virtual void reset_hint (void); + /// Makes a copy of <this> virtual TAO_Endpoint *duplicate (void); - // Makes a copy of <this> + /// Return true if this endpoint is equivalent to <other_endpoint>. Two + /// endpoints are equivalent iff their port and host are the same. CORBA::Boolean is_equivalent (const TAO_Endpoint *other_endpoint); - // Return true if this endpoint is equivalent to <other_endpoint>. Two - // endpoints are equivalent iff their port and host are the same. + /// Return a hash value for this object. CORBA::ULong hash (void); - // Return a hash value for this object. // Allocates memory and returns a copy of <this> // = IIOP_Endpoint-specific methods. + /// Return a reference to the <object_addr>. const ACE_INET_Addr &object_addr (void) const; - // Return a reference to the <object_addr>. + /// Return a pointer to the host string. This object maintains + /// ownership of this string. const char *host (void) const; - // Return a pointer to the host string. This object maintains - // ownership of this string. + /// Copy the string <h> into <host_> and return the resulting pointer. + /// This object maintains ownership of this string. const char *host (const char *h); - // Copy the string <h> into <host_> and return the resulting pointer. - // This object maintains ownership of this string. + /// Return the port number. CORBA::UShort port (void) const; - // Return the port number. + /// Set the port number. CORBA::UShort port (CORBA::UShort p); - // Set the port number. //TAO_IIOP_Connection_Handler *&hint (void); // Access to our <hint_>. private: + /// Helper method for setting INET_Addr. int set (const ACE_INET_Addr &addr, int use_dotted_decimal_addresses); - // Helper method for setting INET_Addr. + /// String representing the host name. CORBA::String_var host_; - // String representing the host name. + /// TCP port number. CORBA::UShort port_; - // TCP port number. + /// Cached instance of <ACE_INET_Addr> for use in making + /// invocations, etc. ACE_INET_Addr object_addr_; - // Cached instance of <ACE_INET_Addr> for use in making - // invocations, etc. // TAO_IIOP_Client_Connection_Handler *hint_; // Hint indicating the last successfully used connection handler for @@ -134,9 +132,9 @@ private: // @@ This needs to be used for optimization. Will look in to this // after MS defense - Bala + /// IIOP Endpoints can be stringed into a list. Return the next + /// endpoint in the list, if any. TAO_IIOP_Endpoint *next_; - // IIOP Endpoints can be stringed into a list. Return the next - // endpoint in the list, if any. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/IIOP_Factory.h b/TAO/tao/IIOP_Factory.h index 89fa9bd2619..ac96b4d83da 100644 --- a/TAO/tao/IIOP_Factory.h +++ b/TAO/tao/IIOP_Factory.h @@ -1,18 +1,15 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// IIOP_Factory.h -// -// = AUTHOR -// Fred Kuhns <fredk@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file IIOP_Factory.h + * + * $Id$ + * + * @author Fred Kuhns <fredk@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_IIOP_FACTORY_H #define TAO_IIOP_FACTORY_H @@ -36,18 +33,18 @@ public: virtual ~TAO_IIOP_Protocol_Factory (void); // = Service Configurator hooks. + /// Dynamic linking hook virtual int init (int argc, char* argv[]); - // Dynamic linking hook + /// Verify prefix is a match virtual int match_prefix (const ACE_CString &prefix); - // Verify prefix is a match + /// Returns the prefix used by the protocol. virtual const char *prefix (void) const; - // Returns the prefix used by the protocol. + /// Return the character used to mark where an endpoint ends and + /// where its options begin. virtual char options_delimiter (void) const; - // Return the character used to mark where an endpoint ends and - // where its options begin. // = Check Protocol_Factory.h for a description of these methods. virtual TAO_Acceptor *make_acceptor (void); @@ -55,10 +52,10 @@ public: virtual int requires_explicit_endpoint (void) const; private: + /// Changing the version number can be used to provide backwards + /// compatibility with old clients. int major_; int minor_; - // Changing the version number can be used to provide backwards - // compatibility with old clients. }; ACE_STATIC_SVC_DECLARE (TAO_IIOP_Protocol_Factory) diff --git a/TAO/tao/IIOP_Lite_Factory.h b/TAO/tao/IIOP_Lite_Factory.h index ccc35d2ba7d..3a264db4486 100644 --- a/TAO/tao/IIOP_Lite_Factory.h +++ b/TAO/tao/IIOP_Lite_Factory.h @@ -1,18 +1,15 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// IIOP_Lite_factory.h -// -// = AUTHOR -// Fred Kuhns <fredk@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file IIOP_Lite_Factory.h + * + * $Id$ + * + * @author Fred Kuhns <fredk@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_IIOP_LITE_FACTORY_H #define TAO_IIOP_LITE_FACTORY_H @@ -38,18 +35,18 @@ public: virtual ~TAO_IIOP_Lite_Protocol_Factory (void); // = Service Configurator hooks. + /// Dynamic linking hook virtual int init (int argc, char* argv[]); - // Dynamic linking hook + /// Verify prefix is a match virtual int match_prefix (const ACE_CString &prefix); - // Verify prefix is a match + /// Returns the prefix used by the protocol. virtual const char *prefix (void) const; - // Returns the prefix used by the protocol. + /// Return the character used to mark where an endpoint ends and + /// where its options begin. virtual char options_delimiter (void) const; - // Return the character used to mark where an endpoint ends and - // where its options begin. // = Check Protocol_Factory.h for a description of these methods. virtual TAO_Acceptor *make_acceptor (void); @@ -57,10 +54,10 @@ public: virtual int requires_explicit_endpoint (void) const; private: + /// Changing the version number can be used to provide backwards + /// compatibility with old clients. int major_; int minor_; - // Changing the version number can be used to provide backwards - // compatibility with old clients. }; ACE_STATIC_SVC_DECLARE (TAO_IIOP_Lite_Protocol_Factory) diff --git a/TAO/tao/IIOP_Profile.h b/TAO/tao/IIOP_Profile.h index 0b44aacaa15..cd4df10b152 100644 --- a/TAO/tao/IIOP_Profile.h +++ b/TAO/tao/IIOP_Profile.h @@ -1,22 +1,19 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// IIOP_Profile.h -// -// = DESCRIPTION -// IIOP profile specific processing -// -// = AUTHOR -// Fred Kuhns <fredk@cs.wustl.edu> -// -// ============================================================================ + + +//============================================================================= +/** + * @file IIOP_Profile.h + * + * $Id$ + * + * IIOP profile specific processing + * + * + * @author Fred Kuhns <fredk@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_IIOP_PROFILE_H #define TAO_IIOP_PROFILE_H @@ -35,159 +32,173 @@ class TAO_IIOP_Client_Connection_Handler; // TAO IIOP_Profile concrete Profile definitions +/** + * @class TAO_IIOP_Profile + * + * @brief This class defines the protocol specific attributes required + * for locating ORBs over a TCP/IP network. + * + * This class defines the IIOP profile as specified in the CORBA + * specification. + */ class TAO_Export TAO_IIOP_Profile : public TAO_Profile { - // = TITLE - // This class defines the protocol specific attributes required - // for locating ORBs over a TCP/IP network. - // - // = DESCRIPTION - // This class defines the IIOP profile as specified in the CORBA - // specification. public: + /// The object key delimiter that IIOP uses or expects. static const char object_key_delimiter_; virtual char object_key_delimiter (void) const; - // The object key delimiter that IIOP uses or expects. + /// Return the char string prefix. static const char *prefix (void); - // Return the char string prefix. + /// Profile constructor, same as above except the object_key has + /// already been marshaled. TAO_IIOP_Profile (const ACE_INET_Addr &addr, const TAO_ObjectKey &object_key, const TAO_GIOP_Version &version, TAO_ORB_Core *orb_core); - // Profile constructor, same as above except the object_key has - // already been marshaled. + /// Profile constructor, this is the most efficient since it + /// doesn't require any address resolution processing. TAO_IIOP_Profile (const char *host, CORBA::UShort port, const TAO_ObjectKey &object_key, const ACE_INET_Addr &addr, const TAO_GIOP_Version &version, TAO_ORB_Core *orb_core); - // Profile constructor, this is the most efficient since it - // doesn't require any address resolution processing. + /// Create object using a string ior. TAO_IIOP_Profile (const char *string, TAO_ORB_Core *orb_core, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Create object using a string ior. + /// Profile constructor, default. TAO_IIOP_Profile (TAO_ORB_Core *orb_core); - // Profile constructor, default. + /// Destructor is to be called only through <_decr_refcnt>. ~TAO_IIOP_Profile (void); - // Destructor is to be called only through <_decr_refcnt>. + /// Initialize this object using the given input string. + /// Url-style string contain only one endpoint. virtual int parse_string (const char *string, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Initialize this object using the given input string. - // Url-style string contain only one endpoint. + /** + * Return a string representation for this profile. + * client must deallocate memory. + * This is used to create url-style reference. Only one + * endpoint is included into the string. + */ virtual char * to_string (CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Return a string representation for this profile. - // client must deallocate memory. - // This is used to create url-style reference. Only one - // endpoint is included into the string. + /// Initialize this object using the given CDR octet string. virtual int decode (TAO_InputCDR& cdr); - // Initialize this object using the given CDR octet string. + /// Encode this profile in a stream, i.e. marshal it. virtual int encode (TAO_OutputCDR &stream) const; - // Encode this profile in a stream, i.e. marshal it. + /** + * Encodes this profile's endpoints into a tagged component. + * This is done only if RTCORBA is enabled, since currently this is + * the only case when we have more than one endpoint per profile. + * Returns 0 on success and -1 on failure. + * + * Endpoints are transmitted using TAO-proprietory tagged component. + * Component tag is TAO_TAG_ENDPOINTS and component data is an + * encapsulation of a sequence of structs, each representing a + * single endpoint. Data format is specified in iiop_endpoins.pidl. + * + * Multiple TAG_ALTERNATE_IIOP_ADDRESS components can be used + * instead of a single proprietory component to transmit multiple + * endpoints. This is somewhat slower and less convenient. Also, + * TAG_ALTERNATE_IIOP_ADDRESS does not provide for transmission of + * endpoint priorities. + * + */ virtual int encode_endpoints (void); - // Encodes this profile's endpoints into a tagged component. - // This is done only if RTCORBA is enabled, since currently this is - // the only case when we have more than one endpoint per profile. - // Returns 0 on success and -1 on failure. - // - // Endpoints are transmitted using TAO-proprietory tagged component. - // Component tag is TAO_TAG_ENDPOINTS and component data is an - // encapsulation of a sequence of structs, each representing a - // single endpoint. Data format is specified in iiop_endpoins.pidl. - // - // Multiple TAG_ALTERNATE_IIOP_ADDRESS components can be used - // instead of a single proprietory component to transmit multiple - // endpoints. This is somewhat slower and less convenient. Also, - // TAG_ALTERNATE_IIOP_ADDRESS does not provide for transmission of - // endpoint priorities. - // + /// @@ deprecated. return a reference to the Object Key. virtual const TAO_ObjectKey &object_key (void) const; - // @@ deprecated. return a reference to the Object Key. + /// Return a pointer to the Object Key. The caller owns the memory + /// allocated for the returned key. virtual TAO_ObjectKey *_key (void) const; - // Return a pointer to the Object Key. The caller owns the memory - // allocated for the returned key. + /// Return pointer to the head of this profile's endpoints list. virtual TAO_Endpoint *endpoint (void); - // Return pointer to the head of this profile's endpoints list. + /// Return how many endpoints this profile contains. virtual size_t endpoint_count (void); - // Return how many endpoints this profile contains. + /** + * Add <endp> to this profile's list of endpoints (it is inserted + * next to the head of the list). This profiles takes ownership of + * <endp>. + */ void add_endpoint (TAO_IIOP_Endpoint *endp); - // Add <endp> to this profile's list of endpoints (it is inserted - // next to the head of the list). This profiles takes ownership of - // <endp>. + /** + * Return true if this profile is equivalent to other_profile. Two + * profiles are equivalent iff their tag, object_key, version and + * all endpoints are the same. + */ virtual CORBA::Boolean is_equivalent (const TAO_Profile *other_profile); - // Return true if this profile is equivalent to other_profile. Two - // profiles are equivalent iff their tag, object_key, version and - // all endpoints are the same. + /// Return a hash value for this object. virtual CORBA::ULong hash (CORBA::ULong max, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Return a hash value for this object. + /// Please refer to Profile.h for the documentation of this + /// function. virtual IOP::TaggedProfile &create_tagged_profile (void); - // Please refer to Profile.h for the documentation of this - // function. private: + /// Creates an encapsulation of the ProfileBody struct in the <cdr> void create_profile_body (TAO_OutputCDR &cdr) const; - // Creates an encapsulation of the ProfileBody struct in the <cdr> + /** + * Helper for <decode>. Decodes endpoints from a tagged component. + * Decode only if RTCORBA is enabled. Furthermore, we may not find + * TAO_TAG_ENDPOINTS component, e.g., if we are talking to nonRT + * version of TAO or some other ORB. This is not an error, and we + * must proceed. Return 0 on success and -1 on failure. + */ int decode_endpoints (void); - // Helper for <decode>. Decodes endpoints from a tagged component. - // Decode only if RTCORBA is enabled. Furthermore, we may not find - // TAO_TAG_ENDPOINTS component, e.g., if we are talking to nonRT - // version of TAO or some other ORB. This is not an error, and we - // must proceed. Return 0 on success and -1 on failure. protected: + /** + * Head of this profile's list of endpoints. This endpoint is not + * dynamically allocated because a profile always contains at least + * one endpoint. + * + * Currently, a profile contains more than one endpoint, i.e., + * list contains more than just the head, only when RTCORBA is enabled. + * However, in the near future, this will be used in nonRT + * mode as well, e.g., to support TAG_ALTERNATE_IIOP_ADDRESS + * feature. + * Addressing info of the default endpoint, i.e., head of the list, + * is transmitted using standard IIOP ProfileBody components. See + * <encode_endpoints> method documentation above for how the rest of + * the endpoint list is transmitted. + */ TAO_IIOP_Endpoint endpoint_; - // Head of this profile's list of endpoints. This endpoint is not - // dynamically allocated because a profile always contains at least - // one endpoint. - // - // Currently, a profile contains more than one endpoint, i.e., - // list contains more than just the head, only when RTCORBA is enabled. - // However, in the near future, this will be used in nonRT - // mode as well, e.g., to support TAG_ALTERNATE_IIOP_ADDRESS - // feature. - // Addressing info of the default endpoint, i.e., head of the list, - // is transmitted using standard IIOP ProfileBody components. See - // <encode_endpoints> method documentation above for how the rest of - // the endpoint list is transmitted. + /// Number of endpoints in the list headed by <endpoint_>. size_t count_; - // Number of endpoints in the list headed by <endpoint_>. private: + /// object_key associated with this profile. TAO_ObjectKey object_key_; - // object_key associated with this profile. + /// Our tagged profile IOP::TaggedProfile tagged_profile_; - // Our tagged profile }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/IOP_Defns.h b/TAO/tao/IOP_Defns.h index 73aa555c9dd..a7b94e3a979 100644 --- a/TAO/tao/IOP_Defns.h +++ b/TAO/tao/IOP_Defns.h @@ -1,27 +1,25 @@ -// $Id$ //-*- C++ -*- -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// IOP_Defn.h -// -// = DESCRIPTION -// Definitions for IOP related classes. IOP definitions are part of -// the Interoperability model specified by the CORBA spec. -// -// = AUTHOR -// Taken from the old GIOP.h file. Not sure of the author -// ============================================================================ +//============================================================================= +/** + * @file IOP_Defns.h + * + * $Id$ + * + * Definitions for IOP related classes. IOP definitions are part of + * the Interoperability model specified by the CORBA spec. + * + * + * @author Taken from the old GIOP.h file. Not sure of the author + */ +//============================================================================= + #ifndef _TAO_IOP_DEFN_H_ #define _TAO_IOP_DEFN_H_ #include "ace/pre.h" // These were all in the GIOP.h file. They shouldn't be combined with // GIOP as they are not specific to GIOP. They are part of the CORBA -// Interoperable reference model. +// Interoperable reference model. // namespace TAO_IOP @@ -32,10 +30,13 @@ // Email to tag-request@omg.org to allocate tags. typedef CORBA::ULong TAO_IOP_Profile_ID; +/** + * @class TAO_IOP_Tagged_Profile + * + * @brief One per protocol. + */ class TAO_IOP_Tagged_Profile { - // = TITLE - // One per protocol. public: TAO_IOP_Profile_ID tag; TAO_opaque profile_data; @@ -44,16 +45,18 @@ public: typedef TAO_Unbounded_Sequence<TAO_IOP_Tagged_Profile> TAO_IOP_Tagged_Profile_Sequence; +/** + * @class TAO_IOP_IOR + * + * @brief InteroperableObjectReference + * + * ... a set of protocol-specific protocol profiles, plus a type + * ID. Only one object is denoted by all of this information. + * It's OK to delete all profiles except the one for the single + * protocol actually being used. + */ class TAO_IOP_IOR { - // = TITLE - // InteroperableObjectReference - // - // = DESCRIPTION - // ... a set of protocol-specific protocol profiles, plus a type - // ID. Only one object is denoted by all of this information. - // It's OK to delete all profiles except the one for the single - // protocol actually being used. public: char *type_id; @@ -82,16 +85,19 @@ enum TAO_IOP_TAG_LOCATION_POLICY = 12 // octet/enum }; +/** + * @class TAO_IOP_TaggedComponent + * + * One way to represent multicomponent profiles, e.g. as done by + * the DCE-CIOP protocol. One of these gets encapsulated in + * Tagged_Profile::profile_data. TAG_MULTIPLE_COMPONENTS may be + * used to represent protocol profiles structured in that way, but + * protocol-specific tags facilitate simpler scanning of IORs + * since you can be assured that each profile only has data used + * within a single ORB protocol. + */ class TAO_IOP_TaggedComponent { - // = DESCRIPTION - // One way to represent multicomponent profiles, e.g. as done by - // the DCE-CIOP protocol. One of these gets encapsulated in - // Tagged_Profile::profile_data. TAG_MULTIPLE_COMPONENTS may be - // used to represent protocol profiles structured in that way, but - // protocol-specific tags facilitate simpler scanning of IORs - // since you can be assured that each profile only has data used - // within a single ORB protocol. public: TAO_IOP_ComponentId tag; diff --git a/TAO/tao/IOR_Parser.h b/TAO/tao/IOR_Parser.h index 5d182a0ce63..a9951aa210a 100644 --- a/TAO/tao/IOR_Parser.h +++ b/TAO/tao/IOR_Parser.h @@ -1,17 +1,14 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// IOR_Parser.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file IOR_Parser.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_IOR_PARSER_H #define TAO_IOR_PARSER_H @@ -26,32 +23,35 @@ #include "ace/Service_Object.h" +/** + * @class TAO_IOR_Parser + * + * @brief Defines the interface for the pluggable IOR parser components + * + * The ORB is able to dynamically load the list of IOR formats it + * understands. That allow us to integrate formats such as + * corbaname:, http: or ftp: only when required. + * This class provides a uniform interface for all the IOR parsers + */ class TAO_Export TAO_IOR_Parser : public ACE_Service_Object { - // = TITLE - // Defines the interface for the pluggable IOR parser components - // - // = DESCRIPTION - // The ORB is able to dynamically load the list of IOR formats it - // understands. That allow us to integrate formats such as - // corbaname:, http: or ftp: only when required. - // This class provides a uniform interface for all the IOR parsers - // public: + /// The destructor virtual ~TAO_IOR_Parser (void); - // The destructor + /// Return 1 if <ior_string> starts with a prefix known to this IOR + /// parser virtual int match_prefix (const char *ior_string) const = 0; - // Return 1 if <ior_string> starts with a prefix known to this IOR - // parser + /** + * Parse the <ior> argument and return an object reference. + * The call may raise the standard system exceptions (NO_MEMORY, + * INV_OBJREF, etc.) + */ virtual CORBA::Object_ptr parse_string (const char *ior, CORBA::ORB_ptr orb, CORBA::Environment &) ACE_THROW_SPEC ((CORBA::SystemException)) = 0; - // Parse the <ior> argument and return an object reference. - // The call may raise the standard system exceptions (NO_MEMORY, - // INV_OBJREF, etc.) }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/Interceptor_List.h b/TAO/tao/Interceptor_List.h index c346c1ebc2b..425e36b417f 100644 --- a/TAO/tao/Interceptor_List.h +++ b/TAO/tao/Interceptor_List.h @@ -39,7 +39,7 @@ public: /// Constructor TAO_Interceptor_List (void); - + /// Destructor virtual ~TAO_Interceptor_List (void); diff --git a/TAO/tao/InterfaceC.h b/TAO/tao/InterfaceC.h index 2168211ad8b..d41eaf9fbd8 100644 --- a/TAO/tao/InterfaceC.h +++ b/TAO/tao/InterfaceC.h @@ -63,17 +63,17 @@ { public: CORBA_IRObject_var (void); // default constructor - CORBA_IRObject_var (CORBA_IRObject_ptr p) : ptr_ (p) {} + CORBA_IRObject_var (CORBA_IRObject_ptr p) : ptr_ (p) {} CORBA_IRObject_var (const CORBA_IRObject_var &); // copy constructor ~CORBA_IRObject_var (void); // destructor - + CORBA_IRObject_var &operator= (CORBA_IRObject_ptr); CORBA_IRObject_var &operator= (const CORBA_IRObject_var &); CORBA_IRObject_ptr operator-> (void) const; - + operator const CORBA_IRObject_ptr &() const; operator CORBA_IRObject_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn CORBA_IRObject_ptr in (void) const; CORBA_IRObject_ptr &inout (void); CORBA_IRObject_ptr &out (void); @@ -99,7 +99,7 @@ operator CORBA_IRObject_ptr &(); CORBA_IRObject_ptr &ptr (void); CORBA_IRObject_ptr operator-> (void); - + private: CORBA_IRObject_ptr &ptr_; }; @@ -108,7 +108,7 @@ class _TAO_IRObject_Remote_Proxy_Impl; class _TAO_IRObject_Proxy_Broker; class _TAO_IRObject_Remote_Proxy_Broker; - + class TAO_Export CORBA_IRObject : public virtual CORBA_Object { public: @@ -121,12 +121,12 @@ static CORBA_IRObject_ptr _duplicate (CORBA_IRObject_ptr obj); static CORBA_IRObject_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static CORBA_IRObject_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static CORBA_IRObject_ptr _nil (void) @@ -137,7 +137,7 @@ static void _tao_any_destructor (void*); virtual IR_DefinitionKind def_kind ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -145,7 +145,7 @@ )); virtual void destroy ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -153,39 +153,39 @@ )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_IRObject_Proxy_Broker *the_TAO_IRObject_Proxy_Broker_; - + protected: CORBA_IRObject (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + CORBA_IRObject ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_IRObject_Remote_Proxy_Impl; friend class _TAO_IRObject_ThruPOA_Proxy_Impl; friend class _TAO_IRObject_Direct_Proxy_Impl; - + virtual ~CORBA_IRObject (void); private: CORBA_IRObject (const CORBA_IRObject &); - void operator= (const CORBA_IRObject &); + void operator= (const CORBA_IRObject &); }; @@ -202,7 +202,7 @@ class TAO_Export _TAO_IRObject_Proxy_Impl : public virtual TAO_Object_Proxy_Impl { public: virtual ~_TAO_IRObject_Proxy_Impl (void) { } - + virtual IR_DefinitionKind def_kind ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -233,15 +233,15 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_IRObject_Remote_Proxy_Impl : +class TAO_Export _TAO_IRObject_Remote_Proxy_Impl : public virtual _TAO_IRObject_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl { public: _TAO_IRObject_Remote_Proxy_Impl (void); - + virtual ~_TAO_IRObject_Remote_Proxy_Impl (void) { } - + virtual IR_DefinitionKind def_kind ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -266,14 +266,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_IRObject_Proxy_Broker @@ -288,24 +288,24 @@ public: protected: _TAO_IRObject_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_IRObject_Remote_Proxy_Broker : public virtual _TAO_IRObject_Proxy_Broker { -public: +public: _TAO_IRObject_Remote_Proxy_Broker (void); - + virtual ~_TAO_IRObject_Remote_Proxy_Broker (void); virtual _TAO_IRObject_Proxy_Impl &select_proxy ( @@ -324,7 +324,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// @@ -332,17 +332,17 @@ public: { public: IR_Contained_var (void); // default constructor - IR_Contained_var (IR_Contained_ptr p) : ptr_ (p) {} + IR_Contained_var (IR_Contained_ptr p) : ptr_ (p) {} IR_Contained_var (const IR_Contained_var &); // copy constructor ~IR_Contained_var (void); // destructor - + IR_Contained_var &operator= (IR_Contained_ptr); IR_Contained_var &operator= (const IR_Contained_var &); IR_Contained_ptr operator-> (void) const; - + operator const IR_Contained_ptr &() const; operator IR_Contained_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_Contained_ptr in (void) const; IR_Contained_ptr &inout (void); IR_Contained_ptr &out (void); @@ -368,7 +368,7 @@ public: operator IR_Contained_ptr &(); IR_Contained_ptr &ptr (void); IR_Contained_ptr operator-> (void); - + private: IR_Contained_ptr &ptr_; }; @@ -377,17 +377,17 @@ public: { public: IR_Repository_var (void); // default constructor - IR_Repository_var (IR_Repository_ptr p) : ptr_ (p) {} + IR_Repository_var (IR_Repository_ptr p) : ptr_ (p) {} IR_Repository_var (const IR_Repository_var &); // copy constructor ~IR_Repository_var (void); // destructor - + IR_Repository_var &operator= (IR_Repository_ptr); IR_Repository_var &operator= (const IR_Repository_var &); IR_Repository_ptr operator-> (void) const; - + operator const IR_Repository_ptr &() const; operator IR_Repository_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_Repository_ptr in (void) const; IR_Repository_ptr &inout (void); IR_Repository_ptr &out (void); @@ -413,7 +413,7 @@ public: operator IR_Repository_ptr &(); IR_Repository_ptr &ptr (void); IR_Repository_ptr operator-> (void); - + private: IR_Repository_ptr &ptr_; }; @@ -422,17 +422,17 @@ public: { public: IR_Container_var (void); // default constructor - IR_Container_var (IR_Container_ptr p) : ptr_ (p) {} + IR_Container_var (IR_Container_ptr p) : ptr_ (p) {} IR_Container_var (const IR_Container_var &); // copy constructor ~IR_Container_var (void); // destructor - + IR_Container_var &operator= (IR_Container_ptr); IR_Container_var &operator= (const IR_Container_var &); IR_Container_ptr operator-> (void) const; - + operator const IR_Container_ptr &() const; operator IR_Container_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_Container_ptr in (void) const; IR_Container_ptr &inout (void); IR_Container_ptr &out (void); @@ -458,7 +458,7 @@ public: operator IR_Container_ptr &(); IR_Container_ptr &ptr (void); IR_Container_ptr operator-> (void); - + private: IR_Container_ptr &ptr_; }; @@ -468,7 +468,7 @@ public: class _TAO_Contained_Remote_Proxy_Impl; class _TAO_Contained_Proxy_Broker; class _TAO_Contained_Remote_Proxy_Broker; - + class TAO_Export IR_Contained: public virtual CORBA_IRObject { public: @@ -481,12 +481,12 @@ public: static IR_Contained_ptr _duplicate (IR_Contained_ptr obj); static IR_Contained_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_Contained_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_Contained_ptr _nil (void) @@ -497,7 +497,7 @@ public: static void _tao_any_destructor (void*); virtual char * id ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -506,7 +506,7 @@ public: virtual void id ( const char * id, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -514,7 +514,7 @@ public: )); virtual char * name ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -523,7 +523,7 @@ public: virtual void name ( const char * name, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -531,7 +531,7 @@ public: )); virtual char * version ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -540,7 +540,7 @@ public: virtual void version ( const char * version, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -548,7 +548,7 @@ public: )); virtual IR_Container_ptr defined_in ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -556,7 +556,7 @@ public: )); virtual char * absolute_name ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -564,7 +564,7 @@ public: )); virtual IR_Repository_ptr containing_repository ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -573,7 +573,7 @@ public: struct Description; class Description_var; - + struct TAO_Export Description { @@ -594,18 +594,18 @@ public: Description_var (Description *); Description_var (const Description_var &); // copy constructor ~Description_var (void); // destructor - + Description_var &operator= (Description *); Description_var &operator= (const Description_var &); Description *operator-> (void); const Description *operator-> (void) const; - + operator const Description &() const; operator Description &(); operator Description &() const; operator Description *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const Description &in (void) const; Description &inout (void); Description *&out (void); @@ -627,7 +627,7 @@ public: operator Description *&(); Description *&ptr (void); Description *operator-> (void); - + private: Description *&ptr_; // assignment from T_var not allowed @@ -637,7 +637,7 @@ public: static CORBA::TypeCode_ptr _tc_Description; virtual IR_Contained::Description * describe ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -648,7 +648,7 @@ public: IR_Container_ptr new_container, const char * new_name, const char * new_version, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -656,39 +656,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_Contained_Proxy_Broker *the_TAO_Contained_Proxy_Broker_; - + protected: IR_Contained (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_Contained ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_Contained_Remote_Proxy_Impl; friend class _TAO_Contained_ThruPOA_Proxy_Impl; friend class _TAO_Contained_Direct_Proxy_Impl; - + virtual ~IR_Contained (void); private: IR_Contained (const IR_Contained &); - void operator= (const IR_Contained &); + void operator= (const IR_Contained &); }; @@ -702,12 +702,12 @@ public: // Base Impl. Declaration // -class TAO_Export _TAO_Contained_Proxy_Impl : +class TAO_Export _TAO_Contained_Proxy_Impl : public virtual _TAO_IRObject_Proxy_Impl { public: virtual ~_TAO_Contained_Proxy_Impl (void) { } - + virtual char * id ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -815,17 +815,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_Contained_Remote_Proxy_Impl : +class TAO_Export _TAO_Contained_Remote_Proxy_Impl : public virtual _TAO_Contained_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_IRObject_Remote_Proxy_Impl - + { public: _TAO_Contained_Remote_Proxy_Impl (void); - + virtual ~_TAO_Contained_Remote_Proxy_Impl (void) { } - + virtual char * id ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -927,14 +927,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_Contained_Proxy_Broker @@ -949,24 +949,24 @@ public: protected: _TAO_Contained_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_Contained_Remote_Proxy_Broker : public virtual _TAO_Contained_Proxy_Broker { -public: +public: _TAO_Contained_Remote_Proxy_Broker (void); - + virtual ~_TAO_Contained_Remote_Proxy_Broker (void); virtual _TAO_Contained_Proxy_Impl &select_proxy ( @@ -985,24 +985,24 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// class TAO_Export IR_ModuleDef_var : public TAO_Base_var { public: IR_ModuleDef_var (void); // default constructor - IR_ModuleDef_var (IR_ModuleDef_ptr p) : ptr_ (p) {} + IR_ModuleDef_var (IR_ModuleDef_ptr p) : ptr_ (p) {} IR_ModuleDef_var (const IR_ModuleDef_var &); // copy constructor ~IR_ModuleDef_var (void); // destructor - + IR_ModuleDef_var &operator= (IR_ModuleDef_ptr); IR_ModuleDef_var &operator= (const IR_ModuleDef_var &); IR_ModuleDef_ptr operator-> (void) const; - + operator const IR_ModuleDef_ptr &() const; operator IR_ModuleDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_ModuleDef_ptr in (void) const; IR_ModuleDef_ptr &inout (void); IR_ModuleDef_ptr &out (void); @@ -1028,7 +1028,7 @@ public: operator IR_ModuleDef_ptr &(); IR_ModuleDef_ptr &ptr (void); IR_ModuleDef_ptr operator-> (void); - + private: IR_ModuleDef_ptr &ptr_; }; @@ -1037,17 +1037,17 @@ class TAO_Export IR_ConstantDef_var : public TAO_Base_var { public: IR_ConstantDef_var (void); // default constructor - IR_ConstantDef_var (IR_ConstantDef_ptr p) : ptr_ (p) {} + IR_ConstantDef_var (IR_ConstantDef_ptr p) : ptr_ (p) {} IR_ConstantDef_var (const IR_ConstantDef_var &); // copy constructor ~IR_ConstantDef_var (void); // destructor - + IR_ConstantDef_var &operator= (IR_ConstantDef_ptr); IR_ConstantDef_var &operator= (const IR_ConstantDef_var &); IR_ConstantDef_ptr operator-> (void) const; - + operator const IR_ConstantDef_ptr &() const; operator IR_ConstantDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_ConstantDef_ptr in (void) const; IR_ConstantDef_ptr &inout (void); IR_ConstantDef_ptr &out (void); @@ -1073,7 +1073,7 @@ public: operator IR_ConstantDef_ptr &(); IR_ConstantDef_ptr &ptr (void); IR_ConstantDef_ptr operator-> (void); - + private: IR_ConstantDef_ptr &ptr_; }; @@ -1082,17 +1082,17 @@ class TAO_Export IR_IDLType_var : public TAO_Base_var { public: IR_IDLType_var (void); // default constructor - IR_IDLType_var (IR_IDLType_ptr p) : ptr_ (p) {} + IR_IDLType_var (IR_IDLType_ptr p) : ptr_ (p) {} IR_IDLType_var (const IR_IDLType_var &); // copy constructor ~IR_IDLType_var (void); // destructor - + IR_IDLType_var &operator= (IR_IDLType_ptr); IR_IDLType_var &operator= (const IR_IDLType_var &); IR_IDLType_ptr operator-> (void) const; - + operator const IR_IDLType_ptr &() const; operator IR_IDLType_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_IDLType_ptr in (void) const; IR_IDLType_ptr &inout (void); IR_IDLType_ptr &out (void); @@ -1118,7 +1118,7 @@ public: operator IR_IDLType_ptr &(); IR_IDLType_ptr &ptr (void); IR_IDLType_ptr operator-> (void); - + private: IR_IDLType_ptr &ptr_; }; @@ -1127,17 +1127,17 @@ class TAO_Export IR_StructDef_var : public TAO_Base_var { public: IR_StructDef_var (void); // default constructor - IR_StructDef_var (IR_StructDef_ptr p) : ptr_ (p) {} + IR_StructDef_var (IR_StructDef_ptr p) : ptr_ (p) {} IR_StructDef_var (const IR_StructDef_var &); // copy constructor ~IR_StructDef_var (void); // destructor - + IR_StructDef_var &operator= (IR_StructDef_ptr); IR_StructDef_var &operator= (const IR_StructDef_var &); IR_StructDef_ptr operator-> (void) const; - + operator const IR_StructDef_ptr &() const; operator IR_StructDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_StructDef_ptr in (void) const; IR_StructDef_ptr &inout (void); IR_StructDef_ptr &out (void); @@ -1163,7 +1163,7 @@ public: operator IR_StructDef_ptr &(); IR_StructDef_ptr &ptr (void); IR_StructDef_ptr operator-> (void); - + private: IR_StructDef_ptr &ptr_; }; @@ -1172,17 +1172,17 @@ class TAO_Export IR_UnionDef_var : public TAO_Base_var { public: IR_UnionDef_var (void); // default constructor - IR_UnionDef_var (IR_UnionDef_ptr p) : ptr_ (p) {} + IR_UnionDef_var (IR_UnionDef_ptr p) : ptr_ (p) {} IR_UnionDef_var (const IR_UnionDef_var &); // copy constructor ~IR_UnionDef_var (void); // destructor - + IR_UnionDef_var &operator= (IR_UnionDef_ptr); IR_UnionDef_var &operator= (const IR_UnionDef_var &); IR_UnionDef_ptr operator-> (void) const; - + operator const IR_UnionDef_ptr &() const; operator IR_UnionDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_UnionDef_ptr in (void) const; IR_UnionDef_ptr &inout (void); IR_UnionDef_ptr &out (void); @@ -1208,7 +1208,7 @@ public: operator IR_UnionDef_ptr &(); IR_UnionDef_ptr &ptr (void); IR_UnionDef_ptr operator-> (void); - + private: IR_UnionDef_ptr &ptr_; }; @@ -1217,17 +1217,17 @@ class TAO_Export IR_EnumDef_var : public TAO_Base_var { public: IR_EnumDef_var (void); // default constructor - IR_EnumDef_var (IR_EnumDef_ptr p) : ptr_ (p) {} + IR_EnumDef_var (IR_EnumDef_ptr p) : ptr_ (p) {} IR_EnumDef_var (const IR_EnumDef_var &); // copy constructor ~IR_EnumDef_var (void); // destructor - + IR_EnumDef_var &operator= (IR_EnumDef_ptr); IR_EnumDef_var &operator= (const IR_EnumDef_var &); IR_EnumDef_ptr operator-> (void) const; - + operator const IR_EnumDef_ptr &() const; operator IR_EnumDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_EnumDef_ptr in (void) const; IR_EnumDef_ptr &inout (void); IR_EnumDef_ptr &out (void); @@ -1253,7 +1253,7 @@ public: operator IR_EnumDef_ptr &(); IR_EnumDef_ptr &ptr (void); IR_EnumDef_ptr operator-> (void); - + private: IR_EnumDef_ptr &ptr_; }; @@ -1262,17 +1262,17 @@ class TAO_Export IR_AliasDef_var : public TAO_Base_var { public: IR_AliasDef_var (void); // default constructor - IR_AliasDef_var (IR_AliasDef_ptr p) : ptr_ (p) {} + IR_AliasDef_var (IR_AliasDef_ptr p) : ptr_ (p) {} IR_AliasDef_var (const IR_AliasDef_var &); // copy constructor ~IR_AliasDef_var (void); // destructor - + IR_AliasDef_var &operator= (IR_AliasDef_ptr); IR_AliasDef_var &operator= (const IR_AliasDef_var &); IR_AliasDef_ptr operator-> (void) const; - + operator const IR_AliasDef_ptr &() const; operator IR_AliasDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_AliasDef_ptr in (void) const; IR_AliasDef_ptr &inout (void); IR_AliasDef_ptr &out (void); @@ -1298,7 +1298,7 @@ public: operator IR_AliasDef_ptr &(); IR_AliasDef_ptr &ptr (void); IR_AliasDef_ptr operator-> (void); - + private: IR_AliasDef_ptr &ptr_; }; @@ -1307,17 +1307,17 @@ class TAO_Export IR_InterfaceDef_var : public TAO_Base_var { public: IR_InterfaceDef_var (void); // default constructor - IR_InterfaceDef_var (IR_InterfaceDef_ptr p) : ptr_ (p) {} + IR_InterfaceDef_var (IR_InterfaceDef_ptr p) : ptr_ (p) {} IR_InterfaceDef_var (const IR_InterfaceDef_var &); // copy constructor ~IR_InterfaceDef_var (void); // destructor - + IR_InterfaceDef_var &operator= (IR_InterfaceDef_ptr); IR_InterfaceDef_var &operator= (const IR_InterfaceDef_var &); IR_InterfaceDef_ptr operator-> (void) const; - + operator const IR_InterfaceDef_ptr &() const; operator IR_InterfaceDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_InterfaceDef_ptr in (void) const; IR_InterfaceDef_ptr &inout (void); IR_InterfaceDef_ptr &out (void); @@ -1343,7 +1343,7 @@ public: operator IR_InterfaceDef_ptr &(); IR_InterfaceDef_ptr &ptr (void); IR_InterfaceDef_ptr operator-> (void); - + private: IR_InterfaceDef_ptr &ptr_; }; @@ -1352,17 +1352,17 @@ class TAO_Export IR_ExceptionDef_var : public TAO_Base_var { public: IR_ExceptionDef_var (void); // default constructor - IR_ExceptionDef_var (IR_ExceptionDef_ptr p) : ptr_ (p) {} + IR_ExceptionDef_var (IR_ExceptionDef_ptr p) : ptr_ (p) {} IR_ExceptionDef_var (const IR_ExceptionDef_var &); // copy constructor ~IR_ExceptionDef_var (void); // destructor - + IR_ExceptionDef_var &operator= (IR_ExceptionDef_ptr); IR_ExceptionDef_var &operator= (const IR_ExceptionDef_var &); IR_ExceptionDef_ptr operator-> (void) const; - + operator const IR_ExceptionDef_ptr &() const; operator IR_ExceptionDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_ExceptionDef_ptr in (void) const; IR_ExceptionDef_ptr &inout (void); IR_ExceptionDef_ptr &out (void); @@ -1388,7 +1388,7 @@ public: operator IR_ExceptionDef_ptr &(); IR_ExceptionDef_ptr &ptr (void); IR_ExceptionDef_ptr operator-> (void); - + private: IR_ExceptionDef_ptr &ptr_; }; @@ -1397,17 +1397,17 @@ class TAO_Export IR_NativeDef_var : public TAO_Base_var { public: IR_NativeDef_var (void); // default constructor - IR_NativeDef_var (IR_NativeDef_ptr p) : ptr_ (p) {} + IR_NativeDef_var (IR_NativeDef_ptr p) : ptr_ (p) {} IR_NativeDef_var (const IR_NativeDef_var &); // copy constructor ~IR_NativeDef_var (void); // destructor - + IR_NativeDef_var &operator= (IR_NativeDef_ptr); IR_NativeDef_var &operator= (const IR_NativeDef_var &); IR_NativeDef_ptr operator-> (void) const; - + operator const IR_NativeDef_ptr &() const; operator IR_NativeDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_NativeDef_ptr in (void) const; IR_NativeDef_ptr &inout (void); IR_NativeDef_ptr &out (void); @@ -1433,18 +1433,18 @@ public: operator IR_NativeDef_ptr &(); IR_NativeDef_ptr &ptr (void); IR_NativeDef_ptr operator-> (void); - + private: IR_NativeDef_ptr &ptr_; }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class _TAO_Unbounded_Object_Sequence_IR_InterfaceDefSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Object_Sequence_IR_InterfaceDefSeq (void); _TAO_Unbounded_Object_Sequence_IR_InterfaceDefSeq (CORBA::ULong maximum); _TAO_Unbounded_Object_Sequence_IR_InterfaceDefSeq (CORBA::ULong maximum, @@ -1466,33 +1466,33 @@ private: virtual void _downcast ( void* target, CORBA_Object *src, - CORBA_Environment &ACE_TRY_ENV = + CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual CORBA_Object* _upcast (void *src) const; - + }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_InterfaceDefSeq // ************************************************************* -class TAO_Export IR_InterfaceDefSeq : public +class TAO_Export IR_InterfaceDefSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Object_Sequence_IR_InterfaceDefSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Object_Sequence<IR_InterfaceDef,IR_InterfaceDef_var> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_InterfaceDefSeq (void); // default ctor IR_InterfaceDefSeq (CORBA::ULong max); // uses max size IR_InterfaceDefSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_InterfaceDef_ptr *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_InterfaceDef_ptr *buffer, CORBA::Boolean release = 0 ); IR_InterfaceDefSeq (const IR_InterfaceDefSeq &); // copy ctor @@ -1516,20 +1516,20 @@ public: IR_InterfaceDefSeq_var (IR_InterfaceDefSeq *); IR_InterfaceDefSeq_var (const IR_InterfaceDefSeq_var &); // copy constructor ~IR_InterfaceDefSeq_var (void); // destructor - + IR_InterfaceDefSeq_var &operator= (IR_InterfaceDefSeq *); IR_InterfaceDefSeq_var &operator= (const IR_InterfaceDefSeq_var &); IR_InterfaceDefSeq *operator-> (void); const IR_InterfaceDefSeq *operator-> (void) const; - + operator const IR_InterfaceDefSeq &() const; operator IR_InterfaceDefSeq &(); operator IR_InterfaceDefSeq &() const; operator IR_InterfaceDefSeq *&(); // variable-size base types only - + TAO_Object_Manager<IR_InterfaceDef, IR_InterfaceDef_var> operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_InterfaceDefSeq &in (void) const; IR_InterfaceDefSeq &inout (void); IR_InterfaceDefSeq *&out (void); @@ -1552,7 +1552,7 @@ public: IR_InterfaceDefSeq *&ptr (void); IR_InterfaceDefSeq *operator-> (void); TAO_Object_Manager<IR_InterfaceDef, IR_InterfaceDef_var> operator[] (CORBA::ULong index); - + private: IR_InterfaceDefSeq *&ptr_; // assignment from T_var not allowed @@ -1563,17 +1563,17 @@ class TAO_Export IR_ValueDef_var : public TAO_Base_var { public: IR_ValueDef_var (void); // default constructor - IR_ValueDef_var (IR_ValueDef_ptr p) : ptr_ (p) {} + IR_ValueDef_var (IR_ValueDef_ptr p) : ptr_ (p) {} IR_ValueDef_var (const IR_ValueDef_var &); // copy constructor ~IR_ValueDef_var (void); // destructor - + IR_ValueDef_var &operator= (IR_ValueDef_ptr); IR_ValueDef_var &operator= (const IR_ValueDef_var &); IR_ValueDef_ptr operator-> (void) const; - + operator const IR_ValueDef_ptr &() const; operator IR_ValueDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_ValueDef_ptr in (void) const; IR_ValueDef_ptr &inout (void); IR_ValueDef_ptr &out (void); @@ -1599,18 +1599,18 @@ public: operator IR_ValueDef_ptr &(); IR_ValueDef_ptr &ptr (void); IR_ValueDef_ptr operator-> (void); - + private: IR_ValueDef_ptr &ptr_; }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class _TAO_Unbounded_Object_Sequence_IR_ValueDefSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Object_Sequence_IR_ValueDefSeq (void); _TAO_Unbounded_Object_Sequence_IR_ValueDefSeq (CORBA::ULong maximum); _TAO_Unbounded_Object_Sequence_IR_ValueDefSeq (CORBA::ULong maximum, @@ -1632,33 +1632,33 @@ private: virtual void _downcast ( void* target, CORBA_Object *src, - CORBA_Environment &ACE_TRY_ENV = + CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual CORBA_Object* _upcast (void *src) const; - + }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_ValueDefSeq // ************************************************************* -class TAO_Export IR_ValueDefSeq : public +class TAO_Export IR_ValueDefSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Object_Sequence_IR_ValueDefSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Object_Sequence<IR_ValueDef,IR_ValueDef_var> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_ValueDefSeq (void); // default ctor IR_ValueDefSeq (CORBA::ULong max); // uses max size IR_ValueDefSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_ValueDef_ptr *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_ValueDef_ptr *buffer, CORBA::Boolean release = 0 ); IR_ValueDefSeq (const IR_ValueDefSeq &); // copy ctor @@ -1682,20 +1682,20 @@ public: IR_ValueDefSeq_var (IR_ValueDefSeq *); IR_ValueDefSeq_var (const IR_ValueDefSeq_var &); // copy constructor ~IR_ValueDefSeq_var (void); // destructor - + IR_ValueDefSeq_var &operator= (IR_ValueDefSeq *); IR_ValueDefSeq_var &operator= (const IR_ValueDefSeq_var &); IR_ValueDefSeq *operator-> (void); const IR_ValueDefSeq *operator-> (void) const; - + operator const IR_ValueDefSeq &() const; operator IR_ValueDefSeq &(); operator IR_ValueDefSeq &() const; operator IR_ValueDefSeq *&(); // variable-size base types only - + TAO_Object_Manager<IR_ValueDef, IR_ValueDef_var> operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ValueDefSeq &in (void) const; IR_ValueDefSeq &inout (void); IR_ValueDefSeq *&out (void); @@ -1718,7 +1718,7 @@ public: IR_ValueDefSeq *&ptr (void); IR_ValueDefSeq *operator-> (void); TAO_Object_Manager<IR_ValueDef, IR_ValueDef_var> operator[] (CORBA::ULong index); - + private: IR_ValueDefSeq *&ptr_; // assignment from T_var not allowed @@ -1729,17 +1729,17 @@ class TAO_Export IR_ValueBoxDef_var : public TAO_Base_var { public: IR_ValueBoxDef_var (void); // default constructor - IR_ValueBoxDef_var (IR_ValueBoxDef_ptr p) : ptr_ (p) {} + IR_ValueBoxDef_var (IR_ValueBoxDef_ptr p) : ptr_ (p) {} IR_ValueBoxDef_var (const IR_ValueBoxDef_var &); // copy constructor ~IR_ValueBoxDef_var (void); // destructor - + IR_ValueBoxDef_var &operator= (IR_ValueBoxDef_ptr); IR_ValueBoxDef_var &operator= (const IR_ValueBoxDef_var &); IR_ValueBoxDef_ptr operator-> (void) const; - + operator const IR_ValueBoxDef_ptr &() const; operator IR_ValueBoxDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_ValueBoxDef_ptr in (void) const; IR_ValueBoxDef_ptr &inout (void); IR_ValueBoxDef_ptr &out (void); @@ -1765,7 +1765,7 @@ public: operator IR_ValueBoxDef_ptr &(); IR_ValueBoxDef_ptr &ptr (void); IR_ValueBoxDef_ptr operator-> (void); - + private: IR_ValueBoxDef_ptr &ptr_; }; @@ -1774,17 +1774,17 @@ class TAO_Export IR_ComponentDef_var : public TAO_Base_var { public: IR_ComponentDef_var (void); // default constructor - IR_ComponentDef_var (IR_ComponentDef_ptr p) : ptr_ (p) {} + IR_ComponentDef_var (IR_ComponentDef_ptr p) : ptr_ (p) {} IR_ComponentDef_var (const IR_ComponentDef_var &); // copy constructor ~IR_ComponentDef_var (void); // destructor - + IR_ComponentDef_var &operator= (IR_ComponentDef_ptr); IR_ComponentDef_var &operator= (const IR_ComponentDef_var &); IR_ComponentDef_ptr operator-> (void) const; - + operator const IR_ComponentDef_ptr &() const; operator IR_ComponentDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_ComponentDef_ptr in (void) const; IR_ComponentDef_ptr &inout (void); IR_ComponentDef_ptr &out (void); @@ -1810,18 +1810,18 @@ public: operator IR_ComponentDef_ptr &(); IR_ComponentDef_ptr &ptr (void); IR_ComponentDef_ptr operator-> (void); - + private: IR_ComponentDef_ptr &ptr_; }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class _TAO_Unbounded_Object_Sequence_IR_ComponentDefSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Object_Sequence_IR_ComponentDefSeq (void); _TAO_Unbounded_Object_Sequence_IR_ComponentDefSeq (CORBA::ULong maximum); _TAO_Unbounded_Object_Sequence_IR_ComponentDefSeq (CORBA::ULong maximum, @@ -1843,33 +1843,33 @@ private: virtual void _downcast ( void* target, CORBA_Object *src, - CORBA_Environment &ACE_TRY_ENV = + CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual CORBA_Object* _upcast (void *src) const; - + }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_ComponentDefSeq // ************************************************************* -class TAO_Export IR_ComponentDefSeq : public +class TAO_Export IR_ComponentDefSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Object_Sequence_IR_ComponentDefSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Object_Sequence<IR_ComponentDef,IR_ComponentDef_var> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_ComponentDefSeq (void); // default ctor IR_ComponentDefSeq (CORBA::ULong max); // uses max size IR_ComponentDefSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_ComponentDef_ptr *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_ComponentDef_ptr *buffer, CORBA::Boolean release = 0 ); IR_ComponentDefSeq (const IR_ComponentDefSeq &); // copy ctor @@ -1893,20 +1893,20 @@ public: IR_ComponentDefSeq_var (IR_ComponentDefSeq *); IR_ComponentDefSeq_var (const IR_ComponentDefSeq_var &); // copy constructor ~IR_ComponentDefSeq_var (void); // destructor - + IR_ComponentDefSeq_var &operator= (IR_ComponentDefSeq *); IR_ComponentDefSeq_var &operator= (const IR_ComponentDefSeq_var &); IR_ComponentDefSeq *operator-> (void); const IR_ComponentDefSeq *operator-> (void) const; - + operator const IR_ComponentDefSeq &() const; operator IR_ComponentDefSeq &(); operator IR_ComponentDefSeq &() const; operator IR_ComponentDefSeq *&(); // variable-size base types only - + TAO_Object_Manager<IR_ComponentDef, IR_ComponentDef_var> operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ComponentDefSeq &in (void) const; IR_ComponentDefSeq &inout (void); IR_ComponentDefSeq *&out (void); @@ -1929,7 +1929,7 @@ public: IR_ComponentDefSeq *&ptr (void); IR_ComponentDefSeq *operator-> (void); TAO_Object_Manager<IR_ComponentDef, IR_ComponentDef_var> operator[] (CORBA::ULong index); - + private: IR_ComponentDefSeq *&ptr_; // assignment from T_var not allowed @@ -1940,17 +1940,17 @@ class TAO_Export IR_ProvidesDef_var : public TAO_Base_var { public: IR_ProvidesDef_var (void); // default constructor - IR_ProvidesDef_var (IR_ProvidesDef_ptr p) : ptr_ (p) {} + IR_ProvidesDef_var (IR_ProvidesDef_ptr p) : ptr_ (p) {} IR_ProvidesDef_var (const IR_ProvidesDef_var &); // copy constructor ~IR_ProvidesDef_var (void); // destructor - + IR_ProvidesDef_var &operator= (IR_ProvidesDef_ptr); IR_ProvidesDef_var &operator= (const IR_ProvidesDef_var &); IR_ProvidesDef_ptr operator-> (void) const; - + operator const IR_ProvidesDef_ptr &() const; operator IR_ProvidesDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_ProvidesDef_ptr in (void) const; IR_ProvidesDef_ptr &inout (void); IR_ProvidesDef_ptr &out (void); @@ -1976,18 +1976,18 @@ public: operator IR_ProvidesDef_ptr &(); IR_ProvidesDef_ptr &ptr (void); IR_ProvidesDef_ptr operator-> (void); - + private: IR_ProvidesDef_ptr &ptr_; }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class _TAO_Unbounded_Object_Sequence_IR_ProvidesDefSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Object_Sequence_IR_ProvidesDefSeq (void); _TAO_Unbounded_Object_Sequence_IR_ProvidesDefSeq (CORBA::ULong maximum); _TAO_Unbounded_Object_Sequence_IR_ProvidesDefSeq (CORBA::ULong maximum, @@ -2009,33 +2009,33 @@ private: virtual void _downcast ( void* target, CORBA_Object *src, - CORBA_Environment &ACE_TRY_ENV = + CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual CORBA_Object* _upcast (void *src) const; - + }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_ProvidesDefSeq // ************************************************************* -class TAO_Export IR_ProvidesDefSeq : public +class TAO_Export IR_ProvidesDefSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Object_Sequence_IR_ProvidesDefSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Object_Sequence<IR_ProvidesDef,IR_ProvidesDef_var> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_ProvidesDefSeq (void); // default ctor IR_ProvidesDefSeq (CORBA::ULong max); // uses max size IR_ProvidesDefSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_ProvidesDef_ptr *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_ProvidesDef_ptr *buffer, CORBA::Boolean release = 0 ); IR_ProvidesDefSeq (const IR_ProvidesDefSeq &); // copy ctor @@ -2059,20 +2059,20 @@ public: IR_ProvidesDefSeq_var (IR_ProvidesDefSeq *); IR_ProvidesDefSeq_var (const IR_ProvidesDefSeq_var &); // copy constructor ~IR_ProvidesDefSeq_var (void); // destructor - + IR_ProvidesDefSeq_var &operator= (IR_ProvidesDefSeq *); IR_ProvidesDefSeq_var &operator= (const IR_ProvidesDefSeq_var &); IR_ProvidesDefSeq *operator-> (void); const IR_ProvidesDefSeq *operator-> (void) const; - + operator const IR_ProvidesDefSeq &() const; operator IR_ProvidesDefSeq &(); operator IR_ProvidesDefSeq &() const; operator IR_ProvidesDefSeq *&(); // variable-size base types only - + TAO_Object_Manager<IR_ProvidesDef, IR_ProvidesDef_var> operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ProvidesDefSeq &in (void) const; IR_ProvidesDefSeq &inout (void); IR_ProvidesDefSeq *&out (void); @@ -2095,7 +2095,7 @@ public: IR_ProvidesDefSeq *&ptr (void); IR_ProvidesDefSeq *operator-> (void); TAO_Object_Manager<IR_ProvidesDef, IR_ProvidesDef_var> operator[] (CORBA::ULong index); - + private: IR_ProvidesDefSeq *&ptr_; // assignment from T_var not allowed @@ -2106,17 +2106,17 @@ class TAO_Export IR_UsesDef_var : public TAO_Base_var { public: IR_UsesDef_var (void); // default constructor - IR_UsesDef_var (IR_UsesDef_ptr p) : ptr_ (p) {} + IR_UsesDef_var (IR_UsesDef_ptr p) : ptr_ (p) {} IR_UsesDef_var (const IR_UsesDef_var &); // copy constructor ~IR_UsesDef_var (void); // destructor - + IR_UsesDef_var &operator= (IR_UsesDef_ptr); IR_UsesDef_var &operator= (const IR_UsesDef_var &); IR_UsesDef_ptr operator-> (void) const; - + operator const IR_UsesDef_ptr &() const; operator IR_UsesDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_UsesDef_ptr in (void) const; IR_UsesDef_ptr &inout (void); IR_UsesDef_ptr &out (void); @@ -2142,18 +2142,18 @@ public: operator IR_UsesDef_ptr &(); IR_UsesDef_ptr &ptr (void); IR_UsesDef_ptr operator-> (void); - + private: IR_UsesDef_ptr &ptr_; }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class _TAO_Unbounded_Object_Sequence_IR_UsesDefSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Object_Sequence_IR_UsesDefSeq (void); _TAO_Unbounded_Object_Sequence_IR_UsesDefSeq (CORBA::ULong maximum); _TAO_Unbounded_Object_Sequence_IR_UsesDefSeq (CORBA::ULong maximum, @@ -2175,33 +2175,33 @@ private: virtual void _downcast ( void* target, CORBA_Object *src, - CORBA_Environment &ACE_TRY_ENV = + CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual CORBA_Object* _upcast (void *src) const; - + }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_UsesDefSeq // ************************************************************* -class TAO_Export IR_UsesDefSeq : public +class TAO_Export IR_UsesDefSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Object_Sequence_IR_UsesDefSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Object_Sequence<IR_UsesDef,IR_UsesDef_var> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_UsesDefSeq (void); // default ctor IR_UsesDefSeq (CORBA::ULong max); // uses max size IR_UsesDefSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_UsesDef_ptr *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_UsesDef_ptr *buffer, CORBA::Boolean release = 0 ); IR_UsesDefSeq (const IR_UsesDefSeq &); // copy ctor @@ -2225,20 +2225,20 @@ public: IR_UsesDefSeq_var (IR_UsesDefSeq *); IR_UsesDefSeq_var (const IR_UsesDefSeq_var &); // copy constructor ~IR_UsesDefSeq_var (void); // destructor - + IR_UsesDefSeq_var &operator= (IR_UsesDefSeq *); IR_UsesDefSeq_var &operator= (const IR_UsesDefSeq_var &); IR_UsesDefSeq *operator-> (void); const IR_UsesDefSeq *operator-> (void) const; - + operator const IR_UsesDefSeq &() const; operator IR_UsesDefSeq &(); operator IR_UsesDefSeq &() const; operator IR_UsesDefSeq *&(); // variable-size base types only - + TAO_Object_Manager<IR_UsesDef, IR_UsesDef_var> operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_UsesDefSeq &in (void) const; IR_UsesDefSeq &inout (void); IR_UsesDefSeq *&out (void); @@ -2261,7 +2261,7 @@ public: IR_UsesDefSeq *&ptr (void); IR_UsesDefSeq *operator-> (void); TAO_Object_Manager<IR_UsesDef, IR_UsesDef_var> operator[] (CORBA::ULong index); - + private: IR_UsesDefSeq *&ptr_; // assignment from T_var not allowed @@ -2272,17 +2272,17 @@ class TAO_Export IR_HomeDef_var : public TAO_Base_var { public: IR_HomeDef_var (void); // default constructor - IR_HomeDef_var (IR_HomeDef_ptr p) : ptr_ (p) {} + IR_HomeDef_var (IR_HomeDef_ptr p) : ptr_ (p) {} IR_HomeDef_var (const IR_HomeDef_var &); // copy constructor ~IR_HomeDef_var (void); // destructor - + IR_HomeDef_var &operator= (IR_HomeDef_ptr); IR_HomeDef_var &operator= (const IR_HomeDef_var &); IR_HomeDef_ptr operator-> (void) const; - + operator const IR_HomeDef_ptr &() const; operator IR_HomeDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_HomeDef_ptr in (void) const; IR_HomeDef_ptr &inout (void); IR_HomeDef_ptr &out (void); @@ -2308,19 +2308,19 @@ public: operator IR_HomeDef_ptr &(); IR_HomeDef_ptr &ptr (void); IR_HomeDef_ptr operator-> (void); - + private: IR_HomeDef_ptr &ptr_; }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class _TAO_Unbounded_Object_Sequence_IR_HomeDefSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Object_Sequence_IR_HomeDefSeq (void); _TAO_Unbounded_Object_Sequence_IR_HomeDefSeq (CORBA::ULong maximum); _TAO_Unbounded_Object_Sequence_IR_HomeDefSeq (CORBA::ULong maximum, @@ -2342,33 +2342,33 @@ private: virtual void _downcast ( void* target, CORBA_Object *src, - CORBA_Environment &ACE_TRY_ENV = + CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual CORBA_Object* _upcast (void *src) const; - + }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_HomeDefSeq // ************************************************************* -class TAO_Export IR_HomeDefSeq : public +class TAO_Export IR_HomeDefSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Object_Sequence_IR_HomeDefSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Object_Sequence<IR_HomeDef,IR_HomeDef_var> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_HomeDefSeq (void); // default ctor IR_HomeDefSeq (CORBA::ULong max); // uses max size IR_HomeDefSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_HomeDef_ptr *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_HomeDef_ptr *buffer, CORBA::Boolean release = 0 ); IR_HomeDefSeq (const IR_HomeDefSeq &); // copy ctor @@ -2392,20 +2392,20 @@ public: IR_HomeDefSeq_var (IR_HomeDefSeq *); IR_HomeDefSeq_var (const IR_HomeDefSeq_var &); // copy constructor ~IR_HomeDefSeq_var (void); // destructor - + IR_HomeDefSeq_var &operator= (IR_HomeDefSeq *); IR_HomeDefSeq_var &operator= (const IR_HomeDefSeq_var &); IR_HomeDefSeq *operator-> (void); const IR_HomeDefSeq *operator-> (void) const; - + operator const IR_HomeDefSeq &() const; operator IR_HomeDefSeq &(); operator IR_HomeDefSeq &() const; operator IR_HomeDefSeq *&(); // variable-size base types only - + TAO_Object_Manager<IR_HomeDef, IR_HomeDef_var> operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_HomeDefSeq &in (void) const; IR_HomeDefSeq &inout (void); IR_HomeDefSeq *&out (void); @@ -2428,7 +2428,7 @@ public: IR_HomeDefSeq *&ptr (void); IR_HomeDefSeq *operator-> (void); TAO_Object_Manager<IR_HomeDef, IR_HomeDef_var> operator[] (CORBA::ULong index); - + private: IR_HomeDefSeq *&ptr_; // assignment from T_var not allowed @@ -2439,17 +2439,17 @@ class TAO_Export IR_EventDef_var : public TAO_Base_var { public: IR_EventDef_var (void); // default constructor - IR_EventDef_var (IR_EventDef_ptr p) : ptr_ (p) {} + IR_EventDef_var (IR_EventDef_ptr p) : ptr_ (p) {} IR_EventDef_var (const IR_EventDef_var &); // copy constructor ~IR_EventDef_var (void); // destructor - + IR_EventDef_var &operator= (IR_EventDef_ptr); IR_EventDef_var &operator= (const IR_EventDef_var &); IR_EventDef_ptr operator-> (void) const; - + operator const IR_EventDef_ptr &() const; operator IR_EventDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_EventDef_ptr in (void) const; IR_EventDef_ptr &inout (void); IR_EventDef_ptr &out (void); @@ -2475,7 +2475,7 @@ public: operator IR_EventDef_ptr &(); IR_EventDef_ptr &ptr (void); IR_EventDef_ptr operator-> (void); - + private: IR_EventDef_ptr &ptr_; }; @@ -2484,17 +2484,17 @@ class TAO_Export IR_EmitsDef_var : public TAO_Base_var { public: IR_EmitsDef_var (void); // default constructor - IR_EmitsDef_var (IR_EmitsDef_ptr p) : ptr_ (p) {} + IR_EmitsDef_var (IR_EmitsDef_ptr p) : ptr_ (p) {} IR_EmitsDef_var (const IR_EmitsDef_var &); // copy constructor ~IR_EmitsDef_var (void); // destructor - + IR_EmitsDef_var &operator= (IR_EmitsDef_ptr); IR_EmitsDef_var &operator= (const IR_EmitsDef_var &); IR_EmitsDef_ptr operator-> (void) const; - + operator const IR_EmitsDef_ptr &() const; operator IR_EmitsDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_EmitsDef_ptr in (void) const; IR_EmitsDef_ptr &inout (void); IR_EmitsDef_ptr &out (void); @@ -2520,18 +2520,18 @@ public: operator IR_EmitsDef_ptr &(); IR_EmitsDef_ptr &ptr (void); IR_EmitsDef_ptr operator-> (void); - + private: IR_EmitsDef_ptr &ptr_; }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class _TAO_Unbounded_Object_Sequence_IR_EmitsDefSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Object_Sequence_IR_EmitsDefSeq (void); _TAO_Unbounded_Object_Sequence_IR_EmitsDefSeq (CORBA::ULong maximum); _TAO_Unbounded_Object_Sequence_IR_EmitsDefSeq (CORBA::ULong maximum, @@ -2553,33 +2553,33 @@ private: virtual void _downcast ( void* target, CORBA_Object *src, - CORBA_Environment &ACE_TRY_ENV = + CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual CORBA_Object* _upcast (void *src) const; - + }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_EmitsDefSeq // ************************************************************* -class TAO_Export IR_EmitsDefSeq : public +class TAO_Export IR_EmitsDefSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Object_Sequence_IR_EmitsDefSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Object_Sequence<IR_EmitsDef,IR_EmitsDef_var> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_EmitsDefSeq (void); // default ctor IR_EmitsDefSeq (CORBA::ULong max); // uses max size IR_EmitsDefSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_EmitsDef_ptr *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_EmitsDef_ptr *buffer, CORBA::Boolean release = 0 ); IR_EmitsDefSeq (const IR_EmitsDefSeq &); // copy ctor @@ -2603,20 +2603,20 @@ public: IR_EmitsDefSeq_var (IR_EmitsDefSeq *); IR_EmitsDefSeq_var (const IR_EmitsDefSeq_var &); // copy constructor ~IR_EmitsDefSeq_var (void); // destructor - + IR_EmitsDefSeq_var &operator= (IR_EmitsDefSeq *); IR_EmitsDefSeq_var &operator= (const IR_EmitsDefSeq_var &); IR_EmitsDefSeq *operator-> (void); const IR_EmitsDefSeq *operator-> (void) const; - + operator const IR_EmitsDefSeq &() const; operator IR_EmitsDefSeq &(); operator IR_EmitsDefSeq &() const; operator IR_EmitsDefSeq *&(); // variable-size base types only - + TAO_Object_Manager<IR_EmitsDef, IR_EmitsDef_var> operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_EmitsDefSeq &in (void) const; IR_EmitsDefSeq &inout (void); IR_EmitsDefSeq *&out (void); @@ -2639,7 +2639,7 @@ public: IR_EmitsDefSeq *&ptr (void); IR_EmitsDefSeq *operator-> (void); TAO_Object_Manager<IR_EmitsDef, IR_EmitsDef_var> operator[] (CORBA::ULong index); - + private: IR_EmitsDefSeq *&ptr_; // assignment from T_var not allowed @@ -2650,17 +2650,17 @@ class TAO_Export IR_PublishesDef_var : public TAO_Base_var { public: IR_PublishesDef_var (void); // default constructor - IR_PublishesDef_var (IR_PublishesDef_ptr p) : ptr_ (p) {} + IR_PublishesDef_var (IR_PublishesDef_ptr p) : ptr_ (p) {} IR_PublishesDef_var (const IR_PublishesDef_var &); // copy constructor ~IR_PublishesDef_var (void); // destructor - + IR_PublishesDef_var &operator= (IR_PublishesDef_ptr); IR_PublishesDef_var &operator= (const IR_PublishesDef_var &); IR_PublishesDef_ptr operator-> (void) const; - + operator const IR_PublishesDef_ptr &() const; operator IR_PublishesDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_PublishesDef_ptr in (void) const; IR_PublishesDef_ptr &inout (void); IR_PublishesDef_ptr &out (void); @@ -2686,18 +2686,18 @@ public: operator IR_PublishesDef_ptr &(); IR_PublishesDef_ptr &ptr (void); IR_PublishesDef_ptr operator-> (void); - + private: IR_PublishesDef_ptr &ptr_; }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class _TAO_Unbounded_Object_Sequence_IR_PublishesDefSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Object_Sequence_IR_PublishesDefSeq (void); _TAO_Unbounded_Object_Sequence_IR_PublishesDefSeq (CORBA::ULong maximum); _TAO_Unbounded_Object_Sequence_IR_PublishesDefSeq (CORBA::ULong maximum, @@ -2719,33 +2719,33 @@ private: virtual void _downcast ( void* target, CORBA_Object *src, - CORBA_Environment &ACE_TRY_ENV = + CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual CORBA_Object* _upcast (void *src) const; - + }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_PublishesDefSeq // ************************************************************* -class TAO_Export IR_PublishesDefSeq : public +class TAO_Export IR_PublishesDefSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Object_Sequence_IR_PublishesDefSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Object_Sequence<IR_PublishesDef,IR_PublishesDef_var> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_PublishesDefSeq (void); // default ctor IR_PublishesDefSeq (CORBA::ULong max); // uses max size IR_PublishesDefSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_PublishesDef_ptr *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_PublishesDef_ptr *buffer, CORBA::Boolean release = 0 ); IR_PublishesDefSeq (const IR_PublishesDefSeq &); // copy ctor @@ -2769,20 +2769,20 @@ public: IR_PublishesDefSeq_var (IR_PublishesDefSeq *); IR_PublishesDefSeq_var (const IR_PublishesDefSeq_var &); // copy constructor ~IR_PublishesDefSeq_var (void); // destructor - + IR_PublishesDefSeq_var &operator= (IR_PublishesDefSeq *); IR_PublishesDefSeq_var &operator= (const IR_PublishesDefSeq_var &); IR_PublishesDefSeq *operator-> (void); const IR_PublishesDefSeq *operator-> (void) const; - + operator const IR_PublishesDefSeq &() const; operator IR_PublishesDefSeq &(); operator IR_PublishesDefSeq &() const; operator IR_PublishesDefSeq *&(); // variable-size base types only - + TAO_Object_Manager<IR_PublishesDef, IR_PublishesDef_var> operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_PublishesDefSeq &in (void) const; IR_PublishesDefSeq &inout (void); IR_PublishesDefSeq *&out (void); @@ -2805,7 +2805,7 @@ public: IR_PublishesDefSeq *&ptr (void); IR_PublishesDefSeq *operator-> (void); TAO_Object_Manager<IR_PublishesDef, IR_PublishesDef_var> operator[] (CORBA::ULong index); - + private: IR_PublishesDefSeq *&ptr_; // assignment from T_var not allowed @@ -2816,17 +2816,17 @@ class TAO_Export IR_ConsumesDef_var : public TAO_Base_var { public: IR_ConsumesDef_var (void); // default constructor - IR_ConsumesDef_var (IR_ConsumesDef_ptr p) : ptr_ (p) {} + IR_ConsumesDef_var (IR_ConsumesDef_ptr p) : ptr_ (p) {} IR_ConsumesDef_var (const IR_ConsumesDef_var &); // copy constructor ~IR_ConsumesDef_var (void); // destructor - + IR_ConsumesDef_var &operator= (IR_ConsumesDef_ptr); IR_ConsumesDef_var &operator= (const IR_ConsumesDef_var &); IR_ConsumesDef_ptr operator-> (void) const; - + operator const IR_ConsumesDef_ptr &() const; operator IR_ConsumesDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_ConsumesDef_ptr in (void) const; IR_ConsumesDef_ptr &inout (void); IR_ConsumesDef_ptr &out (void); @@ -2852,18 +2852,18 @@ public: operator IR_ConsumesDef_ptr &(); IR_ConsumesDef_ptr &ptr (void); IR_ConsumesDef_ptr operator-> (void); - + private: IR_ConsumesDef_ptr &ptr_; }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class _TAO_Unbounded_Object_Sequence_IR_ConsumesDefSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Object_Sequence_IR_ConsumesDefSeq (void); _TAO_Unbounded_Object_Sequence_IR_ConsumesDefSeq (CORBA::ULong maximum); _TAO_Unbounded_Object_Sequence_IR_ConsumesDefSeq (CORBA::ULong maximum, @@ -2885,33 +2885,33 @@ private: virtual void _downcast ( void* target, CORBA_Object *src, - CORBA_Environment &ACE_TRY_ENV = + CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual CORBA_Object* _upcast (void *src) const; - + }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_ConsumesDefSeq // ************************************************************* -class TAO_Export IR_ConsumesDefSeq : public +class TAO_Export IR_ConsumesDefSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Object_Sequence_IR_ConsumesDefSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Object_Sequence<IR_ConsumesDef,IR_ConsumesDef_var> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_ConsumesDefSeq (void); // default ctor IR_ConsumesDefSeq (CORBA::ULong max); // uses max size IR_ConsumesDefSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_ConsumesDef_ptr *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_ConsumesDef_ptr *buffer, CORBA::Boolean release = 0 ); IR_ConsumesDefSeq (const IR_ConsumesDefSeq &); // copy ctor @@ -2935,20 +2935,20 @@ public: IR_ConsumesDefSeq_var (IR_ConsumesDefSeq *); IR_ConsumesDefSeq_var (const IR_ConsumesDefSeq_var &); // copy constructor ~IR_ConsumesDefSeq_var (void); // destructor - + IR_ConsumesDefSeq_var &operator= (IR_ConsumesDefSeq *); IR_ConsumesDefSeq_var &operator= (const IR_ConsumesDefSeq_var &); IR_ConsumesDefSeq *operator-> (void); const IR_ConsumesDefSeq *operator-> (void) const; - + operator const IR_ConsumesDefSeq &() const; operator IR_ConsumesDefSeq &(); operator IR_ConsumesDefSeq &() const; operator IR_ConsumesDefSeq *&(); // variable-size base types only - + TAO_Object_Manager<IR_ConsumesDef, IR_ConsumesDef_var> operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ConsumesDefSeq &in (void) const; IR_ConsumesDefSeq &inout (void); IR_ConsumesDefSeq *&out (void); @@ -2971,7 +2971,7 @@ public: IR_ConsumesDefSeq *&ptr (void); IR_ConsumesDefSeq *operator-> (void); TAO_Object_Manager<IR_ConsumesDef, IR_ConsumesDef_var> operator[] (CORBA::ULong index); - + private: IR_ConsumesDefSeq *&ptr_; // assignment from T_var not allowed @@ -2982,17 +2982,17 @@ class TAO_Export IR_FactoryDef_var : public TAO_Base_var { public: IR_FactoryDef_var (void); // default constructor - IR_FactoryDef_var (IR_FactoryDef_ptr p) : ptr_ (p) {} + IR_FactoryDef_var (IR_FactoryDef_ptr p) : ptr_ (p) {} IR_FactoryDef_var (const IR_FactoryDef_var &); // copy constructor ~IR_FactoryDef_var (void); // destructor - + IR_FactoryDef_var &operator= (IR_FactoryDef_ptr); IR_FactoryDef_var &operator= (const IR_FactoryDef_var &); IR_FactoryDef_ptr operator-> (void) const; - + operator const IR_FactoryDef_ptr &() const; operator IR_FactoryDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_FactoryDef_ptr in (void) const; IR_FactoryDef_ptr &inout (void); IR_FactoryDef_ptr &out (void); @@ -3018,18 +3018,18 @@ public: operator IR_FactoryDef_ptr &(); IR_FactoryDef_ptr &ptr (void); IR_FactoryDef_ptr operator-> (void); - + private: IR_FactoryDef_ptr &ptr_; }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class _TAO_Unbounded_Object_Sequence_IR_FactoryDefSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Object_Sequence_IR_FactoryDefSeq (void); _TAO_Unbounded_Object_Sequence_IR_FactoryDefSeq (CORBA::ULong maximum); _TAO_Unbounded_Object_Sequence_IR_FactoryDefSeq (CORBA::ULong maximum, @@ -3051,33 +3051,33 @@ private: virtual void _downcast ( void* target, CORBA_Object *src, - CORBA_Environment &ACE_TRY_ENV = + CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual CORBA_Object* _upcast (void *src) const; - + }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_FactoryDefSeq // ************************************************************* -class TAO_Export IR_FactoryDefSeq : public +class TAO_Export IR_FactoryDefSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Object_Sequence_IR_FactoryDefSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Object_Sequence<IR_FactoryDef,IR_FactoryDef_var> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_FactoryDefSeq (void); // default ctor IR_FactoryDefSeq (CORBA::ULong max); // uses max size IR_FactoryDefSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_FactoryDef_ptr *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_FactoryDef_ptr *buffer, CORBA::Boolean release = 0 ); IR_FactoryDefSeq (const IR_FactoryDefSeq &); // copy ctor @@ -3101,20 +3101,20 @@ public: IR_FactoryDefSeq_var (IR_FactoryDefSeq *); IR_FactoryDefSeq_var (const IR_FactoryDefSeq_var &); // copy constructor ~IR_FactoryDefSeq_var (void); // destructor - + IR_FactoryDefSeq_var &operator= (IR_FactoryDefSeq *); IR_FactoryDefSeq_var &operator= (const IR_FactoryDefSeq_var &); IR_FactoryDefSeq *operator-> (void); const IR_FactoryDefSeq *operator-> (void) const; - + operator const IR_FactoryDefSeq &() const; operator IR_FactoryDefSeq &(); operator IR_FactoryDefSeq &() const; operator IR_FactoryDefSeq *&(); // variable-size base types only - + TAO_Object_Manager<IR_FactoryDef, IR_FactoryDef_var> operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_FactoryDefSeq &in (void) const; IR_FactoryDefSeq &inout (void); IR_FactoryDefSeq *&out (void); @@ -3137,7 +3137,7 @@ public: IR_FactoryDefSeq *&ptr (void); IR_FactoryDefSeq *operator-> (void); TAO_Object_Manager<IR_FactoryDef, IR_FactoryDef_var> operator[] (CORBA::ULong index); - + private: IR_FactoryDefSeq *&ptr_; // assignment from T_var not allowed @@ -3148,17 +3148,17 @@ class TAO_Export IR_FinderDef_var : public TAO_Base_var { public: IR_FinderDef_var (void); // default constructor - IR_FinderDef_var (IR_FinderDef_ptr p) : ptr_ (p) {} + IR_FinderDef_var (IR_FinderDef_ptr p) : ptr_ (p) {} IR_FinderDef_var (const IR_FinderDef_var &); // copy constructor ~IR_FinderDef_var (void); // destructor - + IR_FinderDef_var &operator= (IR_FinderDef_ptr); IR_FinderDef_var &operator= (const IR_FinderDef_var &); IR_FinderDef_ptr operator-> (void) const; - + operator const IR_FinderDef_ptr &() const; operator IR_FinderDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_FinderDef_ptr in (void) const; IR_FinderDef_ptr &inout (void); IR_FinderDef_ptr &out (void); @@ -3184,18 +3184,18 @@ public: operator IR_FinderDef_ptr &(); IR_FinderDef_ptr &ptr (void); IR_FinderDef_ptr operator-> (void); - + private: IR_FinderDef_ptr &ptr_; }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class _TAO_Unbounded_Object_Sequence_IR_FinderDefSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Object_Sequence_IR_FinderDefSeq (void); _TAO_Unbounded_Object_Sequence_IR_FinderDefSeq (CORBA::ULong maximum); _TAO_Unbounded_Object_Sequence_IR_FinderDefSeq (CORBA::ULong maximum, @@ -3217,33 +3217,33 @@ private: virtual void _downcast ( void* target, CORBA_Object *src, - CORBA_Environment &ACE_TRY_ENV = + CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual CORBA_Object* _upcast (void *src) const; - + }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_FinderDefSeq // ************************************************************* -class TAO_Export IR_FinderDefSeq : public +class TAO_Export IR_FinderDefSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Object_Sequence_IR_FinderDefSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Object_Sequence<IR_FinderDef,IR_FinderDef_var> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_FinderDefSeq (void); // default ctor IR_FinderDefSeq (CORBA::ULong max); // uses max size IR_FinderDefSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_FinderDef_ptr *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_FinderDef_ptr *buffer, CORBA::Boolean release = 0 ); IR_FinderDefSeq (const IR_FinderDefSeq &); // copy ctor @@ -3267,20 +3267,20 @@ public: IR_FinderDefSeq_var (IR_FinderDefSeq *); IR_FinderDefSeq_var (const IR_FinderDefSeq_var &); // copy constructor ~IR_FinderDefSeq_var (void); // destructor - + IR_FinderDefSeq_var &operator= (IR_FinderDefSeq *); IR_FinderDefSeq_var &operator= (const IR_FinderDefSeq_var &); IR_FinderDefSeq *operator-> (void); const IR_FinderDefSeq *operator-> (void) const; - + operator const IR_FinderDefSeq &() const; operator IR_FinderDefSeq &(); operator IR_FinderDefSeq &() const; operator IR_FinderDefSeq *&(); // variable-size base types only - + TAO_Object_Manager<IR_FinderDef, IR_FinderDef_var> operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_FinderDefSeq &in (void) const; IR_FinderDefSeq &inout (void); IR_FinderDefSeq *&out (void); @@ -3303,7 +3303,7 @@ public: IR_FinderDefSeq *&ptr (void); IR_FinderDefSeq *operator-> (void); TAO_Object_Manager<IR_FinderDef, IR_FinderDef_var> operator[] (CORBA::ULong index); - + private: IR_FinderDefSeq *&ptr_; // assignment from T_var not allowed @@ -3314,17 +3314,17 @@ class TAO_Export IR_PrimaryKeyDef_var : public TAO_Base_var { public: IR_PrimaryKeyDef_var (void); // default constructor - IR_PrimaryKeyDef_var (IR_PrimaryKeyDef_ptr p) : ptr_ (p) {} + IR_PrimaryKeyDef_var (IR_PrimaryKeyDef_ptr p) : ptr_ (p) {} IR_PrimaryKeyDef_var (const IR_PrimaryKeyDef_var &); // copy constructor ~IR_PrimaryKeyDef_var (void); // destructor - + IR_PrimaryKeyDef_var &operator= (IR_PrimaryKeyDef_ptr); IR_PrimaryKeyDef_var &operator= (const IR_PrimaryKeyDef_var &); IR_PrimaryKeyDef_ptr operator-> (void) const; - + operator const IR_PrimaryKeyDef_ptr &() const; operator IR_PrimaryKeyDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_PrimaryKeyDef_ptr in (void) const; IR_PrimaryKeyDef_ptr &inout (void); IR_PrimaryKeyDef_ptr &out (void); @@ -3350,18 +3350,18 @@ public: operator IR_PrimaryKeyDef_ptr &(); IR_PrimaryKeyDef_ptr &ptr (void); IR_PrimaryKeyDef_ptr operator-> (void); - + private: IR_PrimaryKeyDef_ptr &ptr_; }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class _TAO_Unbounded_Object_Sequence_IR_ContainedSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Object_Sequence_IR_ContainedSeq (void); _TAO_Unbounded_Object_Sequence_IR_ContainedSeq (CORBA::ULong maximum); _TAO_Unbounded_Object_Sequence_IR_ContainedSeq (CORBA::ULong maximum, @@ -3383,33 +3383,33 @@ private: virtual void _downcast ( void* target, CORBA_Object *src, - CORBA_Environment &ACE_TRY_ENV = + CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual CORBA_Object* _upcast (void *src) const; - + }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_ContainedSeq // ************************************************************* -class TAO_Export IR_ContainedSeq : public +class TAO_Export IR_ContainedSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Object_Sequence_IR_ContainedSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Object_Sequence<IR_Contained,IR_Contained_var> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_ContainedSeq (void); // default ctor IR_ContainedSeq (CORBA::ULong max); // uses max size IR_ContainedSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_Contained_ptr *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_Contained_ptr *buffer, CORBA::Boolean release = 0 ); IR_ContainedSeq (const IR_ContainedSeq &); // copy ctor @@ -3433,20 +3433,20 @@ public: IR_ContainedSeq_var (IR_ContainedSeq *); IR_ContainedSeq_var (const IR_ContainedSeq_var &); // copy constructor ~IR_ContainedSeq_var (void); // destructor - + IR_ContainedSeq_var &operator= (IR_ContainedSeq *); IR_ContainedSeq_var &operator= (const IR_ContainedSeq_var &); IR_ContainedSeq *operator-> (void); const IR_ContainedSeq *operator-> (void) const; - + operator const IR_ContainedSeq &() const; operator IR_ContainedSeq &(); operator IR_ContainedSeq &() const; operator IR_ContainedSeq *&(); // variable-size base types only - + TAO_Object_Manager<IR_Contained, IR_Contained_var> operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ContainedSeq &in (void) const; IR_ContainedSeq &inout (void); IR_ContainedSeq *&out (void); @@ -3470,7 +3470,7 @@ public: IR_ContainedSeq *&ptr (void); IR_ContainedSeq *operator-> (void); TAO_Object_Manager<IR_Contained, IR_Contained_var> operator[] (CORBA::ULong index); - + private: IR_ContainedSeq *&ptr_; // assignment from T_var not allowed @@ -3498,18 +3498,18 @@ public: IR_StructMember_var (IR_StructMember *); IR_StructMember_var (const IR_StructMember_var &); // copy constructor ~IR_StructMember_var (void); // destructor - + IR_StructMember_var &operator= (IR_StructMember *); IR_StructMember_var &operator= (const IR_StructMember_var &); IR_StructMember *operator-> (void); const IR_StructMember *operator-> (void) const; - + operator const IR_StructMember &() const; operator IR_StructMember &(); operator IR_StructMember &() const; operator IR_StructMember *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_StructMember &in (void) const; IR_StructMember &inout (void); IR_StructMember *&out (void); @@ -3531,7 +3531,7 @@ public: operator IR_StructMember *&(); IR_StructMember *&ptr (void); IR_StructMember *operator-> (void); - + private: IR_StructMember *&ptr_; // assignment from T_var not allowed @@ -3539,14 +3539,14 @@ private: }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class TAO_EXPORT_NESTED_MACRO _TAO_Unbounded_Sequence_IR_StructMemberSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Sequence_IR_StructMemberSeq (void); // Default constructor. - _TAO_Unbounded_Sequence_IR_StructMemberSeq (CORBA::ULong maximum); + _TAO_Unbounded_Sequence_IR_StructMemberSeq (CORBA::ULong maximum); _TAO_Unbounded_Sequence_IR_StructMemberSeq (CORBA::ULong maximum, CORBA::ULong length, IR_StructMember *data, @@ -3563,7 +3563,7 @@ private: virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); // Implement the TAO_Base_Sequence methods (see Sequence.h) - + IR_StructMember *get_buffer (CORBA::Boolean orphan = 0); const IR_StructMember *get_buffer (void) const; void replace (CORBA::ULong max, @@ -3572,26 +3572,26 @@ private: CORBA::Boolean release); }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_StructMemberSeq // ************************************************************* -class TAO_Export IR_StructMemberSeq : public +class TAO_Export IR_StructMemberSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Sequence_IR_StructMemberSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Sequence<IR_StructMember> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_StructMemberSeq (void); // default ctor IR_StructMemberSeq (CORBA::ULong max); // uses max size IR_StructMemberSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_StructMember *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_StructMember *buffer, CORBA::Boolean release = 0 ); IR_StructMemberSeq (const IR_StructMemberSeq &); // copy ctor @@ -3615,21 +3615,21 @@ public: IR_StructMemberSeq_var (IR_StructMemberSeq *); IR_StructMemberSeq_var (const IR_StructMemberSeq_var &); // copy constructor ~IR_StructMemberSeq_var (void); // destructor - + IR_StructMemberSeq_var &operator= (IR_StructMemberSeq *); IR_StructMemberSeq_var &operator= (const IR_StructMemberSeq_var &); IR_StructMemberSeq *operator-> (void); const IR_StructMemberSeq *operator-> (void) const; - + operator const IR_StructMemberSeq &() const; operator IR_StructMemberSeq &(); operator IR_StructMemberSeq &() const; operator IR_StructMemberSeq *&(); // variable-size base types only - + IR_StructMember & operator[] (CORBA::ULong index); const IR_StructMember & operator[] (CORBA::ULong index) const; - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_StructMemberSeq &in (void) const; IR_StructMemberSeq &inout (void); IR_StructMemberSeq *&out (void); @@ -3652,7 +3652,7 @@ public: IR_StructMemberSeq *&ptr (void); IR_StructMemberSeq *operator-> (void); IR_StructMember & operator[] (CORBA::ULong index); - + private: IR_StructMemberSeq *&ptr_; // assignment from T_var not allowed @@ -3679,18 +3679,18 @@ public: IR_Initializer_var (IR_Initializer *); IR_Initializer_var (const IR_Initializer_var &); // copy constructor ~IR_Initializer_var (void); // destructor - + IR_Initializer_var &operator= (IR_Initializer *); IR_Initializer_var &operator= (const IR_Initializer_var &); IR_Initializer *operator-> (void); const IR_Initializer *operator-> (void) const; - + operator const IR_Initializer &() const; operator IR_Initializer &(); operator IR_Initializer &() const; operator IR_Initializer *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_Initializer &in (void) const; IR_Initializer &inout (void); IR_Initializer *&out (void); @@ -3712,7 +3712,7 @@ public: operator IR_Initializer *&(); IR_Initializer *&ptr (void); IR_Initializer *operator-> (void); - + private: IR_Initializer *&ptr_; // assignment from T_var not allowed @@ -3720,14 +3720,14 @@ private: }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class TAO_EXPORT_NESTED_MACRO _TAO_Unbounded_Sequence_IR_InitializerSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Sequence_IR_InitializerSeq (void); // Default constructor. - _TAO_Unbounded_Sequence_IR_InitializerSeq (CORBA::ULong maximum); + _TAO_Unbounded_Sequence_IR_InitializerSeq (CORBA::ULong maximum); _TAO_Unbounded_Sequence_IR_InitializerSeq (CORBA::ULong maximum, CORBA::ULong length, IR_Initializer *data, @@ -3744,7 +3744,7 @@ private: virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); // Implement the TAO_Base_Sequence methods (see Sequence.h) - + IR_Initializer *get_buffer (CORBA::Boolean orphan = 0); const IR_Initializer *get_buffer (void) const; void replace (CORBA::ULong max, @@ -3753,26 +3753,26 @@ private: CORBA::Boolean release); }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_InitializerSeq // ************************************************************* -class TAO_Export IR_InitializerSeq : public +class TAO_Export IR_InitializerSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Sequence_IR_InitializerSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Sequence<IR_Initializer> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_InitializerSeq (void); // default ctor IR_InitializerSeq (CORBA::ULong max); // uses max size IR_InitializerSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_Initializer *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_Initializer *buffer, CORBA::Boolean release = 0 ); IR_InitializerSeq (const IR_InitializerSeq &); // copy ctor @@ -3796,21 +3796,21 @@ public: IR_InitializerSeq_var (IR_InitializerSeq *); IR_InitializerSeq_var (const IR_InitializerSeq_var &); // copy constructor ~IR_InitializerSeq_var (void); // destructor - + IR_InitializerSeq_var &operator= (IR_InitializerSeq *); IR_InitializerSeq_var &operator= (const IR_InitializerSeq_var &); IR_InitializerSeq *operator-> (void); const IR_InitializerSeq *operator-> (void) const; - + operator const IR_InitializerSeq &() const; operator IR_InitializerSeq &(); operator IR_InitializerSeq &() const; operator IR_InitializerSeq *&(); // variable-size base types only - + IR_Initializer & operator[] (CORBA::ULong index); const IR_Initializer & operator[] (CORBA::ULong index) const; - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_InitializerSeq &in (void) const; IR_InitializerSeq &inout (void); IR_InitializerSeq *&out (void); @@ -3833,7 +3833,7 @@ public: IR_InitializerSeq *&ptr (void); IR_InitializerSeq *operator-> (void); IR_Initializer & operator[] (CORBA::ULong index); - + private: IR_InitializerSeq *&ptr_; // assignment from T_var not allowed @@ -3862,18 +3862,18 @@ public: IR_UnionMember_var (IR_UnionMember *); IR_UnionMember_var (const IR_UnionMember_var &); // copy constructor ~IR_UnionMember_var (void); // destructor - + IR_UnionMember_var &operator= (IR_UnionMember *); IR_UnionMember_var &operator= (const IR_UnionMember_var &); IR_UnionMember *operator-> (void); const IR_UnionMember *operator-> (void) const; - + operator const IR_UnionMember &() const; operator IR_UnionMember &(); operator IR_UnionMember &() const; operator IR_UnionMember *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_UnionMember &in (void) const; IR_UnionMember &inout (void); IR_UnionMember *&out (void); @@ -3895,7 +3895,7 @@ public: operator IR_UnionMember *&(); IR_UnionMember *&ptr (void); IR_UnionMember *operator-> (void); - + private: IR_UnionMember *&ptr_; // assignment from T_var not allowed @@ -3903,14 +3903,14 @@ private: }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class TAO_EXPORT_NESTED_MACRO _TAO_Unbounded_Sequence_IR_UnionMemberSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Sequence_IR_UnionMemberSeq (void); // Default constructor. - _TAO_Unbounded_Sequence_IR_UnionMemberSeq (CORBA::ULong maximum); + _TAO_Unbounded_Sequence_IR_UnionMemberSeq (CORBA::ULong maximum); _TAO_Unbounded_Sequence_IR_UnionMemberSeq (CORBA::ULong maximum, CORBA::ULong length, IR_UnionMember *data, @@ -3927,7 +3927,7 @@ private: virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); // Implement the TAO_Base_Sequence methods (see Sequence.h) - + IR_UnionMember *get_buffer (CORBA::Boolean orphan = 0); const IR_UnionMember *get_buffer (void) const; void replace (CORBA::ULong max, @@ -3936,26 +3936,26 @@ private: CORBA::Boolean release); }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_UnionMemberSeq // ************************************************************* -class TAO_Export IR_UnionMemberSeq : public +class TAO_Export IR_UnionMemberSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Sequence_IR_UnionMemberSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Sequence<IR_UnionMember> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_UnionMemberSeq (void); // default ctor IR_UnionMemberSeq (CORBA::ULong max); // uses max size IR_UnionMemberSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_UnionMember *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_UnionMember *buffer, CORBA::Boolean release = 0 ); IR_UnionMemberSeq (const IR_UnionMemberSeq &); // copy ctor @@ -3979,21 +3979,21 @@ public: IR_UnionMemberSeq_var (IR_UnionMemberSeq *); IR_UnionMemberSeq_var (const IR_UnionMemberSeq_var &); // copy constructor ~IR_UnionMemberSeq_var (void); // destructor - + IR_UnionMemberSeq_var &operator= (IR_UnionMemberSeq *); IR_UnionMemberSeq_var &operator= (const IR_UnionMemberSeq_var &); IR_UnionMemberSeq *operator-> (void); const IR_UnionMemberSeq *operator-> (void) const; - + operator const IR_UnionMemberSeq &() const; operator IR_UnionMemberSeq &(); operator IR_UnionMemberSeq &() const; operator IR_UnionMemberSeq *&(); // variable-size base types only - + IR_UnionMember & operator[] (CORBA::ULong index); const IR_UnionMember & operator[] (CORBA::ULong index) const; - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_UnionMemberSeq &in (void) const; IR_UnionMemberSeq &inout (void); IR_UnionMemberSeq *&out (void); @@ -4016,7 +4016,7 @@ public: IR_UnionMemberSeq *&ptr (void); IR_UnionMemberSeq *operator-> (void); IR_UnionMember & operator[] (CORBA::ULong index); - + private: IR_UnionMemberSeq *&ptr_; // assignment from T_var not allowed @@ -4027,20 +4027,20 @@ private: // IR_EnumMemberSeq // ************************************************************* -class TAO_Export IR_EnumMemberSeq : public +class TAO_Export IR_EnumMemberSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) TAO_Unbounded_String_Sequence #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_String_Sequence -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_EnumMemberSeq (void); // default ctor IR_EnumMemberSeq (CORBA::ULong max); // uses max size IR_EnumMemberSeq ( - CORBA::ULong max, - CORBA::ULong length, - char * *buffer, + CORBA::ULong max, + CORBA::ULong length, + char * *buffer, CORBA::Boolean release = 0 ); IR_EnumMemberSeq (const IR_EnumMemberSeq &); // copy ctor @@ -4064,20 +4064,20 @@ public: IR_EnumMemberSeq_var (IR_EnumMemberSeq *); IR_EnumMemberSeq_var (const IR_EnumMemberSeq_var &); // copy constructor ~IR_EnumMemberSeq_var (void); // destructor - + IR_EnumMemberSeq_var &operator= (IR_EnumMemberSeq *); IR_EnumMemberSeq_var &operator= (const IR_EnumMemberSeq_var &); IR_EnumMemberSeq *operator-> (void); const IR_EnumMemberSeq *operator-> (void) const; - + operator const IR_EnumMemberSeq &() const; operator IR_EnumMemberSeq &(); operator IR_EnumMemberSeq &() const; operator IR_EnumMemberSeq *&(); // variable-size base types only - + TAO_SeqElem_String_Manager operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_EnumMemberSeq &in (void) const; IR_EnumMemberSeq &inout (void); IR_EnumMemberSeq *&out (void); @@ -4100,7 +4100,7 @@ public: IR_EnumMemberSeq *&ptr (void); IR_EnumMemberSeq *operator-> (void); TAO_SeqElem_String_Manager operator[] (CORBA::ULong index); - + private: IR_EnumMemberSeq *&ptr_; // assignment from T_var not allowed @@ -4125,12 +4125,12 @@ public: static IR_Container_ptr _duplicate (IR_Container_ptr obj); static IR_Container_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_Container_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_Container_ptr _nil (void) @@ -4142,7 +4142,7 @@ public: virtual IR_Contained_ptr lookup ( const char * search_name, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4152,7 +4152,7 @@ public: virtual IR_ContainedSeq * contents ( IR_DefinitionKind limit_type, CORBA::Boolean exclude_inherited, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4164,7 +4164,7 @@ public: CORBA::Long levels_to_search, IR_DefinitionKind limit_type, CORBA::Boolean exclude_inherited, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4173,7 +4173,7 @@ public: struct Description; class Description_var; - + struct TAO_Export Description { @@ -4195,18 +4195,18 @@ public: Description_var (Description *); Description_var (const Description_var &); // copy constructor ~Description_var (void); // destructor - + Description_var &operator= (Description *); Description_var &operator= (const Description_var &); Description *operator-> (void); const Description *operator-> (void) const; - + operator const Description &() const; operator Description &(); operator Description &() const; operator Description *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const Description &in (void) const; Description &inout (void); Description *&out (void); @@ -4228,7 +4228,7 @@ public: operator Description *&(); Description *&ptr (void); Description *operator-> (void); - + private: Description *&ptr_; // assignment from T_var not allowed @@ -4239,14 +4239,14 @@ public: #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class TAO_EXPORT_NESTED_MACRO _TAO_Unbounded_Sequence_IR_Container_DescriptionSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Sequence_IR_Container_DescriptionSeq (void); // Default constructor. - _TAO_Unbounded_Sequence_IR_Container_DescriptionSeq (CORBA::ULong maximum); + _TAO_Unbounded_Sequence_IR_Container_DescriptionSeq (CORBA::ULong maximum); _TAO_Unbounded_Sequence_IR_Container_DescriptionSeq (CORBA::ULong maximum, CORBA::ULong length, Description *data, @@ -4263,7 +4263,7 @@ public: virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); // Implement the TAO_Base_Sequence methods (see Sequence.h) - + Description *get_buffer (CORBA::Boolean orphan = 0); const Description *get_buffer (void) const; void replace (CORBA::ULong max, @@ -4272,28 +4272,28 @@ public: CORBA::Boolean release); }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ - +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ + class DescriptionSeq_var; - + // ************************************************************* // DescriptionSeq // ************************************************************* - - class TAO_Export DescriptionSeq : public + + class TAO_Export DescriptionSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Sequence_IR_Container_DescriptionSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Sequence<Description> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: DescriptionSeq (void); // default ctor DescriptionSeq (CORBA::ULong max); // uses max size DescriptionSeq ( - CORBA::ULong max, - CORBA::ULong length, - Description *buffer, + CORBA::ULong max, + CORBA::ULong length, + Description *buffer, CORBA::Boolean release = 0 ); DescriptionSeq (const DescriptionSeq &); // copy ctor @@ -4305,7 +4305,7 @@ public: #endif /* ! __GNUC__ || g++ >= 2.8 */ }; - + // ************************************************************* // class IR_Container::DescriptionSeq_var // ************************************************************* @@ -4317,20 +4317,20 @@ public: DescriptionSeq_var (DescriptionSeq *); DescriptionSeq_var (const DescriptionSeq_var &); // copy constructor ~DescriptionSeq_var (void); // destructor - + DescriptionSeq_var &operator= (DescriptionSeq *); DescriptionSeq_var &operator= (const DescriptionSeq_var &); DescriptionSeq *operator-> (void); const DescriptionSeq *operator-> (void) const; - + operator const DescriptionSeq &() const; operator DescriptionSeq &(); operator DescriptionSeq &() const; operator DescriptionSeq *&(); // variable-size base types only - + Description & operator[] (CORBA::ULong index); - const Description & operator[] (CORBA::ULong index) const; - // in, inout, out, _retn + const Description & operator[] (CORBA::ULong index) const; + // in, inout, out, _retn const DescriptionSeq &in (void) const; DescriptionSeq &inout (void); DescriptionSeq *&out (void); @@ -4353,7 +4353,7 @@ public: DescriptionSeq *&ptr (void); DescriptionSeq *operator-> (void); Description & operator[] (CORBA::ULong index); - + private: DescriptionSeq *&ptr_; // assignment from T_var not allowed @@ -4366,7 +4366,7 @@ public: IR_DefinitionKind limit_type, CORBA::Boolean exclude_inherited, CORBA::Long max_returned_objs, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4377,7 +4377,7 @@ public: const char * id, const char * name, const char * version, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4390,7 +4390,7 @@ public: const char * version, IR_IDLType_ptr type, const CORBA::Any & value, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4402,7 +4402,7 @@ public: const char * name, const char * version, const IR_StructMemberSeq & members, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4415,7 +4415,7 @@ public: const char * version, IR_IDLType_ptr discriminator_type, const IR_UnionMemberSeq & members, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4427,7 +4427,7 @@ public: const char * name, const char * version, const IR_EnumMemberSeq & members, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4439,7 +4439,7 @@ public: const char * name, const char * version, IR_IDLType_ptr original_type, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4453,7 +4453,7 @@ public: const IR_InterfaceDefSeq & base_interfaces, CORBA::Boolean is_abstract, CORBA::Boolean is_local, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4471,7 +4471,7 @@ public: const IR_ValueDefSeq & abstract_base_values, const IR_InterfaceDefSeq & supported_interfaces, const IR_InitializerSeq & initializers, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4483,7 +4483,7 @@ public: const char * name, const char * version, IR_IDLType_ptr original_type_def, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4495,7 +4495,7 @@ public: const char * name, const char * version, const IR_StructMemberSeq & members, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4506,7 +4506,7 @@ public: const char * id, const char * name, const char * version, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -4514,39 +4514,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_Container_Proxy_Broker *the_TAO_Container_Proxy_Broker_; - + protected: IR_Container (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_Container ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_Container_Remote_Proxy_Impl; friend class _TAO_Container_ThruPOA_Proxy_Impl; friend class _TAO_Container_Direct_Proxy_Impl; - + virtual ~IR_Container (void); private: IR_Container (const IR_Container &); - void operator= (const IR_Container &); + void operator= (const IR_Container &); }; @@ -4559,12 +4559,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_Container_Proxy_Impl : +class TAO_Export _TAO_Container_Proxy_Impl : public virtual _TAO_IRObject_Proxy_Impl { public: virtual ~_TAO_Container_Proxy_Impl (void) { } - + virtual IR_Contained_ptr lookup ( CORBA_Object *_collocated_tao_target_, const char * search_name, @@ -4761,17 +4761,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_Container_Remote_Proxy_Impl : +class TAO_Export _TAO_Container_Remote_Proxy_Impl : public virtual _TAO_Container_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_IRObject_Remote_Proxy_Impl - + { public: _TAO_Container_Remote_Proxy_Impl (void); - + virtual ~_TAO_Container_Remote_Proxy_Impl (void) { } - + virtual IR_Contained_ptr lookup ( CORBA_Object *_collocated_tao_target_, const char * search_name, @@ -4961,14 +4961,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_Container_Proxy_Broker @@ -4983,24 +4983,24 @@ public: protected: _TAO_Container_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_Container_Remote_Proxy_Broker : public virtual _TAO_Container_Proxy_Broker { -public: +public: _TAO_Container_Remote_Proxy_Broker (void); - + virtual ~_TAO_Container_Remote_Proxy_Broker (void); virtual _TAO_Container_Proxy_Impl &select_proxy ( @@ -5019,7 +5019,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -5040,12 +5040,12 @@ public: static IR_IDLType_ptr _duplicate (IR_IDLType_ptr obj); static IR_IDLType_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_IDLType_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_IDLType_ptr _nil (void) @@ -5056,7 +5056,7 @@ public: static void _tao_any_destructor (void*); virtual CORBA::TypeCode_ptr type ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -5064,39 +5064,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_IDLType_Proxy_Broker *the_TAO_IDLType_Proxy_Broker_; - + protected: IR_IDLType (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_IDLType ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_IDLType_Remote_Proxy_Impl; friend class _TAO_IDLType_ThruPOA_Proxy_Impl; friend class _TAO_IDLType_Direct_Proxy_Impl; - + virtual ~IR_IDLType (void); private: IR_IDLType (const IR_IDLType &); - void operator= (const IR_IDLType &); + void operator= (const IR_IDLType &); }; @@ -5109,12 +5109,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_IDLType_Proxy_Impl : +class TAO_Export _TAO_IDLType_Proxy_Impl : public virtual _TAO_IRObject_Proxy_Impl { public: virtual ~_TAO_IDLType_Proxy_Impl (void) { } - + virtual CORBA::TypeCode_ptr type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -5137,17 +5137,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_IDLType_Remote_Proxy_Impl : +class TAO_Export _TAO_IDLType_Remote_Proxy_Impl : public virtual _TAO_IDLType_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_IRObject_Remote_Proxy_Impl - + { public: _TAO_IDLType_Remote_Proxy_Impl (void); - + virtual ~_TAO_IDLType_Remote_Proxy_Impl (void) { } - + virtual CORBA::TypeCode_ptr type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -5164,14 +5164,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_IDLType_Proxy_Broker @@ -5186,24 +5186,24 @@ public: protected: _TAO_IDLType_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_IDLType_Remote_Proxy_Broker : public virtual _TAO_IDLType_Proxy_Broker { -public: +public: _TAO_IDLType_Remote_Proxy_Broker (void); - + virtual ~_TAO_IDLType_Remote_Proxy_Broker (void); virtual _TAO_IDLType_Proxy_Impl &select_proxy ( @@ -5222,24 +5222,24 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// class TAO_Export IR_PrimitiveDef_var : public TAO_Base_var { public: IR_PrimitiveDef_var (void); // default constructor - IR_PrimitiveDef_var (IR_PrimitiveDef_ptr p) : ptr_ (p) {} + IR_PrimitiveDef_var (IR_PrimitiveDef_ptr p) : ptr_ (p) {} IR_PrimitiveDef_var (const IR_PrimitiveDef_var &); // copy constructor ~IR_PrimitiveDef_var (void); // destructor - + IR_PrimitiveDef_var &operator= (IR_PrimitiveDef_ptr); IR_PrimitiveDef_var &operator= (const IR_PrimitiveDef_var &); IR_PrimitiveDef_ptr operator-> (void) const; - + operator const IR_PrimitiveDef_ptr &() const; operator IR_PrimitiveDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_PrimitiveDef_ptr in (void) const; IR_PrimitiveDef_ptr &inout (void); IR_PrimitiveDef_ptr &out (void); @@ -5266,7 +5266,7 @@ public: operator IR_PrimitiveDef_ptr &(); IR_PrimitiveDef_ptr &ptr (void); IR_PrimitiveDef_ptr operator-> (void); - + private: IR_PrimitiveDef_ptr &ptr_; }; @@ -5275,17 +5275,17 @@ class TAO_Export IR_StringDef_var : public TAO_Base_var { public: IR_StringDef_var (void); // default constructor - IR_StringDef_var (IR_StringDef_ptr p) : ptr_ (p) {} + IR_StringDef_var (IR_StringDef_ptr p) : ptr_ (p) {} IR_StringDef_var (const IR_StringDef_var &); // copy constructor ~IR_StringDef_var (void); // destructor - + IR_StringDef_var &operator= (IR_StringDef_ptr); IR_StringDef_var &operator= (const IR_StringDef_var &); IR_StringDef_ptr operator-> (void) const; - + operator const IR_StringDef_ptr &() const; operator IR_StringDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_StringDef_ptr in (void) const; IR_StringDef_ptr &inout (void); IR_StringDef_ptr &out (void); @@ -5311,7 +5311,7 @@ public: operator IR_StringDef_ptr &(); IR_StringDef_ptr &ptr (void); IR_StringDef_ptr operator-> (void); - + private: IR_StringDef_ptr &ptr_; }; @@ -5320,17 +5320,17 @@ class TAO_Export IR_SequenceDef_var : public TAO_Base_var { public: IR_SequenceDef_var (void); // default constructor - IR_SequenceDef_var (IR_SequenceDef_ptr p) : ptr_ (p) {} + IR_SequenceDef_var (IR_SequenceDef_ptr p) : ptr_ (p) {} IR_SequenceDef_var (const IR_SequenceDef_var &); // copy constructor ~IR_SequenceDef_var (void); // destructor - + IR_SequenceDef_var &operator= (IR_SequenceDef_ptr); IR_SequenceDef_var &operator= (const IR_SequenceDef_var &); IR_SequenceDef_ptr operator-> (void) const; - + operator const IR_SequenceDef_ptr &() const; operator IR_SequenceDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_SequenceDef_ptr in (void) const; IR_SequenceDef_ptr &inout (void); IR_SequenceDef_ptr &out (void); @@ -5356,7 +5356,7 @@ public: operator IR_SequenceDef_ptr &(); IR_SequenceDef_ptr &ptr (void); IR_SequenceDef_ptr operator-> (void); - + private: IR_SequenceDef_ptr &ptr_; }; @@ -5365,17 +5365,17 @@ class TAO_Export IR_ArrayDef_var : public TAO_Base_var { public: IR_ArrayDef_var (void); // default constructor - IR_ArrayDef_var (IR_ArrayDef_ptr p) : ptr_ (p) {} + IR_ArrayDef_var (IR_ArrayDef_ptr p) : ptr_ (p) {} IR_ArrayDef_var (const IR_ArrayDef_var &); // copy constructor ~IR_ArrayDef_var (void); // destructor - + IR_ArrayDef_var &operator= (IR_ArrayDef_ptr); IR_ArrayDef_var &operator= (const IR_ArrayDef_var &); IR_ArrayDef_ptr operator-> (void) const; - + operator const IR_ArrayDef_ptr &() const; operator IR_ArrayDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_ArrayDef_ptr in (void) const; IR_ArrayDef_ptr &inout (void); IR_ArrayDef_ptr &out (void); @@ -5401,7 +5401,7 @@ public: operator IR_ArrayDef_ptr &(); IR_ArrayDef_ptr &ptr (void); IR_ArrayDef_ptr operator-> (void); - + private: IR_ArrayDef_ptr &ptr_; }; @@ -5410,17 +5410,17 @@ class TAO_Export IR_WstringDef_var : public TAO_Base_var { public: IR_WstringDef_var (void); // default constructor - IR_WstringDef_var (IR_WstringDef_ptr p) : ptr_ (p) {} + IR_WstringDef_var (IR_WstringDef_ptr p) : ptr_ (p) {} IR_WstringDef_var (const IR_WstringDef_var &); // copy constructor ~IR_WstringDef_var (void); // destructor - + IR_WstringDef_var &operator= (IR_WstringDef_ptr); IR_WstringDef_var &operator= (const IR_WstringDef_var &); IR_WstringDef_ptr operator-> (void) const; - + operator const IR_WstringDef_ptr &() const; operator IR_WstringDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_WstringDef_ptr in (void) const; IR_WstringDef_ptr &inout (void); IR_WstringDef_ptr &out (void); @@ -5446,7 +5446,7 @@ public: operator IR_WstringDef_ptr &(); IR_WstringDef_ptr &ptr (void); IR_WstringDef_ptr operator-> (void); - + private: IR_WstringDef_ptr &ptr_; }; @@ -5455,17 +5455,17 @@ class TAO_Export IR_FixedDef_var : public TAO_Base_var { public: IR_FixedDef_var (void); // default constructor - IR_FixedDef_var (IR_FixedDef_ptr p) : ptr_ (p) {} + IR_FixedDef_var (IR_FixedDef_ptr p) : ptr_ (p) {} IR_FixedDef_var (const IR_FixedDef_var &); // copy constructor ~IR_FixedDef_var (void); // destructor - + IR_FixedDef_var &operator= (IR_FixedDef_ptr); IR_FixedDef_var &operator= (const IR_FixedDef_var &); IR_FixedDef_ptr operator-> (void) const; - + operator const IR_FixedDef_ptr &() const; operator IR_FixedDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_FixedDef_ptr in (void) const; IR_FixedDef_ptr &inout (void); IR_FixedDef_ptr &out (void); @@ -5491,7 +5491,7 @@ public: operator IR_FixedDef_ptr &(); IR_FixedDef_ptr &ptr (void); IR_FixedDef_ptr operator-> (void); - + private: IR_FixedDef_ptr &ptr_; }; @@ -5514,12 +5514,12 @@ public: static IR_Repository_ptr _duplicate (IR_Repository_ptr obj); static IR_Repository_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_Repository_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_Repository_ptr _nil (void) @@ -5531,7 +5531,7 @@ public: virtual IR_Contained_ptr lookup_id ( const char * search_id, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -5540,7 +5540,7 @@ public: virtual CORBA::TypeCode_ptr get_canonical_typecode ( CORBA::TypeCode_ptr tc, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -5549,7 +5549,7 @@ public: virtual IR_PrimitiveDef_ptr get_primitive ( IR_PrimitiveKind kind, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -5558,7 +5558,7 @@ public: virtual IR_StringDef_ptr create_string ( CORBA::ULong bound, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -5567,7 +5567,7 @@ public: virtual IR_WstringDef_ptr create_wstring ( CORBA::ULong bound, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -5577,7 +5577,7 @@ public: virtual IR_SequenceDef_ptr create_sequence ( CORBA::ULong bound, IR_IDLType_ptr element_type, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -5587,7 +5587,7 @@ public: virtual IR_ArrayDef_ptr create_array ( CORBA::ULong length, IR_IDLType_ptr element_type, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -5597,7 +5597,7 @@ public: virtual IR_FixedDef_ptr create_fixed ( CORBA::UShort digits, CORBA::Short scale, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -5605,39 +5605,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_Repository_Proxy_Broker *the_TAO_Repository_Proxy_Broker_; - + protected: IR_Repository (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_Repository ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_Repository_Remote_Proxy_Impl; friend class _TAO_Repository_ThruPOA_Proxy_Impl; friend class _TAO_Repository_Direct_Proxy_Impl; - + virtual ~IR_Repository (void); private: IR_Repository (const IR_Repository &); - void operator= (const IR_Repository &); + void operator= (const IR_Repository &); }; @@ -5650,12 +5650,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_Repository_Proxy_Impl : +class TAO_Export _TAO_Repository_Proxy_Impl : public virtual _TAO_Container_Proxy_Impl { public: virtual ~_TAO_Repository_Proxy_Impl (void) { } - + virtual IR_Contained_ptr lookup_id ( CORBA_Object *_collocated_tao_target_, const char * search_id, @@ -5745,17 +5745,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_Repository_Remote_Proxy_Impl : +class TAO_Export _TAO_Repository_Remote_Proxy_Impl : public virtual _TAO_Repository_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_Container_Remote_Proxy_Impl - + { public: _TAO_Repository_Remote_Proxy_Impl (void); - + virtual ~_TAO_Repository_Remote_Proxy_Impl (void) { } - + virtual IR_Contained_ptr lookup_id ( CORBA_Object *_collocated_tao_target_, const char * search_id, @@ -5839,14 +5839,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_Repository_Proxy_Broker @@ -5861,24 +5861,24 @@ public: protected: _TAO_Repository_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_Repository_Remote_Proxy_Broker : public virtual _TAO_Repository_Proxy_Broker { -public: +public: _TAO_Repository_Remote_Proxy_Broker (void); - + virtual ~_TAO_Repository_Remote_Proxy_Broker (void); virtual _TAO_Repository_Proxy_Impl &select_proxy ( @@ -5897,24 +5897,24 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// class TAO_Export IR_ComponentRepository_var : public TAO_Base_var { public: IR_ComponentRepository_var (void); // default constructor - IR_ComponentRepository_var (IR_ComponentRepository_ptr p) : ptr_ (p) {} + IR_ComponentRepository_var (IR_ComponentRepository_ptr p) : ptr_ (p) {} IR_ComponentRepository_var (const IR_ComponentRepository_var &); // copy constructor ~IR_ComponentRepository_var (void); // destructor - + IR_ComponentRepository_var &operator= (IR_ComponentRepository_ptr); IR_ComponentRepository_var &operator= (const IR_ComponentRepository_var &); IR_ComponentRepository_ptr operator-> (void) const; - + operator const IR_ComponentRepository_ptr &() const; operator IR_ComponentRepository_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_ComponentRepository_ptr in (void) const; IR_ComponentRepository_ptr &inout (void); IR_ComponentRepository_ptr &out (void); @@ -5940,7 +5940,7 @@ public: operator IR_ComponentRepository_ptr &(); IR_ComponentRepository_ptr &ptr (void); IR_ComponentRepository_ptr operator-> (void); - + private: IR_ComponentRepository_ptr &ptr_; }; @@ -5963,12 +5963,12 @@ public: static IR_ComponentRepository_ptr _duplicate (IR_ComponentRepository_ptr obj); static IR_ComponentRepository_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ComponentRepository_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ComponentRepository_ptr _nil (void) @@ -5984,7 +5984,7 @@ public: const char * version, IR_ComponentDef_ptr base_component, const IR_InterfaceDefSeq & supports_interfaces, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -5998,7 +5998,7 @@ public: IR_HomeDef_ptr base_home, IR_ComponentDef_ptr managed_component, IR_ValueDef_ptr primary_key, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -6006,39 +6006,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_ComponentRepository_Proxy_Broker *the_TAO_ComponentRepository_Proxy_Broker_; - + protected: IR_ComponentRepository (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_ComponentRepository ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_ComponentRepository_Remote_Proxy_Impl; friend class _TAO_ComponentRepository_ThruPOA_Proxy_Impl; friend class _TAO_ComponentRepository_Direct_Proxy_Impl; - + virtual ~IR_ComponentRepository (void); private: IR_ComponentRepository (const IR_ComponentRepository &); - void operator= (const IR_ComponentRepository &); + void operator= (const IR_ComponentRepository &); }; @@ -6051,12 +6051,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_ComponentRepository_Proxy_Impl : +class TAO_Export _TAO_ComponentRepository_Proxy_Impl : public virtual _TAO_Repository_Proxy_Impl { public: virtual ~_TAO_ComponentRepository_Proxy_Impl (void) { } - + virtual IR_ComponentDef_ptr create_component ( CORBA_Object *_collocated_tao_target_, const char * id, @@ -6098,17 +6098,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_ComponentRepository_Remote_Proxy_Impl : +class TAO_Export _TAO_ComponentRepository_Remote_Proxy_Impl : public virtual _TAO_ComponentRepository_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_Repository_Remote_Proxy_Impl - + { public: _TAO_ComponentRepository_Remote_Proxy_Impl (void); - + virtual ~_TAO_ComponentRepository_Remote_Proxy_Impl (void) { } - + virtual IR_ComponentDef_ptr create_component ( CORBA_Object *_collocated_tao_target_, const char * id, @@ -6144,14 +6144,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_ComponentRepository_Proxy_Broker @@ -6166,24 +6166,24 @@ public: protected: _TAO_ComponentRepository_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_ComponentRepository_Remote_Proxy_Broker : public virtual _TAO_ComponentRepository_Proxy_Broker { -public: +public: _TAO_ComponentRepository_Remote_Proxy_Broker (void); - + virtual ~_TAO_ComponentRepository_Remote_Proxy_Broker (void); virtual _TAO_ComponentRepository_Proxy_Impl &select_proxy ( @@ -6202,7 +6202,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -6223,12 +6223,12 @@ public: static IR_ModuleDef_ptr _duplicate (IR_ModuleDef_ptr obj); static IR_ModuleDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ModuleDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ModuleDef_ptr _nil (void) @@ -6239,84 +6239,84 @@ public: static void _tao_any_destructor (void*); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_ModuleDef_Proxy_Broker *the_TAO_ModuleDef_Proxy_Broker_; - + protected: IR_ModuleDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_ModuleDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_ModuleDef_Remote_Proxy_Impl; friend class _TAO_ModuleDef_ThruPOA_Proxy_Impl; friend class _TAO_ModuleDef_Direct_Proxy_Impl; - + virtual ~IR_ModuleDef (void); private: IR_ModuleDef (const IR_ModuleDef &); - void operator= (const IR_ModuleDef &); + void operator= (const IR_ModuleDef &); }; - + // The Proxy Implementations are used by each interface to // perform a call. Each different implementation encapsulate // an invocation logics. - + /////////////////////////////////////////////////////////////////////// // Base Impl. Declaration // - - class TAO_Export _TAO_ModuleDef_Proxy_Impl : - public virtual _TAO_Container_Proxy_Impl, + + class TAO_Export _TAO_ModuleDef_Proxy_Impl : + public virtual _TAO_Container_Proxy_Impl, public virtual _TAO_Contained_Proxy_Impl { public: virtual ~_TAO_ModuleDef_Proxy_Impl (void) { } - + protected: _TAO_ModuleDef_Proxy_Impl (void); - + }; - + // // Base Proxy Impl. Declaration /////////////////////////////////////////////////////////////////////// - - + + /////////////////////////////////////////////////////////////////////// // Remote Impl. Declaration // -class TAO_Export _TAO_ModuleDef_Remote_Proxy_Impl : +class TAO_Export _TAO_ModuleDef_Remote_Proxy_Impl : public virtual _TAO_ModuleDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, - public virtual _TAO_Container_Remote_Proxy_Impl, + public virtual _TAO_Container_Remote_Proxy_Impl, public virtual _TAO_Contained_Remote_Proxy_Impl - + { public: _TAO_ModuleDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_ModuleDef_Remote_Proxy_Impl (void) { } - + }; // @@ -6325,14 +6325,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_ModuleDef_Proxy_Broker @@ -6347,24 +6347,24 @@ public: protected: _TAO_ModuleDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_ModuleDef_Remote_Proxy_Broker : public virtual _TAO_ModuleDef_Proxy_Broker { -public: +public: _TAO_ModuleDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_ModuleDef_Remote_Proxy_Broker (void); virtual _TAO_ModuleDef_Proxy_Impl &select_proxy ( @@ -6383,7 +6383,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// struct TAO_Export IR_ModuleDescription @@ -6408,18 +6408,18 @@ public: IR_ModuleDescription_var (IR_ModuleDescription *); IR_ModuleDescription_var (const IR_ModuleDescription_var &); // copy constructor ~IR_ModuleDescription_var (void); // destructor - + IR_ModuleDescription_var &operator= (IR_ModuleDescription *); IR_ModuleDescription_var &operator= (const IR_ModuleDescription_var &); IR_ModuleDescription *operator-> (void); const IR_ModuleDescription *operator-> (void) const; - + operator const IR_ModuleDescription &() const; operator IR_ModuleDescription &(); operator IR_ModuleDescription &() const; operator IR_ModuleDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ModuleDescription &in (void) const; IR_ModuleDescription &inout (void); IR_ModuleDescription *&out (void); @@ -6441,7 +6441,7 @@ public: operator IR_ModuleDescription *&(); IR_ModuleDescription *&ptr (void); IR_ModuleDescription *operator-> (void); - + private: IR_ModuleDescription *&ptr_; // assignment from T_var not allowed @@ -6466,12 +6466,12 @@ public: static IR_ConstantDef_ptr _duplicate (IR_ConstantDef_ptr obj); static IR_ConstantDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ConstantDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ConstantDef_ptr _nil (void) @@ -6482,7 +6482,7 @@ public: static void _tao_any_destructor (void*); virtual CORBA::TypeCode_ptr type ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -6490,7 +6490,7 @@ public: )); virtual IR_IDLType_ptr type_def ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -6499,7 +6499,7 @@ public: virtual void type_def ( IR_IDLType_ptr type_def, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -6507,7 +6507,7 @@ public: )); virtual CORBA::Any * value ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -6516,7 +6516,7 @@ public: virtual void value ( const CORBA::Any & value, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -6524,39 +6524,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_ConstantDef_Proxy_Broker *the_TAO_ConstantDef_Proxy_Broker_; - + protected: IR_ConstantDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_ConstantDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_ConstantDef_Remote_Proxy_Impl; friend class _TAO_ConstantDef_ThruPOA_Proxy_Impl; friend class _TAO_ConstantDef_Direct_Proxy_Impl; - + virtual ~IR_ConstantDef (void); private: IR_ConstantDef (const IR_ConstantDef &); - void operator= (const IR_ConstantDef &); + void operator= (const IR_ConstantDef &); }; @@ -6569,12 +6569,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_ConstantDef_Proxy_Impl : +class TAO_Export _TAO_ConstantDef_Proxy_Impl : public virtual _TAO_Contained_Proxy_Impl { public: virtual ~_TAO_ConstantDef_Proxy_Impl (void) { } - + virtual CORBA::TypeCode_ptr type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -6631,17 +6631,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_ConstantDef_Remote_Proxy_Impl : +class TAO_Export _TAO_ConstantDef_Remote_Proxy_Impl : public virtual _TAO_ConstantDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_Contained_Remote_Proxy_Impl - + { public: _TAO_ConstantDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_ConstantDef_Remote_Proxy_Impl (void) { } - + virtual CORBA::TypeCode_ptr type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -6692,14 +6692,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_ConstantDef_Proxy_Broker @@ -6714,24 +6714,24 @@ public: protected: _TAO_ConstantDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_ConstantDef_Remote_Proxy_Broker : public virtual _TAO_ConstantDef_Proxy_Broker { -public: +public: _TAO_ConstantDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_ConstantDef_Remote_Proxy_Broker (void); virtual _TAO_ConstantDef_Proxy_Impl &select_proxy ( @@ -6750,7 +6750,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// struct TAO_Export IR_ConstantDescription @@ -6777,18 +6777,18 @@ public: IR_ConstantDescription_var (IR_ConstantDescription *); IR_ConstantDescription_var (const IR_ConstantDescription_var &); // copy constructor ~IR_ConstantDescription_var (void); // destructor - + IR_ConstantDescription_var &operator= (IR_ConstantDescription *); IR_ConstantDescription_var &operator= (const IR_ConstantDescription_var &); IR_ConstantDescription *operator-> (void); const IR_ConstantDescription *operator-> (void) const; - + operator const IR_ConstantDescription &() const; operator IR_ConstantDescription &(); operator IR_ConstantDescription &() const; operator IR_ConstantDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ConstantDescription &in (void) const; IR_ConstantDescription &inout (void); IR_ConstantDescription *&out (void); @@ -6810,7 +6810,7 @@ public: operator IR_ConstantDescription *&(); IR_ConstantDescription *&ptr (void); IR_ConstantDescription *operator-> (void); - + private: IR_ConstantDescription *&ptr_; // assignment from T_var not allowed @@ -6821,17 +6821,17 @@ class TAO_Export IR_TypedefDef_var : public TAO_Base_var { public: IR_TypedefDef_var (void); // default constructor - IR_TypedefDef_var (IR_TypedefDef_ptr p) : ptr_ (p) {} + IR_TypedefDef_var (IR_TypedefDef_ptr p) : ptr_ (p) {} IR_TypedefDef_var (const IR_TypedefDef_var &); // copy constructor ~IR_TypedefDef_var (void); // destructor - + IR_TypedefDef_var &operator= (IR_TypedefDef_ptr); IR_TypedefDef_var &operator= (const IR_TypedefDef_var &); IR_TypedefDef_ptr operator-> (void) const; - + operator const IR_TypedefDef_ptr &() const; operator IR_TypedefDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_TypedefDef_ptr in (void) const; IR_TypedefDef_ptr &inout (void); IR_TypedefDef_ptr &out (void); @@ -6857,7 +6857,7 @@ public: operator IR_TypedefDef_ptr &(); IR_TypedefDef_ptr &ptr (void); IR_TypedefDef_ptr operator-> (void); - + private: IR_TypedefDef_ptr &ptr_; }; @@ -6880,12 +6880,12 @@ public: static IR_TypedefDef_ptr _duplicate (IR_TypedefDef_ptr obj); static IR_TypedefDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_TypedefDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_TypedefDef_ptr _nil (void) @@ -6896,84 +6896,84 @@ public: static void _tao_any_destructor (void*); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_TypedefDef_Proxy_Broker *the_TAO_TypedefDef_Proxy_Broker_; - + protected: IR_TypedefDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_TypedefDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_TypedefDef_Remote_Proxy_Impl; friend class _TAO_TypedefDef_ThruPOA_Proxy_Impl; friend class _TAO_TypedefDef_Direct_Proxy_Impl; - + virtual ~IR_TypedefDef (void); private: IR_TypedefDef (const IR_TypedefDef &); - void operator= (const IR_TypedefDef &); + void operator= (const IR_TypedefDef &); }; - + // The Proxy Implementations are used by each interface to // perform a call. Each different implementation encapsulate // an invocation logics. - + /////////////////////////////////////////////////////////////////////// // Base Impl. Declaration // - - class TAO_Export _TAO_TypedefDef_Proxy_Impl : - public virtual _TAO_Contained_Proxy_Impl, + + class TAO_Export _TAO_TypedefDef_Proxy_Impl : + public virtual _TAO_Contained_Proxy_Impl, public virtual _TAO_IDLType_Proxy_Impl { public: virtual ~_TAO_TypedefDef_Proxy_Impl (void) { } - + protected: _TAO_TypedefDef_Proxy_Impl (void); - + }; - + // // Base Proxy Impl. Declaration /////////////////////////////////////////////////////////////////////// - - + + /////////////////////////////////////////////////////////////////////// // Remote Impl. Declaration // -class TAO_Export _TAO_TypedefDef_Remote_Proxy_Impl : +class TAO_Export _TAO_TypedefDef_Remote_Proxy_Impl : public virtual _TAO_TypedefDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, - public virtual _TAO_Contained_Remote_Proxy_Impl, + public virtual _TAO_Contained_Remote_Proxy_Impl, public virtual _TAO_IDLType_Remote_Proxy_Impl - + { public: _TAO_TypedefDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_TypedefDef_Remote_Proxy_Impl (void) { } - + }; // @@ -6982,14 +6982,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_TypedefDef_Proxy_Broker @@ -7004,24 +7004,24 @@ public: protected: _TAO_TypedefDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_TypedefDef_Remote_Proxy_Broker : public virtual _TAO_TypedefDef_Proxy_Broker { -public: +public: _TAO_TypedefDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_TypedefDef_Remote_Proxy_Broker (void); virtual _TAO_TypedefDef_Proxy_Impl &select_proxy ( @@ -7040,7 +7040,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// struct TAO_Export IR_TypeDescription @@ -7066,18 +7066,18 @@ public: IR_TypeDescription_var (IR_TypeDescription *); IR_TypeDescription_var (const IR_TypeDescription_var &); // copy constructor ~IR_TypeDescription_var (void); // destructor - + IR_TypeDescription_var &operator= (IR_TypeDescription *); IR_TypeDescription_var &operator= (const IR_TypeDescription_var &); IR_TypeDescription *operator-> (void); const IR_TypeDescription *operator-> (void) const; - + operator const IR_TypeDescription &() const; operator IR_TypeDescription &(); operator IR_TypeDescription &() const; operator IR_TypeDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_TypeDescription &in (void) const; IR_TypeDescription &inout (void); IR_TypeDescription *&out (void); @@ -7099,7 +7099,7 @@ public: operator IR_TypeDescription *&(); IR_TypeDescription *&ptr (void); IR_TypeDescription *operator-> (void); - + private: IR_TypeDescription *&ptr_; // assignment from T_var not allowed @@ -7124,12 +7124,12 @@ public: static IR_StructDef_ptr _duplicate (IR_StructDef_ptr obj); static IR_StructDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_StructDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_StructDef_ptr _nil (void) @@ -7140,7 +7140,7 @@ public: static void _tao_any_destructor (void*); virtual IR_StructMemberSeq * members ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -7149,7 +7149,7 @@ public: virtual void members ( const IR_StructMemberSeq & members, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -7157,39 +7157,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_StructDef_Proxy_Broker *the_TAO_StructDef_Proxy_Broker_; - + protected: IR_StructDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_StructDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_StructDef_Remote_Proxy_Impl; friend class _TAO_StructDef_ThruPOA_Proxy_Impl; friend class _TAO_StructDef_Direct_Proxy_Impl; - + virtual ~IR_StructDef (void); private: IR_StructDef (const IR_StructDef &); - void operator= (const IR_StructDef &); + void operator= (const IR_StructDef &); }; @@ -7202,13 +7202,13 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_StructDef_Proxy_Impl : - public virtual _TAO_TypedefDef_Proxy_Impl, +class TAO_Export _TAO_StructDef_Proxy_Impl : + public virtual _TAO_TypedefDef_Proxy_Impl, public virtual _TAO_Container_Proxy_Impl { public: virtual ~_TAO_StructDef_Proxy_Impl (void) { } - + virtual IR_StructMemberSeq * members ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -7240,18 +7240,18 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_StructDef_Remote_Proxy_Impl : +class TAO_Export _TAO_StructDef_Remote_Proxy_Impl : public virtual _TAO_StructDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, - public virtual _TAO_TypedefDef_Remote_Proxy_Impl, + public virtual _TAO_TypedefDef_Remote_Proxy_Impl, public virtual _TAO_Container_Remote_Proxy_Impl - + { public: _TAO_StructDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_StructDef_Remote_Proxy_Impl (void) { } - + virtual IR_StructMemberSeq * members ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -7277,14 +7277,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_StructDef_Proxy_Broker @@ -7299,24 +7299,24 @@ public: protected: _TAO_StructDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_StructDef_Remote_Proxy_Broker : public virtual _TAO_StructDef_Proxy_Broker { -public: +public: _TAO_StructDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_StructDef_Remote_Proxy_Broker (void); virtual _TAO_StructDef_Proxy_Impl &select_proxy ( @@ -7335,7 +7335,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -7356,12 +7356,12 @@ public: static IR_UnionDef_ptr _duplicate (IR_UnionDef_ptr obj); static IR_UnionDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_UnionDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_UnionDef_ptr _nil (void) @@ -7372,7 +7372,7 @@ public: static void _tao_any_destructor (void*); virtual CORBA::TypeCode_ptr discriminator_type ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -7380,7 +7380,7 @@ public: )); virtual IR_IDLType_ptr discriminator_type_def ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -7389,7 +7389,7 @@ public: virtual void discriminator_type_def ( IR_IDLType_ptr discriminator_type_def, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -7397,7 +7397,7 @@ public: )); virtual IR_UnionMemberSeq * members ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -7406,7 +7406,7 @@ public: virtual void members ( const IR_UnionMemberSeq & members, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -7414,39 +7414,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_UnionDef_Proxy_Broker *the_TAO_UnionDef_Proxy_Broker_; - + protected: IR_UnionDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_UnionDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_UnionDef_Remote_Proxy_Impl; friend class _TAO_UnionDef_ThruPOA_Proxy_Impl; friend class _TAO_UnionDef_Direct_Proxy_Impl; - + virtual ~IR_UnionDef (void); private: IR_UnionDef (const IR_UnionDef &); - void operator= (const IR_UnionDef &); + void operator= (const IR_UnionDef &); }; @@ -7459,13 +7459,13 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_UnionDef_Proxy_Impl : - public virtual _TAO_TypedefDef_Proxy_Impl, +class TAO_Export _TAO_UnionDef_Proxy_Impl : + public virtual _TAO_TypedefDef_Proxy_Impl, public virtual _TAO_Container_Proxy_Impl { public: virtual ~_TAO_UnionDef_Proxy_Impl (void) { } - + virtual CORBA::TypeCode_ptr discriminator_type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -7522,18 +7522,18 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_UnionDef_Remote_Proxy_Impl : +class TAO_Export _TAO_UnionDef_Remote_Proxy_Impl : public virtual _TAO_UnionDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, - public virtual _TAO_TypedefDef_Remote_Proxy_Impl, + public virtual _TAO_TypedefDef_Remote_Proxy_Impl, public virtual _TAO_Container_Remote_Proxy_Impl - + { public: _TAO_UnionDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_UnionDef_Remote_Proxy_Impl (void) { } - + virtual CORBA::TypeCode_ptr discriminator_type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -7584,14 +7584,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_UnionDef_Proxy_Broker @@ -7606,24 +7606,24 @@ public: protected: _TAO_UnionDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_UnionDef_Remote_Proxy_Broker : public virtual _TAO_UnionDef_Proxy_Broker { -public: +public: _TAO_UnionDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_UnionDef_Remote_Proxy_Broker (void); virtual _TAO_UnionDef_Proxy_Impl &select_proxy ( @@ -7642,7 +7642,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -7663,12 +7663,12 @@ public: static IR_EnumDef_ptr _duplicate (IR_EnumDef_ptr obj); static IR_EnumDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_EnumDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_EnumDef_ptr _nil (void) @@ -7679,7 +7679,7 @@ public: static void _tao_any_destructor (void*); virtual IR_EnumMemberSeq * members ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -7688,7 +7688,7 @@ public: virtual void members ( const IR_EnumMemberSeq & members, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -7696,39 +7696,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_EnumDef_Proxy_Broker *the_TAO_EnumDef_Proxy_Broker_; - + protected: IR_EnumDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_EnumDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_EnumDef_Remote_Proxy_Impl; friend class _TAO_EnumDef_ThruPOA_Proxy_Impl; friend class _TAO_EnumDef_Direct_Proxy_Impl; - + virtual ~IR_EnumDef (void); private: IR_EnumDef (const IR_EnumDef &); - void operator= (const IR_EnumDef &); + void operator= (const IR_EnumDef &); }; @@ -7741,12 +7741,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_EnumDef_Proxy_Impl : +class TAO_Export _TAO_EnumDef_Proxy_Impl : public virtual _TAO_TypedefDef_Proxy_Impl { public: virtual ~_TAO_EnumDef_Proxy_Impl (void) { } - + virtual IR_EnumMemberSeq * members ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -7778,17 +7778,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_EnumDef_Remote_Proxy_Impl : +class TAO_Export _TAO_EnumDef_Remote_Proxy_Impl : public virtual _TAO_EnumDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_TypedefDef_Remote_Proxy_Impl - + { public: _TAO_EnumDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_EnumDef_Remote_Proxy_Impl (void) { } - + virtual IR_EnumMemberSeq * members ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -7814,14 +7814,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_EnumDef_Proxy_Broker @@ -7836,24 +7836,24 @@ public: protected: _TAO_EnumDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_EnumDef_Remote_Proxy_Broker : public virtual _TAO_EnumDef_Proxy_Broker { -public: +public: _TAO_EnumDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_EnumDef_Remote_Proxy_Broker (void); virtual _TAO_EnumDef_Proxy_Impl &select_proxy ( @@ -7872,7 +7872,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -7893,12 +7893,12 @@ public: static IR_AliasDef_ptr _duplicate (IR_AliasDef_ptr obj); static IR_AliasDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_AliasDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_AliasDef_ptr _nil (void) @@ -7909,7 +7909,7 @@ public: static void _tao_any_destructor (void*); virtual IR_IDLType_ptr original_type_def ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -7918,7 +7918,7 @@ public: virtual void original_type_def ( IR_IDLType_ptr original_type_def, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -7926,39 +7926,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_AliasDef_Proxy_Broker *the_TAO_AliasDef_Proxy_Broker_; - + protected: IR_AliasDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_AliasDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_AliasDef_Remote_Proxy_Impl; friend class _TAO_AliasDef_ThruPOA_Proxy_Impl; friend class _TAO_AliasDef_Direct_Proxy_Impl; - + virtual ~IR_AliasDef (void); private: IR_AliasDef (const IR_AliasDef &); - void operator= (const IR_AliasDef &); + void operator= (const IR_AliasDef &); }; @@ -7971,12 +7971,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_AliasDef_Proxy_Impl : +class TAO_Export _TAO_AliasDef_Proxy_Impl : public virtual _TAO_TypedefDef_Proxy_Impl { public: virtual ~_TAO_AliasDef_Proxy_Impl (void) { } - + virtual IR_IDLType_ptr original_type_def ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -8008,17 +8008,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_AliasDef_Remote_Proxy_Impl : +class TAO_Export _TAO_AliasDef_Remote_Proxy_Impl : public virtual _TAO_AliasDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_TypedefDef_Remote_Proxy_Impl - + { public: _TAO_AliasDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_AliasDef_Remote_Proxy_Impl (void) { } - + virtual IR_IDLType_ptr original_type_def ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -8044,14 +8044,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_AliasDef_Proxy_Broker @@ -8066,24 +8066,24 @@ public: protected: _TAO_AliasDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_AliasDef_Remote_Proxy_Broker : public virtual _TAO_AliasDef_Proxy_Broker { -public: +public: _TAO_AliasDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_AliasDef_Remote_Proxy_Broker (void); virtual _TAO_AliasDef_Proxy_Impl &select_proxy ( @@ -8102,7 +8102,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -8123,12 +8123,12 @@ public: static IR_NativeDef_ptr _duplicate (IR_NativeDef_ptr obj); static IR_NativeDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_NativeDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_NativeDef_ptr _nil (void) @@ -8139,82 +8139,82 @@ public: static void _tao_any_destructor (void*); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_NativeDef_Proxy_Broker *the_TAO_NativeDef_Proxy_Broker_; - + protected: IR_NativeDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_NativeDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_NativeDef_Remote_Proxy_Impl; friend class _TAO_NativeDef_ThruPOA_Proxy_Impl; friend class _TAO_NativeDef_Direct_Proxy_Impl; - + virtual ~IR_NativeDef (void); private: IR_NativeDef (const IR_NativeDef &); - void operator= (const IR_NativeDef &); + void operator= (const IR_NativeDef &); }; - + // The Proxy Implementations are used by each interface to // perform a call. Each different implementation encapsulate // an invocation logics. - + /////////////////////////////////////////////////////////////////////// // Base Impl. Declaration // - -class TAO_Export _TAO_NativeDef_Proxy_Impl : + +class TAO_Export _TAO_NativeDef_Proxy_Impl : public virtual _TAO_TypedefDef_Proxy_Impl { public: virtual ~_TAO_NativeDef_Proxy_Impl (void) { } - + protected: _TAO_NativeDef_Proxy_Impl (void); - + }; - + // // Base Proxy Impl. Declaration /////////////////////////////////////////////////////////////////////// - - + + /////////////////////////////////////////////////////////////////////// // Remote Impl. Declaration // -class TAO_Export _TAO_NativeDef_Remote_Proxy_Impl : +class TAO_Export _TAO_NativeDef_Remote_Proxy_Impl : public virtual _TAO_NativeDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_TypedefDef_Remote_Proxy_Impl - + { public: _TAO_NativeDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_NativeDef_Remote_Proxy_Impl (void) { } - + }; // @@ -8223,14 +8223,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_NativeDef_Proxy_Broker @@ -8245,24 +8245,24 @@ public: protected: _TAO_NativeDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_NativeDef_Remote_Proxy_Broker : public virtual _TAO_NativeDef_Proxy_Broker { -public: +public: _TAO_NativeDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_NativeDef_Remote_Proxy_Broker (void); virtual _TAO_NativeDef_Proxy_Impl &select_proxy ( @@ -8281,7 +8281,7 @@ private: _TAO_NativeDef_Remote_Proxy_Broker *the_TAO_NativeDef_Remote_Proxy_Broker (void); // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -8302,12 +8302,12 @@ public: static IR_PrimitiveDef_ptr _duplicate (IR_PrimitiveDef_ptr obj); static IR_PrimitiveDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_PrimitiveDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_PrimitiveDef_ptr _nil (void) @@ -8318,7 +8318,7 @@ public: static void _tao_any_destructor (void*); virtual IR_PrimitiveKind kind ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -8326,39 +8326,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_PrimitiveDef_Proxy_Broker *the_TAO_PrimitiveDef_Proxy_Broker_; - + protected: IR_PrimitiveDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_PrimitiveDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_PrimitiveDef_Remote_Proxy_Impl; friend class _TAO_PrimitiveDef_ThruPOA_Proxy_Impl; friend class _TAO_PrimitiveDef_Direct_Proxy_Impl; - + virtual ~IR_PrimitiveDef (void); private: IR_PrimitiveDef (const IR_PrimitiveDef &); - void operator= (const IR_PrimitiveDef &); + void operator= (const IR_PrimitiveDef &); }; @@ -8371,12 +8371,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_PrimitiveDef_Proxy_Impl : +class TAO_Export _TAO_PrimitiveDef_Proxy_Impl : public virtual _TAO_IDLType_Proxy_Impl { public: virtual ~_TAO_PrimitiveDef_Proxy_Impl (void) { } - + virtual IR_PrimitiveKind kind ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -8399,17 +8399,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_PrimitiveDef_Remote_Proxy_Impl : +class TAO_Export _TAO_PrimitiveDef_Remote_Proxy_Impl : public virtual _TAO_PrimitiveDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_IDLType_Remote_Proxy_Impl - + { public: _TAO_PrimitiveDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_PrimitiveDef_Remote_Proxy_Impl (void) { } - + virtual IR_PrimitiveKind kind ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -8426,14 +8426,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_PrimitiveDef_Proxy_Broker @@ -8448,24 +8448,24 @@ public: protected: _TAO_PrimitiveDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_PrimitiveDef_Remote_Proxy_Broker : public virtual _TAO_PrimitiveDef_Proxy_Broker { -public: +public: _TAO_PrimitiveDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_PrimitiveDef_Remote_Proxy_Broker (void); virtual _TAO_PrimitiveDef_Proxy_Impl &select_proxy ( @@ -8484,7 +8484,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -8505,12 +8505,12 @@ public: static IR_StringDef_ptr _duplicate (IR_StringDef_ptr obj); static IR_StringDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_StringDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_StringDef_ptr _nil (void) @@ -8521,7 +8521,7 @@ public: static void _tao_any_destructor (void*); virtual CORBA::ULong bound ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -8530,7 +8530,7 @@ public: virtual void bound ( CORBA::ULong bound, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -8538,39 +8538,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_StringDef_Proxy_Broker *the_TAO_StringDef_Proxy_Broker_; - + protected: IR_StringDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_StringDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_StringDef_Remote_Proxy_Impl; friend class _TAO_StringDef_ThruPOA_Proxy_Impl; friend class _TAO_StringDef_Direct_Proxy_Impl; - + virtual ~IR_StringDef (void); private: IR_StringDef (const IR_StringDef &); - void operator= (const IR_StringDef &); + void operator= (const IR_StringDef &); }; @@ -8583,12 +8583,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_StringDef_Proxy_Impl : +class TAO_Export _TAO_StringDef_Proxy_Impl : public virtual _TAO_IDLType_Proxy_Impl { public: virtual ~_TAO_StringDef_Proxy_Impl (void) { } - + virtual CORBA::ULong bound ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -8620,17 +8620,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_StringDef_Remote_Proxy_Impl : +class TAO_Export _TAO_StringDef_Remote_Proxy_Impl : public virtual _TAO_StringDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_IDLType_Remote_Proxy_Impl - + { public: _TAO_StringDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_StringDef_Remote_Proxy_Impl (void) { } - + virtual CORBA::ULong bound ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -8656,14 +8656,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_StringDef_Proxy_Broker @@ -8678,24 +8678,24 @@ public: protected: _TAO_StringDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_StringDef_Remote_Proxy_Broker : public virtual _TAO_StringDef_Proxy_Broker { -public: +public: _TAO_StringDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_StringDef_Remote_Proxy_Broker (void); virtual _TAO_StringDef_Proxy_Impl &select_proxy ( @@ -8714,7 +8714,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -8735,12 +8735,12 @@ public: static IR_WstringDef_ptr _duplicate (IR_WstringDef_ptr obj); static IR_WstringDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_WstringDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_WstringDef_ptr _nil (void) @@ -8751,7 +8751,7 @@ public: static void _tao_any_destructor (void*); virtual CORBA::ULong bound ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -8760,7 +8760,7 @@ public: virtual void bound ( CORBA::ULong bound, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -8768,39 +8768,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_WstringDef_Proxy_Broker *the_TAO_WstringDef_Proxy_Broker_; - + protected: IR_WstringDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_WstringDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_WstringDef_Remote_Proxy_Impl; friend class _TAO_WstringDef_ThruPOA_Proxy_Impl; friend class _TAO_WstringDef_Direct_Proxy_Impl; - + virtual ~IR_WstringDef (void); private: IR_WstringDef (const IR_WstringDef &); - void operator= (const IR_WstringDef &); + void operator= (const IR_WstringDef &); }; @@ -8813,12 +8813,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_WstringDef_Proxy_Impl : +class TAO_Export _TAO_WstringDef_Proxy_Impl : public virtual _TAO_IDLType_Proxy_Impl { public: virtual ~_TAO_WstringDef_Proxy_Impl (void) { } - + virtual CORBA::ULong bound ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -8850,17 +8850,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_WstringDef_Remote_Proxy_Impl : +class TAO_Export _TAO_WstringDef_Remote_Proxy_Impl : public virtual _TAO_WstringDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_IDLType_Remote_Proxy_Impl - + { public: _TAO_WstringDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_WstringDef_Remote_Proxy_Impl (void) { } - + virtual CORBA::ULong bound ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -8886,14 +8886,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_WstringDef_Proxy_Broker @@ -8908,24 +8908,24 @@ public: protected: _TAO_WstringDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_WstringDef_Remote_Proxy_Broker : public virtual _TAO_WstringDef_Proxy_Broker { -public: +public: _TAO_WstringDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_WstringDef_Remote_Proxy_Broker (void); virtual _TAO_WstringDef_Proxy_Impl &select_proxy ( @@ -8944,7 +8944,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -8965,12 +8965,12 @@ public: static IR_FixedDef_ptr _duplicate (IR_FixedDef_ptr obj); static IR_FixedDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_FixedDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_FixedDef_ptr _nil (void) @@ -8981,7 +8981,7 @@ public: static void _tao_any_destructor (void*); virtual CORBA::UShort digits ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -8990,7 +8990,7 @@ public: virtual void digits ( CORBA::UShort digits, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -8998,7 +8998,7 @@ public: )); virtual CORBA::Short scale ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9007,7 +9007,7 @@ public: virtual void scale ( CORBA::Short scale, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9015,39 +9015,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_FixedDef_Proxy_Broker *the_TAO_FixedDef_Proxy_Broker_; - + protected: IR_FixedDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_FixedDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_FixedDef_Remote_Proxy_Impl; friend class _TAO_FixedDef_ThruPOA_Proxy_Impl; friend class _TAO_FixedDef_Direct_Proxy_Impl; - + virtual ~IR_FixedDef (void); private: IR_FixedDef (const IR_FixedDef &); - void operator= (const IR_FixedDef &); + void operator= (const IR_FixedDef &); }; @@ -9060,12 +9060,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_FixedDef_Proxy_Impl : +class TAO_Export _TAO_FixedDef_Proxy_Impl : public virtual _TAO_IDLType_Proxy_Impl { public: virtual ~_TAO_FixedDef_Proxy_Impl (void) { } - + virtual CORBA::UShort digits ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -9114,17 +9114,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_FixedDef_Remote_Proxy_Impl : +class TAO_Export _TAO_FixedDef_Remote_Proxy_Impl : public virtual _TAO_FixedDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_IDLType_Remote_Proxy_Impl - + { public: _TAO_FixedDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_FixedDef_Remote_Proxy_Impl (void) { } - + virtual CORBA::UShort digits ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -9167,14 +9167,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_FixedDef_Proxy_Broker @@ -9189,24 +9189,24 @@ public: protected: _TAO_FixedDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_FixedDef_Remote_Proxy_Broker : public virtual _TAO_FixedDef_Proxy_Broker { -public: +public: _TAO_FixedDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_FixedDef_Remote_Proxy_Broker (void); virtual _TAO_FixedDef_Proxy_Impl &select_proxy ( @@ -9225,7 +9225,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -9246,12 +9246,12 @@ public: static IR_SequenceDef_ptr _duplicate (IR_SequenceDef_ptr obj); static IR_SequenceDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_SequenceDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_SequenceDef_ptr _nil (void) @@ -9262,7 +9262,7 @@ public: static void _tao_any_destructor (void*); virtual CORBA::ULong bound ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9271,7 +9271,7 @@ public: virtual void bound ( CORBA::ULong bound, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9279,7 +9279,7 @@ public: )); virtual CORBA::TypeCode_ptr element_type ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9287,7 +9287,7 @@ public: )); virtual IR_IDLType_ptr element_type_def ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9296,7 +9296,7 @@ public: virtual void element_type_def ( IR_IDLType_ptr element_type_def, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9304,39 +9304,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_SequenceDef_Proxy_Broker *the_TAO_SequenceDef_Proxy_Broker_; - + protected: IR_SequenceDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_SequenceDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_SequenceDef_Remote_Proxy_Impl; friend class _TAO_SequenceDef_ThruPOA_Proxy_Impl; friend class _TAO_SequenceDef_Direct_Proxy_Impl; - + virtual ~IR_SequenceDef (void); private: IR_SequenceDef (const IR_SequenceDef &); - void operator= (const IR_SequenceDef &); + void operator= (const IR_SequenceDef &); }; @@ -9349,12 +9349,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_SequenceDef_Proxy_Impl : +class TAO_Export _TAO_SequenceDef_Proxy_Impl : public virtual _TAO_IDLType_Proxy_Impl { public: virtual ~_TAO_SequenceDef_Proxy_Impl (void) { } - + virtual CORBA::ULong bound ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -9412,17 +9412,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_SequenceDef_Remote_Proxy_Impl : +class TAO_Export _TAO_SequenceDef_Remote_Proxy_Impl : public virtual _TAO_SequenceDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_IDLType_Remote_Proxy_Impl - + { public: _TAO_SequenceDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_SequenceDef_Remote_Proxy_Impl (void) { } - + virtual CORBA::ULong bound ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -9473,14 +9473,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_SequenceDef_Proxy_Broker @@ -9495,24 +9495,24 @@ public: protected: _TAO_SequenceDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_SequenceDef_Remote_Proxy_Broker : public virtual _TAO_SequenceDef_Proxy_Broker { -public: +public: _TAO_SequenceDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_SequenceDef_Remote_Proxy_Broker (void); virtual _TAO_SequenceDef_Proxy_Impl &select_proxy ( @@ -9531,7 +9531,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -9552,12 +9552,12 @@ public: static IR_ArrayDef_ptr _duplicate (IR_ArrayDef_ptr obj); static IR_ArrayDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ArrayDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ArrayDef_ptr _nil (void) @@ -9568,7 +9568,7 @@ public: static void _tao_any_destructor (void*); virtual CORBA::ULong length ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9577,7 +9577,7 @@ public: virtual void length ( CORBA::ULong length, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9585,7 +9585,7 @@ public: )); virtual CORBA::TypeCode_ptr element_type ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9593,7 +9593,7 @@ public: )); virtual IR_IDLType_ptr element_type_def ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9602,7 +9602,7 @@ public: virtual void element_type_def ( IR_IDLType_ptr element_type_def, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9610,39 +9610,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_ArrayDef_Proxy_Broker *the_TAO_ArrayDef_Proxy_Broker_; - + protected: IR_ArrayDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_ArrayDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_ArrayDef_Remote_Proxy_Impl; friend class _TAO_ArrayDef_ThruPOA_Proxy_Impl; friend class _TAO_ArrayDef_Direct_Proxy_Impl; - + virtual ~IR_ArrayDef (void); private: IR_ArrayDef (const IR_ArrayDef &); - void operator= (const IR_ArrayDef &); + void operator= (const IR_ArrayDef &); }; @@ -9655,12 +9655,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_ArrayDef_Proxy_Impl : +class TAO_Export _TAO_ArrayDef_Proxy_Impl : public virtual _TAO_IDLType_Proxy_Impl { public: virtual ~_TAO_ArrayDef_Proxy_Impl (void) { } - + virtual CORBA::ULong length ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -9717,17 +9717,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_ArrayDef_Remote_Proxy_Impl : +class TAO_Export _TAO_ArrayDef_Remote_Proxy_Impl : public virtual _TAO_ArrayDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_IDLType_Remote_Proxy_Impl - + { public: _TAO_ArrayDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_ArrayDef_Remote_Proxy_Impl (void) { } - + virtual CORBA::ULong length ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -9778,14 +9778,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_ArrayDef_Proxy_Broker @@ -9800,24 +9800,24 @@ public: protected: _TAO_ArrayDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_ArrayDef_Remote_Proxy_Broker : public virtual _TAO_ArrayDef_Proxy_Broker { -public: +public: _TAO_ArrayDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_ArrayDef_Remote_Proxy_Broker (void); virtual _TAO_ArrayDef_Proxy_Impl &select_proxy ( @@ -9836,7 +9836,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -9845,8 +9845,8 @@ class _TAO_ExceptionDef_Remote_Proxy_Impl; class _TAO_ExceptionDef_Proxy_Broker; class _TAO_ExceptionDef_Remote_Proxy_Broker; -class TAO_Export IR_ExceptionDef - : public virtual IR_Contained, +class TAO_Export IR_ExceptionDef + : public virtual IR_Contained, public virtual IR_Container { public: @@ -9859,12 +9859,12 @@ public: static IR_ExceptionDef_ptr _duplicate (IR_ExceptionDef_ptr obj); static IR_ExceptionDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ExceptionDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ExceptionDef_ptr _nil (void) @@ -9875,7 +9875,7 @@ public: static void _tao_any_destructor (void*); virtual CORBA::TypeCode_ptr type ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9883,7 +9883,7 @@ public: )); virtual IR_StructMemberSeq * members ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9892,7 +9892,7 @@ public: virtual void members ( const IR_StructMemberSeq & members, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -9900,39 +9900,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_ExceptionDef_Proxy_Broker *the_TAO_ExceptionDef_Proxy_Broker_; - + protected: IR_ExceptionDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_ExceptionDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_ExceptionDef_Remote_Proxy_Impl; friend class _TAO_ExceptionDef_ThruPOA_Proxy_Impl; friend class _TAO_ExceptionDef_Direct_Proxy_Impl; - + virtual ~IR_ExceptionDef (void); private: IR_ExceptionDef (const IR_ExceptionDef &); - void operator= (const IR_ExceptionDef &); + void operator= (const IR_ExceptionDef &); }; @@ -9945,13 +9945,13 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_ExceptionDef_Proxy_Impl : - public virtual _TAO_Contained_Proxy_Impl, +class TAO_Export _TAO_ExceptionDef_Proxy_Impl : + public virtual _TAO_Contained_Proxy_Impl, public virtual _TAO_Container_Proxy_Impl { public: virtual ~_TAO_ExceptionDef_Proxy_Impl (void) { } - + virtual CORBA::TypeCode_ptr type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -9991,18 +9991,18 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_ExceptionDef_Remote_Proxy_Impl : +class TAO_Export _TAO_ExceptionDef_Remote_Proxy_Impl : public virtual _TAO_ExceptionDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, - public virtual _TAO_Contained_Remote_Proxy_Impl, + public virtual _TAO_Contained_Remote_Proxy_Impl, public virtual _TAO_Container_Remote_Proxy_Impl - + { public: _TAO_ExceptionDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_ExceptionDef_Remote_Proxy_Impl (void) { } - + virtual CORBA::TypeCode_ptr type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -10036,14 +10036,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_ExceptionDef_Proxy_Broker @@ -10058,24 +10058,24 @@ public: protected: _TAO_ExceptionDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_ExceptionDef_Remote_Proxy_Broker : public virtual _TAO_ExceptionDef_Proxy_Broker { -public: +public: _TAO_ExceptionDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_ExceptionDef_Remote_Proxy_Broker (void); virtual _TAO_ExceptionDef_Proxy_Impl &select_proxy ( @@ -10094,7 +10094,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// struct TAO_Export IR_ExceptionDescription @@ -10120,18 +10120,18 @@ public: IR_ExceptionDescription_var (IR_ExceptionDescription *); IR_ExceptionDescription_var (const IR_ExceptionDescription_var &); // copy constructor ~IR_ExceptionDescription_var (void); // destructor - + IR_ExceptionDescription_var &operator= (IR_ExceptionDescription *); IR_ExceptionDescription_var &operator= (const IR_ExceptionDescription_var &); IR_ExceptionDescription *operator-> (void); const IR_ExceptionDescription *operator-> (void) const; - + operator const IR_ExceptionDescription &() const; operator IR_ExceptionDescription &(); operator IR_ExceptionDescription &() const; operator IR_ExceptionDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ExceptionDescription &in (void) const; IR_ExceptionDescription &inout (void); IR_ExceptionDescription *&out (void); @@ -10153,7 +10153,7 @@ public: operator IR_ExceptionDescription *&(); IR_ExceptionDescription *&ptr (void); IR_ExceptionDescription *operator-> (void); - + private: IR_ExceptionDescription *&ptr_; // assignment from T_var not allowed @@ -10161,12 +10161,12 @@ private: }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class _TAO_Unbounded_Object_Sequence_IR_ExceptionDefSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Object_Sequence_IR_ExceptionDefSeq (void); _TAO_Unbounded_Object_Sequence_IR_ExceptionDefSeq (CORBA::ULong maximum); _TAO_Unbounded_Object_Sequence_IR_ExceptionDefSeq (CORBA::ULong maximum, @@ -10188,33 +10188,33 @@ private: virtual void _downcast ( void* target, CORBA_Object *src, - CORBA_Environment &ACE_TRY_ENV = + CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual CORBA_Object* _upcast (void *src) const; - + }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_ExceptionDefSeq // ************************************************************* -class TAO_Export IR_ExceptionDefSeq : public +class TAO_Export IR_ExceptionDefSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Object_Sequence_IR_ExceptionDefSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Object_Sequence<IR_ExceptionDef,IR_ExceptionDef_var> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_ExceptionDefSeq (void); // default ctor IR_ExceptionDefSeq (CORBA::ULong max); // uses max size IR_ExceptionDefSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_ExceptionDef_ptr *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_ExceptionDef_ptr *buffer, CORBA::Boolean release = 0 ); IR_ExceptionDefSeq (const IR_ExceptionDefSeq &); // copy ctor @@ -10238,20 +10238,20 @@ public: IR_ExceptionDefSeq_var (IR_ExceptionDefSeq *); IR_ExceptionDefSeq_var (const IR_ExceptionDefSeq_var &); // copy constructor ~IR_ExceptionDefSeq_var (void); // destructor - + IR_ExceptionDefSeq_var &operator= (IR_ExceptionDefSeq *); IR_ExceptionDefSeq_var &operator= (const IR_ExceptionDefSeq_var &); IR_ExceptionDefSeq *operator-> (void); const IR_ExceptionDefSeq *operator-> (void) const; - + operator const IR_ExceptionDefSeq &() const; operator IR_ExceptionDefSeq &(); operator IR_ExceptionDefSeq &() const; operator IR_ExceptionDefSeq *&(); // variable-size base types only - + TAO_Object_Manager<IR_ExceptionDef, IR_ExceptionDef_var> operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ExceptionDefSeq &in (void) const; IR_ExceptionDefSeq &inout (void); IR_ExceptionDefSeq *&out (void); @@ -10274,7 +10274,7 @@ public: IR_ExceptionDefSeq *&ptr (void); IR_ExceptionDefSeq *operator-> (void); TAO_Object_Manager<IR_ExceptionDef, IR_ExceptionDef_var> operator[] (CORBA::ULong index); - + private: IR_ExceptionDefSeq *&ptr_; // assignment from T_var not allowed @@ -10282,14 +10282,14 @@ private: }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class TAO_EXPORT_NESTED_MACRO _TAO_Unbounded_Sequence_IR_ExcDescriptionSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Sequence_IR_ExcDescriptionSeq (void); // Default constructor. - _TAO_Unbounded_Sequence_IR_ExcDescriptionSeq (CORBA::ULong maximum); + _TAO_Unbounded_Sequence_IR_ExcDescriptionSeq (CORBA::ULong maximum); _TAO_Unbounded_Sequence_IR_ExcDescriptionSeq (CORBA::ULong maximum, CORBA::ULong length, IR_ExceptionDescription *data, @@ -10306,7 +10306,7 @@ private: virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); // Implement the TAO_Base_Sequence methods (see Sequence.h) - + IR_ExceptionDescription *get_buffer (CORBA::Boolean orphan = 0); const IR_ExceptionDescription *get_buffer (void) const; void replace (CORBA::ULong max, @@ -10315,26 +10315,26 @@ private: CORBA::Boolean release); }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_ExcDescriptionSeq // ************************************************************* -class TAO_Export IR_ExcDescriptionSeq : public +class TAO_Export IR_ExcDescriptionSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Sequence_IR_ExcDescriptionSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Sequence<IR_ExceptionDescription> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_ExcDescriptionSeq (void); // default ctor IR_ExcDescriptionSeq (CORBA::ULong max); // uses max size IR_ExcDescriptionSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_ExceptionDescription *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_ExceptionDescription *buffer, CORBA::Boolean release = 0 ); IR_ExcDescriptionSeq (const IR_ExcDescriptionSeq &); // copy ctor @@ -10358,21 +10358,21 @@ public: IR_ExcDescriptionSeq_var (IR_ExcDescriptionSeq *); IR_ExcDescriptionSeq_var (const IR_ExcDescriptionSeq_var &); // copy constructor ~IR_ExcDescriptionSeq_var (void); // destructor - + IR_ExcDescriptionSeq_var &operator= (IR_ExcDescriptionSeq *); IR_ExcDescriptionSeq_var &operator= (const IR_ExcDescriptionSeq_var &); IR_ExcDescriptionSeq *operator-> (void); const IR_ExcDescriptionSeq *operator-> (void) const; - + operator const IR_ExcDescriptionSeq &() const; operator IR_ExcDescriptionSeq &(); operator IR_ExcDescriptionSeq &() const; operator IR_ExcDescriptionSeq *&(); // variable-size base types only - + IR_ExceptionDescription & operator[] (CORBA::ULong index); const IR_ExceptionDescription & operator[] (CORBA::ULong index) const; - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ExcDescriptionSeq &in (void) const; IR_ExcDescriptionSeq &inout (void); IR_ExcDescriptionSeq *&out (void); @@ -10395,7 +10395,7 @@ public: IR_ExcDescriptionSeq *&ptr (void); IR_ExcDescriptionSeq *operator-> (void); IR_ExceptionDescription & operator[] (CORBA::ULong index); - + private: IR_ExcDescriptionSeq *&ptr_; // assignment from T_var not allowed @@ -10406,17 +10406,17 @@ class TAO_Export IR_AttributeDef_var : public TAO_Base_var { public: IR_AttributeDef_var (void); // default constructor - IR_AttributeDef_var (IR_AttributeDef_ptr p) : ptr_ (p) {} + IR_AttributeDef_var (IR_AttributeDef_ptr p) : ptr_ (p) {} IR_AttributeDef_var (const IR_AttributeDef_var &); // copy constructor ~IR_AttributeDef_var (void); // destructor - + IR_AttributeDef_var &operator= (IR_AttributeDef_ptr); IR_AttributeDef_var &operator= (const IR_AttributeDef_var &); IR_AttributeDef_ptr operator-> (void) const; - + operator const IR_AttributeDef_ptr &() const; operator IR_AttributeDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_AttributeDef_ptr in (void) const; IR_AttributeDef_ptr &inout (void); IR_AttributeDef_ptr &out (void); @@ -10442,7 +10442,7 @@ public: operator IR_AttributeDef_ptr &(); IR_AttributeDef_ptr &ptr (void); IR_AttributeDef_ptr operator-> (void); - + private: IR_AttributeDef_ptr &ptr_; }; @@ -10465,12 +10465,12 @@ public: static IR_AttributeDef_ptr _duplicate (IR_AttributeDef_ptr obj); static IR_AttributeDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_AttributeDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_AttributeDef_ptr _nil (void) @@ -10481,7 +10481,7 @@ public: static void _tao_any_destructor (void*); virtual CORBA::TypeCode_ptr type ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -10489,7 +10489,7 @@ public: )); virtual IR_IDLType_ptr type_def ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -10498,7 +10498,7 @@ public: virtual void type_def ( IR_IDLType_ptr type_def, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -10506,7 +10506,7 @@ public: )); virtual IR_AttributeMode mode ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -10515,7 +10515,7 @@ public: virtual void mode ( IR_AttributeMode mode, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -10523,39 +10523,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_AttributeDef_Proxy_Broker *the_TAO_AttributeDef_Proxy_Broker_; - + protected: IR_AttributeDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_AttributeDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_AttributeDef_Remote_Proxy_Impl; friend class _TAO_AttributeDef_ThruPOA_Proxy_Impl; friend class _TAO_AttributeDef_Direct_Proxy_Impl; - + virtual ~IR_AttributeDef (void); private: IR_AttributeDef (const IR_AttributeDef &); - void operator= (const IR_AttributeDef &); + void operator= (const IR_AttributeDef &); }; @@ -10568,12 +10568,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_AttributeDef_Proxy_Impl : +class TAO_Export _TAO_AttributeDef_Proxy_Impl : public virtual _TAO_Contained_Proxy_Impl { public: virtual ~_TAO_AttributeDef_Proxy_Impl (void) { } - + virtual CORBA::TypeCode_ptr type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -10630,17 +10630,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_AttributeDef_Remote_Proxy_Impl : +class TAO_Export _TAO_AttributeDef_Remote_Proxy_Impl : public virtual _TAO_AttributeDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_Contained_Remote_Proxy_Impl - + { public: _TAO_AttributeDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_AttributeDef_Remote_Proxy_Impl (void) { } - + virtual CORBA::TypeCode_ptr type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -10691,14 +10691,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_AttributeDef_Proxy_Broker @@ -10713,24 +10713,24 @@ public: protected: _TAO_AttributeDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_AttributeDef_Remote_Proxy_Broker : public virtual _TAO_AttributeDef_Proxy_Broker { -public: +public: _TAO_AttributeDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_AttributeDef_Remote_Proxy_Broker (void); virtual _TAO_AttributeDef_Proxy_Impl &select_proxy ( @@ -10749,7 +10749,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// struct TAO_Export IR_AttributeDescription @@ -10778,18 +10778,18 @@ public: IR_AttributeDescription_var (IR_AttributeDescription *); IR_AttributeDescription_var (const IR_AttributeDescription_var &); // copy constructor ~IR_AttributeDescription_var (void); // destructor - + IR_AttributeDescription_var &operator= (IR_AttributeDescription *); IR_AttributeDescription_var &operator= (const IR_AttributeDescription_var &); IR_AttributeDescription *operator-> (void); const IR_AttributeDescription *operator-> (void) const; - + operator const IR_AttributeDescription &() const; operator IR_AttributeDescription &(); operator IR_AttributeDescription &() const; operator IR_AttributeDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_AttributeDescription &in (void) const; IR_AttributeDescription &inout (void); IR_AttributeDescription *&out (void); @@ -10811,7 +10811,7 @@ public: operator IR_AttributeDescription *&(); IR_AttributeDescription *&ptr (void); IR_AttributeDescription *operator-> (void); - + private: IR_AttributeDescription *&ptr_; // assignment from T_var not allowed @@ -10840,18 +10840,18 @@ public: IR_ParameterDescription_var (IR_ParameterDescription *); IR_ParameterDescription_var (const IR_ParameterDescription_var &); // copy constructor ~IR_ParameterDescription_var (void); // destructor - + IR_ParameterDescription_var &operator= (IR_ParameterDescription *); IR_ParameterDescription_var &operator= (const IR_ParameterDescription_var &); IR_ParameterDescription *operator-> (void); const IR_ParameterDescription *operator-> (void) const; - + operator const IR_ParameterDescription &() const; operator IR_ParameterDescription &(); operator IR_ParameterDescription &() const; operator IR_ParameterDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ParameterDescription &in (void) const; IR_ParameterDescription &inout (void); IR_ParameterDescription *&out (void); @@ -10873,7 +10873,7 @@ public: operator IR_ParameterDescription *&(); IR_ParameterDescription *&ptr (void); IR_ParameterDescription *operator-> (void); - + private: IR_ParameterDescription *&ptr_; // assignment from T_var not allowed @@ -10881,14 +10881,14 @@ private: }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class TAO_EXPORT_NESTED_MACRO _TAO_Unbounded_Sequence_IR_ParDescriptionSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Sequence_IR_ParDescriptionSeq (void); // Default constructor. - _TAO_Unbounded_Sequence_IR_ParDescriptionSeq (CORBA::ULong maximum); + _TAO_Unbounded_Sequence_IR_ParDescriptionSeq (CORBA::ULong maximum); _TAO_Unbounded_Sequence_IR_ParDescriptionSeq (CORBA::ULong maximum, CORBA::ULong length, IR_ParameterDescription *data, @@ -10905,7 +10905,7 @@ private: virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); // Implement the TAO_Base_Sequence methods (see Sequence.h) - + IR_ParameterDescription *get_buffer (CORBA::Boolean orphan = 0); const IR_ParameterDescription *get_buffer (void) const; void replace (CORBA::ULong max, @@ -10914,26 +10914,26 @@ private: CORBA::Boolean release); }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_ParDescriptionSeq // ************************************************************* -class TAO_Export IR_ParDescriptionSeq : public +class TAO_Export IR_ParDescriptionSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Sequence_IR_ParDescriptionSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Sequence<IR_ParameterDescription> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_ParDescriptionSeq (void); // default ctor IR_ParDescriptionSeq (CORBA::ULong max); // uses max size IR_ParDescriptionSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_ParameterDescription *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_ParameterDescription *buffer, CORBA::Boolean release = 0 ); IR_ParDescriptionSeq (const IR_ParDescriptionSeq &); // copy ctor @@ -10957,21 +10957,21 @@ public: IR_ParDescriptionSeq_var (IR_ParDescriptionSeq *); IR_ParDescriptionSeq_var (const IR_ParDescriptionSeq_var &); // copy constructor ~IR_ParDescriptionSeq_var (void); // destructor - + IR_ParDescriptionSeq_var &operator= (IR_ParDescriptionSeq *); IR_ParDescriptionSeq_var &operator= (const IR_ParDescriptionSeq_var &); IR_ParDescriptionSeq *operator-> (void); const IR_ParDescriptionSeq *operator-> (void) const; - + operator const IR_ParDescriptionSeq &() const; operator IR_ParDescriptionSeq &(); operator IR_ParDescriptionSeq &() const; operator IR_ParDescriptionSeq *&(); // variable-size base types only - + IR_ParameterDescription & operator[] (CORBA::ULong index); const IR_ParameterDescription & operator[] (CORBA::ULong index) const; - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ParDescriptionSeq &in (void) const; IR_ParDescriptionSeq &inout (void); IR_ParDescriptionSeq *&out (void); @@ -10994,7 +10994,7 @@ public: IR_ParDescriptionSeq *&ptr (void); IR_ParDescriptionSeq *operator-> (void); IR_ParameterDescription & operator[] (CORBA::ULong index); - + private: IR_ParDescriptionSeq *&ptr_; // assignment from T_var not allowed @@ -11005,20 +11005,20 @@ private: // IR_ContextIdSeq // ************************************************************* -class TAO_Export IR_ContextIdSeq : public +class TAO_Export IR_ContextIdSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) TAO_Unbounded_String_Sequence #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_String_Sequence -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_ContextIdSeq (void); // default ctor IR_ContextIdSeq (CORBA::ULong max); // uses max size IR_ContextIdSeq ( - CORBA::ULong max, - CORBA::ULong length, - char * *buffer, + CORBA::ULong max, + CORBA::ULong length, + char * *buffer, CORBA::Boolean release = 0 ); IR_ContextIdSeq (const IR_ContextIdSeq &); // copy ctor @@ -11042,20 +11042,20 @@ public: IR_ContextIdSeq_var (IR_ContextIdSeq *); IR_ContextIdSeq_var (const IR_ContextIdSeq_var &); // copy constructor ~IR_ContextIdSeq_var (void); // destructor - + IR_ContextIdSeq_var &operator= (IR_ContextIdSeq *); IR_ContextIdSeq_var &operator= (const IR_ContextIdSeq_var &); IR_ContextIdSeq *operator-> (void); const IR_ContextIdSeq *operator-> (void) const; - + operator const IR_ContextIdSeq &() const; operator IR_ContextIdSeq &(); operator IR_ContextIdSeq &() const; operator IR_ContextIdSeq *&(); // variable-size base types only - + TAO_SeqElem_String_Manager operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ContextIdSeq &in (void) const; IR_ContextIdSeq &inout (void); IR_ContextIdSeq *&out (void); @@ -11078,7 +11078,7 @@ public: IR_ContextIdSeq *&ptr (void); IR_ContextIdSeq *operator-> (void); TAO_SeqElem_String_Manager operator[] (CORBA::ULong index); - + private: IR_ContextIdSeq *&ptr_; // assignment from T_var not allowed @@ -11089,17 +11089,17 @@ class TAO_Export IR_OperationDef_var : public TAO_Base_var { public: IR_OperationDef_var (void); // default constructor - IR_OperationDef_var (IR_OperationDef_ptr p) : ptr_ (p) {} + IR_OperationDef_var (IR_OperationDef_ptr p) : ptr_ (p) {} IR_OperationDef_var (const IR_OperationDef_var &); // copy constructor ~IR_OperationDef_var (void); // destructor - + IR_OperationDef_var &operator= (IR_OperationDef_ptr); IR_OperationDef_var &operator= (const IR_OperationDef_var &); IR_OperationDef_ptr operator-> (void) const; - + operator const IR_OperationDef_ptr &() const; operator IR_OperationDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_OperationDef_ptr in (void) const; IR_OperationDef_ptr &inout (void); IR_OperationDef_ptr &out (void); @@ -11125,7 +11125,7 @@ public: operator IR_OperationDef_ptr &(); IR_OperationDef_ptr &ptr (void); IR_OperationDef_ptr operator-> (void); - + private: IR_OperationDef_ptr &ptr_; }; @@ -11148,12 +11148,12 @@ public: static IR_OperationDef_ptr _duplicate (IR_OperationDef_ptr obj); static IR_OperationDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_OperationDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_OperationDef_ptr _nil (void) @@ -11164,7 +11164,7 @@ public: static void _tao_any_destructor (void*); virtual CORBA::TypeCode_ptr result ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -11172,7 +11172,7 @@ public: )); virtual IR_IDLType_ptr result_def ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -11181,7 +11181,7 @@ public: virtual void result_def ( IR_IDLType_ptr result_def, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -11189,7 +11189,7 @@ public: )); virtual IR_ParDescriptionSeq * params ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -11198,7 +11198,7 @@ public: virtual void params ( const IR_ParDescriptionSeq & params, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -11206,7 +11206,7 @@ public: )); virtual IR_OperationMode mode ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -11215,7 +11215,7 @@ public: virtual void mode ( IR_OperationMode mode, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -11223,7 +11223,7 @@ public: )); virtual IR_ContextIdSeq * contexts ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -11232,7 +11232,7 @@ public: virtual void contexts ( const IR_ContextIdSeq & contexts, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -11240,7 +11240,7 @@ public: )); virtual IR_ExceptionDefSeq * exceptions ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -11249,7 +11249,7 @@ public: virtual void exceptions ( const IR_ExceptionDefSeq & exceptions, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -11257,39 +11257,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_OperationDef_Proxy_Broker *the_TAO_OperationDef_Proxy_Broker_; - + protected: IR_OperationDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_OperationDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_OperationDef_Remote_Proxy_Impl; friend class _TAO_OperationDef_ThruPOA_Proxy_Impl; friend class _TAO_OperationDef_Direct_Proxy_Impl; - + virtual ~IR_OperationDef (void); private: IR_OperationDef (const IR_OperationDef &); - void operator= (const IR_OperationDef &); + void operator= (const IR_OperationDef &); }; @@ -11302,12 +11302,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_OperationDef_Proxy_Impl : +class TAO_Export _TAO_OperationDef_Proxy_Impl : public virtual _TAO_Contained_Proxy_Impl { public: virtual ~_TAO_OperationDef_Proxy_Impl (void) { } - + virtual CORBA::TypeCode_ptr result ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -11415,17 +11415,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_OperationDef_Remote_Proxy_Impl : +class TAO_Export _TAO_OperationDef_Remote_Proxy_Impl : public virtual _TAO_OperationDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_Contained_Remote_Proxy_Impl - + { public: _TAO_OperationDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_OperationDef_Remote_Proxy_Impl (void) { } - + virtual CORBA::TypeCode_ptr result ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -11527,14 +11527,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_OperationDef_Proxy_Broker @@ -11549,24 +11549,24 @@ public: protected: _TAO_OperationDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_OperationDef_Remote_Proxy_Broker : public virtual _TAO_OperationDef_Proxy_Broker { -public: +public: _TAO_OperationDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_OperationDef_Remote_Proxy_Broker (void); virtual _TAO_OperationDef_Proxy_Impl &select_proxy ( @@ -11585,7 +11585,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// struct TAO_Export IR_OperationDescription @@ -11615,18 +11615,18 @@ public: IR_OperationDescription_var (IR_OperationDescription *); IR_OperationDescription_var (const IR_OperationDescription_var &); // copy constructor ~IR_OperationDescription_var (void); // destructor - + IR_OperationDescription_var &operator= (IR_OperationDescription *); IR_OperationDescription_var &operator= (const IR_OperationDescription_var &); IR_OperationDescription *operator-> (void); const IR_OperationDescription *operator-> (void) const; - + operator const IR_OperationDescription &() const; operator IR_OperationDescription &(); operator IR_OperationDescription &() const; operator IR_OperationDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_OperationDescription &in (void) const; IR_OperationDescription &inout (void); IR_OperationDescription *&out (void); @@ -11648,7 +11648,7 @@ public: operator IR_OperationDescription *&(); IR_OperationDescription *&ptr (void); IR_OperationDescription *operator-> (void); - + private: IR_OperationDescription *&ptr_; // assignment from T_var not allowed @@ -11659,20 +11659,20 @@ private: // IR_RepositoryIdSeq // ************************************************************* -class TAO_Export IR_RepositoryIdSeq : public +class TAO_Export IR_RepositoryIdSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) TAO_Unbounded_String_Sequence #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_String_Sequence -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_RepositoryIdSeq (void); // default ctor IR_RepositoryIdSeq (CORBA::ULong max); // uses max size IR_RepositoryIdSeq ( - CORBA::ULong max, - CORBA::ULong length, - char * *buffer, + CORBA::ULong max, + CORBA::ULong length, + char * *buffer, CORBA::Boolean release = 0 ); IR_RepositoryIdSeq (const IR_RepositoryIdSeq &); // copy ctor @@ -11696,20 +11696,20 @@ public: IR_RepositoryIdSeq_var (IR_RepositoryIdSeq *); IR_RepositoryIdSeq_var (const IR_RepositoryIdSeq_var &); // copy constructor ~IR_RepositoryIdSeq_var (void); // destructor - + IR_RepositoryIdSeq_var &operator= (IR_RepositoryIdSeq *); IR_RepositoryIdSeq_var &operator= (const IR_RepositoryIdSeq_var &); IR_RepositoryIdSeq *operator-> (void); const IR_RepositoryIdSeq *operator-> (void) const; - + operator const IR_RepositoryIdSeq &() const; operator IR_RepositoryIdSeq &(); operator IR_RepositoryIdSeq &() const; operator IR_RepositoryIdSeq *&(); // variable-size base types only - + TAO_SeqElem_String_Manager operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_RepositoryIdSeq &in (void) const; IR_RepositoryIdSeq &inout (void); IR_RepositoryIdSeq *&out (void); @@ -11732,7 +11732,7 @@ public: IR_RepositoryIdSeq *&ptr (void); IR_RepositoryIdSeq *operator-> (void); TAO_SeqElem_String_Manager operator[] (CORBA::ULong index); - + private: IR_RepositoryIdSeq *&ptr_; // assignment from T_var not allowed @@ -11740,14 +11740,14 @@ private: }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class TAO_EXPORT_NESTED_MACRO _TAO_Unbounded_Sequence_IR_OpDescriptionSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Sequence_IR_OpDescriptionSeq (void); // Default constructor. - _TAO_Unbounded_Sequence_IR_OpDescriptionSeq (CORBA::ULong maximum); + _TAO_Unbounded_Sequence_IR_OpDescriptionSeq (CORBA::ULong maximum); _TAO_Unbounded_Sequence_IR_OpDescriptionSeq (CORBA::ULong maximum, CORBA::ULong length, IR_OperationDescription *data, @@ -11764,7 +11764,7 @@ private: virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); // Implement the TAO_Base_Sequence methods (see Sequence.h) - + IR_OperationDescription *get_buffer (CORBA::Boolean orphan = 0); const IR_OperationDescription *get_buffer (void) const; void replace (CORBA::ULong max, @@ -11773,26 +11773,26 @@ private: CORBA::Boolean release); }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_OpDescriptionSeq // ************************************************************* -class TAO_Export IR_OpDescriptionSeq : public +class TAO_Export IR_OpDescriptionSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Sequence_IR_OpDescriptionSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Sequence<IR_OperationDescription> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_OpDescriptionSeq (void); // default ctor IR_OpDescriptionSeq (CORBA::ULong max); // uses max size IR_OpDescriptionSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_OperationDescription *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_OperationDescription *buffer, CORBA::Boolean release = 0 ); IR_OpDescriptionSeq (const IR_OpDescriptionSeq &); // copy ctor @@ -11816,21 +11816,21 @@ public: IR_OpDescriptionSeq_var (IR_OpDescriptionSeq *); IR_OpDescriptionSeq_var (const IR_OpDescriptionSeq_var &); // copy constructor ~IR_OpDescriptionSeq_var (void); // destructor - + IR_OpDescriptionSeq_var &operator= (IR_OpDescriptionSeq *); IR_OpDescriptionSeq_var &operator= (const IR_OpDescriptionSeq_var &); IR_OpDescriptionSeq *operator-> (void); const IR_OpDescriptionSeq *operator-> (void) const; - + operator const IR_OpDescriptionSeq &() const; operator IR_OpDescriptionSeq &(); operator IR_OpDescriptionSeq &() const; operator IR_OpDescriptionSeq *&(); // variable-size base types only - + IR_OperationDescription & operator[] (CORBA::ULong index); const IR_OperationDescription & operator[] (CORBA::ULong index) const; - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_OpDescriptionSeq &in (void) const; IR_OpDescriptionSeq &inout (void); IR_OpDescriptionSeq *&out (void); @@ -11853,7 +11853,7 @@ public: IR_OpDescriptionSeq *&ptr (void); IR_OpDescriptionSeq *operator-> (void); IR_OperationDescription & operator[] (CORBA::ULong index); - + private: IR_OpDescriptionSeq *&ptr_; // assignment from T_var not allowed @@ -11861,14 +11861,14 @@ private: }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class TAO_EXPORT_NESTED_MACRO _TAO_Unbounded_Sequence_IR_AttrDescriptionSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Sequence_IR_AttrDescriptionSeq (void); // Default constructor. - _TAO_Unbounded_Sequence_IR_AttrDescriptionSeq (CORBA::ULong maximum); + _TAO_Unbounded_Sequence_IR_AttrDescriptionSeq (CORBA::ULong maximum); _TAO_Unbounded_Sequence_IR_AttrDescriptionSeq (CORBA::ULong maximum, CORBA::ULong length, IR_AttributeDescription *data, @@ -11885,7 +11885,7 @@ private: virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); // Implement the TAO_Base_Sequence methods (see Sequence.h) - + IR_AttributeDescription *get_buffer (CORBA::Boolean orphan = 0); const IR_AttributeDescription *get_buffer (void) const; void replace (CORBA::ULong max, @@ -11894,26 +11894,26 @@ private: CORBA::Boolean release); }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_AttrDescriptionSeq // ************************************************************* -class TAO_Export IR_AttrDescriptionSeq : public +class TAO_Export IR_AttrDescriptionSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Sequence_IR_AttrDescriptionSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Sequence<IR_AttributeDescription> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_AttrDescriptionSeq (void); // default ctor IR_AttrDescriptionSeq (CORBA::ULong max); // uses max size IR_AttrDescriptionSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_AttributeDescription *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_AttributeDescription *buffer, CORBA::Boolean release = 0 ); IR_AttrDescriptionSeq (const IR_AttrDescriptionSeq &); // copy ctor @@ -11938,21 +11938,21 @@ public: IR_AttrDescriptionSeq_var (IR_AttrDescriptionSeq *); IR_AttrDescriptionSeq_var (const IR_AttrDescriptionSeq_var &); // copy constructor ~IR_AttrDescriptionSeq_var (void); // destructor - + IR_AttrDescriptionSeq_var &operator= (IR_AttrDescriptionSeq *); IR_AttrDescriptionSeq_var &operator= (const IR_AttrDescriptionSeq_var &); IR_AttrDescriptionSeq *operator-> (void); const IR_AttrDescriptionSeq *operator-> (void) const; - + operator const IR_AttrDescriptionSeq &() const; operator IR_AttrDescriptionSeq &(); operator IR_AttrDescriptionSeq &() const; operator IR_AttrDescriptionSeq *&(); // variable-size base types only - + IR_AttributeDescription & operator[] (CORBA::ULong index); const IR_AttributeDescription & operator[] (CORBA::ULong index) const; - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_AttrDescriptionSeq &in (void) const; IR_AttrDescriptionSeq &inout (void); IR_AttrDescriptionSeq *&out (void); @@ -11975,7 +11975,7 @@ public: IR_AttrDescriptionSeq *&ptr (void); IR_AttrDescriptionSeq *operator-> (void); IR_AttributeDescription & operator[] (CORBA::ULong index); - + private: IR_AttrDescriptionSeq *&ptr_; // assignment from T_var not allowed @@ -12000,12 +12000,12 @@ public: static IR_InterfaceDef_ptr _duplicate (IR_InterfaceDef_ptr obj); static IR_InterfaceDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_InterfaceDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_InterfaceDef_ptr _nil (void) @@ -12016,7 +12016,7 @@ public: static void _tao_any_destructor (void*); virtual IR_InterfaceDefSeq * base_interfaces ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -12025,7 +12025,7 @@ public: virtual void base_interfaces ( const IR_InterfaceDefSeq & base_interfaces, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -12033,7 +12033,7 @@ public: )); virtual CORBA::Boolean is_abstract ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -12042,7 +12042,7 @@ public: virtual void is_abstract ( CORBA::Boolean is_abstract, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -12050,7 +12050,7 @@ public: )); virtual CORBA::Boolean is_local ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -12059,7 +12059,7 @@ public: virtual void is_local ( CORBA::Boolean is_local, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -12068,7 +12068,7 @@ public: virtual CORBA::Boolean is_a ( const char * interface_id, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -12083,7 +12083,7 @@ public: IR_AttributeMode mode, const IR_ExceptionDefSeq & get_exceptions, const IR_ExceptionDefSeq & put_exceptions, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -12099,7 +12099,7 @@ public: const IR_ParDescriptionSeq & params, const IR_ExceptionDefSeq & exceptions, const IR_ContextIdSeq & contexts, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -12107,39 +12107,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_InterfaceDef_Proxy_Broker *the_TAO_InterfaceDef_Proxy_Broker_; - + protected: IR_InterfaceDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_InterfaceDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_InterfaceDef_Remote_Proxy_Impl; friend class _TAO_InterfaceDef_ThruPOA_Proxy_Impl; friend class _TAO_InterfaceDef_Direct_Proxy_Impl; - + virtual ~IR_InterfaceDef (void); private: IR_InterfaceDef (const IR_InterfaceDef &); - void operator= (const IR_InterfaceDef &); + void operator= (const IR_InterfaceDef &); }; @@ -12152,14 +12152,14 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_InterfaceDef_Proxy_Impl : - public virtual _TAO_Container_Proxy_Impl, - public virtual _TAO_Contained_Proxy_Impl, +class TAO_Export _TAO_InterfaceDef_Proxy_Impl : + public virtual _TAO_Container_Proxy_Impl, + public virtual _TAO_Contained_Proxy_Impl, public virtual _TAO_IDLType_Proxy_Impl { public: virtual ~_TAO_InterfaceDef_Proxy_Impl (void) { } - + virtual IR_InterfaceDefSeq * base_interfaces ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -12265,19 +12265,19 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_InterfaceDef_Remote_Proxy_Impl : +class TAO_Export _TAO_InterfaceDef_Remote_Proxy_Impl : public virtual _TAO_InterfaceDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, - public virtual _TAO_Container_Remote_Proxy_Impl, - public virtual _TAO_Contained_Remote_Proxy_Impl, + public virtual _TAO_Container_Remote_Proxy_Impl, + public virtual _TAO_Contained_Remote_Proxy_Impl, public virtual _TAO_IDLType_Remote_Proxy_Impl - + { public: _TAO_InterfaceDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_InterfaceDef_Remote_Proxy_Impl (void) { } - + virtual IR_InterfaceDefSeq * base_interfaces ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -12377,14 +12377,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_InterfaceDef_Proxy_Broker @@ -12399,24 +12399,24 @@ public: protected: _TAO_InterfaceDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_InterfaceDef_Remote_Proxy_Broker : public virtual _TAO_InterfaceDef_Proxy_Broker { -public: +public: _TAO_InterfaceDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_InterfaceDef_Remote_Proxy_Broker (void); virtual _TAO_InterfaceDef_Proxy_Impl &select_proxy ( @@ -12435,7 +12435,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// struct TAO_Export IR_InterfaceDescription @@ -12466,18 +12466,18 @@ public: IR_InterfaceDescription_var (IR_InterfaceDescription *); IR_InterfaceDescription_var (const IR_InterfaceDescription_var &); // copy constructor ~IR_InterfaceDescription_var (void); // destructor - + IR_InterfaceDescription_var &operator= (IR_InterfaceDescription *); IR_InterfaceDescription_var &operator= (const IR_InterfaceDescription_var &); IR_InterfaceDescription *operator-> (void); const IR_InterfaceDescription *operator-> (void) const; - + operator const IR_InterfaceDescription &() const; operator IR_InterfaceDescription &(); operator IR_InterfaceDescription &() const; operator IR_InterfaceDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_InterfaceDescription &in (void) const; IR_InterfaceDescription &inout (void); IR_InterfaceDescription *&out (void); @@ -12499,7 +12499,7 @@ public: operator IR_InterfaceDescription *&(); IR_InterfaceDescription *&ptr (void); IR_InterfaceDescription *operator-> (void); - + private: IR_InterfaceDescription *&ptr_; // assignment from T_var not allowed @@ -12531,18 +12531,18 @@ public: IR_ValueMember_var (IR_ValueMember *); IR_ValueMember_var (const IR_ValueMember_var &); // copy constructor ~IR_ValueMember_var (void); // destructor - + IR_ValueMember_var &operator= (IR_ValueMember *); IR_ValueMember_var &operator= (const IR_ValueMember_var &); IR_ValueMember *operator-> (void); const IR_ValueMember *operator-> (void) const; - + operator const IR_ValueMember &() const; operator IR_ValueMember &(); operator IR_ValueMember &() const; operator IR_ValueMember *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ValueMember &in (void) const; IR_ValueMember &inout (void); IR_ValueMember *&out (void); @@ -12564,7 +12564,7 @@ public: operator IR_ValueMember *&(); IR_ValueMember *&ptr (void); IR_ValueMember *operator-> (void); - + private: IR_ValueMember *&ptr_; // assignment from T_var not allowed @@ -12572,14 +12572,14 @@ private: }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class TAO_EXPORT_NESTED_MACRO _TAO_Unbounded_Sequence_IR_ValueMemberSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Sequence_IR_ValueMemberSeq (void); // Default constructor. - _TAO_Unbounded_Sequence_IR_ValueMemberSeq (CORBA::ULong maximum); + _TAO_Unbounded_Sequence_IR_ValueMemberSeq (CORBA::ULong maximum); _TAO_Unbounded_Sequence_IR_ValueMemberSeq (CORBA::ULong maximum, CORBA::ULong length, IR_ValueMember *data, @@ -12596,7 +12596,7 @@ private: virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); // Implement the TAO_Base_Sequence methods (see Sequence.h) - + IR_ValueMember *get_buffer (CORBA::Boolean orphan = 0); const IR_ValueMember *get_buffer (void) const; void replace (CORBA::ULong max, @@ -12605,26 +12605,26 @@ private: CORBA::Boolean release); }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_ValueMemberSeq // ************************************************************* -class TAO_Export IR_ValueMemberSeq : public +class TAO_Export IR_ValueMemberSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Sequence_IR_ValueMemberSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Sequence<IR_ValueMember> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_ValueMemberSeq (void); // default ctor IR_ValueMemberSeq (CORBA::ULong max); // uses max size IR_ValueMemberSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_ValueMember *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_ValueMember *buffer, CORBA::Boolean release = 0 ); IR_ValueMemberSeq (const IR_ValueMemberSeq &); // copy ctor @@ -12648,21 +12648,21 @@ public: IR_ValueMemberSeq_var (IR_ValueMemberSeq *); IR_ValueMemberSeq_var (const IR_ValueMemberSeq_var &); // copy constructor ~IR_ValueMemberSeq_var (void); // destructor - + IR_ValueMemberSeq_var &operator= (IR_ValueMemberSeq *); IR_ValueMemberSeq_var &operator= (const IR_ValueMemberSeq_var &); IR_ValueMemberSeq *operator-> (void); const IR_ValueMemberSeq *operator-> (void) const; - + operator const IR_ValueMemberSeq &() const; operator IR_ValueMemberSeq &(); operator IR_ValueMemberSeq &() const; operator IR_ValueMemberSeq *&(); // variable-size base types only - + IR_ValueMember & operator[] (CORBA::ULong index); const IR_ValueMember & operator[] (CORBA::ULong index) const; - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ValueMemberSeq &in (void) const; IR_ValueMemberSeq &inout (void); IR_ValueMemberSeq *&out (void); @@ -12685,7 +12685,7 @@ public: IR_ValueMemberSeq *&ptr (void); IR_ValueMemberSeq *operator-> (void); IR_ValueMember & operator[] (CORBA::ULong index); - + private: IR_ValueMemberSeq *&ptr_; // assignment from T_var not allowed @@ -12696,17 +12696,17 @@ class TAO_Export IR_ValueMemberDef_var : public TAO_Base_var { public: IR_ValueMemberDef_var (void); // default constructor - IR_ValueMemberDef_var (IR_ValueMemberDef_ptr p) : ptr_ (p) {} + IR_ValueMemberDef_var (IR_ValueMemberDef_ptr p) : ptr_ (p) {} IR_ValueMemberDef_var (const IR_ValueMemberDef_var &); // copy constructor ~IR_ValueMemberDef_var (void); // destructor - + IR_ValueMemberDef_var &operator= (IR_ValueMemberDef_ptr); IR_ValueMemberDef_var &operator= (const IR_ValueMemberDef_var &); IR_ValueMemberDef_ptr operator-> (void) const; - + operator const IR_ValueMemberDef_ptr &() const; operator IR_ValueMemberDef_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IR_ValueMemberDef_ptr in (void) const; IR_ValueMemberDef_ptr &inout (void); IR_ValueMemberDef_ptr &out (void); @@ -12732,7 +12732,7 @@ public: operator IR_ValueMemberDef_ptr &(); IR_ValueMemberDef_ptr &ptr (void); IR_ValueMemberDef_ptr operator-> (void); - + private: IR_ValueMemberDef_ptr &ptr_; }; @@ -12755,12 +12755,12 @@ public: static IR_ValueMemberDef_ptr _duplicate (IR_ValueMemberDef_ptr obj); static IR_ValueMemberDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ValueMemberDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ValueMemberDef_ptr _nil (void) @@ -12771,7 +12771,7 @@ public: static void _tao_any_destructor (void*); virtual CORBA::TypeCode_ptr type ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -12779,7 +12779,7 @@ public: )); virtual IR_IDLType_ptr type_def ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -12788,7 +12788,7 @@ public: virtual void type_def ( IR_IDLType_ptr type_def, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -12796,7 +12796,7 @@ public: )); virtual CORBA::Visibility access ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -12805,7 +12805,7 @@ public: virtual void access ( CORBA::Visibility access, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -12813,39 +12813,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_ValueMemberDef_Proxy_Broker *the_TAO_ValueMemberDef_Proxy_Broker_; - + protected: IR_ValueMemberDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_ValueMemberDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_ValueMemberDef_Remote_Proxy_Impl; friend class _TAO_ValueMemberDef_ThruPOA_Proxy_Impl; friend class _TAO_ValueMemberDef_Direct_Proxy_Impl; - + virtual ~IR_ValueMemberDef (void); private: IR_ValueMemberDef (const IR_ValueMemberDef &); - void operator= (const IR_ValueMemberDef &); + void operator= (const IR_ValueMemberDef &); }; @@ -12858,12 +12858,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_ValueMemberDef_Proxy_Impl : +class TAO_Export _TAO_ValueMemberDef_Proxy_Impl : public virtual _TAO_Contained_Proxy_Impl { public: virtual ~_TAO_ValueMemberDef_Proxy_Impl (void) { } - + virtual CORBA::TypeCode_ptr type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -12920,17 +12920,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_ValueMemberDef_Remote_Proxy_Impl : +class TAO_Export _TAO_ValueMemberDef_Remote_Proxy_Impl : public virtual _TAO_ValueMemberDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_Contained_Remote_Proxy_Impl - + { public: _TAO_ValueMemberDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_ValueMemberDef_Remote_Proxy_Impl (void) { } - + virtual CORBA::TypeCode_ptr type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -12981,14 +12981,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_ValueMemberDef_Proxy_Broker @@ -13003,24 +13003,24 @@ public: protected: _TAO_ValueMemberDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_ValueMemberDef_Remote_Proxy_Broker : public virtual _TAO_ValueMemberDef_Proxy_Broker { -public: +public: _TAO_ValueMemberDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_ValueMemberDef_Remote_Proxy_Broker (void); virtual _TAO_ValueMemberDef_Proxy_Impl &select_proxy ( @@ -13039,7 +13039,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -13060,12 +13060,12 @@ public: static IR_ValueDef_ptr _duplicate (IR_ValueDef_ptr obj); static IR_ValueDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ValueDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ValueDef_ptr _nil (void) @@ -13076,7 +13076,7 @@ public: static void _tao_any_destructor (void*); virtual IR_InterfaceDefSeq * supported_interfaces ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13085,7 +13085,7 @@ public: virtual void supported_interfaces ( const IR_InterfaceDefSeq & supported_interfaces, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13093,7 +13093,7 @@ public: )); virtual IR_InitializerSeq * initializers ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13102,7 +13102,7 @@ public: virtual void initializers ( const IR_InitializerSeq & initializers, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13110,7 +13110,7 @@ public: )); virtual IR_ValueDef_ptr base_value ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13119,7 +13119,7 @@ public: virtual void base_value ( IR_ValueDef_ptr base_value, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13127,7 +13127,7 @@ public: )); virtual IR_ValueDefSeq * abstract_base_values ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13136,7 +13136,7 @@ public: virtual void abstract_base_values ( const IR_ValueDefSeq & abstract_base_values, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13144,7 +13144,7 @@ public: )); virtual CORBA::Boolean is_abstract ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13153,7 +13153,7 @@ public: virtual void is_abstract ( CORBA::Boolean is_abstract, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13161,7 +13161,7 @@ public: )); virtual CORBA::Boolean is_custom ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13170,7 +13170,7 @@ public: virtual void is_custom ( CORBA::Boolean is_custom, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13178,7 +13178,7 @@ public: )); virtual CORBA::Boolean is_truncatable ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13187,7 +13187,7 @@ public: virtual void is_truncatable ( CORBA::Boolean is_truncatable, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13196,7 +13196,7 @@ public: virtual CORBA::Boolean is_a ( const char * id, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13209,7 +13209,7 @@ public: const char * version, IR_IDLType_ptr type, CORBA::Visibility access, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13224,7 +13224,7 @@ public: IR_AttributeMode mode, const IR_ExceptionDefSeq & get_exceptions, const IR_ExceptionDefSeq & put_exceptions, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13240,7 +13240,7 @@ public: const IR_ParDescriptionSeq & params, const IR_ExceptionDefSeq & exceptions, const IR_ContextIdSeq & contexts, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13248,39 +13248,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_ValueDef_Proxy_Broker *the_TAO_ValueDef_Proxy_Broker_; - + protected: IR_ValueDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_ValueDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_ValueDef_Remote_Proxy_Impl; friend class _TAO_ValueDef_ThruPOA_Proxy_Impl; friend class _TAO_ValueDef_Direct_Proxy_Impl; - + virtual ~IR_ValueDef (void); private: IR_ValueDef (const IR_ValueDef &); - void operator= (const IR_ValueDef &); + void operator= (const IR_ValueDef &); }; @@ -13293,14 +13293,14 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_ValueDef_Proxy_Impl : - public virtual _TAO_Container_Proxy_Impl, - public virtual _TAO_Contained_Proxy_Impl, +class TAO_Export _TAO_ValueDef_Proxy_Impl : + public virtual _TAO_Container_Proxy_Impl, + public virtual _TAO_Contained_Proxy_Impl, public virtual _TAO_IDLType_Proxy_Impl { public: virtual ~_TAO_ValueDef_Proxy_Impl (void) { } - + virtual IR_InterfaceDefSeq * supported_interfaces ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -13487,19 +13487,19 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_ValueDef_Remote_Proxy_Impl : +class TAO_Export _TAO_ValueDef_Remote_Proxy_Impl : public virtual _TAO_ValueDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, - public virtual _TAO_Container_Remote_Proxy_Impl, - public virtual _TAO_Contained_Remote_Proxy_Impl, + public virtual _TAO_Container_Remote_Proxy_Impl, + public virtual _TAO_Contained_Remote_Proxy_Impl, public virtual _TAO_IDLType_Remote_Proxy_Impl - + { public: _TAO_ValueDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_ValueDef_Remote_Proxy_Impl (void) { } - + virtual IR_InterfaceDefSeq * supported_interfaces ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -13680,14 +13680,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_ValueDef_Proxy_Broker @@ -13702,24 +13702,24 @@ public: protected: _TAO_ValueDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_ValueDef_Remote_Proxy_Broker : public virtual _TAO_ValueDef_Proxy_Broker { -public: +public: _TAO_ValueDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_ValueDef_Remote_Proxy_Broker (void); virtual _TAO_ValueDef_Proxy_Impl &select_proxy ( @@ -13738,7 +13738,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// struct TAO_Export IR_ValueDescription @@ -13774,18 +13774,18 @@ public: IR_ValueDescription_var (IR_ValueDescription *); IR_ValueDescription_var (const IR_ValueDescription_var &); // copy constructor ~IR_ValueDescription_var (void); // destructor - + IR_ValueDescription_var &operator= (IR_ValueDescription *); IR_ValueDescription_var &operator= (const IR_ValueDescription_var &); IR_ValueDescription *operator-> (void); const IR_ValueDescription *operator-> (void) const; - + operator const IR_ValueDescription &() const; operator IR_ValueDescription &(); operator IR_ValueDescription &() const; operator IR_ValueDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ValueDescription &in (void) const; IR_ValueDescription &inout (void); IR_ValueDescription *&out (void); @@ -13807,7 +13807,7 @@ public: operator IR_ValueDescription *&(); IR_ValueDescription *&ptr (void); IR_ValueDescription *operator-> (void); - + private: IR_ValueDescription *&ptr_; // assignment from T_var not allowed @@ -13832,12 +13832,12 @@ public: static IR_ValueBoxDef_ptr _duplicate (IR_ValueBoxDef_ptr obj); static IR_ValueBoxDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ValueBoxDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ValueBoxDef_ptr _nil (void) @@ -13848,7 +13848,7 @@ public: static void _tao_any_destructor (void*); virtual IR_IDLType_ptr original_type_def ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13857,7 +13857,7 @@ public: virtual void original_type_def ( IR_IDLType_ptr original_type_def, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -13865,39 +13865,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_ValueBoxDef_Proxy_Broker *the_TAO_ValueBoxDef_Proxy_Broker_; - + protected: IR_ValueBoxDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_ValueBoxDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_ValueBoxDef_Remote_Proxy_Impl; friend class _TAO_ValueBoxDef_ThruPOA_Proxy_Impl; friend class _TAO_ValueBoxDef_Direct_Proxy_Impl; - + virtual ~IR_ValueBoxDef (void); private: IR_ValueBoxDef (const IR_ValueBoxDef &); - void operator= (const IR_ValueBoxDef &); + void operator= (const IR_ValueBoxDef &); }; @@ -13910,12 +13910,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_ValueBoxDef_Proxy_Impl : +class TAO_Export _TAO_ValueBoxDef_Proxy_Impl : public virtual _TAO_TypedefDef_Proxy_Impl { public: virtual ~_TAO_ValueBoxDef_Proxy_Impl (void) { } - + virtual IR_IDLType_ptr original_type_def ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -13947,17 +13947,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_ValueBoxDef_Remote_Proxy_Impl : +class TAO_Export _TAO_ValueBoxDef_Remote_Proxy_Impl : public virtual _TAO_ValueBoxDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_TypedefDef_Remote_Proxy_Impl - + { public: _TAO_ValueBoxDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_ValueBoxDef_Remote_Proxy_Impl (void) { } - + virtual IR_IDLType_ptr original_type_def ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -13983,14 +13983,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_ValueBoxDef_Proxy_Broker @@ -14005,24 +14005,24 @@ public: protected: _TAO_ValueBoxDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_ValueBoxDef_Remote_Proxy_Broker : public virtual _TAO_ValueBoxDef_Proxy_Broker { -public: +public: _TAO_ValueBoxDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_ValueBoxDef_Remote_Proxy_Broker (void); virtual _TAO_ValueBoxDef_Proxy_Impl &select_proxy ( @@ -14041,7 +14041,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -14062,12 +14062,12 @@ public: static IR_ProvidesDef_ptr _duplicate (IR_ProvidesDef_ptr obj); static IR_ProvidesDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ProvidesDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ProvidesDef_ptr _nil (void) @@ -14078,7 +14078,7 @@ public: static void _tao_any_destructor (void*); virtual IR_InterfaceDef_ptr interface_type ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -14086,39 +14086,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_ProvidesDef_Proxy_Broker *the_TAO_ProvidesDef_Proxy_Broker_; - + protected: IR_ProvidesDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_ProvidesDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_ProvidesDef_Remote_Proxy_Impl; friend class _TAO_ProvidesDef_ThruPOA_Proxy_Impl; friend class _TAO_ProvidesDef_Direct_Proxy_Impl; - + virtual ~IR_ProvidesDef (void); private: IR_ProvidesDef (const IR_ProvidesDef &); - void operator= (const IR_ProvidesDef &); + void operator= (const IR_ProvidesDef &); }; @@ -14131,12 +14131,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_ProvidesDef_Proxy_Impl : +class TAO_Export _TAO_ProvidesDef_Proxy_Impl : public virtual _TAO_Contained_Proxy_Impl { public: virtual ~_TAO_ProvidesDef_Proxy_Impl (void) { } - + virtual IR_InterfaceDef_ptr interface_type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -14159,17 +14159,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_ProvidesDef_Remote_Proxy_Impl : +class TAO_Export _TAO_ProvidesDef_Remote_Proxy_Impl : public virtual _TAO_ProvidesDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_Contained_Remote_Proxy_Impl - + { public: _TAO_ProvidesDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_ProvidesDef_Remote_Proxy_Impl (void) { } - + virtual IR_InterfaceDef_ptr interface_type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -14186,14 +14186,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_ProvidesDef_Proxy_Broker @@ -14208,24 +14208,24 @@ public: protected: _TAO_ProvidesDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_ProvidesDef_Remote_Proxy_Broker : public virtual _TAO_ProvidesDef_Proxy_Broker { -public: +public: _TAO_ProvidesDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_ProvidesDef_Remote_Proxy_Broker (void); virtual _TAO_ProvidesDef_Proxy_Impl &select_proxy ( @@ -14244,7 +14244,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// struct TAO_Export IR_ProvidesDescription @@ -14270,18 +14270,18 @@ public: IR_ProvidesDescription_var (IR_ProvidesDescription *); IR_ProvidesDescription_var (const IR_ProvidesDescription_var &); // copy constructor ~IR_ProvidesDescription_var (void); // destructor - + IR_ProvidesDescription_var &operator= (IR_ProvidesDescription *); IR_ProvidesDescription_var &operator= (const IR_ProvidesDescription_var &); IR_ProvidesDescription *operator-> (void); const IR_ProvidesDescription *operator-> (void) const; - + operator const IR_ProvidesDescription &() const; operator IR_ProvidesDescription &(); operator IR_ProvidesDescription &() const; operator IR_ProvidesDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ProvidesDescription &in (void) const; IR_ProvidesDescription &inout (void); IR_ProvidesDescription *&out (void); @@ -14303,7 +14303,7 @@ public: operator IR_ProvidesDescription *&(); IR_ProvidesDescription *&ptr (void); IR_ProvidesDescription *operator-> (void); - + private: IR_ProvidesDescription *&ptr_; // assignment from T_var not allowed @@ -14328,12 +14328,12 @@ public: static IR_UsesDef_ptr _duplicate (IR_UsesDef_ptr obj); static IR_UsesDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_UsesDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_UsesDef_ptr _nil (void) @@ -14344,7 +14344,7 @@ public: static void _tao_any_destructor (void*); virtual IR_InterfaceDef_ptr interface_type ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -14352,7 +14352,7 @@ public: )); virtual CORBA::Boolean is_multiple ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -14360,39 +14360,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_UsesDef_Proxy_Broker *the_TAO_UsesDef_Proxy_Broker_; - + protected: IR_UsesDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_UsesDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_UsesDef_Remote_Proxy_Impl; friend class _TAO_UsesDef_ThruPOA_Proxy_Impl; friend class _TAO_UsesDef_Direct_Proxy_Impl; - + virtual ~IR_UsesDef (void); private: IR_UsesDef (const IR_UsesDef &); - void operator= (const IR_UsesDef &); + void operator= (const IR_UsesDef &); }; @@ -14405,12 +14405,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_UsesDef_Proxy_Impl : +class TAO_Export _TAO_UsesDef_Proxy_Impl : public virtual _TAO_Contained_Proxy_Impl { public: virtual ~_TAO_UsesDef_Proxy_Impl (void) { } - + virtual IR_InterfaceDef_ptr interface_type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -14441,17 +14441,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_UsesDef_Remote_Proxy_Impl : +class TAO_Export _TAO_UsesDef_Remote_Proxy_Impl : public virtual _TAO_UsesDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_Contained_Remote_Proxy_Impl - + { public: _TAO_UsesDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_UsesDef_Remote_Proxy_Impl (void) { } - + virtual IR_InterfaceDef_ptr interface_type ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -14476,14 +14476,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_UsesDef_Proxy_Broker @@ -14498,24 +14498,24 @@ public: protected: _TAO_UsesDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_UsesDef_Remote_Proxy_Broker : public virtual _TAO_UsesDef_Proxy_Broker { -public: +public: _TAO_UsesDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_UsesDef_Remote_Proxy_Broker (void); virtual _TAO_UsesDef_Proxy_Impl &select_proxy ( @@ -14534,7 +14534,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// struct TAO_Export IR_UsesDescription @@ -14561,18 +14561,18 @@ public: IR_UsesDescription_var (IR_UsesDescription *); IR_UsesDescription_var (const IR_UsesDescription_var &); // copy constructor ~IR_UsesDescription_var (void); // destructor - + IR_UsesDescription_var &operator= (IR_UsesDescription *); IR_UsesDescription_var &operator= (const IR_UsesDescription_var &); IR_UsesDescription *operator-> (void); const IR_UsesDescription *operator-> (void) const; - + operator const IR_UsesDescription &() const; operator IR_UsesDescription &(); operator IR_UsesDescription &() const; operator IR_UsesDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_UsesDescription &in (void) const; IR_UsesDescription &inout (void); IR_UsesDescription *&out (void); @@ -14594,7 +14594,7 @@ public: operator IR_UsesDescription *&(); IR_UsesDescription *&ptr (void); IR_UsesDescription *operator-> (void); - + private: IR_UsesDescription *&ptr_; // assignment from T_var not allowed @@ -14604,14 +14604,14 @@ private: TAO_NAMESPACE_STORAGE_CLASS CORBA::TypeCode_ptr _tc_IR_UsesDescription; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class TAO_EXPORT_NESTED_MACRO _TAO_Unbounded_Sequence_IR_ProvidesDescSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Sequence_IR_ProvidesDescSeq (void); // Default constructor. - _TAO_Unbounded_Sequence_IR_ProvidesDescSeq (CORBA::ULong maximum); + _TAO_Unbounded_Sequence_IR_ProvidesDescSeq (CORBA::ULong maximum); _TAO_Unbounded_Sequence_IR_ProvidesDescSeq (CORBA::ULong maximum, CORBA::ULong length, IR_ProvidesDescription *data, @@ -14628,7 +14628,7 @@ TAO_NAMESPACE_STORAGE_CLASS CORBA::TypeCode_ptr _tc_IR_UsesDescription; virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); // Implement the TAO_Base_Sequence methods (see Sequence.h) - + IR_ProvidesDescription *get_buffer (CORBA::Boolean orphan = 0); const IR_ProvidesDescription *get_buffer (void) const; void replace (CORBA::ULong max, @@ -14637,26 +14637,26 @@ TAO_NAMESPACE_STORAGE_CLASS CORBA::TypeCode_ptr _tc_IR_UsesDescription; CORBA::Boolean release); }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_ProvidesDescSeq // ************************************************************* -class TAO_Export IR_ProvidesDescSeq : public +class TAO_Export IR_ProvidesDescSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Sequence_IR_ProvidesDescSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Sequence<IR_ProvidesDescription> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_ProvidesDescSeq (void); // default ctor IR_ProvidesDescSeq (CORBA::ULong max); // uses max size IR_ProvidesDescSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_ProvidesDescription *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_ProvidesDescription *buffer, CORBA::Boolean release = 0 ); IR_ProvidesDescSeq (const IR_ProvidesDescSeq &); // copy ctor @@ -14680,21 +14680,21 @@ public: IR_ProvidesDescSeq_var (IR_ProvidesDescSeq *); IR_ProvidesDescSeq_var (const IR_ProvidesDescSeq_var &); // copy constructor ~IR_ProvidesDescSeq_var (void); // destructor - + IR_ProvidesDescSeq_var &operator= (IR_ProvidesDescSeq *); IR_ProvidesDescSeq_var &operator= (const IR_ProvidesDescSeq_var &); IR_ProvidesDescSeq *operator-> (void); const IR_ProvidesDescSeq *operator-> (void) const; - + operator const IR_ProvidesDescSeq &() const; operator IR_ProvidesDescSeq &(); operator IR_ProvidesDescSeq &() const; operator IR_ProvidesDescSeq *&(); // variable-size base types only - + IR_ProvidesDescription & operator[] (CORBA::ULong index); const IR_ProvidesDescription & operator[] (CORBA::ULong index) const; - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ProvidesDescSeq &in (void) const; IR_ProvidesDescSeq &inout (void); IR_ProvidesDescSeq *&out (void); @@ -14717,7 +14717,7 @@ public: IR_ProvidesDescSeq *&ptr (void); IR_ProvidesDescSeq *operator-> (void); IR_ProvidesDescription & operator[] (CORBA::ULong index); - + private: IR_ProvidesDescSeq *&ptr_; // assignment from T_var not allowed @@ -14725,14 +14725,14 @@ private: }; #if !defined (TAO_USE_SEQUENCE_TEMPLATES) - + class TAO_EXPORT_NESTED_MACRO _TAO_Unbounded_Sequence_IR_UsesDescSeq : public TAO_Unbounded_Base_Sequence { public: // = Initialization and termination methods. - + _TAO_Unbounded_Sequence_IR_UsesDescSeq (void); // Default constructor. - _TAO_Unbounded_Sequence_IR_UsesDescSeq (CORBA::ULong maximum); + _TAO_Unbounded_Sequence_IR_UsesDescSeq (CORBA::ULong maximum); _TAO_Unbounded_Sequence_IR_UsesDescSeq (CORBA::ULong maximum, CORBA::ULong length, IR_UsesDescription *data, @@ -14749,7 +14749,7 @@ private: virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); // Implement the TAO_Base_Sequence methods (see Sequence.h) - + IR_UsesDescription *get_buffer (CORBA::Boolean orphan = 0); const IR_UsesDescription *get_buffer (void) const; void replace (CORBA::ULong max, @@ -14758,26 +14758,26 @@ private: CORBA::Boolean release); }; -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ // ************************************************************* // IR_UsesDescSeq // ************************************************************* -class TAO_Export IR_UsesDescSeq : public +class TAO_Export IR_UsesDescSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) _TAO_Unbounded_Sequence_IR_UsesDescSeq #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Sequence<IR_UsesDescription> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: IR_UsesDescSeq (void); // default ctor IR_UsesDescSeq (CORBA::ULong max); // uses max size IR_UsesDescSeq ( - CORBA::ULong max, - CORBA::ULong length, - IR_UsesDescription *buffer, + CORBA::ULong max, + CORBA::ULong length, + IR_UsesDescription *buffer, CORBA::Boolean release = 0 ); IR_UsesDescSeq (const IR_UsesDescSeq &); // copy ctor @@ -14801,21 +14801,21 @@ public: IR_UsesDescSeq_var (IR_UsesDescSeq *); IR_UsesDescSeq_var (const IR_UsesDescSeq_var &); // copy constructor ~IR_UsesDescSeq_var (void); // destructor - + IR_UsesDescSeq_var &operator= (IR_UsesDescSeq *); IR_UsesDescSeq_var &operator= (const IR_UsesDescSeq_var &); IR_UsesDescSeq *operator-> (void); const IR_UsesDescSeq *operator-> (void) const; - + operator const IR_UsesDescSeq &() const; operator IR_UsesDescSeq &(); operator IR_UsesDescSeq &() const; operator IR_UsesDescSeq *&(); // variable-size base types only - + IR_UsesDescription & operator[] (CORBA::ULong index); const IR_UsesDescription & operator[] (CORBA::ULong index) const; - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_UsesDescSeq &in (void) const; IR_UsesDescSeq &inout (void); IR_UsesDescSeq *&out (void); @@ -14838,7 +14838,7 @@ public: IR_UsesDescSeq *&ptr (void); IR_UsesDescSeq *operator-> (void); IR_UsesDescription & operator[] (CORBA::ULong index); - + private: IR_UsesDescSeq *&ptr_; // assignment from T_var not allowed @@ -14863,12 +14863,12 @@ public: static IR_EventDef_ptr _duplicate (IR_EventDef_ptr obj); static IR_EventDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_EventDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_EventDef_ptr _nil (void) @@ -14880,7 +14880,7 @@ public: virtual CORBA::Boolean is_a ( const char * event_id, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -14888,7 +14888,7 @@ public: )); virtual IR_ValueDef_ptr event ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -14896,39 +14896,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_EventDef_Proxy_Broker *the_TAO_EventDef_Proxy_Broker_; - + protected: IR_EventDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_EventDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_EventDef_Remote_Proxy_Impl; friend class _TAO_EventDef_ThruPOA_Proxy_Impl; friend class _TAO_EventDef_Direct_Proxy_Impl; - + virtual ~IR_EventDef (void); private: IR_EventDef (const IR_EventDef &); - void operator= (const IR_EventDef &); + void operator= (const IR_EventDef &); }; @@ -14941,12 +14941,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_EventDef_Proxy_Impl : +class TAO_Export _TAO_EventDef_Proxy_Impl : public virtual _TAO_Contained_Proxy_Impl { public: virtual ~_TAO_EventDef_Proxy_Impl (void) { } - + virtual CORBA::Boolean is_a ( CORBA_Object *_collocated_tao_target_, const char * event_id, @@ -14978,17 +14978,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_EventDef_Remote_Proxy_Impl : +class TAO_Export _TAO_EventDef_Remote_Proxy_Impl : public virtual _TAO_EventDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_Contained_Remote_Proxy_Impl - + { public: _TAO_EventDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_EventDef_Remote_Proxy_Impl (void) { } - + virtual CORBA::Boolean is_a ( CORBA_Object *_collocated_tao_target_, const char * event_id, @@ -15014,14 +15014,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_EventDef_Proxy_Broker @@ -15036,24 +15036,24 @@ public: protected: _TAO_EventDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_EventDef_Remote_Proxy_Broker : public virtual _TAO_EventDef_Proxy_Broker { -public: +public: _TAO_EventDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_EventDef_Remote_Proxy_Broker (void); virtual _TAO_EventDef_Proxy_Impl &select_proxy ( @@ -15072,7 +15072,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// struct TAO_Export IR_EventDescription @@ -15098,18 +15098,18 @@ public: IR_EventDescription_var (IR_EventDescription *); IR_EventDescription_var (const IR_EventDescription_var &); // copy constructor ~IR_EventDescription_var (void); // destructor - + IR_EventDescription_var &operator= (IR_EventDescription *); IR_EventDescription_var &operator= (const IR_EventDescription_var &); IR_EventDescription *operator-> (void); const IR_EventDescription *operator-> (void) const; - + operator const IR_EventDescription &() const; operator IR_EventDescription &(); operator IR_EventDescription &() const; operator IR_EventDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_EventDescription &in (void) const; IR_EventDescription &inout (void); IR_EventDescription *&out (void); @@ -15131,7 +15131,7 @@ public: operator IR_EventDescription *&(); IR_EventDescription *&ptr (void); IR_EventDescription *operator-> (void); - + private: IR_EventDescription *&ptr_; // assignment from T_var not allowed @@ -15156,12 +15156,12 @@ public: static IR_EmitsDef_ptr _duplicate (IR_EmitsDef_ptr obj); static IR_EmitsDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_EmitsDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_EmitsDef_ptr _nil (void) @@ -15172,82 +15172,82 @@ public: static void _tao_any_destructor (void*); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_EmitsDef_Proxy_Broker *the_TAO_EmitsDef_Proxy_Broker_; - + protected: IR_EmitsDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_EmitsDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_EmitsDef_Remote_Proxy_Impl; friend class _TAO_EmitsDef_ThruPOA_Proxy_Impl; friend class _TAO_EmitsDef_Direct_Proxy_Impl; - + virtual ~IR_EmitsDef (void); private: IR_EmitsDef (const IR_EmitsDef &); - void operator= (const IR_EmitsDef &); + void operator= (const IR_EmitsDef &); }; - + // The Proxy Implementations are used by each interface to // perform a call. Each different implementation encapsulate // an invocation logics. - + /////////////////////////////////////////////////////////////////////// // Base Impl. Declaration // - -class TAO_Export _TAO_EmitsDef_Proxy_Impl + +class TAO_Export _TAO_EmitsDef_Proxy_Impl : public virtual _TAO_EventDef_Proxy_Impl { public: virtual ~_TAO_EmitsDef_Proxy_Impl (void) { } - + protected: _TAO_EmitsDef_Proxy_Impl (void); - + }; - + // // Base Proxy Impl. Declaration /////////////////////////////////////////////////////////////////////// - - + + /////////////////////////////////////////////////////////////////////// // Remote Impl. Declaration // -class TAO_Export _TAO_EmitsDef_Remote_Proxy_Impl : +class TAO_Export _TAO_EmitsDef_Remote_Proxy_Impl : public virtual _TAO_EmitsDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_EventDef_Remote_Proxy_Impl - + { public: _TAO_EmitsDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_EmitsDef_Remote_Proxy_Impl (void) { } - + }; // @@ -15256,14 +15256,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_EmitsDef_Proxy_Broker @@ -15278,24 +15278,24 @@ public: protected: _TAO_EmitsDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_EmitsDef_Remote_Proxy_Broker : public virtual _TAO_EmitsDef_Proxy_Broker { -public: +public: _TAO_EmitsDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_EmitsDef_Remote_Proxy_Broker (void); virtual _TAO_EmitsDef_Proxy_Impl &select_proxy ( @@ -15314,7 +15314,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// class _TAO_PublishesDef_Proxy_Impl; @@ -15334,12 +15334,12 @@ public: static IR_PublishesDef_ptr _duplicate (IR_PublishesDef_ptr obj); static IR_PublishesDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_PublishesDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_PublishesDef_ptr _nil (void) @@ -15350,82 +15350,82 @@ public: static void _tao_any_destructor (void*); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_PublishesDef_Proxy_Broker *the_TAO_PublishesDef_Proxy_Broker_; - + protected: IR_PublishesDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_PublishesDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_PublishesDef_Remote_Proxy_Impl; friend class _TAO_PublishesDef_ThruPOA_Proxy_Impl; friend class _TAO_PublishesDef_Direct_Proxy_Impl; - + virtual ~IR_PublishesDef (void); private: IR_PublishesDef (const IR_PublishesDef &); - void operator= (const IR_PublishesDef &); + void operator= (const IR_PublishesDef &); }; - + // The Proxy Implementations are used by each interface to // perform a call. Each different implementation encapsulate // an invocation logics. - + /////////////////////////////////////////////////////////////////////// // Base Impl. Declaration // - -class TAO_Export _TAO_PublishesDef_Proxy_Impl + +class TAO_Export _TAO_PublishesDef_Proxy_Impl : public virtual _TAO_EventDef_Proxy_Impl { public: virtual ~_TAO_PublishesDef_Proxy_Impl (void) { } - + protected: _TAO_PublishesDef_Proxy_Impl (void); - + }; - + // // Base Proxy Impl. Declaration /////////////////////////////////////////////////////////////////////// - - + + /////////////////////////////////////////////////////////////////////// // Remote Impl. Declaration // -class TAO_Export _TAO_PublishesDef_Remote_Proxy_Impl : +class TAO_Export _TAO_PublishesDef_Remote_Proxy_Impl : public virtual _TAO_PublishesDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_EventDef_Remote_Proxy_Impl - + { public: _TAO_PublishesDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_PublishesDef_Remote_Proxy_Impl (void) { } - + }; // @@ -15434,14 +15434,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_PublishesDef_Proxy_Broker @@ -15456,24 +15456,24 @@ public: protected: _TAO_PublishesDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_PublishesDef_Remote_Proxy_Broker : public virtual _TAO_PublishesDef_Proxy_Broker { -public: +public: _TAO_PublishesDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_PublishesDef_Remote_Proxy_Broker (void); virtual _TAO_PublishesDef_Proxy_Impl &select_proxy ( @@ -15492,7 +15492,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -15513,12 +15513,12 @@ public: static IR_ConsumesDef_ptr _duplicate (IR_ConsumesDef_ptr obj); static IR_ConsumesDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ConsumesDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ConsumesDef_ptr _nil (void) @@ -15529,82 +15529,82 @@ public: static void _tao_any_destructor (void*); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_ConsumesDef_Proxy_Broker *the_TAO_ConsumesDef_Proxy_Broker_; - + protected: IR_ConsumesDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_ConsumesDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_ConsumesDef_Remote_Proxy_Impl; friend class _TAO_ConsumesDef_ThruPOA_Proxy_Impl; friend class _TAO_ConsumesDef_Direct_Proxy_Impl; - + virtual ~IR_ConsumesDef (void); private: IR_ConsumesDef (const IR_ConsumesDef &); - void operator= (const IR_ConsumesDef &); + void operator= (const IR_ConsumesDef &); }; - + // The Proxy Implementations are used by each interface to // perform a call. Each different implementation encapsulate // an invocation logics. - + /////////////////////////////////////////////////////////////////////// // Base Impl. Declaration // - -class TAO_Export _TAO_ConsumesDef_Proxy_Impl + +class TAO_Export _TAO_ConsumesDef_Proxy_Impl : public virtual _TAO_EventDef_Proxy_Impl { public: virtual ~_TAO_ConsumesDef_Proxy_Impl (void) { } - + protected: _TAO_ConsumesDef_Proxy_Impl (void); - + }; - + // // Base Proxy Impl. Declaration /////////////////////////////////////////////////////////////////////// - - + + /////////////////////////////////////////////////////////////////////// // Remote Impl. Declaration // -class TAO_Export _TAO_ConsumesDef_Remote_Proxy_Impl : +class TAO_Export _TAO_ConsumesDef_Remote_Proxy_Impl : public virtual _TAO_ConsumesDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_EventDef_Remote_Proxy_Impl - + { public: _TAO_ConsumesDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_ConsumesDef_Remote_Proxy_Impl (void) { } - + }; // @@ -15613,14 +15613,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_ConsumesDef_Proxy_Broker @@ -15635,24 +15635,24 @@ public: protected: _TAO_ConsumesDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_ConsumesDef_Remote_Proxy_Broker : public virtual _TAO_ConsumesDef_Proxy_Broker { -public: +public: _TAO_ConsumesDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_ConsumesDef_Remote_Proxy_Broker (void); virtual _TAO_ConsumesDef_Proxy_Impl &select_proxy ( @@ -15671,7 +15671,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -15692,12 +15692,12 @@ public: static IR_ComponentDef_ptr _duplicate (IR_ComponentDef_ptr obj); static IR_ComponentDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ComponentDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_ComponentDef_ptr _nil (void) @@ -15708,7 +15708,7 @@ public: static void _tao_any_destructor (void*); virtual IR_InterfaceDefSeq * supported_interfaces ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -15717,7 +15717,7 @@ public: virtual void supported_interfaces ( const IR_InterfaceDefSeq & supported_interfaces, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -15725,7 +15725,7 @@ public: )); virtual IR_ComponentDef_ptr base_component ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -15733,7 +15733,7 @@ public: )); virtual IR_ProvidesDefSeq * provides_interfaces ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -15741,7 +15741,7 @@ public: )); virtual IR_UsesDefSeq * uses_interfaces ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -15749,7 +15749,7 @@ public: )); virtual IR_EmitsDefSeq * emits_events ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -15757,7 +15757,7 @@ public: )); virtual IR_PublishesDefSeq * publishes_events ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -15765,7 +15765,7 @@ public: )); virtual IR_ConsumesDefSeq * consumes_events ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -15773,7 +15773,7 @@ public: )); virtual CORBA::Boolean is_basic ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -15785,7 +15785,7 @@ public: const char * name, const char * version, IR_InterfaceDef_ptr interface_type, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -15798,7 +15798,7 @@ public: const char * version, IR_InterfaceDef_ptr interface_type, CORBA::Boolean is_multiple, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -15810,7 +15810,7 @@ public: const char * name, const char * version, IR_ValueDef_ptr value, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -15822,7 +15822,7 @@ public: const char * name, const char * version, IR_ValueDef_ptr value, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -15834,7 +15834,7 @@ public: const char * name, const char * version, IR_ValueDef_ptr value, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -15842,39 +15842,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_ComponentDef_Proxy_Broker *the_TAO_ComponentDef_Proxy_Broker_; - + protected: IR_ComponentDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_ComponentDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_ComponentDef_Remote_Proxy_Impl; friend class _TAO_ComponentDef_ThruPOA_Proxy_Impl; friend class _TAO_ComponentDef_Direct_Proxy_Impl; - + virtual ~IR_ComponentDef (void); private: IR_ComponentDef (const IR_ComponentDef &); - void operator= (const IR_ComponentDef &); + void operator= (const IR_ComponentDef &); }; // The Proxy Implementations are used by each interface to @@ -15886,12 +15886,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_ComponentDef_Proxy_Impl : +class TAO_Export _TAO_ComponentDef_Proxy_Impl : public virtual _TAO_InterfaceDef_Proxy_Impl { public: virtual ~_TAO_ComponentDef_Proxy_Impl (void) { } - + virtual IR_InterfaceDefSeq * supported_interfaces ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -16040,17 +16040,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_ComponentDef_Remote_Proxy_Impl : +class TAO_Export _TAO_ComponentDef_Remote_Proxy_Impl : public virtual _TAO_ComponentDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_InterfaceDef_Remote_Proxy_Impl - + { public: _TAO_ComponentDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_ComponentDef_Remote_Proxy_Impl (void) { } - + virtual IR_InterfaceDefSeq * supported_interfaces ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -16193,14 +16193,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_ComponentDef_Proxy_Broker @@ -16215,24 +16215,24 @@ public: protected: _TAO_ComponentDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_ComponentDef_Remote_Proxy_Broker : public virtual _TAO_ComponentDef_Proxy_Broker { -public: +public: _TAO_ComponentDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_ComponentDef_Remote_Proxy_Broker (void); virtual _TAO_ComponentDef_Proxy_Impl &select_proxy ( @@ -16251,7 +16251,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// struct TAO_Export IR_ComponentDescription @@ -16285,18 +16285,18 @@ public: IR_ComponentDescription_var (IR_ComponentDescription *); IR_ComponentDescription_var (const IR_ComponentDescription_var &); // copy constructor ~IR_ComponentDescription_var (void); // destructor - + IR_ComponentDescription_var &operator= (IR_ComponentDescription *); IR_ComponentDescription_var &operator= (const IR_ComponentDescription_var &); IR_ComponentDescription *operator-> (void); const IR_ComponentDescription *operator-> (void) const; - + operator const IR_ComponentDescription &() const; operator IR_ComponentDescription &(); operator IR_ComponentDescription &() const; operator IR_ComponentDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_ComponentDescription &in (void) const; IR_ComponentDescription &inout (void); IR_ComponentDescription *&out (void); @@ -16318,7 +16318,7 @@ public: operator IR_ComponentDescription *&(); IR_ComponentDescription *&ptr (void); IR_ComponentDescription *operator-> (void); - + private: IR_ComponentDescription *&ptr_; // assignment from T_var not allowed @@ -16343,12 +16343,12 @@ public: static IR_PrimaryKeyDef_ptr _duplicate (IR_PrimaryKeyDef_ptr obj); static IR_PrimaryKeyDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_PrimaryKeyDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_PrimaryKeyDef_ptr _nil (void) @@ -16360,7 +16360,7 @@ public: virtual CORBA::Boolean is_a ( const char * primary_key_id, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -16368,7 +16368,7 @@ public: )); virtual IR_ValueDef_ptr primary_key ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -16376,39 +16376,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_PrimaryKeyDef_Proxy_Broker *the_TAO_PrimaryKeyDef_Proxy_Broker_; - + protected: IR_PrimaryKeyDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_PrimaryKeyDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_PrimaryKeyDef_Remote_Proxy_Impl; friend class _TAO_PrimaryKeyDef_ThruPOA_Proxy_Impl; friend class _TAO_PrimaryKeyDef_Direct_Proxy_Impl; - + virtual ~IR_PrimaryKeyDef (void); private: IR_PrimaryKeyDef (const IR_PrimaryKeyDef &); - void operator= (const IR_PrimaryKeyDef &); + void operator= (const IR_PrimaryKeyDef &); }; @@ -16421,12 +16421,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_PrimaryKeyDef_Proxy_Impl : +class TAO_Export _TAO_PrimaryKeyDef_Proxy_Impl : public virtual _TAO_Contained_Proxy_Impl { public: virtual ~_TAO_PrimaryKeyDef_Proxy_Impl (void) { } - + virtual CORBA::Boolean is_a ( CORBA_Object *_collocated_tao_target_, const char * primary_key_id, @@ -16458,17 +16458,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_PrimaryKeyDef_Remote_Proxy_Impl : +class TAO_Export _TAO_PrimaryKeyDef_Remote_Proxy_Impl : public virtual _TAO_PrimaryKeyDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_Contained_Remote_Proxy_Impl - + { public: _TAO_PrimaryKeyDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_PrimaryKeyDef_Remote_Proxy_Impl (void) { } - + virtual CORBA::Boolean is_a ( CORBA_Object *_collocated_tao_target_, const char * primary_key_id, @@ -16494,14 +16494,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_PrimaryKeyDef_Proxy_Broker @@ -16516,24 +16516,24 @@ public: protected: _TAO_PrimaryKeyDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_PrimaryKeyDef_Remote_Proxy_Broker : public virtual _TAO_PrimaryKeyDef_Proxy_Broker { -public: +public: _TAO_PrimaryKeyDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_PrimaryKeyDef_Remote_Proxy_Broker (void); virtual _TAO_PrimaryKeyDef_Proxy_Impl &select_proxy ( @@ -16552,7 +16552,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// struct TAO_Export IR_PrimaryKeyDescription @@ -16578,18 +16578,18 @@ public: IR_PrimaryKeyDescription_var (IR_PrimaryKeyDescription *); IR_PrimaryKeyDescription_var (const IR_PrimaryKeyDescription_var &); // copy constructor ~IR_PrimaryKeyDescription_var (void); // destructor - + IR_PrimaryKeyDescription_var &operator= (IR_PrimaryKeyDescription *); IR_PrimaryKeyDescription_var &operator= (const IR_PrimaryKeyDescription_var &); IR_PrimaryKeyDescription *operator-> (void); const IR_PrimaryKeyDescription *operator-> (void) const; - + operator const IR_PrimaryKeyDescription &() const; operator IR_PrimaryKeyDescription &(); operator IR_PrimaryKeyDescription &() const; operator IR_PrimaryKeyDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_PrimaryKeyDescription &in (void) const; IR_PrimaryKeyDescription &inout (void); IR_PrimaryKeyDescription *&out (void); @@ -16611,7 +16611,7 @@ public: operator IR_PrimaryKeyDescription *&(); IR_PrimaryKeyDescription *&ptr (void); IR_PrimaryKeyDescription *operator-> (void); - + private: IR_PrimaryKeyDescription *&ptr_; // assignment from T_var not allowed @@ -16636,12 +16636,12 @@ public: static IR_FactoryDef_ptr _duplicate (IR_FactoryDef_ptr obj); static IR_FactoryDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_FactoryDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_FactoryDef_ptr _nil (void) @@ -16652,82 +16652,82 @@ public: static void _tao_any_destructor (void*); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_FactoryDef_Proxy_Broker *the_TAO_FactoryDef_Proxy_Broker_; - + protected: IR_FactoryDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_FactoryDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_FactoryDef_Remote_Proxy_Impl; friend class _TAO_FactoryDef_ThruPOA_Proxy_Impl; friend class _TAO_FactoryDef_Direct_Proxy_Impl; - + virtual ~IR_FactoryDef (void); private: IR_FactoryDef (const IR_FactoryDef &); - void operator= (const IR_FactoryDef &); + void operator= (const IR_FactoryDef &); }; - + // The Proxy Implementations are used by each interface to // perform a call. Each different implementation encapsulate // an invocation logics. - + /////////////////////////////////////////////////////////////////////// // Base Impl. Declaration // - -class TAO_Export _TAO_FactoryDef_Proxy_Impl + +class TAO_Export _TAO_FactoryDef_Proxy_Impl : public virtual _TAO_OperationDef_Proxy_Impl { public: virtual ~_TAO_FactoryDef_Proxy_Impl (void) { } - + protected: _TAO_FactoryDef_Proxy_Impl (void); - + }; - + // // Base Proxy Impl. Declaration /////////////////////////////////////////////////////////////////////// - - + + /////////////////////////////////////////////////////////////////////// // Remote Impl. Declaration // -class TAO_Export _TAO_FactoryDef_Remote_Proxy_Impl : +class TAO_Export _TAO_FactoryDef_Remote_Proxy_Impl : public virtual _TAO_FactoryDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_OperationDef_Remote_Proxy_Impl - + { public: _TAO_FactoryDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_FactoryDef_Remote_Proxy_Impl (void) { } - + }; // @@ -16736,14 +16736,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_FactoryDef_Proxy_Broker @@ -16758,24 +16758,24 @@ public: protected: _TAO_FactoryDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_FactoryDef_Remote_Proxy_Broker : public virtual _TAO_FactoryDef_Proxy_Broker { -public: +public: _TAO_FactoryDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_FactoryDef_Remote_Proxy_Broker (void); virtual _TAO_FactoryDef_Proxy_Impl &select_proxy ( @@ -16794,7 +16794,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -16815,12 +16815,12 @@ public: static IR_FinderDef_ptr _duplicate (IR_FinderDef_ptr obj); static IR_FinderDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_FinderDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_FinderDef_ptr _nil (void) @@ -16831,82 +16831,82 @@ public: static void _tao_any_destructor (void*); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_FinderDef_Proxy_Broker *the_TAO_FinderDef_Proxy_Broker_; - + protected: IR_FinderDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_FinderDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_FinderDef_Remote_Proxy_Impl; friend class _TAO_FinderDef_ThruPOA_Proxy_Impl; friend class _TAO_FinderDef_Direct_Proxy_Impl; - + virtual ~IR_FinderDef (void); private: IR_FinderDef (const IR_FinderDef &); - void operator= (const IR_FinderDef &); + void operator= (const IR_FinderDef &); }; - + // The Proxy Implementations are used by each interface to // perform a call. Each different implementation encapsulate // an invocation logics. - + /////////////////////////////////////////////////////////////////////// // Base Impl. Declaration // - -class TAO_Export _TAO_FinderDef_Proxy_Impl + +class TAO_Export _TAO_FinderDef_Proxy_Impl : public virtual _TAO_OperationDef_Proxy_Impl { public: virtual ~_TAO_FinderDef_Proxy_Impl (void) { } - + protected: _TAO_FinderDef_Proxy_Impl (void); - + }; - + // // Base Proxy Impl. Declaration /////////////////////////////////////////////////////////////////////// - - + + /////////////////////////////////////////////////////////////////////// // Remote Impl. Declaration // -class TAO_Export _TAO_FinderDef_Remote_Proxy_Impl : +class TAO_Export _TAO_FinderDef_Remote_Proxy_Impl : public virtual _TAO_FinderDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_OperationDef_Remote_Proxy_Impl - + { public: _TAO_FinderDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_FinderDef_Remote_Proxy_Impl (void) { } - + }; // @@ -16915,14 +16915,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_FinderDef_Proxy_Broker @@ -16937,24 +16937,24 @@ public: protected: _TAO_FinderDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_FinderDef_Remote_Proxy_Broker : public virtual _TAO_FinderDef_Proxy_Broker { -public: +public: _TAO_FinderDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_FinderDef_Remote_Proxy_Broker (void); virtual _TAO_FinderDef_Proxy_Impl &select_proxy ( @@ -16973,7 +16973,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// // Forward Classes Declaration @@ -16994,12 +16994,12 @@ public: static IR_HomeDef_ptr _duplicate (IR_HomeDef_ptr obj); static IR_HomeDef_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_HomeDef_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IR_HomeDef_ptr _nil (void) @@ -17010,7 +17010,7 @@ public: static void _tao_any_destructor (void*); virtual IR_HomeDef_ptr base_home ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -17018,7 +17018,7 @@ public: )); virtual IR_ComponentDef_ptr managed_component ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -17026,7 +17026,7 @@ public: )); virtual IR_PrimaryKeyDef_ptr primary_key ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -17034,7 +17034,7 @@ public: )); virtual IR_FactoryDefSeq * factories ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -17042,7 +17042,7 @@ public: )); virtual IR_FinderDefSeq * finders ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -17050,7 +17050,7 @@ public: )); virtual CORBA::Boolean is_basic ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -17062,7 +17062,7 @@ public: const char * name, const char * version, IR_ValueDef_ptr primary_key, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -17075,7 +17075,7 @@ public: const char * version, const IR_ParDescriptionSeq & params, const IR_ExceptionDefSeq & exceptions, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -17088,7 +17088,7 @@ public: const char * version, const IR_ParDescriptionSeq & params, const IR_ExceptionDefSeq & exceptions, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -17096,39 +17096,39 @@ public: )); virtual CORBA::Boolean _is_a ( - const CORBA::Char *type_id, - CORBA::Environment &ACE_TRY_ENV = + const CORBA::Char *type_id, + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; private: _TAO_HomeDef_Proxy_Broker *the_TAO_HomeDef_Proxy_Broker_; - + protected: IR_HomeDef (int collocated = 0); - + protected: // This methods travese the inheritance tree and set the // parents piece of the given class in the right mode virtual void _tao_setup_collocation (int collocated); - + IR_HomeDef ( - TAO_Stub *objref, + TAO_Stub *objref, CORBA::Boolean _tao_collocated = 0, TAO_Abstract_ServantBase *servant = 0 ); - + friend class _TAO_HomeDef_Remote_Proxy_Impl; friend class _TAO_HomeDef_ThruPOA_Proxy_Impl; friend class _TAO_HomeDef_Direct_Proxy_Impl; - + virtual ~IR_HomeDef (void); private: IR_HomeDef (const IR_HomeDef &); - void operator= (const IR_HomeDef &); + void operator= (const IR_HomeDef &); }; @@ -17141,12 +17141,12 @@ private: // Base Impl. Declaration // -class TAO_Export _TAO_HomeDef_Proxy_Impl : +class TAO_Export _TAO_HomeDef_Proxy_Impl : public virtual _TAO_InterfaceDef_Proxy_Impl { public: virtual ~_TAO_HomeDef_Proxy_Impl (void) { } - + virtual IR_HomeDef_ptr base_home ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -17247,17 +17247,17 @@ protected: // Remote Impl. Declaration // -class TAO_Export _TAO_HomeDef_Remote_Proxy_Impl : +class TAO_Export _TAO_HomeDef_Remote_Proxy_Impl : public virtual _TAO_HomeDef_Proxy_Impl, public virtual TAO_Remote_Object_Proxy_Impl, public virtual _TAO_InterfaceDef_Remote_Proxy_Impl - + { public: _TAO_HomeDef_Remote_Proxy_Impl (void); - + virtual ~_TAO_HomeDef_Remote_Proxy_Impl (void) { } - + virtual IR_HomeDef_ptr base_home ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV @@ -17274,7 +17274,7 @@ public: CORBA::SystemException )); - virtual IR_PrimaryKeyDef_ptr primary_key ( + virtual IR_PrimaryKeyDef_ptr primary_key ( CORBA_Object *_collocated_tao_target_, CORBA::Environment &ACE_TRY_ENV ) @@ -17352,14 +17352,14 @@ public: // The Proxy Brokers are used by each interface to get -// the right proxy for performing a call. In the new +// the right proxy for performing a call. In the new // collocation scheme, the proxy to be used can vary on -// a call by call basis. +// a call by call basis. /////////////////////////////////////////////////////////////////////// -// Base Proxy Broker Declaration +// Base Proxy Broker Declaration // class TAO_Export _TAO_HomeDef_Proxy_Broker @@ -17374,24 +17374,24 @@ public: protected: _TAO_HomeDef_Proxy_Broker (void); - + }; // -// End Base Proxy Broker Declaration +// End Base Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// -// Remote Proxy Broker Declaration +// Remote Proxy Broker Declaration // class TAO_Export _TAO_HomeDef_Remote_Proxy_Broker : public virtual _TAO_HomeDef_Proxy_Broker { -public: +public: _TAO_HomeDef_Remote_Proxy_Broker (void); - + virtual ~_TAO_HomeDef_Remote_Proxy_Broker (void); virtual _TAO_HomeDef_Proxy_Impl &select_proxy ( @@ -17410,7 +17410,7 @@ public: }; // -// End Remote Proxy Broker Declaration +// End Remote Proxy Broker Declaration /////////////////////////////////////////////////////////////////////// struct TAO_Export IR_HomeDescription @@ -17443,18 +17443,18 @@ public: IR_HomeDescription_var (IR_HomeDescription *); IR_HomeDescription_var (const IR_HomeDescription_var &); // copy constructor ~IR_HomeDescription_var (void); // destructor - + IR_HomeDescription_var &operator= (IR_HomeDescription *); IR_HomeDescription_var &operator= (const IR_HomeDescription_var &); IR_HomeDescription *operator-> (void); const IR_HomeDescription *operator-> (void) const; - + operator const IR_HomeDescription &() const; operator IR_HomeDescription &(); operator IR_HomeDescription &() const; operator IR_HomeDescription *&(); // variable-size types only - - // in, inout, out, _retn + + // in, inout, out, _retn const IR_HomeDescription &in (void) const; IR_HomeDescription &inout (void); IR_HomeDescription *&out (void); @@ -17476,7 +17476,7 @@ public: operator IR_HomeDescription *&(); IR_HomeDescription *&ptr (void); IR_HomeDescription *operator-> (void); - + private: IR_HomeDescription *&ptr_; // assignment from T_var not allowed @@ -17916,7 +17916,7 @@ TAO_Export CORBA::Boolean operator>>= (const CORBA::Any &, const IR_HomeDescript #ifndef __ACE_INLINE__ -TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_DefinitionKind &); // +TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_DefinitionKind &); // TAO_Export CORBA::Boolean operator>> (TAO_InputCDR &, IR_DefinitionKind &); TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const CORBA_IRObject_ptr ); TAO_Export CORBA::Boolean operator>> (TAO_InputCDR &, CORBA_IRObject_ptr &); @@ -18094,7 +18094,7 @@ TAO_Export CORBA::Boolean operator>> ( TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_IDLType_ptr ); TAO_Export CORBA::Boolean operator>> (TAO_InputCDR &, IR_IDLType_ptr &); -TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_PrimitiveKind &); // +TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_PrimitiveKind &); // TAO_Export CORBA::Boolean operator>> (TAO_InputCDR &, IR_PrimitiveKind &); TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_Repository_ptr ); TAO_Export CORBA::Boolean operator>> (TAO_InputCDR &, IR_Repository_ptr &); @@ -18157,15 +18157,15 @@ TAO_Export CORBA::Boolean operator>> ( IR_ExcDescriptionSeq & ); -TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_AttributeMode &); // +TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_AttributeMode &); // TAO_Export CORBA::Boolean operator>> (TAO_InputCDR &, IR::AttributeMode &); TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_AttributeDef_ptr ); TAO_Export CORBA::Boolean operator>> (TAO_InputCDR &, IR_AttributeDef_ptr &); TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_AttributeDescription &); TAO_Export CORBA::Boolean operator>> (TAO_InputCDR &, IR_AttributeDescription &); -TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_OperationMode &); // +TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_OperationMode &); // TAO_Export CORBA::Boolean operator>> (TAO_InputCDR &, IR::OperationMode &); -TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_ParameterMode &); // +TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_ParameterMode &); // TAO_Export CORBA::Boolean operator>> (TAO_InputCDR &, IR::ParameterMode &); TAO_Export CORBA::Boolean operator<< (TAO_OutputCDR &, const IR_ParameterDescription &); TAO_Export CORBA::Boolean operator>> (TAO_InputCDR &, IR_ParameterDescription &); diff --git a/TAO/tao/Invocation.h b/TAO/tao/Invocation.h index 57bde43b23f..11c4a834933 100644 --- a/TAO/tao/Invocation.h +++ b/TAO/tao/Invocation.h @@ -1,40 +1,37 @@ -// This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Invocation.h -// -// = DESCRIPTION -// Encapsulate the logic for remote invocations, oneways or -// twoways. -// -// THREADING NOTE: Threads should never manipulate another -// thread's invocations. In this implementation, all data -// structures used to represent invocations (and parts of them) -// are owned by the thread which created them. Multiple threads -// may make of course concurrent invocations safely, since the -// GIOP code is reentrant. -// -// = AUTHOR -// Carlos O'Ryan <coryan@cs.wustl.edu> and Alexander Babu Arulanthu -// <alex@cs.wustl.edu> -// -// ============================================================================ - -#ifndef TAO_INVOCATION_H -#define TAO_INVOCATION_H +// This may look like C, but it's really -*- C++ -*- + +//============================================================================= +/** + * @file Invocation.h + * + * $Id$ + * + * Encapsulate the logic for remote invocations, oneways or + * twoways. + * + * THREADING NOTE: Threads should never manipulate another + * thread's invocations. In this implementation, all data + * structures used to represent invocations (and parts of them) + * are owned by the thread which created them. Multiple threads + * may make of course concurrent invocations safely, since the + * GIOP code is reentrant. + * + * + * @author Carlos O'Ryan <coryan@cs.wustl.edu> + * @author Alexander Babu Arulanthu <alex@cs.wustl.edu> + */ +//============================================================================= + + +#ifndef TAO_INVOCATION_H +#define TAO_INVOCATION_H #include "ace/pre.h" #include "tao/CDR.h" #if !defined (ACE_LACKS_PRAGMA_ONCE) # pragma once -#endif /* ACE_LACKS_PRAGMA_ONCE */ +#endif /* ACE_LACKS_PRAGMA_ONCE */ #include "tao/Any.h" #include "tao/Synch_Reply_Dispatcher.h" @@ -52,25 +49,27 @@ enum TAO_Invoke_Status // invoke() call successful. TAO_INVOKE_RESTART, - // The request must be restarted, a temporary failure has ocurred. + // The request must be restarted, a temporary failure has ocurred. TAO_INVOKE_EXCEPTION - // An exception was raised. + // An exception was raised. }; // **************************************************************** +/** + * @class TAO_GIOP_Invocation + * + * @brief Encapsulates common behavior for both oneway and twoway + * invocations. + * + * This class connects (or lookups a connection from the cache) + * to the remote server, builds the CDR stream for the Request, + * send the CDR stream and expects the response and interprets + * the incoming CDR stream. + */ class TAO_Export TAO_GIOP_Invocation { - // = TITLE - // Encapsulates common behavior for both oneway and twoway - // invocations. - // - // = DESCRIPTION - // This class connects (or lookups a connection from the cache) - // to the remote server, builds the CDR stream for the Request, - // send the CDR stream and expects the response and interprets - // the incoming CDR stream. friend class TAO_Endpoint_Selector_Factory; friend class TAO_Default_Endpoint_Selector; @@ -82,221 +81,242 @@ class TAO_Export TAO_GIOP_Invocation friend class TAO_Client_Priority_Policy_Selector; public: + /// Default constructor. This should never get called, it is here + /// only to appease older versions of g++. TAO_GIOP_Invocation (void); - // Default constructor. This should never get called, it is here - // only to appease older versions of g++. - - TAO_GIOP_Invocation (TAO_Stub *data, - const char *operation, - CORBA::ULong opname_len, - CORBA::Boolean argument_flag, - TAO_ORB_Core *orb_core); - // Constructor. + /// Constructor. + TAO_GIOP_Invocation (TAO_Stub *data, + const char *operation, + CORBA::ULong opname_len, + CORBA::Boolean argument_flag, + TAO_ORB_Core *orb_core); + + /** + * This destructor is virtual so that the derived synchronous + * invocation classes can call <idle> method on the <Transport>, if + * they want to. All the synchronous invocations <idle> the + * Transport, but asynchronous invocations do not do that. + */ virtual ~TAO_GIOP_Invocation (void); - // This destructor is virtual so that the derived synchronous - // invocation classes can call <idle> method on the <Transport>, if - // they want to. All the synchronous invocations <idle> the - // Transport, but asynchronous invocations do not do that. + /** + * Initialize the Request header. + * The <message_size> field of the GIOP header is left blank and + * must be filled later. + * The function only returns once a connection has been succesfully + * established *OR* all profiles have been tried. In that case it + * raises the CORBA::TRANSIENT exception. + */ void prepare_header (CORBA::Octet response_flags, - CORBA_Environment &ACE_TRY_ENV = - TAO_default_environment ()) + CORBA_Environment &ACE_TRY_ENV = + TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); - // Initialize the Request header. - // The <message_size> field of the GIOP header is left blank and - // must be filled later. - // The function only returns once a connection has been succesfully - // established *OR* all profiles have been tried. In that case it - // raises the CORBA::TRANSIENT exception. - IOP::ServiceContextList& service_info (void); - // Accessor to the request ServiceContextList. Only valid when - // sending a request message. + /// Accessor to the request ServiceContextList. Only valid when + /// sending a request message. + IOP::ServiceContextList& service_info (void); + /// Return the request id of this invocation. CORBA::ULong request_id (void); - // Return the request id of this invocation. - TAO_OutputCDR &out_stream (void); - // Return the underlying output stream. + /// Return the underlying output stream. + TAO_OutputCDR &out_stream (void); // CORBA::Boolean restart_flag (void); + /// Set the value for the restart flag. void restart_flag (CORBA::Boolean flag); - // Set the value for the restart flag. + /// resets the forwarding profile and behaves like we are fowarded + /// (to the same server) int close_connection (void); - // resets the forwarding profile and behaves like we are fowarded - // (to the same server) - void start (CORBA_Environment &ACE_TRY_ENV = - TAO_default_environment ()) + /// Establishes a connection to the remote server, initializes + /// the GIOP headers in the output CDR. + void start (CORBA_Environment &ACE_TRY_ENV = + TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); - // Establishes a connection to the remote server, initializes - // the GIOP headers in the output CDR. + /// Dynamically allocate <inconsistent_policies_> PolicyList. void init_inconsistent_policies (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); - // Dynamically allocate <inconsistent_policies_> PolicyList. + /// Return PolicyList stored in <inconsistent_policies_> and give up + /// its ownership. User must deallocate memory. CORBA::PolicyList *get_inconsistent_policies (void); - // Return PolicyList stored in <inconsistent_policies_> and give up - // its ownership. User must deallocate memory. protected: + /** + * Sends the request, does not wait for the response. + * Returns TAO_INVOKE_RESTART if the write call failed and the + * request must be re-attempted. + * Notice that the same profile is tried again because it may be + * that the server closed the connection simply to release + * resources. + */ int invoke (CORBA::Boolean is_roundtrip, - CORBA_Environment &ACE_TRY_ENV = - TAO_default_environment ()) + CORBA_Environment &ACE_TRY_ENV = + TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); - // Sends the request, does not wait for the response. - // Returns TAO_INVOKE_RESTART if the write call failed and the - // request must be re-attempted. - // Notice that the same profile is tried again because it may be - // that the server closed the connection simply to release - // resources. + /** + * Helper method, the response for a Request or LocateRequest was a + * LOCATION_FORWARD or TAO_GIOP_OBJECT_FORWARD. + * In any case we must demarshal the object reference and setup the + * profiles. + * It returns TAO_INVOKE_RESTART unless an exception is raised. + */ int location_forward (TAO_InputCDR &inp_stream, - CORBA_Environment &ACE_TRY_ENV = - TAO_default_environment ()) + CORBA_Environment &ACE_TRY_ENV = + TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); - // Helper method, the response for a Request or LocateRequest was a - // LOCATION_FORWARD or TAO_GIOP_OBJECT_FORWARD. - // In any case we must demarshal the object reference and setup the - // profiles. - // It returns TAO_INVOKE_RESTART unless an exception is raised. + /** + * Create the IOP::IOR info. We will create the info atmost + * once. Return index of the profile we are using to make the + * invocation. + */ CORBA::ULong create_ior_info (void); - // Create the IOP::IOR info. We will create the info atmost - // once. Return index of the profile we are using to make the - // invocation. + /** + * Add RT-related context to the service context list if the + * invocation target supports RTCORBA::CLIENT_PROPAGATED priority + * model. + */ void add_rt_service_context (CORBA_Environment &ACE_TRY_ENV = - TAO_default_environment ()); - // Add RT-related context to the service context list if the - // invocation target supports RTCORBA::CLIENT_PROPAGATED priority - // model. + TAO_default_environment ()); protected: + /// The object on which this invocation is going. TAO_Stub *stub_; - // The object on which this invocation is going. + /// Buffer used for both the output and input CDR streams, this is + /// "safe" because we only one of the streams at a time. char buffer_ [ACE_CDR::DEFAULT_BUFSIZE]; - // Buffer used for both the output and input CDR streams, this is - // "safe" because we only one of the streams at a time. - TAO_Operation_Details op_details_; - // The relevant operation detail + /// The relevant operation detail + TAO_Operation_Details op_details_; TAO_Target_Specification target_spec_; - TAO_OutputCDR out_stream_; - // Stream into which the response is placed. + /// Stream into which the response is placed. + TAO_OutputCDR out_stream_; - TAO_ORB_Core* orb_core_; - // The orb_core context where we make this invocation. + /// The orb_core context where we make this invocation. + TAO_ORB_Core* orb_core_; - TAO_Transport *transport_; - // This invocation is using this transport, may change... + /// This invocation is using this transport, may change... + TAO_Transport *transport_; + /// Strategy for making decisions about which endpoint/profile to use + /// for invocation. TAO_Invocation_Endpoint_Selector *endpoint_selector_; - // Strategy for making decisions about which endpoint/profile to use - // for invocation. + /// Flag indicating whether <endpoint_selector_> has been + /// initialized. int is_selector_initialized_; - // Flag indicating whether <endpoint_selector_> has been - // initialized. #if (TAO_HAS_RT_CORBA == 1) + /// Store information used by <endpoint_selector_> for making + /// endpoint selection decisions. TAO_Endpoint_Selection_State endpoint_selection_state_; - // Store information used by <endpoint_selector_> for making - // endpoint selection decisions. - -#endif /* TAO_HAS_RT_CORBA == 1 */ +#endif /* TAO_HAS_RT_CORBA == 1 */ + + /** + * If current effective policies cause the invocation to raise + * CORBA::INV_POLICY exception, the conflicting/problematic policies + * are stored in this list. This is used by + * <Object::_validate_connection> method to inform clients about + * causes of invocation failure. + * + * Conflicting policies are only stored in this list if + * <init_inconsistent_policies> method has been called prior to the + * beginning of invocation. This saves extra work of conflicting + * policies 'logging' when it's not needed. + * + */ CORBA::PolicyList_var inconsistent_policies_; - // If current effective policies cause the invocation to raise - // CORBA::INV_POLICY exception, the conflicting/problematic policies - // are stored in this list. This is used by - // <Object::_validate_connection> method to inform clients about - // causes of invocation failure. - // - // Conflicting policies are only stored in this list if - // <init_inconsistent_policies> method has been called prior to the - // beginning of invocation. This saves extra work of conflicting - // policies 'logging' when it's not needed. - // + /// This invocation is using this profile. TAO_Profile *profile_; - // This invocation is using this profile. + /// This invocation is using this endpoint from <profile_>. TAO_Endpoint *endpoint_; - // This invocation is using this endpoint from <profile_>. + /// The timeout remaining for this request, it is initialized in + /// start() and updated as required. ACE_Time_Value max_wait_time_value_; ACE_Time_Value *max_wait_time_; - // The timeout remaining for this request, it is initialized in - // start() and updated as required. + /** + * The ior info. This would be needed for GIOP 1.2, as the clients + * could receive an exception from the server asking for this + * info. The exception that the client receives is + * LOC_NEEDS_ADDRESSING_MODE. If we receive an exception we will + * fill up this data atmost *once* and send it to the server. + */ IOP::IOR ior_info_; - // The ior info. This would be needed for GIOP 1.2, as the clients - // could receive an exception from the server asking for this - // info. The exception that the client receives is - // LOC_NEEDS_ADDRESSING_MODE. If we receive an exception we will - // fill up this data atmost *once* and send it to the server. + /** + * Flag indicating whether RTCORBA-specific service context list + * processing has taken place. This is needed because + * <prepare_header> may get called multiple times, but we only need + * to do the service context list processing once. + */ int rt_context_initialized_; - // Flag indicating whether RTCORBA-specific service context list - // processing has taken place. This is needed because - // <prepare_header> may get called multiple times, but we only need - // to do the service context list processing once. + /** + * This flag is turned on when the previous invocation on an + * endpoint or a profile returned a TAO_INVOKE_RESTART. FT CORBA + * relies on this flag for guarenteeing unique id's during + * reinvocations. + */ CORBA::Boolean restart_flag_; - // This flag is turned on when the previous invocation on an - // endpoint or a profile returned a TAO_INVOKE_RESTART. FT CORBA - // relies on this flag for guarenteeing unique id's during - // reinvocations. }; // **************************************************************** +/** + * @class TAO_GIOP_Synch_Invocation + * + * @brief TAO_GIOP_Synch_Invocation. + * + * Base class for TAO_GIOP_Twoway_Invocation and + * TAO_GIOP_Oneway_Invocation. + */ class TAO_Export TAO_GIOP_Synch_Invocation : public TAO_GIOP_Invocation { - // = TITLE - // TAO_GIOP_Synch_Invocation. - // - // = DESCRIPTION - // Base class for TAO_GIOP_Twoway_Invocation and - // TAO_GIOP_Oneway_Invocation. - // public: + /// Default constructor. This should never get called, it is here + /// only to appease older versions of g++. TAO_GIOP_Synch_Invocation (void); - // Default constructor. This should never get called, it is here - // only to appease older versions of g++. + /// Constructor. TAO_GIOP_Synch_Invocation (TAO_Stub *stub, - const char *operation, - CORBA::ULong opname_len, - CORBA::Boolean argument_flag, - TAO_ORB_Core *orb_core); - // Constructor. + const char *operation, + CORBA::ULong opname_len, + CORBA::Boolean argument_flag, + TAO_ORB_Core *orb_core); + /// Destructor. virtual ~TAO_GIOP_Synch_Invocation (void); - // Destructor. + /// Return the underlying input stream. Called by the stub to demarshal + /// the results of the upcall into whatever return arguments there may be. TAO_InputCDR &inp_stream (void); - // Return the underlying input stream. Called by the stub to demarshal - // the results of the upcall into whatever return arguments there may be. protected: + /// Implementation of the invoke() methods, handles the basic + /// send/reply code and the system exceptions. int invoke_i (CORBA::Boolean is_locate_request, - CORBA::Environment &ACE_TRY_ENV) + CORBA::Environment &ACE_TRY_ENV) ACE_THROW_SPEC ((CORBA::SystemException)); - // Implementation of the invoke() methods, handles the basic - // send/reply code and the system exceptions. + /// Reply dispatcher for the current synchronous invocation. TAO_Synch_Reply_Dispatcher rd_; - // Reply dispatcher for the current synchronous invocation. }; // **************************************************************** @@ -305,41 +325,43 @@ class TAO_Export TAO_GIOP_Twoway_Invocation : public TAO_GIOP_Synch_Invocation { // = TITLE - // TAO_GIOP_Twoway_Invocation. + // TAO_GIOP_Twoway_Invocation. // // = DESCRIPTION - // Sends a two-way request, and expects the reply. - // This class connects (or lookups a connection from the cache) to - // the remote server, builds the CDR stream for the Request, send - // the CDR stream and expects the response and interprets the - // incoming CDR stream. + // Sends a two-way request, and expects the reply. + // This class connects (or lookups a connection from the cache) to + // the remote server, builds the CDR stream for the Request, send + // the CDR stream and expects the response and interprets the + // incoming CDR stream. // public: + /// Constructor. TAO_GIOP_Twoway_Invocation (TAO_Stub *stub, - const char *operation, - CORBA::ULong opname_len, - CORBA::Boolean argument_flag, - TAO_ORB_Core *orb_core); - // Constructor. + const char *operation, + CORBA::ULong opname_len, + CORBA::Boolean argument_flag, + TAO_ORB_Core *orb_core); + /// Destructor. virtual ~TAO_GIOP_Twoway_Invocation (void); - // Destructor. - void start (CORBA_Environment &ACE_TRY_ENV = - TAO_default_environment ()) + /// Establishes a connection to the remote server, initializes + /// the GIOP headers in the output CDR. + void start (CORBA_Environment &ACE_TRY_ENV = + TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); - // Establishes a connection to the remote server, initializes - // the GIOP headers in the output CDR. + /** + * Special purpose invoke method used by the generated stubs. This + * accomplishes the same task as the normal invoke except that + * Exceptions are allocated and decoded here. This reduces the + * footprint of the generated stubs. + */ int invoke (TAO_Exception_Data *excepts, - CORBA::ULong except_count, - CORBA_Environment &ACE_TRY_ENV = - TAO_default_environment ()) + CORBA::ULong except_count, + CORBA_Environment &ACE_TRY_ENV = + TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::Exception)); - // Special purpose invoke method used by the generated stubs. This - // accomplishes the same task as the normal invoke except that - // Exceptions are allocated and decoded here. This reduces the - // footprint of the generated stubs. }; // **************************************************************** @@ -348,38 +370,38 @@ class TAO_Export TAO_GIOP_Oneway_Invocation : public TAO_GIOP_Synch_Invocation { // = TITLE - // TAO_GIOP_Oneway_Invocation + // TAO_GIOP_Oneway_Invocation // // = DESCRIPTION - // Sends a oneway request. + // Sends a oneway request. // public: + /// Constructor. TAO_GIOP_Oneway_Invocation (TAO_Stub *stub, - const char *operation, - CORBA::ULong opname_len, - CORBA::Boolean argument_flag, - TAO_ORB_Core *orb_core); - // Constructor. + const char *operation, + CORBA::ULong opname_len, + CORBA::Boolean argument_flag, + TAO_ORB_Core *orb_core); + /// Destructor. virtual ~TAO_GIOP_Oneway_Invocation (void); - // Destructor. - void start (CORBA_Environment &ACE_TRY_ENV = - TAO_default_environment ()) + /// Establishes a connection to the remote server, initializes + /// the GIOP headers in the output CDR. + void start (CORBA_Environment &ACE_TRY_ENV = + TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); - // Establishes a connection to the remote server, initializes - // the GIOP headers in the output CDR. - int invoke (CORBA_Environment &ACE_TRY_ENV = - TAO_default_environment ()) + /// Send request, without blocking for any response. + int invoke (CORBA_Environment &ACE_TRY_ENV = + TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); - // Send request, without blocking for any response. + /// Acessor for private member. TAO::SyncScope sync_scope (void); - // Acessor for private member. private: + /// Our sync scope. TAO::SyncScope sync_scope_; - // Our sync scope. }; // **************************************************************** @@ -391,23 +413,23 @@ class TAO_Export TAO_GIOP_Locate_Request_Invocation // Sends a locate request. // public: + /// Constructor. TAO_GIOP_Locate_Request_Invocation (TAO_Stub *data, - TAO_ORB_Core *orb_core); - // Constructor. + TAO_ORB_Core *orb_core); + /// Destructor. ~TAO_GIOP_Locate_Request_Invocation (void); - // Destructor. - void start (CORBA_Environment &ACE_TRY_ENV = - TAO_default_environment ()) + /// Establishes a connection to the remote server, initializes + /// the GIOP headers in the output CDR. + void start (CORBA_Environment &ACE_TRY_ENV = + TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); - // Establishes a connection to the remote server, initializes - // the GIOP headers in the output CDR. - int invoke (CORBA_Environment &ACE_TRY_ENV = - TAO_default_environment ()) + /// Send request, without blocking for any response. + int invoke (CORBA_Environment &ACE_TRY_ENV = + TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); - // Send request, without blocking for any response. }; // **************************************************************** diff --git a/TAO/tao/Invocation_Endpoint_Selectors.h b/TAO/tao/Invocation_Endpoint_Selectors.h index acfb91e28c7..b28930c4fb0 100644 --- a/TAO/tao/Invocation_Endpoint_Selectors.h +++ b/TAO/tao/Invocation_Endpoint_Selectors.h @@ -1,22 +1,19 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Invocation_Endpoint_Selectors.h -// -// = DESCRIPTION -// Strategies for selecting profile/endpoint from an IOR for making an -// invocation. -// -// = AUTHOR -// Marina Spivak <marina@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Invocation_Endpoint_Selectors.h + * + * $Id$ + * + * Strategies for selecting profile/endpoint from an IOR for making an + * invocation. + * + * + * @author Marina Spivak <marina@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_INVOCATION_ENDPOINT_SELECTOR_H #define TAO_INVOCATION_ENDPOINT_SELECTOR_H @@ -37,35 +34,36 @@ class TAO_PriorityModelPolicy; class TAO_ClientProtocolPolicy; class TAO_PriorityBandedConnectionPolicy; +/** + * @class TAO_Endpoint_Selector_Factory + * + * @brief Factory for initializing <Endpoint_Selection_State> and + * obtaining appropriate <Invocation_Endpoint_Selector>. + * + * Used by Invocation classes to intialize its endpoint selection + * strategy and state based on the effective policies. + * Endpoint selection strategies are stateless objects - all the + * state they need is contained by Invocation in + * <Endpoint_Selection_State>. Thus, rather than allocating an + * endpoint selection strategy object for each Invocation, the + * factory simply returns the appropriate one from the + * set preallocated in the ORB_Core. One endpoint selection + * strategy object can be used by many invocations concurrently. + */ class TAO_Export TAO_Endpoint_Selector_Factory { - // = TITLE - // Factory for initializing <Endpoint_Selection_State> and - // obtaining appropriate <Invocation_Endpoint_Selector>. - // - // = DESCRIPTION - // Used by Invocation classes to intialize its endpoint selection - // strategy and state based on the effective policies. - // Endpoint selection strategies are stateless objects - all the - // state they need is contained by Invocation in - // <Endpoint_Selection_State>. Thus, rather than allocating an - // endpoint selection strategy object for each Invocation, the - // factory simply returns the appropriate one from the - // set preallocated in the ORB_Core. One endpoint selection - // strategy object can be used by many invocations concurrently. - // public: + /// Constructor. TAO_Endpoint_Selector_Factory (void); - // Constructor. + /// Destructor. ~TAO_Endpoint_Selector_Factory (void); - // Destructor. + /// Initialize Invocation's endpoint selection strategy and + /// state. void get_selector (TAO_GIOP_Invocation *invocation, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Initialize Invocation's endpoint selection strategy and - // state. private: @@ -73,22 +71,24 @@ private: #if (TAO_HAS_RT_CORBA == 1) + /** + * Gets the appropriate selector if TAO_HAS_CLIENT_PRIORITY_POLICY + * is enabled. Also initializes endpoint selection state as + * necessary. WARNING: TAO::Client_Pririority_Policy is + * deprecated. See TAO RTCORBA documentation for more details. + */ void check_client_priority_policy (TAO_GIOP_Invocation *invocation, CORBA::Environment &ACE_TRY_ENV); - // Gets the appropriate selector if TAO_HAS_CLIENT_PRIORITY_POLICY - // is enabled. Also initializes endpoint selection state as - // necessary. WARNING: TAO::Client_Pririority_Policy is - // deprecated. See TAO RTCORBA documentation for more details. + /// Initializes RTCORBA::ClientProtocolPolicy in the endpoint + /// selection state. void init_client_protocol (TAO_GIOP_Invocation *invocation, CORBA::Environment &ACE_TRY_ENV); - // Initializes RTCORBA::ClientProtocolPolicy in the endpoint - // selection state. + /// Initializes RTCORBA::PriorityBandsPolicy in the endpoint + /// selection state. void init_bands (TAO_GIOP_Invocation *invocation, CORBA::Environment &ACE_TRY_ENV); - // Initializes RTCORBA::PriorityBandsPolicy in the endpoint - // selection state. #endif /* TAO_HAS_RT_CORBA == 1 */ }; @@ -97,30 +97,31 @@ private: #if (TAO_HAS_RT_CORBA == 1) +/** + * @class TAO_Endpoint_Selection_State + * + * @brief Per-Invocation state for endpoint selection activities. + * + * Stores effective policy overrides for an Invocation, as well as + * some state about which endpoint was selected (so we know where + * we left off in case we need to try another endpoint during the + * same invocation). This class is used by + * 1) TAO_Endpoint_Selector_Factory to determine which endpoint + * selection strategy is appropriate for the Invocation + * 2) Concrete Invocation_Endpoint_Selectors to look up/store + * selection state. + */ class TAO_Export TAO_Endpoint_Selection_State { - // = TITLE - // Per-Invocation state for endpoint selection activities. - // - // = DESCRIPTION - // Stores effective policy overrides for an Invocation, as well as - // some state about which endpoint was selected (so we know where - // we left off in case we need to try another endpoint during the - // same invocation). This class is used by - // 1) TAO_Endpoint_Selector_Factory to determine which endpoint - // selection strategy is appropriate for the Invocation - // 2) Concrete Invocation_Endpoint_Selectors to look up/store - // selection state. - // public: // = Initialization and termination. + /// Constructor. TAO_Endpoint_Selection_State (void); - // Constructor. + /// Destructor. ~TAO_Endpoint_Selection_State (void); - // Destructor. // = State. @@ -131,83 +132,92 @@ public: TAO_PrivateConnectionPolicy *private_connection_; TAO_PriorityBandedConnectionPolicy *bands_policy_; + /** + * Index into the RTCORBA::ProtocolList of the + * <client_protocol_policy_>, identifying the protocol we should + * attempt using next. + * TAO_Client_Priority_Policy_Selector uses this data member to keep + * track of the profile index to try next. + */ CORBA::ULong client_protocol_index_; - // Index into the RTCORBA::ProtocolList of the - // <client_protocol_policy_>, identifying the protocol we should - // attempt using next. - // TAO_Client_Priority_Policy_Selector uses this data member to keep - // track of the profile index to try next. + /// Flag indicating whether at least one endpoint satisfying all the + /// policies was found during the lifetime of this object. int valid_endpoint_found_; - // Flag indicating whether at least one endpoint satisfying all the - // policies was found during the lifetime of this object. + /// If using RTCORBA::CLIENT_PROPAGATED priority model, cache our + /// client priority here. CORBA::Short client_priority_; - // If using RTCORBA::CLIENT_PROPAGATED priority model, cache our - // client priority here. + /** + * If we need to select endpoint based on a range of priorities, + * e.g., as in TAO_Bands_Endpoint_Selector, cache the target range + * here. + */ CORBA::Short min_priority_; CORBA::Short max_priority_; - // If we need to select endpoint based on a range of priorities, - // e.g., as in TAO_Bands_Endpoint_Selector, cache the target range - // here. }; #endif /* TAO_HAS_RT_CORBA == 1 */ // **************************************************************** +/** + * @class TAO_Invocation_Endpoint_Selector + * + * @brief Defines the interface for policy-based endpoint selection + * strategies. + * + * Selects/reselects server endpoint for an Invocation. Different + * concrete strategies perform selection based on different + * policies. + * All endpoint selection strategies are stateless objects - any + * necessary state is stored in Invocation's + * <endpoint_selection_state_>. + */ class TAO_Export TAO_Invocation_Endpoint_Selector { - // = TITLE - // Defines the interface for policy-based endpoint selection - // strategies. - // - // = DESCRIPTION - // Selects/reselects server endpoint for an Invocation. Different - // concrete strategies perform selection based on different - // policies. - // All endpoint selection strategies are stateless objects - any - // necessary state is stored in Invocation's - // <endpoint_selection_state_>. - // public: + /// Constructor. TAO_Invocation_Endpoint_Selector (void); - // Constructor. + /// Destructor. virtual ~TAO_Invocation_Endpoint_Selector (void); - // Destructor. + /// Select the endpoint and set <invocation>'s <profile_> and + /// <endpoint_> data members accordingly. virtual void select_endpoint (TAO_GIOP_Invocation *invocation, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()) = 0; - // Select the endpoint and set <invocation>'s <profile_> and - // <endpoint_> data members accordingly. + /** + * This method must be called when previously selected endpoint + * didn't work out, and we want to try another one, i.e., reselect. + * This method performs the necessary state updates, so that next + * <select_endpoint> call picks a new endpoint. + */ virtual void next (TAO_GIOP_Invocation *invocation, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()) = 0; - // This method must be called when previously selected endpoint - // didn't work out, and we want to try another one, i.e., reselect. - // This method performs the necessary state updates, so that next - // <select_endpoint> call picks a new endpoint. + /** + * This method must be called if the invocation attempt on a + * selected endpoint resulted in location forward. This method + * performs the necessary state updates, so that next <select_endpoint> + * call picks a new endpoint. + */ virtual void forward (TAO_GIOP_Invocation *invocation, const TAO_MProfile &mprofile, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()) = 0; - // This method must be called if the invocation attempt on a - // selected endpoint resulted in location forward. This method - // performs the necessary state updates, so that next <select_endpoint> - // call picks a new endpoint. + /// Update the state to indicate that the selected endpoint/profile + /// were used successfully. virtual void success (TAO_GIOP_Invocation *invocation) = 0; - // Update the state to indicate that the selected endpoint/profile - // were used successfully. + /// Update the state to reflect that the connection being used for + /// the invocation has been closed by the server. virtual void close_connection (TAO_GIOP_Invocation *invocation) = 0; - // Update the state to reflect that the connection being used for - // the invocation has been closed by the server. }; // **************************************************************** @@ -227,11 +237,11 @@ class TAO_Export TAO_Default_Endpoint_Selector : // profile, and so on. // public: + /// Constructor. TAO_Default_Endpoint_Selector (void); - // Constructor. + /// Destructor. virtual ~TAO_Default_Endpoint_Selector (void); - // Destructor. virtual void select_endpoint (TAO_GIOP_Invocation *invocation, CORBA::Environment &ACE_TRY_ENV = @@ -263,18 +273,18 @@ class TAO_Export TAO_Priority_Endpoint_Selector : // set and its value is RTCORBA::CLIENT_PROPAGATED. // public: + /// Constructor. TAO_Priority_Endpoint_Selector (void); - // Constructor. + /// Destructor. virtual ~TAO_Priority_Endpoint_Selector (void); - // Destructor. virtual void select_endpoint (TAO_GIOP_Invocation *invocation, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); private: + /// Helper for <select_endpoint>. int is_multihomed (TAO_Endpoint *endpoint); - // Helper for <select_endpoint>. }; // **************************************************************** @@ -290,11 +300,11 @@ class TAO_Export TAO_Bands_Endpoint_Selector : // RTCORBA::PriorityBandedConnectionPolicy is set. // public: + /// Constructor. TAO_Bands_Endpoint_Selector (void); - // Constructor. + /// Destructor. virtual ~TAO_Bands_Endpoint_Selector (void); - // Destructor. virtual void select_endpoint (TAO_GIOP_Invocation *invocation, CORBA::Environment &ACE_TRY_ENV = @@ -315,11 +325,11 @@ class TAO_Export TAO_Protocol_Endpoint_Selector : // RTCORBA::SERVER_DECLARED priority model. // public: + /// Constructor. TAO_Protocol_Endpoint_Selector (void); - // Constructor. + /// Destructor. virtual ~TAO_Protocol_Endpoint_Selector (void); - // Destructor. virtual void select_endpoint (TAO_GIOP_Invocation *invocation, CORBA::Environment &ACE_TRY_ENV = @@ -335,10 +345,10 @@ public: virtual void close_connection (TAO_GIOP_Invocation *invocation); protected: + /// Helper for <select_endpoint>. virtual void endpoint (TAO_GIOP_Invocation *invocation, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Helper for <select_endpoint>. }; // **************************************************************** @@ -357,11 +367,11 @@ class TAO_Export TAO_Client_Priority_Policy_Selector : // information. // public: + /// Constructor. TAO_Client_Priority_Policy_Selector (void); - // Constructor. + /// Destructor. virtual ~TAO_Client_Priority_Policy_Selector (void); - // Destructor. virtual void select_endpoint (TAO_GIOP_Invocation *invocation, CORBA::Environment &ACE_TRY_ENV = @@ -391,20 +401,20 @@ class TAO_Export TAO_Priority_Protocol_Selector : // set and the priority model is RTCORBA::CLIENT_PROPAGATED. // public: + /// Constructor. TAO_Priority_Protocol_Selector (void); - // Constructor. + /// Destructor. virtual ~TAO_Priority_Protocol_Selector (void); - // Destructor. protected: + /// virtual void endpoint (TAO_GIOP_Invocation *invocation, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // + /// Helper for <select_endpoint>. int is_multihomed (TAO_Endpoint *endpoint); - // Helper for <select_endpoint>. }; // **************************************************************** @@ -421,11 +431,11 @@ class TAO_Export TAO_Bands_Protocol_Selector : // and RTCORBA::PriorityBandedConnectionPolicy are set. // public: + /// Constructor. TAO_Bands_Protocol_Selector (void); - // Constructor. + /// Destructor. virtual ~TAO_Bands_Protocol_Selector (void); - // Destructor. protected: virtual void endpoint (TAO_GIOP_Invocation *invocation, diff --git a/TAO/tao/Leader_Follower.h b/TAO/tao/Leader_Follower.h index a6bfca1c025..d3daf4a20c0 100644 --- a/TAO/tao/Leader_Follower.h +++ b/TAO/tao/Leader_Follower.h @@ -1,17 +1,14 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Leader_Follower.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file Leader_Follower.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_LEADER_FOLLOWER_H #define TAO_LEADER_FOLLOWER_H @@ -28,177 +25,185 @@ class TAO_Export TAO_Leader_Follower { public: + /// Constructor TAO_Leader_Follower (TAO_ORB_Core *orb_core); - // Constructor + /// Destructor ~TAO_Leader_Follower (void); - // Destructor + /// The current thread has become a server thread (i.e. called + /// ORB::run), update any flags and counters. int set_event_loop_thread (ACE_Time_Value *max_wait_time); - // The current thread has become a server thread (i.e. called - // ORB::run), update any flags and counters. + /// The current thread is not a server thread anymore, reset any + /// flags and counters. void reset_event_loop_thread (void); - // The current thread is not a server thread anymore, reset any - // flags and counters. + /// This thread is going to perform an upcall, it will no longer be + /// an event loop thread. void set_upcall_thread (void); - // This thread is going to perform an upcall, it will no longer be - // an event loop thread. + /// Is there any thread running as a leader? int leader_available (void) const; - // Is there any thread running as a leader? + /// A server thread is making a request. void set_client_thread (void); - // A server thread is making a request. + /// A server thread has finished is making a request. void reset_client_thread (void); - // A server thread has finished is making a request. + /// The current thread has become the leader thread in the + /// client side leader-follower set. void set_client_leader_thread (void) ; - // The current thread has become the leader thread in the - // client side leader-follower set. + /// The current thread is no longer the leader thread in the client + /// side leader-follower set. void reset_client_leader_thread (void) ; - // The current thread is no longer the leader thread in the client - // side leader-follower set. + /// sets the thread ID of the leader thread in the leader-follower + /// model void set_client_leader_thread (ACE_thread_t thread_ID); - // sets the thread ID of the leader thread in the leader-follower - // model + /// checks if we are a leader thread int is_client_leader_thread (void) const; - // checks if we are a leader thread + /** + * A leader thread is relinquishing its role, unless there are more + * leader threads running pick up a follower (if there is any) to + * play the leader role. + */ int elect_new_leader (void); - // A leader thread is relinquishing its role, unless there are more - // leader threads running pick up a follower (if there is any) to - // play the leader role. + /** + * adds the a follower to the set of followers in the leader- + * follower model + * returns 0 on success, -1 on failure and 1 if the element is + * already there. + */ int add_follower (ACE_SYNCH_CONDITION *follower_ptr); - // adds the a follower to the set of followers in the leader- - // follower model - // returns 0 on success, -1 on failure and 1 if the element is - // already there. + /// checks for the availablity of a follower + /// returns 1 on available, 0 else int follower_available (void) const; - // checks for the availablity of a follower - // returns 1 on available, 0 else + /// removes a follower from the leader-follower set + /// returns 0 on success, -1 on failure int remove_follower (ACE_SYNCH_CONDITION *follower_ptr); - // removes a follower from the leader-follower set - // returns 0 on success, -1 on failure + /// returns randomly a follower from the leader-follower set + /// returns follower on success, else 0 ACE_SYNCH_CONDITION *get_next_follower (void); - // returns randomly a follower from the leader-follower set - // returns follower on success, else 0 + /// Accessors ACE_SYNCH_MUTEX &lock (void); ACE_Reverse_Lock<ACE_SYNCH_MUTEX> &reverse_lock (void); - // Accessors + /// Check if there are any client threads running int has_clients (void) const; - // Check if there are any client threads running + /// Accesor to the reactor ACE_Reactor *reactor (void); - // Accesor to the reactor private: + /// Shortcut to obtain the TSS resources of the orb core. TAO_ORB_Core_TSS_Resources *get_tss_resources (void) const; - // Shortcut to obtain the TSS resources of the orb core. + /// Wait for the client leader to complete. int wait_for_client_leader_to_complete (ACE_Time_Value *max_wait_time); - // Wait for the client leader to complete. + /** + * Implement the reset_event_loop_thread() method, once the TSS + * resources have been acquired. + * Also used in the set_upcall_thread. + */ void reset_event_loop_thread_i (TAO_ORB_Core_TSS_Resources *tss); - // Implement the reset_event_loop_thread() method, once the TSS - // resources have been acquired. - // Also used in the set_upcall_thread. private: + /// The orb core TAO_ORB_Core *orb_core_; - // The orb core + /// To synchronize access to the members. ACE_SYNCH_MUTEX lock_; - // To synchronize access to the members. + /// do protect the access to the following three members ACE_Reverse_Lock<ACE_SYNCH_MUTEX> reverse_lock_; - // do protect the access to the following three members ACE_Unbounded_Set<ACE_SYNCH_CONDITION *> follower_set_; // keep a set of followers around (protected) + /** + * Count the number of active leaders. + * There could be many leaders in the thread pool (i.e. calling + * ORB::run), and the same leader could show up multiple times as it + * receives nested upcalls and sends more requests. + */ int leaders_; - // Count the number of active leaders. - // There could be many leaders in the thread pool (i.e. calling - // ORB::run), and the same leader could show up multiple times as it - // receives nested upcalls and sends more requests. + /// Count the number of active clients, this is useful to know when + /// to deactivate the reactor int clients_; - // Count the number of active clients, this is useful to know when - // to deactivate the reactor + /// The reactor ACE_Reactor *reactor_; - // The reactor + /// Is a client thread the current leader? int client_thread_is_leader_; - // Is a client thread the current leader? + /// Are server threads waiting for the client leader to complete? int event_loop_threads_waiting_; - // Are server threads waiting for the client leader to complete? + /// Condition variable for server threads waiting for the client + /// leader to complete. ACE_SYNCH_CONDITION event_loop_threads_condition_; - // Condition variable for server threads waiting for the client - // leader to complete. }; class TAO_Export TAO_LF_Client_Thread_Helper { public: + /// Constructor TAO_LF_Client_Thread_Helper (TAO_Leader_Follower &leader_follower); - // Constructor + /// Destructor ~TAO_LF_Client_Thread_Helper (void); - // Destructor private: + /// Reference to leader/followers object. TAO_Leader_Follower &leader_follower_; - // Reference to leader/followers object. }; class TAO_Export TAO_LF_Client_Leader_Thread_Helper { public: + /// Constructor TAO_LF_Client_Leader_Thread_Helper (TAO_Leader_Follower &leader_follower); - // Constructor + /// Destructor ~TAO_LF_Client_Leader_Thread_Helper (void); - // Destructor private: + /// Reference to leader/followers object. TAO_Leader_Follower &leader_follower_; - // Reference to leader/followers object. }; class TAO_Export TAO_LF_Event_Loop_Thread_Helper { public: + /// Constructor TAO_LF_Event_Loop_Thread_Helper (TAO_Leader_Follower &leader_follower); - // Constructor + /// Destructor ~TAO_LF_Event_Loop_Thread_Helper (void); - // Destructor + /// Calls <set_event_loop_thread> on the leader/followers object. int set_event_loop_thread (ACE_Time_Value *max_wait_time); - // Calls <set_event_loop_thread> on the leader/followers object. private: + /// Reference to leader/followers object. TAO_Leader_Follower &leader_follower_; - // Reference to leader/followers object. + /// Remembers whether we have to call the reset method in the + /// destructor. int call_reset_; - // Remembers whether we have to call the reset method in the - // destructor. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/LocalObject.h b/TAO/tao/LocalObject.h index 2a011199f2a..12ede1c1eaf 100644 --- a/TAO/tao/LocalObject.h +++ b/TAO/tao/LocalObject.h @@ -1,24 +1,21 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// LocalObject.h -// -// = DESCRIPTION -// Header file for CORBA's base "LocalObject" type. -// -// A "LocalObject" is an entity that can be the target of an local -// invocation. See the CORBA Component Model specification for details. -// -// = AUTHOR -// Portions Copyright 1997 by Washington University -// -// ============================================================================ + +//============================================================================= +/** + * @file LocalObject.h + * + * $Id$ + * + * Header file for CORBA's base "LocalObject" type. + * + * A "LocalObject" is an entity that can be the target of an local + * invocation. See the CORBA Component Model specification for details. + * + * + * @author Portions Copyright 1997 by Washington University + */ +//============================================================================= + #ifndef TAO_CORBA_LOCALOBJECT_H #define TAO_CORBA_LOCALOBJECT_H @@ -31,52 +28,58 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class CORBA_LocalObject + @@ NW: It is not clear whether minimum CORBA should support + * LocalObject or not. I think it should. + */ class TAO_Export CORBA_LocalObject : public virtual CORBA_Object { - // @@ NW: It is not clear whether minimum CORBA should support - // LocalObject or not. I think it should. public: + /// destructor virtual ~CORBA_LocalObject (void); - // destructor + /// increment the ref count static CORBA_LocalObject_ptr _duplicate (CORBA_LocalObject_ptr obj); - // increment the ref count + /// return a NUL object static CORBA_LocalObject_ptr _nil (void); - // return a NUL object + /** + * @@ Narrowing a CORBA_LocalObject to a CORBA_Object is broken + * right now. The solution seems to be making CORBA_Object an + * abstract base class and create a CORBA_RemoteObject for regular + * object. Or, even easier, add a <is_local> member into + * CORBA_Object. I'll take the easier route for now. + */ static CORBA_LocalObject_ptr _narrow (CORBA_Object_ptr obj, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // @@ Narrowing a CORBA_LocalObject to a CORBA_Object is broken - // right now. The solution seems to be making CORBA_Object an - // abstract base class and create a CORBA_RemoteObject for regular - // object. Or, even easier, add a <is_local> member into - // CORBA_Object. I'll take the easier route for now. + /// no-op it is just here to simplify some templates. static CORBA_LocalObject_ptr _unchecked_narrow (CORBA_Object_ptr obj, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // no-op it is just here to simplify some templates. #if (TAO_HAS_MINIMUM_CORBA == 0) + /// Always returns false. virtual CORBA::Boolean _non_existent (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Always returns false. + /// throws NO_IMPLEMENT. virtual CORBA::ImplementationDef_ptr _get_implementation (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // throws NO_IMPLEMENT. #if (TAO_HAS_INTERFACE_REPOSITORY == 1) + /// throws NO_IMPLEMENT. virtual IR_InterfaceDef *_get_interface (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // throws NO_IMPLEMENT. #endif /* TAO_HAS_INTERFACE_REPOSITORY == 1 */ + /// throws NO_IMPLEMENT. virtual void _create_request (CORBA::Context_ptr ctx, const CORBA::Char *operation, CORBA::NVList_ptr arg_list, @@ -85,7 +88,6 @@ public: CORBA::Flags req_flags, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // throws NO_IMPLEMENT. virtual void _create_request (CORBA::Context_ptr ctx, const CORBA::Char *operation, @@ -100,93 +102,99 @@ public: // throws NO_IMPLEMENT. + /// throws NO_IMPLEMENT. virtual CORBA::Request_ptr _request (const CORBA::Char *operation, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // throws NO_IMPLEMENT. #endif /* TAO_HAS_MINIMUM_CORBA */ #if (TAO_HAS_CORBA_MESSAGING == 1) + /// throws NO_IMPLEMENT. CORBA::Policy_ptr _get_policy ( CORBA::PolicyType type, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); - // throws NO_IMPLEMENT. + /// throws NO_IMPLEMENT. CORBA::Policy_ptr _get_client_policy ( CORBA::PolicyType type, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); - // throws NO_IMPLEMENT. + /// throws NO_IMPLEMENT. CORBA::Object_ptr _set_policy_overrides ( const CORBA::PolicyList & policies, CORBA::SetOverrideType set_add, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); - // throws NO_IMPLEMENT. + /// throws NO_IMPLEMENT. CORBA::PolicyList * _get_policy_overrides ( const CORBA::PolicyTypeSeq & types, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); - // throws NO_IMPLEMENT. + /// throws NO_IMPLEMENT. CORBA::Boolean _validate_connection ( CORBA::PolicyList_out inconsistent_policies, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ); - // throws NO_IMPLEMENT. #endif /* TAO_HAS_CORBA_MESSAGING == 1 */ + /** + * Return a (potentially non-unique) hash value for this object. + * This method relies on the representation of the object + * reference's private state. Since that changes easily (when + * different ORB protocols are in use) there is no default + * implementation. + */ virtual CORBA::ULong _hash (CORBA::ULong maximum, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Return a (potentially non-unique) hash value for this object. - // This method relies on the representation of the object - // reference's private state. Since that changes easily (when - // different ORB protocols are in use) there is no default - // implementation. + /** + * Try to determine if this object is the same as <other_obj>. This + * method relies on the representation of the object reference's + * private state. Since that changes easily (when different ORB + * protocols are in use) there is no default implementation. + */ virtual CORBA::Boolean _is_equivalent (CORBA_Object_ptr other_obj, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) ACE_THROW_SPEC (()); - // Try to determine if this object is the same as <other_obj>. This - // method relies on the representation of the object reference's - // private state. Since that changes easily (when different ORB - // protocols are in use) there is no default implementation. // = Reference count managment. + /// Increment the reference count. virtual void _add_ref (void); - // Increment the reference count. + /// Decrement the reference count. virtual void _remove_ref (void); - // Decrement the reference count. // = TAO extensions + /// throws NO_IMPLEMENT. virtual TAO_ObjectKey *_key (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // throws NO_IMPLEMENT. #if 0 + /** + * Return a reference to the object key of profile in-use. + * If there's no in-use profile, then the program will + * probably crash. This method does not create a new copy. + */ virtual const TAO_ObjectKey &_object_key (void); - // Return a reference to the object key of profile in-use. - // If there's no in-use profile, then the program will - // probably crash. This method does not create a new copy. + /// Downcasting this object pointer to some other derived class. + /// This QueryInterface stuff only work for local object. virtual void * _tao_QueryInterface (ptr_arith_t type); - // Downcasting this object pointer to some other derived class. - // This QueryInterface stuff only work for local object. #endif /* 0 */ #if !defined(__GNUC__) || __GNUC__ > 2 || __GNUC_MINOR__ >= 8 @@ -221,9 +229,9 @@ public: CORBA_LocalObject_var &operator= (const CORBA_LocalObject_var &); CORBA_LocalObject_ptr operator-> (void) const; + /// in, inout, out, _retn operator const CORBA_LocalObject_ptr &() const; operator CORBA_LocalObject_ptr &(); - // in, inout, out, _retn CORBA_LocalObject_ptr in (void) const; CORBA_LocalObject_ptr &inout (void); CORBA_LocalObject_ptr &out (void); @@ -251,18 +259,19 @@ private: CORBA_LocalObject_ptr &ptr_; }; +/** + * @class TAO_Local_RefCounted_Object + This class adds default reference counting to local objects. + */ class TAO_Export TAO_Local_RefCounted_Object : public virtual CORBA_LocalObject { - // - // This class adds default reference counting to local objects. - // public: + /// Increment reference count. virtual void _add_ref (void); - // Increment reference count. + /// Decrement reference count. virtual void _remove_ref (void); - // Decrement reference count. protected: TAO_Local_RefCounted_Object (void); diff --git a/TAO/tao/MProfile.h b/TAO/tao/MProfile.h index 977c5647089..ba1255a070a 100644 --- a/TAO/tao/MProfile.h +++ b/TAO/tao/MProfile.h @@ -1,21 +1,18 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// MProfile.h -// -// = DESCRIPTION -// Keep track of profile lists -// -// = AUTHOR -// Fred Kuhns <fredk@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file MProfile.h + * + * $Id$ + * + * Keep track of profile lists + * + * + * @author Fred Kuhns <fredk@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_MPROFILE_H #define TAO_MPROFILE_H @@ -31,193 +28,204 @@ typedef CORBA::ULong TAO_PHandle; +/** + * @class TAO_MProfile + * + * @brief This class implements the basic interface for supporting + * multiple profiles. + * + * Multiple profiles can be treated either as a circular queue or + * a linear array of profiles. + * It is assumed that locking will only be required when a profile + * list is associated with a TAO_Stub. Thus when the + * TAO_Stub accepts ownership of an MProfile it also assumes + * responsibility for controling access (i.e. locking). + */ class TAO_Export TAO_MProfile { - // = TITLE - // This class implements the basic interface for supporting - // multiple profiles. - // - // = DESCRIPTION - // Multiple profiles can be treated either as a circular queue or - // a linear array of profiles. - // - // It is assumed that locking will only be required when a profile - // list is associated with a TAO_Stub. Thus when the - // TAO_Stub accepts ownership of an MProfile it also assumes - // responsibility for controling access (i.e. locking). public: // = Initialization and termination methods. TAO_MProfile (CORBA::ULong sz = 0); + /** + * **NOTE: IF mprofiles->last_ > 0, THEN this->size_ will be set to + * mprofiles->last_. Otherwise this->size_ - mprofiles->size_. + * Furthermore, current_ is set back to 0! i.e. rewound. + * The reference count on any profiles in mprofiles is increment + * when their references (i.e. pointers) are copied. + */ TAO_MProfile (const TAO_MProfile &mprofiles); - // **NOTE: IF mprofiles->last_ > 0, THEN this->size_ will be set to - // mprofiles->last_. Otherwise this->size_ - mprofiles->size_. - // Furthermore, current_ is set back to 0! i.e. rewound. - // The reference count on any profiles in mprofiles is increment - // when their references (i.e. pointers) are copied. + /// Assigment operator. TAO_MProfile& operator= (const TAO_MProfile& mprofiles); - // Assigment operator. + /// Destructor: decrements reference count on all references + /// profiles! ~TAO_MProfile (void); - // Destructor: decrements reference count on all references - // profiles! + /// Inits MProfile to hold sz TAO_Profiles. + /// NOT THREAD SAFE int set (CORBA::ULong sz); - // Inits MProfile to hold sz TAO_Profiles. - // NOT THREAD SAFE + /** + * Inits this to the values of mprofile. NOTE: We use + * mprofile->last_ instead of mprofile->size_ to set this->size_. + * This is so we can use set () to trim a profile list!! + * NOT THREAD SAFE + */ int set (const TAO_MProfile &mprofile); - // Inits this to the values of mprofile. NOTE: We use - // mprofile->last_ instead of mprofile->size_ to set this->size_. - // This is so we can use set () to trim a profile list!! - // NOT THREAD SAFE + /// increase the number of profiles this object can hold. + /// NOT THREAD SAFE int grow (CORBA::ULong sz); - // increase the number of profiles this object can hold. - // NOT THREAD SAFE + /// Treat as a circular list. TAO_Profile *get_cnext (void); - // Treat as a circular list. + /// Get next profile in list, return 0 at end of list. TAO_Profile *get_next (void); - // Get next profile in list, return 0 at end of list. + /// Assume a circular list of profiles. TAO_Profile *get_cprev (void); - // Assume a circular list of profiles. + /// Get previous profile, stop at beginning of list and return 0. TAO_Profile *get_prev (void); - // Get previous profile, stop at beginning of list and return 0. + /// Return a pointer to the current profile, will not increment + /// reference pointer. TAO_Profile *get_current_profile (void); - // Return a pointer to the current profile, will not increment - // reference pointer. + /// Return a pointer to the profile referenced by handle void. TAO_Profile *get_profile (TAO_PHandle handle); - // Return a pointer to the profile referenced by handle void. // rem_profile (TAO_PHandle handle); let's wait. + /// Returns the index for the current profile. TAO_PHandle get_current_handle (void); - // Returns the index for the current profile. + /// Returns the index for the current profile. TAO_PHandle get_current_handle (void) const; - // Returns the index for the current profile. + /// Returns the number of profiles stored in the list (last_+1). CORBA::ULong profile_count (void) const; - // Returns the number of profiles stored in the list (last_+1). + /// return the maximum number of profiles that can be stored in this + /// container, (size_+1) CORBA::ULong size (void) const; - // return the maximum number of profiles that can be stored in this - // container, (size_+1) + /// Return the profile at position <slot>. If <slot> is out of range + /// it returns 0. const TAO_Profile* get_profile (CORBA::ULong slot) const; - // Return the profile at position <slot>. If <slot> is out of range - // it returns 0. + /// Sets the current slot back to 0. void rewind (void); - // Sets the current slot back to 0. + /// Return the index of this entry or -1 if it can not be added. + /// reference count on profile in incremented! int add_profile (TAO_Profile *pfile); - // Return the index of this entry or -1 if it can not be added. - // reference count on profile in incremented! + /// Return the index of this entry or -1 if it can not be added. + /// this object assumes ownership of this profile!! int give_profile (TAO_Profile *pfile); - // Return the index of this entry or -1 if it can not be added. - // this object assumes ownership of this profile!! + /// append the profiles in pfiles to this object. The count + /// will be incremented on the individual profile objects. int add_profiles (TAO_MProfile *pfiles); - // append the profiles in pfiles to this object. The count - // will be incremented on the individual profile objects. + /// remove from this MProfile any profiles which also appear in pfiles. int remove_profile (const TAO_Profile *pfile); - // remove from this MProfile any profiles which also appear in pfiles. + /// remove from this MProfile any profiles which also appear in pfiles. int remove_profiles (const TAO_MProfile *pfiles); - // remove from this MProfile any profiles which also appear in pfiles. + /// Set a pointer to the MProfile whose 'current' TAO_Profile was + /// forwarded This object is the set of forwarding profiles. void forward_from (TAO_MProfile *mprofiles); - // Set a pointer to the MProfile whose 'current' TAO_Profile was - // forwarded This object is the set of forwarding profiles. + /// Returns a pointer to the profile which was forwarded. TAO_MProfile *forward_from (void); - // Returns a pointer to the profile which was forwarded. + /** + * Returns true of there is at least one profile in first which + * is_equivalent with at least one profile in second. + * NON-THREAD SAFE, relies on some other entity to guarentee + * the profiles will not change during the call. + */ CORBA::Boolean is_equivalent (const TAO_MProfile *rhs); - // Returns true of there is at least one profile in first which - // is_equivalent with at least one profile in second. - // NON-THREAD SAFE, relies on some other entity to guarentee - // the profiles will not change during the call. + /** + * use all registered profiles. The hash() method is called on each + * profile and the results are averaged together. + * NON-THREAD SAFE. + */ CORBA::ULong hash (CORBA::ULong max, CORBA::Environment &ACE_TRY_ENV); - // use all registered profiles. The hash() method is called on each - // profile and the results are averaged together. - // NON-THREAD SAFE. protected: + /// This method handle the dynamic allocation of the data member + /// <policy_list_>. void create_policy_list (void); - // This method handle the dynamic allocation of the data member - // <policy_list_>. public: + /// Sets the policies list associated with the profiles + /// owned by the TAO_MProfile. void policy_list (CORBA::PolicyList *policy_list); - // Sets the policies list associated with the profiles - // owned by the TAO_MProfile. + /// Gets the policies list associated with the profiles + /// owned by the TAO_MProfile. CORBA::PolicyList * policy_list (void); - // Gets the policies list associated with the profiles - // owned by the TAO_MProfile. protected: + /// Initialize the policy list, demarsharling the policy. void init_policy_list (void); - // Initialize the policy list, demarsharling the policy. protected: + /// Stores the policy list for the profile of this MProfile. friend class TAO_Profile; CORBA::PolicyList *policy_list_; - // Stores the policy list for the profile of this MProfile. CORBA::Boolean is_policy_list_initialized_; + /// Mutex used to make sure that only one policy list + /// is created. ACE_SYNCH_RECURSIVE_MUTEX mutex_; - // Mutex used to make sure that only one policy list - // is created. protected: + /// return the complete list of profiles, this object retains + /// ownership! TAO_Profile **pfiles (void) const; - // return the complete list of profiles, this object retains - // ownership! private: + /// Helper method to implement the destructor void cleanup (void); - // Helper method to implement the destructor private: + /** + * Used for chaning references when the current profile is + * forwarded. Note, this will only be valid for an MProfile which + * contains a list of forward_profiles for some initial or base + * profile. This is a backward reference to the profile list which + * received the relocate message. The actual profile what was + * forwarded will be forward_from_->get_current_profile () + */ TAO_MProfile *forward_from_; - // Used for chaning references when the current profile is - // forwarded. Note, this will only be valid for an MProfile which - // contains a list of forward_profiles for some initial or base - // profile. This is a backward reference to the profile list which - // received the relocate message. The actual profile what was - // forwarded will be forward_from_->get_current_profile () + /// Actual list of profiles. TAO_Profile **pfiles_; - // Actual list of profiles. + /// Points to the next profile to be used. 0 ... size_ TAO_PHandle current_; - // Points to the next profile to be used. 0 ... size_ + /// Max size of array TAO_PHandle size_; - // Max size of array + /// Index plus 1 of last valid entry! May be < size_. TAO_PHandle last_; - // Index plus 1 of last valid entry! May be < size_. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/Managed_Types.h b/TAO/tao/Managed_Types.h index 06eac372d52..dedd12b52c1 100644 --- a/TAO/tao/Managed_Types.h +++ b/TAO/tao/Managed_Types.h @@ -1,19 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Managed_Types.h -// -// = AUTHOR -// -// Aniruddha Gokhale -// -// ============================================================================ + +//============================================================================= +/** + * @file Managed_Types.h + * + * $Id$ + * + * @author Aniruddha Gokhale + */ +//============================================================================= + #ifndef TAO_MANAGED_TYPES_H #define TAO_MANAGED_TYPES_H @@ -27,93 +23,91 @@ /****************************************************************/ +/** + * @class TAO_String_Manager + * + * @brief Manager for strings. + * + * This class implements the generic string manager and is used in the C++ + * mapping of "struct" members that are of type "string". The difference + * between this class and the CORBA::String_var class is that the default + * conctructor initializes the underlying string to an empty string in this + * class whereas it is a NUL string for the _var class. + */ class TAO_Export TAO_String_Manager { - // = TITLE - // Manager for strings. - // - // = DESCRIPTION - // - // This class implements the generic string manager and is used in the C++ - // mapping of "struct" members that are of type "string". The difference - // between this class and the CORBA::String_var class is that the default - // conctructor initializes the underlying string to an empty string in this - // class whereas it is a NUL string for the _var class. - // public: + /// default CTOR will initialize the underlying ptr_ to empty string. TAO_String_Manager (void); - // default CTOR will initialize the underlying ptr_ to empty string. + /// copy constructor TAO_String_Manager (const TAO_String_Manager &); - // copy constructor + /// destructor ~TAO_String_Manager (void); - // destructor + /// assignment from another managed type TAO_String_Manager &operator= (const TAO_String_Manager&); - // assignment from another managed type + /// assignment from var type will make a copy TAO_String_Manager &operator= (const CORBA::String_var&); - // assignment from var type will make a copy + /// assignment from a constant char* will make a copy TAO_String_Manager &operator= (const char *); - // assignment from a constant char* will make a copy + /// assignment from char* will not make a copy. The String_Manager will now + /// own the string. TAO_String_Manager &operator= (char *); - // assignment from char* will not make a copy. The String_Manager will now - // own the string. + /// cast (read-only) operator const char*() const; - // cast (read-only) + /// for in parameter. const char *in (void) const; - // for in parameter. + /// for inout parameter. char *&inout (void); - // for inout parameter. + /// for out parameter. char *&out (void); - // for out parameter. + /// for string of return type. char *_retn (void); - // for string of return type. private: + /// The underlying string char *ptr_; - // The underlying string }; /****************************************************************/ +/** + * @class TAO_SeqElem_String_Manager + * + * @brief TAO_SeqElem_String_Manager + * + * Manager for strings that are the element type of sequences. + * Similar to the mapping for sequences of objects (and other + * pseudo objects) the mapping for sequences of strings requires + * an auxiliar class or <Manager> to handle the allocation and + * deallocation of the string. The main difference with respect + * to String_var classes is that automatic release is not + * controlled on a per-item basis, but for the sequence as a + * whole. The difference wrt Object_Manager is that strings are + * duplicated using CORBA::string_dup () as opposed to + * T::_duplicate(), and released using CORBA::string_free() + * instead of CORBA::release() + * This class implements the generic string manager and is used to + * instantiate the proper sequence types. + * This class will have the same semantics as the string manager classes + * defined earlier with respect to the various assignment + * operators. However, the freeing of old storage will be dependent on the + * "release" value of the parent sequence class. + */ class TAO_Export TAO_SeqElem_String_Manager { - // = TITLE - // TAO_SeqElem_String_Manager - // - // = DESCRIPTION - // Manager for strings that are the element type of sequences. - // - // Similar to the mapping for sequences of objects (and other - // pseudo objects) the mapping for sequences of strings requires - // an auxiliar class or <Manager> to handle the allocation and - // deallocation of the string. The main difference with respect - // to String_var classes is that automatic release is not - // controlled on a per-item basis, but for the sequence as a - // whole. The difference wrt Object_Manager is that strings are - // duplicated using CORBA::string_dup () as opposed to - // T::_duplicate(), and released using CORBA::string_free() - // instead of CORBA::release() - // - // This class implements the generic string manager and is used to - // instantiate the proper sequence types. - // - // This class will have the same semantics as the string manager classes - // defined earlier with respect to the various assignment - // operators. However, the freeing of old storage will be dependent on the - // "release" value of the parent sequence class. - // public: friend class TAO_Unbounded_String_Sequence; @@ -122,150 +116,148 @@ public: // friend template<CORBA::ULong MAX> // class TAO_Bounded_String_Sequence<TAO_SeqElem_String_Manager,MAX>; + /// copy constructor TAO_SeqElem_String_Manager (const TAO_SeqElem_String_Manager &); - // copy constructor + /// constructor from address of an element TAO_SeqElem_String_Manager (char **buffer, CORBA::Boolean release); - // constructor from address of an element + /// destructor ~TAO_SeqElem_String_Manager (void); - // destructor + /// assignment from another managed type TAO_SeqElem_String_Manager &operator= (const TAO_SeqElem_String_Manager&); - // assignment from another managed type + /// assignment from var type will make a copy TAO_SeqElem_String_Manager &operator= (const CORBA::String_var&); - // assignment from var type will make a copy + /// assignment from a constant char* will make a copy TAO_SeqElem_String_Manager &operator= (const char *); - // assignment from a constant char* will make a copy + /// assignment from char* will not make a copy. The SeqElem_String_Manager will now + /// own the string. TAO_SeqElem_String_Manager &operator= (char *); - // assignment from char* will not make a copy. The SeqElem_String_Manager will now - // own the string. + /// cast (read-only) operator const char*() const; - // cast (read-only) + /// for in parameter. const char *in (void) const; - // for in parameter. + /// for inout parameter. char *&inout (void); - // for inout parameter. + /// for out parameter. char *&out (void); - // for out parameter. + /// for string of return type. char *_retn (void); - // for string of return type. private: + /// Address of string element from the parent's buffer. char **ptr_; - // Address of string element from the parent's buffer. + /// control memory managment semantics. CORBA::Boolean release_; - // control memory managment semantics. // following are now allowed since these managed class will be used only by // the [] operator of the sequence class. The [] operator will not use the // following ctors to instantiate the managed instance + /// default ctor TAO_SeqElem_String_Manager (void); - // default ctor }; // **************************************************************** +/** + * @class TAO_WString_Manager + * + * @brief Manager for wide strings. + * + * This class implements the generic wstring manager and is used + * in the C++ mapping of "struct" members that are of type + * "wstring". + * The difference between this class and the CORBA::WString_var + * class is that the default constructor initializes the + * underlying wstring to an empty string in this class whereas it + * is a NUL wstring for the _var class. + */ class TAO_Export TAO_WString_Manager { - // = TITLE - // Manager for wide strings. - // - // = DESCRIPTION - // - // This class implements the generic wstring manager and is used - // in the C++ mapping of "struct" members that are of type - // "wstring". - // The difference between this class and the CORBA::WString_var - // class is that the default constructor initializes the - // underlying wstring to an empty string in this class whereas it - // is a NUL wstring for the _var class. - // public: + /// default CTOR will initialize the underlying ptr_ to empty string. TAO_WString_Manager (void); - // default CTOR will initialize the underlying ptr_ to empty string. + /// copy constructor TAO_WString_Manager (const TAO_WString_Manager &); - // copy constructor + /// destructor ~TAO_WString_Manager (void); - // destructor + /// assignment from another managed type TAO_WString_Manager &operator= (const TAO_WString_Manager&); - // assignment from another managed type + /// assignment from var type will make a copy TAO_WString_Manager &operator= (const CORBA::WString_var&); - // assignment from var type will make a copy + /// assignment from a constant wchar* will make a copy TAO_WString_Manager &operator= (const CORBA::WChar *); - // assignment from a constant wchar* will make a copy + /// assignment from wchar* will not make a copy. The WString_Manager + /// will now own the string. TAO_WString_Manager &operator= (CORBA::WChar *); - // assignment from wchar* will not make a copy. The WString_Manager - // will now own the string. + /// cast (read-only) operator const CORBA::WChar*() const; - // cast (read-only) + /// for in parameter. const CORBA::WChar *in (void) const; - // for in parameter. + /// for inout parameter. CORBA::WChar *&inout (void); - // for inout parameter. + /// for out parameter. CORBA::WChar *&out (void); - // for out parameter. + /// for string of return type. CORBA::WChar *_retn (void); - // for string of return type. private: + /// The underlying wide string CORBA::WChar *ptr_; - // The underlying wide string }; /****************************************************************/ +/** + * @class TAO_SeqElem_WString_Manager + * + * @brief TAO_SeqElem_WString_Manager + * + * Manager for strings that are the element type of sequences. + * Similar to the mapping for sequences of objects (and other + * pseudo objects) the mapping for sequences of strings requires + * an auxiliar class or <Manager> to handle the allocation and + * deallocation of the string. The main difference with respect + * to WString_var classes is that automatic release is not + * controlled on a per-item basis, but for the sequence as a + * whole. The difference wrt Object_Manager is that strings are + * duplicated using CORBA::WString_dup () as opposed to + * T::_duplicate(), and released using CORBA::WString_free() + * instead of CORBA::release() + * This class implements the generic string manager and is used to + * instantiate the proper sequence types. + * This class will have the same semantics as the string manager + * classes defined earlier with respect to the various assignment + * operators. However, the freeing of old storage will be + * dependent on the "release" value of the parent sequence class. + */ class TAO_Export TAO_SeqElem_WString_Manager { - // = TITLE - // TAO_SeqElem_WString_Manager - // - // = DESCRIPTION - // Manager for strings that are the element type of sequences. - // - // Similar to the mapping for sequences of objects (and other - // pseudo objects) the mapping for sequences of strings requires - // an auxiliar class or <Manager> to handle the allocation and - // deallocation of the string. The main difference with respect - // to WString_var classes is that automatic release is not - // controlled on a per-item basis, but for the sequence as a - // whole. The difference wrt Object_Manager is that strings are - // duplicated using CORBA::WString_dup () as opposed to - // T::_duplicate(), and released using CORBA::WString_free() - // instead of CORBA::release() - // - // This class implements the generic string manager and is used to - // instantiate the proper sequence types. - // - // This class will have the same semantics as the string manager - // classes defined earlier with respect to the various assignment - // operators. However, the freeing of old storage will be - // dependent on the "release" value of the parent sequence class. - // public: friend class TAO_Unbounded_WString_Sequence; @@ -274,57 +266,57 @@ public: // friend template<CORBA::ULong MAX> // class TAO_Bounded_WString_Sequence<TAO_SeqElem_WString_Manager,MAX>; + /// constructor from address of an element TAO_SeqElem_WString_Manager (CORBA::WChar **buffer, CORBA::Boolean release); - // constructor from address of an element + /// copy constructor TAO_SeqElem_WString_Manager (const TAO_SeqElem_WString_Manager &); - // copy constructor + /// destructor ~TAO_SeqElem_WString_Manager (void); - // destructor + /// assignment from another managed type TAO_SeqElem_WString_Manager &operator= (const TAO_SeqElem_WString_Manager&); - // assignment from another managed type + /// assignment from var type will make a copy TAO_SeqElem_WString_Manager &operator= (const CORBA::WString_var&); - // assignment from var type will make a copy + /// assignment from a constant char* will make a copy TAO_SeqElem_WString_Manager &operator= (const CORBA::WChar *); - // assignment from a constant char* will make a copy + /// assignment from char* will not make a copy. The + /// SeqElem_WString_Manager will now own the string. TAO_SeqElem_WString_Manager &operator= (CORBA::WChar *); - // assignment from char* will not make a copy. The - // SeqElem_WString_Manager will now own the string. + /// cast (read-only) operator const CORBA::WChar*() const; - // cast (read-only) + /// for in parameter. const CORBA::WChar *in (void) const; - // for in parameter. + /// for inout parameter. CORBA::WChar *&inout (void); - // for inout parameter. + /// for out parameter. CORBA::WChar *&out (void); - // for out parameter. + /// for string of return type. CORBA::WChar *_retn (void); - // for string of return type. private: + /// Address of string element from the parent's buffer. CORBA::WChar **ptr_; - // Address of string element from the parent's buffer. + /// control memory managment semantics. CORBA::Boolean release_; - // control memory managment semantics. // following are now allowed since these managed class will be used only by // the [] operator of the sequence class. The [] operator will not use the // following ctors to instantiate the managed instance + /// default ctor TAO_SeqElem_WString_Manager (void); - // default ctor }; diff --git a/TAO/tao/Marshal.h b/TAO/tao/Marshal.h index 2d3f436e671..65617f21c57 100644 --- a/TAO/tao/Marshal.h +++ b/TAO/tao/Marshal.h @@ -1,21 +1,18 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Marshal.h -// -// = DESCRIPTION -// Classes that marshal various IDL data types. -// -// = AUTHOR -// Aniruddha S. Gokhale -// -// ============================================================================ + +//============================================================================= +/** + * @file Marshal.h + * + * $Id$ + * + * Classes that marshal various IDL data types. + * + * + * @author Aniruddha S. Gokhale + */ +//============================================================================= + #ifndef TAO_MARSHAL_H #define TAO_MARSHAL_H @@ -51,334 +48,374 @@ class TAO_Marshal_Alias; class TAO_Marshal_Except; class TAO_Marshal_WString; +/** + * @class TAO_Marshal_Object + * + * @brief TAO_Marshal_Object + * + * The Marshaling object that provides a common interface to the + * CDR object for marshaling different IDL data types + * Provides a set of virtual methods for appending and skipping + * data over a CDR stream. + */ class TAO_Export TAO_Marshal_Object { - // = TITLE - // TAO_Marshal_Object - // - // = DESCRIPTION - // The Marshaling object that provides a common interface to the - // CDR object for marshaling different IDL data types - // - // Provides a set of virtual methods for appending and skipping - // data over a CDR stream. public: + /// constructor TAO_Marshal_Object (void); - // constructor + /// destructor virtual ~TAO_Marshal_Object (void); - // destructor + /// skip entry point, it allocates the right kind of Marshal_Object + /// and invokes skip on it. static CORBA::TypeCode::traverse_status perform_skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV); - // skip entry point, it allocates the right kind of Marshal_Object - // and invokes skip on it. + /// skip operation virtual CORBA::TypeCode::traverse_status skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV) = 0; - // skip operation + /// append entry point, it allocates the right kind of Marshal_Object + /// and invokes skip on it. static CORBA::TypeCode::traverse_status perform_append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV); - // append entry point, it allocates the right kind of Marshal_Object - // and invokes skip on it. + /// append operation virtual CORBA::TypeCode::traverse_status append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV) = 0; - // append operation }; +/** + * @class TAO_Marshal_Primitive: + * + * @brief TAO_Marshal_Primitive + * + * marshaling primitives + */ class TAO_Export TAO_Marshal_Primitive: public TAO_Marshal_Object { - // = TITLE - // TAO_Marshal_Primitive - // = DESCRIPTION - // marshaling primitives public: TAO_Marshal_Primitive (void); + /// skip operation virtual CORBA::TypeCode::traverse_status skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV); - // skip operation + /// append operation virtual CORBA::TypeCode::traverse_status append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV); - // append operation }; +/** + * @class TAO_Marshal_Any: + * + * @brief TAO_Marshal_Any + * + * Marshal an Any + */ class TAO_Export TAO_Marshal_Any: public TAO_Marshal_Object { - // = TITLE - // TAO_Marshal_Any - // = DESCRIPTION - // Marshal an Any public: TAO_Marshal_Any (void); + /// skip operation virtual CORBA::TypeCode::traverse_status skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV); - // skip operation + /// append operation virtual CORBA::TypeCode::traverse_status append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV); - // append operation }; +/** + * @class TAO_Marshal_TypeCode: + * + * @brief TAO_Marshal_TypeCode + * + * marshal a typecode + */ class TAO_Export TAO_Marshal_TypeCode: public TAO_Marshal_Object { - // = TITLE - // TAO_Marshal_TypeCode - // = DESCRIPTION - // marshal a typecode public: TAO_Marshal_TypeCode (void); + /// skip operation virtual CORBA::TypeCode::traverse_status skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV); - // skip operation + /// append operation virtual CORBA::TypeCode::traverse_status append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV); - // append operation }; +/** + * @class TAO_Marshal_Principal: + * + * @brief TAO_Marshal_Principal + * + * marshal a principal + */ class TAO_Export TAO_Marshal_Principal: public TAO_Marshal_Object { - // = TITLE - // TAO_Marshal_Principal - // = DESCRIPTION - // marshal a principal public: TAO_Marshal_Principal (void); + /// skip operation virtual CORBA::TypeCode::traverse_status skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV); - // skip operation + /// append operation virtual CORBA::TypeCode::traverse_status append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV); - // append operation }; +/** + * @class TAO_Marshal_ObjRef: + * + * @brief TAO_Marshal_ObjRef + * + * marshal an object reference + */ class TAO_Export TAO_Marshal_ObjRef: public TAO_Marshal_Object { - // = TITLE - // TAO_Marshal_ObjRef - // = DESCRIPTION - // marshal an object reference public: TAO_Marshal_ObjRef (void); + /// skip operation virtual CORBA::TypeCode::traverse_status skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV); - // skip operation + /// append operation virtual CORBA::TypeCode::traverse_status append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV); - // append operation }; +/** + * @class TAO_Marshal_Struct: + * + * @brief TAO_Marshal_Struct + * + * marshal a struct + */ class TAO_Export TAO_Marshal_Struct: public TAO_Marshal_Object { - // = TITLE - // TAO_Marshal_Struct - // = DESCRIPTION - // marshal a struct public: TAO_Marshal_Struct (void); + /// skip operation virtual CORBA::TypeCode::traverse_status skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV); - // skip operation + /// append operation virtual CORBA::TypeCode::traverse_status append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV); - // append operation }; +/** + * @class TAO_Marshal_Union: + * + * @brief TAO_Marshal_Union + * + * marshal a union + */ class TAO_Export TAO_Marshal_Union: public TAO_Marshal_Object { - // = TITLE - // TAO_Marshal_Union - // = DESCRIPTION - // marshal a union public: TAO_Marshal_Union (void); + /// skip operation virtual CORBA::TypeCode::traverse_status skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV); - // skip operation + /// append operation virtual CORBA::TypeCode::traverse_status append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV); - // append operation }; +/** + * @class TAO_Marshal_String: + * + * @brief TAO_Marshal_String + * + * marshal a string + */ class TAO_Export TAO_Marshal_String: public TAO_Marshal_Object { - // = TITLE - // TAO_Marshal_String - // = DESCRIPTION - // marshal a string public: TAO_Marshal_String (void); + /// skip operation virtual CORBA::TypeCode::traverse_status skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV); - // skip operation + /// append operation virtual CORBA::TypeCode::traverse_status append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV); - // append operation }; +/** + * @class TAO_Marshal_Sequence: + * + * @brief TAO_Marshal_Sequence + * + * marshal a sequence + */ class TAO_Export TAO_Marshal_Sequence: public TAO_Marshal_Object { - // = TITLE - // TAO_Marshal_Sequence - // = DESCRIPTION - // marshal a sequence public: TAO_Marshal_Sequence (void); + /// skip operation virtual CORBA::TypeCode::traverse_status skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV); - // skip operation + /// append operation virtual CORBA::TypeCode::traverse_status append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV); - // append operation }; +/** + * @class TAO_Marshal_Array: + * + * @brief TAO_Marshal_Array + * + * marshal an array + */ class TAO_Export TAO_Marshal_Array: public TAO_Marshal_Object { - // = TITLE - // TAO_Marshal_Array - // = DESCRIPTION - // marshal an array public: TAO_Marshal_Array (void); + /// skip operation virtual CORBA::TypeCode::traverse_status skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV); - // skip operation + /// append operation virtual CORBA::TypeCode::traverse_status append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV); - // append operation }; +/** + * @class TAO_Marshal_Alias: + * + * @brief TAO_Marshal_Alias + * + * marshal an alias + */ class TAO_Export TAO_Marshal_Alias: public TAO_Marshal_Object { - // = TITLE - // TAO_Marshal_Alias - // = DESCRIPTION - // marshal an alias public: TAO_Marshal_Alias (void); + /// skip operation virtual CORBA::TypeCode::traverse_status skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV); - // skip operation + /// append operation virtual CORBA::TypeCode::traverse_status append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV); - // append operation }; +/** + * @class TAO_Marshal_Except: + * + * @brief TAO_Marshal_Except + * + * marshal an exception + */ class TAO_Export TAO_Marshal_Except: public TAO_Marshal_Object { - // = TITLE - // TAO_Marshal_Except - // = DESCRIPTION - // marshal an exception public: TAO_Marshal_Except (void); + /// skip operation virtual CORBA::TypeCode::traverse_status skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV); - // skip operation + /// append operation virtual CORBA::TypeCode::traverse_status append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV); - // append operation }; +/** + * @class TAO_Marshal_WString + * + * @brief TAO_Marshal_WString + * + * marshal a wide string + */ class TAO_Export TAO_Marshal_WString : public TAO_Marshal_Object { - // = TITLE - // TAO_Marshal_WString - // = DESCRIPTION - // marshal a wide string public: TAO_Marshal_WString (void); + /// skip operation virtual CORBA::TypeCode::traverse_status skip (CORBA::TypeCode_ptr tc, TAO_InputCDR *context, CORBA_Environment &ACE_TRY_ENV); - // skip operation + /// append operation virtual CORBA::TypeCode::traverse_status append (CORBA::TypeCode_ptr tc, TAO_InputCDR *src, TAO_OutputCDR *dest, CORBA_Environment &ACE_TRY_ENV); - // append operation }; diff --git a/TAO/tao/Messaging_ORBInitializer.h b/TAO/tao/Messaging_ORBInitializer.h index 4ff45328b29..1f9bef9081b 100644 --- a/TAO/tao/Messaging_ORBInitializer.h +++ b/TAO/tao/Messaging_ORBInitializer.h @@ -1,19 +1,15 @@ // -*- C++ -*- -// -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Messaging_ORBInitializer.h -// -// = AUTHOR -// Ossama Othman <ossama@uci.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Messaging_ORBInitializer.h + * + * $Id$ + * + * @author Ossama Othman <ossama@uci.edu> + */ +//============================================================================= + #ifndef TAO_MESSAGING_ORB_INITIALIZER_H #define TAO_MESSAGING_ORB_INITIALIZER_H @@ -57,10 +53,10 @@ public: private: + ////< Register Messaging policy factories. void register_policy_factories ( PortableInterceptor::ORBInitInfo_ptr info TAO_ENV_ARG_DECL); - ///< Register Messaging policy factories. }; diff --git a/TAO/tao/Messaging_PolicyFactory.h b/TAO/tao/Messaging_PolicyFactory.h index 6ef0f960375..df7da183b48 100644 --- a/TAO/tao/Messaging_PolicyFactory.h +++ b/TAO/tao/Messaging_PolicyFactory.h @@ -1,20 +1,15 @@ // -*- C++ -*- -// -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Messaging_PolicyFactory.h -// -// = AUTHOR -// Carlos O'Ryan <coryan@uci.edu> -// Ossama Othman <ossama@uci.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Messaging_PolicyFactory.h + * + * $Id$ + * + * @author Carlos O'Ryan <coryan@uci.edu> Ossama Othman <ossama@uci.edu> + */ +//============================================================================= + #ifndef TAO_MESSAGING_POLICY_FACTORY_H #define TAO_MESSAGING_POLICY_FACTORY_H diff --git a/TAO/tao/Messaging_Policy_i.h b/TAO/tao/Messaging_Policy_i.h index a951b4cab5f..b156d03ebe8 100644 --- a/TAO/tao/Messaging_Policy_i.h +++ b/TAO/tao/Messaging_Policy_i.h @@ -1,21 +1,14 @@ /* -*- C++ -*- */ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = DESCRIPTION -// Implementation classes for the Messaging related policies -// -// = FILENAME -// Messaging_Policy_i.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// ============================================================================ +//============================================================================= +/** + * @file Messaging_Policy_i.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_MESSAGING_POLICY_I_H #define TAO_MESSAGING_POLICY_I_H @@ -46,11 +39,11 @@ class TAO_Export TAO_RelativeRoundtripTimeoutPolicy // request. // public: + /// Constructor. TAO_RelativeRoundtripTimeoutPolicy (const TimeBase::TimeT& relative_expiry); - // Constructor. + /// Copy constructor. TAO_RelativeRoundtripTimeoutPolicy (const TAO_RelativeRoundtripTimeoutPolicy &rhs); - // Copy constructor. /// Implement the timeout hook, this is set in the ORB_Core at /// initialization time. @@ -59,13 +52,13 @@ public: int &has_timeout, ACE_Time_Value &time_value); + /// Helper method for the implementation of + /// CORBA::ORB::create_policy. static CORBA::Policy_ptr create (const CORBA::Any& val, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Helper method for the implementation of - // CORBA::ORB::create_policy. + /// Returns a copy of <this>. virtual TAO_RelativeRoundtripTimeoutPolicy *clone (void) const; - // Returns a copy of <this>. // = The Messaging::RelativeRoundtripTimeoutPolicy methods virtual TimeBase::TimeT relative_expiry (CORBA::Environment &ACE_TRY_ENV) @@ -80,12 +73,12 @@ public: virtual void destroy (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); + /// Change the CORBA representation to the ACE representation. void set_time_value (ACE_Time_Value &time_value); - // Change the CORBA representation to the ACE representation. private: + /// The attribute TimeBase::TimeT relative_expiry_; - // The attribute }; #endif /* TAO_HAS_RELATIVE_ROUNDTRIP_TIMEOUT_POLICY == 1 */ @@ -106,11 +99,11 @@ class TAO_Export TAO_Sync_Scope_Policy // transport requests. // public: + /// Constructor. TAO_Sync_Scope_Policy (Messaging::SyncScope synchronization); - // Constructor. + /// Copy constructor. TAO_Sync_Scope_Policy (const TAO_Sync_Scope_Policy &rhs); - // Copy constructor. /// Implement the Sync_Scope hook, this is set in the ORB_Core at /// initialization time. @@ -119,13 +112,13 @@ public: int &has_synchronization, int &scope); + /// Helper method for the implementation of + /// CORBA::ORB::create_policy. static CORBA::Policy_ptr create (const CORBA::Any& val, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Helper method for the implementation of - // CORBA::ORB::create_policy. + /// Returns a copy of <this>. virtual TAO_Sync_Scope_Policy *clone (void) const; - // Returns a copy of <this>. // = The Messaging::SyncScopePolicy methods. @@ -145,8 +138,8 @@ public: private: + /// The attribute Messaging::SyncScope synchronization_; - // The attribute }; #endif /* TAO_HAS_SYNC_SCOPE_POLICY == 1 */ diff --git a/TAO/tao/Muxed_TMS.h b/TAO/tao/Muxed_TMS.h index daf7e35db96..a7385f1ce0a 100644 --- a/TAO/tao/Muxed_TMS.h +++ b/TAO/tao/Muxed_TMS.h @@ -1,15 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = AUTHOR -// Alexander Babu Arulanthu <alex@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Muxed_TMS.h + * + * $Id$ + * + * @author Alexander Babu Arulanthu <alex@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_MUXED_TMS_H #define TAO_MUXED_TMS_H @@ -26,28 +26,30 @@ class TAO_Pluggable_Reply_Params; +/** + * @class TAO_Muxed_TMS + * + * Using this strategy a single connection can have multiple + * outstanding requests. + * @@ Can the performance of the demuxer be made more predictable, + * for example, using the request id as an active demux key? + * NOTE: check the OMG resolutions about bidirectional + * connections, it is possible that the request ids can only + * assume even or odd values. + */ class TAO_Export TAO_Muxed_TMS : public TAO_Transport_Mux_Strategy { - // = DESCRIPTION - // Using this strategy a single connection can have multiple - // outstanding requests. - // @@ Can the performance of the demuxer be made more predictable, - // for example, using the request id as an active demux key? - // NOTE: check the OMG resolutions about bidirectional - // connections, it is possible that the request ids can only - // assume even or odd values. - // public: + /// Constructor. TAO_Muxed_TMS (TAO_Transport *transport); - // Constructor. + /// Destructor. virtual ~TAO_Muxed_TMS (void); - // Destructor. + /// Generate and return an unique request id for the current + /// invocation. virtual CORBA::ULong request_id (void); - // Generate and return an unique request id for the current - // invocation. // = Please read the documentation in the TAO_Transport_Mux_Strategy // class. @@ -66,12 +68,12 @@ public: virtual void connection_closed (void); protected: + /// Lock to protect the state of this class ACE_SYNCH_MUTEX lock_; - // Lock to protect the state of this class + /// Used to generate a different request_id on each call to + /// request_id(). CORBA::ULong request_id_generator_; - // Used to generate a different request_id on each call to - // request_id(). typedef ACE_Hash_Map_Manager_Ex <CORBA::ULong, TAO_Reply_Dispatcher *, @@ -79,12 +81,12 @@ protected: ACE_Equal_To <CORBA::ULong>, ACE_Null_Mutex> REQUEST_DISPATCHER_TABLE; + /// Table of <Request ID, Reply Dispatcher> pairs. REQUEST_DISPATCHER_TABLE dispatcher_table_; - // Table of <Request ID, Reply Dispatcher> pairs. + /// Keep track of the orb core pointer. We need to this to create the + /// Reply Dispatchers. TAO_ORB_Core *orb_core_; - // Keep track of the orb core pointer. We need to this to create the - // Reply Dispatchers. // @@ Commented for the time being, let the commented line stay for // sometime - Bala diff --git a/TAO/tao/NVList.h b/TAO/tao/NVList.h index 9f38e79e5b4..0d23b31f066 100644 --- a/TAO/tao/NVList.h +++ b/TAO/tao/NVList.h @@ -1,20 +1,16 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// NVList.h -// -// = AUTHOR -// Copyright 1994-1995 by Sun Microsystems Inc. -// and -// Aniruddha Gokhale (additions, missing operations) -// -// ============================================================================ + +//============================================================================= +/** + * @file NVList.h + * + * $Id$ + * + * @author Copyright 1994-1995 by Sun Microsystems Inc. + * @author Aniruddha Gokhale <gokhale@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_NVLIST_H #define TAO_NVLIST_H @@ -31,30 +27,31 @@ class TAO_InputCDR; +/** + * @class CORBA_NamedValue + * + * @brief NamedValue ... these occur only in "NVList" (named value list) data + * structures. The binary form of the data structure is frozen and + * visible to programs using it (e.g. from C). The C++ class supports + * some programming discipline, e.g. to avoid memory leaks. + * They just represent parameters to calls. The name is optional, and + * the value is packaged as an Any. The flags indicate parameter + * mode, and some ownership rules for "top level" memory. + */ class TAO_Export CORBA_NamedValue { - // = TITLE - // NamedValue ... these occur only in "NVList" (named value list) data - // structures. The binary form of the data structure is frozen and - // visible to programs using it (e.g. from C). The C++ class supports - // some programming discipline, e.g. to avoid memory leaks. - // - // They just represent parameters to calls. The name is optional, and - // the value is packaged as an Any. The flags indicate parameter - // mode, and some ownership rules for "top level" memory. - // public: + /// optional name const char *name (void) const; - // optional name + /// return the value CORBA::Any_ptr value (void) const; - // return the value + /// return the parameter mode flag CORBA::Flags flags (void) const; - // return the parameter mode flag + /// destructor - manages the name and value ~CORBA_NamedValue (void); - // destructor - manages the name and value // The pseudo object static methods.. static CORBA_NamedValue* _duplicate (CORBA_NamedValue*); @@ -71,44 +68,44 @@ public: #endif /* __GNUC__ */ private: + /// maintains how many references exist to this object CORBA::ULong refcount_; - // maintains how many references exist to this object + /// Protects the reference count. ACE_SYNCH_MUTEX refcount_lock_; - // Protects the reference count. + /// holds the value CORBA::Any any_; - // holds the value + /// parameter mode flags CORBA::Flags flags_; - // parameter mode flags + /// optional IDL name of the parameter char *name_; - // optional IDL name of the parameter + /// private constructor. Cannot be directly instantiated other than + /// by its friends. CORBA_NamedValue (void); - // private constructor. Cannot be directly instantiated other than - // by its friends. friend class CORBA_ORB; friend class CORBA_NVList; friend class CORBA_Request; }; +/** + * @class CORBA_NamedValue_var + * + * @brief The T_var class for NamedValue + * + * As any other pseudo object NamedValue must have a T_var class, + * the interface an semantics are specified in the CORBA spec. + * = NOTE + * We use CORBA_NamedValue_ptr as the _ptr type instead of + * CORBA::NamedValue_ptr, this is an attempt to reduced the cyclic + * dependencies in TAO. + */ class TAO_Export CORBA_NamedValue_var { - // = TITLE - // The T_var class for NamedValue - // - // = DESCRIPTION - // As any other pseudo object NamedValue must have a T_var class, - // the interface an semantics are specified in the CORBA spec. - // - // = NOTE - // We use CORBA_NamedValue_ptr as the _ptr type instead of - // CORBA::NamedValue_ptr, this is an attempt to reduced the cyclic - // dependencies in TAO. - // public: CORBA_NamedValue_var (void); // default constructor CORBA_NamedValue_var (CORBA_NamedValue_ptr); @@ -119,9 +116,9 @@ public: CORBA_NamedValue_var &operator= (const CORBA_NamedValue_var &); CORBA_NamedValue_ptr operator-> (void) const; + /// in, inout, out, _retn operator const CORBA_NamedValue_ptr &() const; operator CORBA_NamedValue_ptr &(); - // in, inout, out, _retn CORBA_NamedValue_ptr in (void) const; CORBA_NamedValue_ptr &inout (void); CORBA_NamedValue_ptr &out (void); @@ -132,20 +129,20 @@ private: CORBA_NamedValue_ptr ptr_; }; +/** + * @class CORBA_NamedValue_out + * + * @brief The T_out class for NamedValue + * + * As any other pseudo object NamedValue must have a T_out class, + * the interface an semantics are specified in the CORBA spec. + * = NOTE + * We use CORBA_NamedValue_ptr as the _ptr type instead of + * CORBA::NamedValue_ptr, this is an attempt to reduced the cyclic + * dependencies in TAO. + */ class TAO_Export CORBA_NamedValue_out { - // = TITLE - // The T_out class for NamedValue - // - // = DESCRIPTION - // As any other pseudo object NamedValue must have a T_out class, - // the interface an semantics are specified in the CORBA spec. - // - // = NOTE - // We use CORBA_NamedValue_ptr as the _ptr type instead of - // CORBA::NamedValue_ptr, this is an attempt to reduced the cyclic - // dependencies in TAO. - // public: CORBA_NamedValue_out (CORBA_NamedValue_ptr &); CORBA_NamedValue_out (CORBA_NamedValue_var &); @@ -163,71 +160,73 @@ private: // **************************************************************** +/** + * @class CORBA_NVList + * + * @brief NVList ... this is used in the (client side) DII (Dynamic + * Invocation Interface) to hold parameters, except for the return + * parameter. It's used in the same role in the (server side) DSI + * (Dynamic Skeleton Interface). + * + * Each user (client, server) provides the typecode and memory for + * each parameter using an NVList, then talks to the ORB using a + * Request or ServerRequest pseudo-object. The ORB copies data + * to/from the IPC messages (e.g. IIOP::Request, IIOP::Response) + * as appropriate. + */ class TAO_Export CORBA_NVList { - // = TITLE - // NVList ... this is used in the (client side) DII (Dynamic - // Invocation Interface) to hold parameters, except for the return - // parameter. It's used in the same role in the (server side) DSI - // (Dynamic Skeleton Interface). - // - // = DESCRIPTION - // Each user (client, server) provides the typecode and memory for - // each parameter using an NVList, then talks to the ORB using a - // Request or ServerRequest pseudo-object. The ORB copies data - // to/from the IPC messages (e.g. IIOP::Request, IIOP::Response) - // as appropriate. public: + /// destructor ~CORBA_NVList (void); - // destructor + /// return the current number of elements in the list CORBA::ULong count (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // return the current number of elements in the list + /// add an element and just initialize the flags CORBA_NamedValue_ptr add (CORBA::Flags, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // add an element and just initialize the flags + /// add an element and initialize its name and flags CORBA_NamedValue_ptr add_item (const char *, CORBA::Flags, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // add an element and initialize its name and flags + /// initializes a value, name, and flags CORBA_NamedValue_ptr add_value (const char *, const CORBA::Any &, CORBA::Flags, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // initializes a value, name, and flags + /// just like add_item. In addition, memory management of char * name + /// is taken over by the NVList CORBA_NamedValue_ptr add_item_consume (char *, CORBA::Flags, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // just like add_item. In addition, memory management of char * name - // is taken over by the NVList + /// just like add_value. In addition, the NVList controls the memory + /// management of the char *name and Any *value parameter CORBA_NamedValue_ptr add_value_consume (char *, CORBA::Any_ptr, CORBA::Flags, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // just like add_value. In addition, the NVList controls the memory - // management of the char *name and Any *value parameter + /// retrieve the item at the nth location. Raises Bounds CORBA_NamedValue_ptr item (CORBA::ULong n, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // retrieve the item at the nth location. Raises Bounds // CORBA::Status + /// remove element at index n. Raises Bounds void remove (CORBA::ULong n, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // remove element at index n. Raises Bounds // The pseudo object static methods.. static CORBA_NVList* _duplicate (CORBA_NVList*); @@ -239,37 +238,43 @@ public: // = TAO Extensions: + /** + * Set the incoming CDR stream, this is used by TAO to perform lazy + * evaluation of the NVList in an incoming ServerRequest. + * The <flag> is used to check which parameters (IN, OUT and/or + * INOUT) are to be extracted + */ void _tao_incoming_cdr (TAO_InputCDR &cdr, int flag, int &lazy_evaluation, CORBA::Environment &ACE_TRY_ENV); - // Set the incoming CDR stream, this is used by TAO to perform lazy - // evaluation of the NVList in an incoming ServerRequest. - // The <flag> is used to check which parameters (IN, OUT and/or - // INOUT) are to be extracted + /// Encode the NVList into the CDR stream. <flag> masks the type of + /// arguments (IN, OUT or INOUT) that are to be marshaled. void _tao_encode (TAO_OutputCDR &cdr, TAO_ORB_Core *orb_core, int flag, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Encode the NVList into the CDR stream. <flag> masks the type of - // arguments (IN, OUT or INOUT) that are to be marshaled. + /// Decode the NVList arguments from the <cdr> stream. void _tao_decode (TAO_InputCDR &cdr, int flag, CORBA::Environment &ACE_TRY_ENV); - // Decode the NVList arguments from the <cdr> stream. + /** + * Return the required alignment to marshal the NVList without any + * re-alignment. + * It returns ACE_CDR::MAX_ALIGNMENT to indicate errors. + */ ptr_arith_t _tao_target_alignment (void); - // Return the required alignment to marshal the NVList without any - // re-alignment. - // It returns ACE_CDR::MAX_ALIGNMENT to indicate errors. + /** + * If this list is used by a DII request, this will tell us if + * our CDR stream contains any marshaled arguments (needed for + * GIOP 1.2). + */ CORBA::Boolean _lazy_has_arguments (void) const; - // If this list is used by a DII request, this will tell us if - // our CDR stream contains any marshaled arguments (needed for - // GIOP 1.2). // Useful for template programming. #if !defined(__GNUC__) || __GNUC__ > 2 || __GNUC_MINOR__ >= 8 @@ -278,60 +283,62 @@ public: #endif /* __GNUC__ */ private: + /// constructor - cannot be instantiated directly other than through the + /// ORB::create_list method CORBA_NVList (void); - // constructor - cannot be instantiated directly other than through the - // ORB::create_list method + /// helper to increase the list size. This is used by all the add_ + /// methods of the NVList class CORBA_NamedValue_ptr add_element (CORBA::Flags, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // helper to increase the list size. This is used by all the add_ - // methods of the NVList class + /// Lazy evaluation routine to fill up the Anys in the NVList from + /// the CDR stream. void evaluate (CORBA::Environment &ACE_TRY_ENV); - // Lazy evaluation routine to fill up the Anys in the NVList from - // the CDR stream. private: + /// internal list of parameters stored as NamedValues ACE_Unbounded_Queue<CORBA_NamedValue_ptr> values_; - // internal list of parameters stored as NamedValues + /// maximum length of list CORBA::ULong max_; - // maximum length of list + /// maintains how many references exist to this object CORBA::ULong refcount_; - // maintains how many references exist to this object + /// Protects the reference count. ACE_SYNCH_MUTEX refcount_lock_; - // Protects the reference count. + /** + * When the NVList is used as part of a Server Request we can simply + * store the CDR buffer and perform lazy evaluation to compute the + * Anys. + */ TAO_InputCDR *incoming_; - // When the NVList is used as part of a Server Request we can simply - // store the CDR buffer and perform lazy evaluation to compute the - // Anys. + /// The flags used to check which parameters are actually extracted + /// from the <incoming_> buffer int incoming_flag_; - // The flags used to check which parameters are actually extracted - // from the <incoming_> buffer friend class CORBA_ORB; friend class CORBA_Request; }; +/** + * @class CORBA_NVList_var + * + * @brief The T_var class for NVList + * + * As any other pseudo object NVList must have a T_var class, + * the interface an semantics are specified in the CORBA spec. + * = NOTE + * We use CORBA_NVList_ptr as the _ptr type instead of + * CORBA::NVList_ptr, this is an attempt to reduced the cyclic + * dependencies in TAO. + */ class TAO_Export CORBA_NVList_var { - // = TITLE - // The T_var class for NVList - // - // = DESCRIPTION - // As any other pseudo object NVList must have a T_var class, - // the interface an semantics are specified in the CORBA spec. - // - // = NOTE - // We use CORBA_NVList_ptr as the _ptr type instead of - // CORBA::NVList_ptr, this is an attempt to reduced the cyclic - // dependencies in TAO. - // public: CORBA_NVList_var (void); CORBA_NVList_var (CORBA_NVList_ptr); @@ -342,9 +349,9 @@ public: CORBA_NVList_var &operator= (const CORBA_NVList_var &); CORBA_NVList_ptr operator-> (void) const; + /// in, inout, out, _retn operator const CORBA_NVList_ptr &() const; operator CORBA_NVList_ptr &(); - // in, inout, out, _retn CORBA_NVList_ptr in (void) const; CORBA_NVList_ptr &inout (void); CORBA_NVList_ptr &out (void); @@ -355,20 +362,20 @@ private: CORBA_NVList_ptr ptr_; }; +/** + * @class CORBA_NVList_out + * + * @brief The T_out class for NVList + * + * As any other pseudo object NVList must have a T_out class, + * the interface an semantics are specified in the CORBA spec. + * = NOTE + * We use CORBA_NVList_ptr as the _ptr type instead of + * CORBA::NVList_ptr, this is an attempt to reduced the cyclic + * dependencies in TAO. + */ class TAO_Export CORBA_NVList_out { - // = TITLE - // The T_out class for NVList - // - // = DESCRIPTION - // As any other pseudo object NVList must have a T_out class, - // the interface an semantics are specified in the CORBA spec. - // - // = NOTE - // We use CORBA_NVList_ptr as the _ptr type instead of - // CORBA::NVList_ptr, this is an attempt to reduced the cyclic - // dependencies in TAO. - // public: CORBA_NVList_out (CORBA_NVList_ptr &); CORBA_NVList_out (CORBA_NVList_var &); diff --git a/TAO/tao/ORB.cpp b/TAO/tao/ORB.cpp index 8335bd2735a..8c25f2b3c88 100644 --- a/TAO/tao/ORB.cpp +++ b/TAO/tao/ORB.cpp @@ -35,11 +35,11 @@ # include "ORBInitializer_Registry.h" #if TAO_HAS_RT_CORBA == 1 -# include "RT_ORBInitializer.h" // @@ This should go away! +# include "RT_ORBInitializer.h" /* @@ This should go away! */ #endif /* TAO_HAS_RT_CORBA == 1 */ #if TAO_HAS_CORBA_MESSAGING == 1 -# include "Messaging_ORBInitializer.h" // @@ This should go away! +# include "Messaging_ORBInitializer.h" /* @@ This should go away! */ #endif /* TAO_HAS_CORBA_MESSAGING == 1 */ #if defined (TAO_HAS_VALUETYPE) diff --git a/TAO/tao/ORB.h b/TAO/tao/ORB.h index 7e4d6a9c755..9841c3ec537 100644 --- a/TAO/tao/ORB.h +++ b/TAO/tao/ORB.h @@ -1,22 +1,20 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// ORB.h -// -// = DESCRIPTION -// Header file for CORBA's <ORB> type and type. -// -// = AUTHOR -// Copyright 1994-1995 by Sun Microsystems Inc. and Douglas C. Schmidt. -// -// ============================================================================ + + +//============================================================================= +/** + * @file ORB.h + * + * $Id$ + * + * Header file for CORBA's <ORB> type and type. + * + * + * @author Copyright 1994-1995 by Sun Microsystems Inc. + * @author Douglas C. Schmidt <schmidt@uci.edu> + */ +//============================================================================= + #ifndef TAO_ORB_H #define TAO_ORB_H @@ -60,20 +58,20 @@ class TAO_ValueFactory_Map; // **************************************************************** +/** + * @class CORBA_ORB + * + * @brief ORB pseudo-objref. + * + * The "ORB" pseudo-object is used in bootstrapping, such as to + * create object references from strings. This class is intended + * to be inherited by others, which will provide some more of the + * CORBA support. Implementations of this "CORBA::ORB" class must + * know how to create stringify/destringify their objrefs, as well + * as how to marshal and unmarshal them. + */ class TAO_Export CORBA_ORB { - // = TITLE - // ORB pseudo-objref. - // - // = DESCRIPTION - // - // The "ORB" pseudo-object is used in bootstrapping, such as to - // create object references from strings. This class is intended - // to be inherited by others, which will provide some more of the - // CORBA support. Implementations of this "CORBA::ORB" class must - // know how to create stringify/destringify their objrefs, as well - // as how to marshal and unmarshal them. - // public: // ORB_Core has special privileges @@ -95,8 +93,8 @@ public: virtual void _tao_decode (TAO_InputCDR &cdr, CORBA::Environment &); + /// = TAO extension static InvalidName* _downcast (CORBA_Exception *ex); - // = TAO extension static CORBA::Exception *_alloc (void); }; static CORBA::TypeCode_ptr _tc_InvalidName; @@ -112,29 +110,33 @@ public: typedef CORBA_ORB_ObjectIdList *ObjectIdList_ptr; static CORBA::TypeCode_ptr _tc_ObjectIdList; + /// Return a duplicate of <{orb}>. When work with this duplicate is + /// complete, it should be freed up using <CORBA::release()>. static CORBA::ORB_ptr _duplicate (CORBA::ORB_ptr orb); - // Return a duplicate of <{orb}>. When work with this duplicate is - // complete, it should be freed up using <CORBA::release()>. + /// Returns a pointer to a nil ORB, i.e., an non-existent ORB. This + /// can be used for initialization or in comparisons. static CORBA::ORB_ptr _nil (void); - // Returns a pointer to a nil ORB, i.e., an non-existent ORB. This - // can be used for initialization or in comparisons. + /** + * Turn a string-ified object reference back into an object pointer. + * Typically these strings are created using <object_to_string()>, + * but not necessarily locally. + */ CORBA::Object_ptr string_to_object (const char *str, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Turn a string-ified object reference back into an object pointer. - // Typically these strings are created using <object_to_string()>, - // but not necessarily locally. + /** + * Turn an object reference into a string. Each type of ORB, + * e.g. an IIOP ORB, must implement this. This can be used by + * servers to publish their whereabouts to clients. The output of + * this is typically eventually given to <string_to_object()> as an + * argument. + */ char * object_to_string (CORBA::Object_ptr obj, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Turn an object reference into a string. Each type of ORB, - // e.g. an IIOP ORB, must implement this. This can be used by - // servers to publish their whereabouts to clients. The output of - // this is typically eventually given to <string_to_object()> as an - // argument. #ifdef TAO_HAS_VALUETYPE @@ -214,39 +216,51 @@ public: // = ORB event loop methods. + /** + * Instructs the ORB to initialize itself and run its event loop in + * the current thread, not returning until the ORB has shut down. + * If an error occurs during initialization or a run-time this + * method will return -1. + */ int run (CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Instructs the ORB to initialize itself and run its event loop in - // the current thread, not returning until the ORB has shut down. - // If an error occurs during initialization or a run-time this - // method will return -1. + /** + * Instructs the ORB to initialize itself and run its event loop in + * the current thread, not returning until the ORB has shut down. + * If an error occurs during initialization or a run-time this + * method will return -1. If no requests arrive at this thread + * before the <tv> "relative" timeout elapses we return to the + * caller with a value of 0 (this allows timeouts). Otherwise, if + * we've returned since we've been asked to shut down the value of 1 + * is returned. + */ int run (ACE_Time_Value &tv, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Instructs the ORB to initialize itself and run its event loop in - // the current thread, not returning until the ORB has shut down. - // If an error occurs during initialization or a run-time this - // method will return -1. If no requests arrive at this thread - // before the <tv> "relative" timeout elapses we return to the - // caller with a value of 0 (this allows timeouts). Otherwise, if - // we've returned since we've been asked to shut down the value of 1 - // is returned. + /** + * Instructs the ORB to initialize itself and run its event loop in + * the current thread, not returning until the ORB has shut down. + * If an error occurs during initialization or a run-time this + * method will return -1. If <tv> is non-NULL, then if no requests + * arrive at this thread before the "relative" timeout elapses we + * return to the caller with a value of 0 (this allows timeouts). + * Otherwise, if we've returned since we've been asked to shut down + * the value of 1 is returned. + */ int run (ACE_Time_Value *tv, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Instructs the ORB to initialize itself and run its event loop in - // the current thread, not returning until the ORB has shut down. - // If an error occurs during initialization or a run-time this - // method will return -1. If <tv> is non-NULL, then if no requests - // arrive at this thread before the "relative" timeout elapses we - // return to the caller with a value of 0 (this allows timeouts). - // Otherwise, if we've returned since we've been asked to shut down - // the value of 1 is returned. + /// Returns an indication of whether the ORB needs to perform some + /// work. CORBA::Boolean work_pending (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Returns an indication of whether the ORB needs to perform some - // work. + /** + * This operation performs an implementation-defined unit of + * work. Note that the default behavior is not to block; this + * behavior can be modified by passing an appropriate + * <ACE_Time_Value>. + */ int perform_work (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); int perform_work (ACE_Time_Value &, @@ -255,52 +269,54 @@ public: int perform_work (ACE_Time_Value *, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // This operation performs an implementation-defined unit of - // work. Note that the default behavior is not to block; this - // behavior can be modified by passing an appropriate - // <ACE_Time_Value>. + /** + * This operation instructs the ORB to shut down. Shutting down the + * ORB causes all Object Adapters to be shut down. If + * <wait_for_completion> parameter is TRUE, this operation blocks + * until all ORB processing (including request processing and object + * deactivation or other operations associated with object adapters) + * has completed. + */ void shutdown (CORBA::Boolean wait_for_completion = 0, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // This operation instructs the ORB to shut down. Shutting down the - // ORB causes all Object Adapters to be shut down. If - // <wait_for_completion> parameter is TRUE, this operation blocks - // until all ORB processing (including request processing and object - // deactivation or other operations associated with object adapters) - // has completed. + /** + * Destroy the ORB, releasing any resources. Notice that TAO *cannot* + * release the resources even if you have destroyed all the + * references to a particular ORB. CORBA::ORB_init() is required to + * return the same pointer if called with the same ORBid, only after + * ORB::destroy() is called it may return a new one. + */ void destroy (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Destroy the ORB, releasing any resources. Notice that TAO *cannot* - // release the resources even if you have destroyed all the - // references to a particular ORB. CORBA::ORB_init() is required to - // return the same pointer if called with the same ORBid, only after - // ORB::destroy() is called it may return a new one. CORBA_Object_ptr resolve_initial_references (const char *name, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); + /** + * This method acts as a mini-bootstrapping Naming Service, which is + * provided by the ORB for certain well-known object references. TAO + * supports the "NameService", "TradingService", "RootPOA", "ImplRepo", + * and "POACurrent" via this method. The <timeout> value bounds the + * amount of time the ORB blocks waiting to resolve the service. + * This is most useful for bootstrapping remote services, such as + * the "NameService" or "TradingService", that are commonly resolved + * via multicast. By default, the value is 0, which means "use the + * <TAO_DEFAULT_SERVICE_RESOLUTION_TIMEOUT> timeout period". Note + * that by using a default value for the <timeout> parameter, TAO + * will remains compliant with the CORBA + * <resolve_initial_references> specification. + */ CORBA_Object_ptr resolve_initial_references (const char *name, ACE_Time_Value *timeout, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // This method acts as a mini-bootstrapping Naming Service, which is - // provided by the ORB for certain well-known object references. TAO - // supports the "NameService", "TradingService", "RootPOA", "ImplRepo", - // and "POACurrent" via this method. The <timeout> value bounds the - // amount of time the ORB blocks waiting to resolve the service. - // This is most useful for bootstrapping remote services, such as - // the "NameService" or "TradingService", that are commonly resolved - // via multicast. By default, the value is 0, which means "use the - // <TAO_DEFAULT_SERVICE_RESOLUTION_TIMEOUT> timeout period". Note - // that by using a default value for the <timeout> parameter, TAO - // will remains compliant with the CORBA - // <resolve_initial_references> specification. + /// Returns a sequence of ObjectIds that lists which objects have + /// references available via the initial references mechanism. CORBA_ORB_ObjectIdList_ptr list_initial_services ( CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Returns a sequence of ObjectIds that lists which objects have - // references available via the initial references mechanism. CORBA::Policy_ptr create_policy (CORBA::PolicyType type, const CORBA::Any& val, @@ -311,20 +327,20 @@ public: // = TAO-specific extensions to the CORBA specification. // ---------------------------------------------------------------- + /// Resolve the POA. CORBA_Object_ptr resolve_root_poa (CORBA_Environment &ACE_TRY_ENV); - // Resolve the POA. + /// Delegates on the ORB_Core to create a TAO_Stub. TAO_Stub *create_stub_object (const TAO_ObjectKey &key, const char *type_id, CORBA::PolicyList *policy_list, TAO_Acceptor_Filter *acceptor_filter, CORBA_Environment &ACE_TRY_ENV); - // Delegates on the ORB_Core to create a TAO_Stub. + /// Initialize the ORB globals correctly, i.e., only when they + /// haven't been initialized yet. static void init_orb_globals (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Initialize the ORB globals correctly, i.e., only when they - // haven't been initialized yet. // The function used by tao to handle the "unexpected" exceptions, // It raises CORBA::UNKNOWN. @@ -334,25 +350,27 @@ public: CORBA::ULong _incr_refcnt (void); CORBA::ULong _decr_refcnt (void); + /// Set the IOR flag. + /// Get the IOR flag. void _use_omg_ior_format (CORBA::Boolean ior); - // Set the IOR flag. CORBA::Boolean _use_omg_ior_format (void); - // Get the IOR flag. + /// Set collocation optimization status. + /// Get collocation optimization status. void _optimize_collocation_objects (CORBA::Boolean opt); - // Set collocation optimization status. CORBA::Boolean _optimize_collocation_objects (void) const; - // Get collocation optimization status. + /// Get the ORB core. TAO_ORB_Core *orb_core (void) const; - // Get the ORB core. + /** + * TAO specific extension to get and set the client ID. The client + * id can be set by the application which would be used by the FT + * service. As there are no specific interfaces defined in the spec, + * we have this prorpietary extensions + */ const ACE_CString &_tao_ft_client_id (void); void _tao_ft_client_id (const char *id); - // TAO specific extension to get and set the client ID. The client - // id can be set by the application which would be used by the FT - // service. As there are no specific interfaces defined in the spec, - // we have this prorpietary extensions #if !defined(__GNUC__) || __GNUC__ > 2 || __GNUC_MINOR__ >= 8 typedef CORBA_ORB_ptr _ptr_type; @@ -365,31 +383,31 @@ protected: CORBA_ORB (TAO_ORB_Core *orb_core); ~CORBA_ORB (void); + /// Resolve the POA current. CORBA_Object_ptr resolve_poa_current (CORBA_Environment &ACE_TRY_ENV); - // Resolve the POA current. + /// Resolve the Policy Manager for this ORB. + /// Resolve the Policy Current for this thread. CORBA_Object_ptr resolve_policy_manager (CORBA::Environment&); - // Resolve the Policy Manager for this ORB. CORBA_Object_ptr resolve_policy_current (CORBA::Environment&); - // Resolve the Policy Current for this thread. + /// Resolve the RTORB. CORBA_Object_ptr resolve_rt_orb (CORBA_Environment &ACE_TRY_ENV); - // Resolve the RTORB. + /// Resolve the RT Current. CORBA_Object_ptr resolve_rt_current (CORBA_Environment &ACE_TRY_ENV); - // Resolve the RT Current. + /// Resolve the Priority_Mapping_Manager. CORBA_Object_ptr resolve_priority_mapping_manager (CORBA_Environment &ACE_TRY_ENV); - // Resolve the Priority_Mapping_Manager. private: + /// Resolve the given service based on the service ID. CORBA_Object_ptr resolve_service (MCAST_SERVICEID service_id, ACE_Time_Value *timeout, CORBA::Environment& ACE_TRY_ENV); - // Resolve the given service based on the service ID. int multicast_query (char* &buf, const char *service_name, @@ -399,45 +417,45 @@ private: // returns and IOR string, the client is responsible for freeing // memory! + /// Resolve the reference of a service of type <name>. CORBA_Object_ptr multicast_to_service (const char *service_name, u_short port, ACE_Time_Value *timeout, CORBA::Environment& ACE_TRY_ENV); - // Resolve the reference of a service of type <name>. + /// Convert an OMG IOR into an object reference. CORBA::Object_ptr ior_string_to_object (const char* ior, CORBA::Environment &ACE_TRY_ENV); - // Convert an OMG IOR into an object reference. + /// Convert an URL style IOR into an object reference. CORBA::Object_ptr url_ior_string_to_object (const char* ior, CORBA::Environment &ACE_TRY_ENV); - // Convert an URL style IOR into an object reference. + /// Check if ORB has shutdown. If it has, throw an exception. void check_shutdown (CORBA::Environment &ACE_TRY_ENV); - // Check if ORB has shutdown. If it has, throw an exception. private: + /// lock required for mutual exclusion between multiple threads. ACE_SYNCH_MUTEX lock_; - // lock required for mutual exclusion between multiple threads. + /// Maintains a reference count of number of instantiations of the + /// ORB. u_int refcount_; - // Maintains a reference count of number of instantiations of the - // ORB. + /// Count of the number of times that <ORB_init> has been called. static int orb_init_count_; - // Count of the number of times that <ORB_init> has been called. // This must be protected by <ACE_Static_Object_Lock>. + /// The ORB_Core that created us.... TAO_ORB_Core *orb_core_; - // The ORB_Core that created us.... #if defined (TAO_HAS_VALUETYPE) + /// If non-0 then this is the Factory for OBV unmarshaling TAO_ValueFactory_Map *valuetype_factory_map_; - // If non-0 then this is the Factory for OBV unmarshaling #endif /* TAO_HAS_VALUETYPE */ + /// Decides whether to use the URL notation or to use IOR notation. CORBA::Boolean use_omg_ior_format_; - // Decides whether to use the URL notation or to use IOR notation. // = NON-PROVIDED METHODS CORBA_ORB (const CORBA_ORB &); @@ -456,9 +474,9 @@ public: CORBA_ORB_var &operator= (const CORBA_ORB_var &); CORBA::ORB_ptr operator-> (void) const; + /// in, inout, out, _retn operator const CORBA::ORB_ptr &() const; operator CORBA::ORB_ptr &(); - // in, inout, out, _retn CORBA::ORB_ptr in (void) const; CORBA::ORB_ptr &inout (void); CORBA::ORB_ptr &out (void); diff --git a/TAO/tao/ORBInitInfo.h b/TAO/tao/ORBInitInfo.h index 4b9f1259dcb..0f5e413b29e 100644 --- a/TAO/tao/ORBInitInfo.h +++ b/TAO/tao/ORBInitInfo.h @@ -173,7 +173,7 @@ public: static TAO_ORBInitInfo * _narrow ( CORBA::Object_ptr obj, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - + static TAO_ORBInitInfo * _unchecked_narrow ( CORBA::Object_ptr obj, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); diff --git a/TAO/tao/ORBInitializer_Registry.h b/TAO/tao/ORBInitializer_Registry.h index 01adff92185..3754ad869a4 100644 --- a/TAO/tao/ORBInitializer_Registry.h +++ b/TAO/tao/ORBInitializer_Registry.h @@ -35,8 +35,8 @@ class TAO_Export TAO_ORBInitializer_Registry { friend class TAO_Singleton<TAO_ORBInitializer_Registry, ACE_SYNCH_MUTEX>; friend void PortableInterceptor::register_orb_initializer ( - PortableInterceptor::ORBInitializer_ptr init, - CORBA::Environment &); + PortableInterceptor::ORBInitializer_ptr init, + CORBA::Environment &); friend CORBA::ORB_ptr CORBA::ORB_init (int &, char *argv[], const char *, diff --git a/TAO/tao/ORB_Core.h b/TAO/tao/ORB_Core.h index 5facba63bc5..b7ff1805584 100644 --- a/TAO/tao/ORB_Core.h +++ b/TAO/tao/ORB_Core.h @@ -649,8 +649,8 @@ public: /// Give each registered IOR interceptor the opportunity to add /// tagged components to profiles of each created servant. void establish_components (TAO_MProfile &mp, - CORBA::PolicyList *policy_list, - CORBA::Environment &ACE_TRY_ENV); + CORBA::PolicyList *policy_list, + CORBA::Environment &ACE_TRY_ENV); /// Create a new object, use the adapter registry to create a /// collocated object, if not possible then create a regular @@ -966,9 +966,9 @@ protected: // to be "Advanced_Resource_Factory". static const char *resource_factory_name_; - // Name of the service object for DII request creation that needs - // to be instantiated. The default value is "Dynamic_Adaper". If - // TAO_DynamicInterface is linked, dynamic_adapter_name() will be + // Name of the service object for DII request creation that needs + // to be instantiated. The default value is "Dynamic_Adaper". If + // TAO_DynamicInterface is linked, dynamic_adapter_name() will be // called to set the value to "Concrete_Dynamic_Adapter". static const char *dynamic_adapter_name_; diff --git a/TAO/tao/Object.h b/TAO/tao/Object.h index eec1a76bd2b..aabd9267832 100644 --- a/TAO/tao/Object.h +++ b/TAO/tao/Object.h @@ -1,26 +1,23 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// object.h -// -// = DESCRIPTION -// Header file for Win32 interface to CORBA's base "Object" type. -// -// A "Object" is an entity that can be the target of an invocation -// using an ORB. All CORBA objects provide this functionality. -// See the CORBA 2.0 specification for details. -// -// = AUTHOR -// Portions Copyright 1994-1995 by Sun Microsystems Inc. -// Portions Copyright 1997 by Washington University -// -// ============================================================================ + +//============================================================================= +/** + * @file Object.h + * + * $Id$ + * + * Header file for Win32 interface to CORBA's base "Object" type. + * + * A "Object" is an entity that can be the target of an invocation + * using an ORB. All CORBA objects provide this functionality. + * See the CORBA 2.0 specification for details. + * + * + * @author Portions Copyright 1994-1995 by Sun Microsystems Inc. + * @author Portions Copyright 1997 by Washington University + */ +//============================================================================= + #ifndef TAO_CORBA_OBJECT_H #define TAO_CORBA_OBJECT_H @@ -43,15 +40,16 @@ class TAO_Stub; class TAO_Export CORBA_Object { public: + /// destructor virtual ~CORBA_Object (void); - // destructor + /// increment the ref count static CORBA_Object_ptr _duplicate (CORBA_Object_ptr obj); - // increment the ref count + /// return a NUL object static CORBA_Object_ptr _nil (void); - // return a NUL object + /// no-op it is just here to simplify some templates. ACE_INLINE_FOR_GNUC static CORBA_Object_ptr _narrow (CORBA_Object_ptr obj, CORBA_Environment &ACE_TRY_ENV = @@ -59,10 +57,9 @@ public: static CORBA_Object_ptr _unchecked_narrow (CORBA_Object_ptr obj, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // no-op it is just here to simplify some templates. + /// Used in the implementation of CORBA::Any static void _tao_any_destructor (void*); - // Used in the implementation of CORBA::Any // These calls correspond to over-the-wire operations, or at least // do so in many common cases. The normal implementation assumes a @@ -70,20 +67,20 @@ public: // making such calls, but may be overridden when it appears // appropriate. + /// determine if we are of the type specified by the "logical_type_id" virtual CORBA::Boolean _is_a (const char *logical_type_id, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // determine if we are of the type specified by the "logical_type_id" + /// The repository ID for the most derived class, this is an + /// implementation method and does no remote invocations! virtual const char* _interface_repository_id (void) const; - // The repository ID for the most derived class, this is an - // implementation method and does no remote invocations! + /// Is this object collocated with the servant? virtual CORBA::Boolean _is_collocated (void) const; - // Is this object collocated with the servant? + /// Is this a local object? virtual CORBA::Boolean _is_local (void) const; - // Is this a local object? virtual TAO_Abstract_ServantBase*_servant (void) const; @@ -92,11 +89,11 @@ public: virtual CORBA::Boolean _non_existent (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); + /// This method is deprecated in the CORBA 2.2 spec, we just return 0 + /// every time. virtual CORBA::ImplementationDef_ptr _get_implementation (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // This method is deprecated in the CORBA 2.2 spec, we just return 0 - // every time. #if (TAO_HAS_INTERFACE_REPOSITORY == 1) @@ -139,10 +136,10 @@ public: // multi-protocol remote invocation interface as is assumed by the // calls above ... that's how it can have a default implementation. + /// DII operation to create a request. virtual CORBA::Request_ptr _request (const char *operation, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // DII operation to create a request. #if (TAO_HAS_CORBA_MESSAGING == 1) @@ -175,37 +172,43 @@ public: #endif /* TAO_HAS_CORBA_MESSAGING == 1 */ + /** + * Return a (potentially non-unique) hash value for this object. + * This method relies on the representation of the object + * reference's private state. Since that changes easily (when + * different ORB protocols are in use) there is no default + * implementation. + */ virtual CORBA::ULong _hash (CORBA::ULong maximum, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Return a (potentially non-unique) hash value for this object. - // This method relies on the representation of the object - // reference's private state. Since that changes easily (when - // different ORB protocols are in use) there is no default - // implementation. + /** + * Try to determine if this object is the same as <other_obj>. This + * method relies on the representation of the object reference's + * private state. Since that changes easily (when different ORB + * protocols are in use) there is no default implementation. + */ virtual CORBA::Boolean _is_equivalent (CORBA::Object_ptr other_obj, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) ACE_THROW_SPEC (()); - // Try to determine if this object is the same as <other_obj>. This - // method relies on the representation of the object reference's - // private state. Since that changes easily (when different ORB - // protocols are in use) there is no default implementation. + /// Return the object key as an out parameter. Caller should release + /// return value when finished with it. virtual TAO_ObjectKey *_key (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Return the object key as an out parameter. Caller should release - // return value when finished with it. + /** + * Return a reference to the object key of profile in-use. + * If there's no in-use profile, then the program will + * probably crash. This method does not create a new copy. + */ virtual const TAO_ObjectKey &_object_key (void); - // Return a reference to the object key of profile in-use. - // If there's no in-use profile, then the program will - // probably crash. This method does not create a new copy. + /// Downcasting this object pointer to some other derived class. + /// This QueryInterface stuff only work for local object. virtual void * _tao_QueryInterface (ptr_arith_t type); - // Downcasting this object pointer to some other derived class. - // This QueryInterface stuff only work for local object. #if !defined(__GNUC__) || __GNUC__ > 2 || __GNUC_MINOR__ >= 8 typedef CORBA_Object_ptr _ptr_type; @@ -214,11 +217,11 @@ public: // Useful for template programming. // = Reference count managment. + /// Increment the reference count. virtual void _add_ref (void); - // Increment the reference count. + /// Decrement the reference count. virtual void _remove_ref (void); - // Decrement the reference count. // = TAO extensions @@ -227,54 +230,58 @@ public: TAO_Abstract_ServantBase *servant = 0); + /// get the underlying stub object virtual TAO_Stub *_stubobj (void) const; - // get the underlying stub object + /// Sets the proxy broker. virtual void _proxy_broker (TAO_Object_Proxy_Broker *proxy_broker); - // Sets the proxy broker. + /// Gets the proxy broker. virtual TAO_Object_Proxy_Broker *_proxy_broker (void); - // Gets the proxy broker. protected: + /// Initializing a local object. CORBA_Object (int dummy); - // Initializing a local object. // = Internal Reference count managment. + /// Increment the reference count. CORBA::ULong _incr_refcnt (void); - // Increment the reference count. + /// Decrement the reference count. CORBA::ULong _decr_refcnt (void); - // Decrement the reference count. + /// Flag to indicate collocation. It is 0 except for collocated + /// objects. CORBA::Boolean is_collocated_; - // Flag to indicate collocation. It is 0 except for collocated - // objects. + /// Servant pointer. It is 0 except for collocated objects. TAO_Abstract_ServantBase *servant_; - // Servant pointer. It is 0 except for collocated objects. + /// Specify whether this is a local object or not. CORBA::Boolean is_local_; - // Specify whether this is a local object or not. + /** + * Pointer to the Proxy Broker i.e. the instance + * that takes care of getting the right proxy + * for performing a given call. + */ TAO_Object_Proxy_Broker *proxy_broker_; - // Pointer to the Proxy Broker i.e. the instance - // that takes care of getting the right proxy - // for performing a given call. private: + /** + * Pointer to the protocol-specific "object" containing important + * profiling information regarding this proxy. + * The protocol proxy is (potentially) shared among several + * CORBA_Objects + */ TAO_Stub *protocol_proxy_; - // Pointer to the protocol-specific "object" containing important - // profiling information regarding this proxy. - // The protocol proxy is (potentially) shared among several - // CORBA_Objects + /// Number of outstanding references to this object. CORBA::ULong refcount_; - // Number of outstanding references to this object. + /// Protect the reference count, this is OK because we do no + /// duplicates or releases on the critical path. ACE_SYNCH_MUTEX refcount_lock_; - // Protect the reference count, this is OK because we do no - // duplicates or releases on the critical path. // = Unimplemented methods CORBA_Object (const CORBA_Object &); @@ -293,9 +300,9 @@ public: CORBA_Object_var &operator= (const CORBA_Object_var &); CORBA::Object_ptr operator-> (void) const; + /// in, inout, out, _retn operator const CORBA::Object_ptr &() const; operator CORBA::Object_ptr &(); - // in, inout, out, _retn CORBA::Object_ptr in (void) const; CORBA::Object_ptr &inout (void); CORBA::Object_ptr &out (void); diff --git a/TAO/tao/Object_Loader.h b/TAO/tao/Object_Loader.h index a1c9205603a..e95d9bf545f 100644 --- a/TAO/tao/Object_Loader.h +++ b/TAO/tao/Object_Loader.h @@ -1,17 +1,14 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Object_Loader.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file Object_Loader.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_OBJECT_LOADER_H #define TAO_OBJECT_LOADER_H @@ -25,29 +22,32 @@ #include "ace/Service_Object.h" +/** + * @class TAO_Object_Loader + * + * @brief A class to dynamically load object implementations into an + * ORB. + * + * Many services and components of the ORB can be dynamically + * loaded, this is the class used to implement .... + * @@ TODO + */ class TAO_Export TAO_Object_Loader : public ACE_Service_Object { - // = TITLE - // A class to dynamically load object implementations into an - // ORB. - // - // = DESCRIPTION - // Many services and components of the ORB can be dynamically - // loaded, this is the class used to implement .... - // @@ TODO - // public: + /// The destructor virtual ~TAO_Object_Loader (void); - // The destructor + /** + * Create and activate a new object into the orb. + * This method cannot throw any exception, but it can return a nil + * object to indicate an error condition. + */ virtual CORBA::Object_ptr create_object (CORBA::ORB_ptr orb, int argc, char *argv [], CORBA::Environment &) ACE_THROW_SPEC (()) = 0; - // Create and activate a new object into the orb. - // This method cannot throw any exception, but it can return a nil - // object to indicate an error condition. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/Object_Proxy_Broker.h b/TAO/tao/Object_Proxy_Broker.h index 420179ef4a6..b5dd2031d01 100644 --- a/TAO/tao/Object_Proxy_Broker.h +++ b/TAO/tao/Object_Proxy_Broker.h @@ -1,22 +1,19 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Object_Proxy_Broker.h -// -// = DESCRIPTION -// This files contains the abstract class for the CORBA Object -// proxy brokers. Interface specific proxy broker are generated -// by the IDL compiler. -// -// = AUTHOR -// Angelo Corsaro <corsaro@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Object_Proxy_Broker.h + * + * $Id$ + * + * This files contains the abstract class for the CORBA Object + * proxy brokers. Interface specific proxy broker are generated + * by the IDL compiler. + * + * + * @author Angelo Corsaro <corsaro@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_OBJECT_PROXY_BROKER_H_ #define TAO_OBJECT_PROXY_BROKER_H_ @@ -28,7 +25,7 @@ #if !defined (ACE_LACKS_PRAGMA_ONCE) # pragma once -#endif // ACE_LACKS_PRAGMA_ONCE +#endif /* ACE_LACKS_PRAGMA_ONCE */ class TAO_Export TAO_Object_Proxy_Broker { @@ -48,4 +45,4 @@ protected: #include "ace/post.h" -#endif // TAO_OBJECT_PROXY_BROKER_H_ +#endif /* TAO_OBJECT_PROXY_BROKER_H_ */ diff --git a/TAO/tao/Object_Proxy_Impl.h b/TAO/tao/Object_Proxy_Impl.h index 619edaceb1d..1f6f3f3703b 100644 --- a/TAO/tao/Object_Proxy_Impl.h +++ b/TAO/tao/Object_Proxy_Impl.h @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Object_Proxy_Impl.h -// -// = DESCRIPTION -// This files contains the proxy definition of the interface that -// all the Object proxy have to imlements. -// -// = AUTHOR -// Angelo Corsaro <corsaro@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Object_Proxy_Impl.h + * + * $Id$ + * + * This files contains the proxy definition of the interface that + * all the Object proxy have to imlements. + * + * + * @author Angelo Corsaro <corsaro@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_OBJECT_PROXY_IMPL_H_ #define TAO_OBJECT_PROXY_IMPL_H_ @@ -23,14 +20,16 @@ #include "ace/pre.h" #include "tao/corbafwd.h" +/** + * @class TAO_Object_Proxy_Impl + * + * @brief TAO_Object_Proxy_Impl + * + * This class defines the interface that the proxy for the class + * CORBA::Object have to implement. + */ class TAO_Export TAO_Object_Proxy_Impl { - // = TITLE - // TAO_Object_Proxy_Impl - // - // = DESCRIPTION - // This class defines the interface that the proxy for the class - // CORBA::Object have to implement. public: virtual ~TAO_Object_Proxy_Impl (void); diff --git a/TAO/tao/OctetSeqC.h b/TAO/tao/OctetSeqC.h index f699dfce4d0..acb0cc39da5 100644 --- a/TAO/tao/OctetSeqC.h +++ b/TAO/tao/OctetSeqC.h @@ -62,20 +62,20 @@ class CORBA_OctetSeq_var; // CORBA_OctetSeq // ************************************************************* -class TAO_Export CORBA_OctetSeq : public +class TAO_Export CORBA_OctetSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) TAO_Unbounded_Sequence<CORBA::Octet> #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_Sequence<CORBA::Octet> -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: CORBA_OctetSeq (void); // default ctor CORBA_OctetSeq (CORBA::ULong max); // uses max size CORBA_OctetSeq ( - CORBA::ULong max, - CORBA::ULong length, - CORBA::Octet *buffer, + CORBA::ULong max, + CORBA::ULong length, + CORBA::Octet *buffer, CORBA::Boolean release = 0 ); CORBA_OctetSeq (const CORBA_OctetSeq &); // copy ctor @@ -115,21 +115,21 @@ public: CORBA_OctetSeq_var (const CORBA_OctetSeq_var &); // copy constructor CORBA_OctetSeq_var (const CORBA_OctetSeq &); // fixed-size base types only ~CORBA_OctetSeq_var (void); // destructor - + CORBA_OctetSeq_var &operator= (CORBA_OctetSeq *); CORBA_OctetSeq_var &operator= (const CORBA_OctetSeq_var &); CORBA_OctetSeq_var &operator= (const CORBA_OctetSeq &); // fixed-size base types only CORBA_OctetSeq *operator-> (void); const CORBA_OctetSeq *operator-> (void) const; - + operator const CORBA_OctetSeq &() const; operator CORBA_OctetSeq &(); operator CORBA_OctetSeq &() const; - + CORBA::Octet & operator[] (CORBA::ULong index); const CORBA::Octet & operator[] (CORBA::ULong index) const; - - // in, inout, out, _retn + + // in, inout, out, _retn const CORBA_OctetSeq &in (void) const; CORBA_OctetSeq &inout (void); CORBA_OctetSeq *&out (void); @@ -159,7 +159,7 @@ public: CORBA_OctetSeq *&ptr (void); CORBA_OctetSeq *operator-> (void); CORBA::Octet & operator[] (CORBA::ULong index); - + private: CORBA_OctetSeq *&ptr_; // assignment from T_var not allowed diff --git a/TAO/tao/Parser_Registry.h b/TAO/tao/Parser_Registry.h index 1244458a251..cf78deaabbd 100644 --- a/TAO/tao/Parser_Registry.h +++ b/TAO/tao/Parser_Registry.h @@ -1,16 +1,16 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = AUTHOR -// Priyanka Gontla <pgontla@uci.edu> -// Carlos O'Ryan <coryan@uci.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Parser_Registry.h + * + * $Id$ + * + * @author Priyanka Gontla <pgontla@uci.edu> + * @author Carlos O'Ryan <coryan@uci.edu> + */ +//============================================================================= + #ifndef TAO_PARSER_REGISTRY_H #define TAO_PARSER_REGISTRY_H @@ -28,31 +28,32 @@ class TAO_ORB_Core; class TAO_IOR_Parser; +/** + * @class TAO_Parser_Registry + * + * @brief Maintain the collection of known IOR format parsers + * + * The ORB dynamically loads a collection of IOR parsers (check + * the IOR_Parser class). The collection is kept in this class + * for easy lookup and use. + */ class TAO_Export TAO_Parser_Registry { - // = TITLE - // Maintain the collection of known IOR format parsers - // - // = DESCRIPTION - // The ORB dynamically loads a collection of IOR parsers (check - // the IOR_Parser class). The collection is kept in this class - // for easy lookup and use. - // public: // = Initialization and termination methods. + /// Default constructor. TAO_Parser_Registry (void); - // Default constructor. + /// Dstructor. ~TAO_Parser_Registry (void); - // Dstructor. + /// Initialize the parser registry with the list of known protocols. + /// Invoked by the ORB during startup. int open (TAO_ORB_Core *orb_core); - // Initialize the parser registry with the list of known protocols. - // Invoked by the ORB during startup. + /// Find the parser that can parse <ior_string> + /// The lookup is based on the prefix in the string TAO_IOR_Parser *match_parser (const char *ior_string); - // Find the parser that can parse <ior_string> - // The lookup is based on the prefix in the string // = Iterator. typedef TAO_IOR_Parser** Parser_Iterator; @@ -65,11 +66,11 @@ private: ACE_UNIMPLEMENTED_FUNC (void operator= (const TAO_Parser_Registry&)) private: + /// List of parsers TAO_IOR_Parser **parsers_; - // List of parsers + /// Number of parsers size_t size_; - // Number of parsers }; #if defined(__ACE_INLINE__) diff --git a/TAO/tao/Pluggable.h b/TAO/tao/Pluggable.h index a5f94b17f54..585b37e6baf 100644 --- a/TAO/tao/Pluggable.h +++ b/TAO/tao/Pluggable.h @@ -1,21 +1,18 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Pluggable.h -// -// = DESCRIPTION -// Interface for the TAO pluggable protocol framework. -// -// = AUTHOR -// Fred Kuhns <fredk@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Pluggable.h + * + * $Id$ + * + * Interface for the TAO pluggable protocol framework. + * + * + * @author Fred Kuhns <fredk@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_PLUGGABLE_H #define TAO_PLUGGABLE_H @@ -56,44 +53,46 @@ class TAO_Connection_Handler; typedef ACE_Message_Queue<ACE_NULL_SYNCH> TAO_Transport_Buffering_Queue; +/** + * @class TAO_Transport + * + * @brief Generic definitions for the Transport class. + * + * The transport object is created in the Service handler + * constructor and deleted in the Service Handler's destructor!! + */ class TAO_Export TAO_Transport { - // = TITLE - // Generic definitions for the Transport class. - // - // = DESCRIPTION - // The transport object is created in the Service handler - // constructor and deleted in the Service Handler's destructor!! friend class TAO_Transport_Sync_Strategy; friend class TAO_Eager_Buffering_Sync_Strategy; friend class TAO_Delayed_Buffering_Sync_Strategy; public: + /// default creator, requres the tag value be supplied. TAO_Transport (CORBA::ULong tag, TAO_ORB_Core *orb_core); - // default creator, requres the tag value be supplied. + /// destructor virtual ~TAO_Transport (void); - // destructor + /// The tag, each concrete class will have a specific tag value. CORBA::ULong tag (void) const; - // The tag, each concrete class will have a specific tag value. + /// Call the corresponding connection handler's <close> + /// method. virtual void close_connection (void) = 0; - // Call the corresponding connection handler's <close> - // method. + /// Idles the corresponding connection handler. virtual int idle (void) = 0; - // Idles the corresponding connection handler. + /// This method provides a way to gain access to the underlying file + /// handle used by the reactor. virtual ACE_HANDLE handle (void) = 0; - // This method provides a way to gain access to the underlying file - // handle used by the reactor. + /// This method provides a way to gain access to the underlying event + /// handler used by the reactor. virtual ACE_Event_Handler *event_handler (void) = 0; - // This method provides a way to gain access to the underlying event - // handler used by the reactor. virtual ssize_t send (TAO_Stub *stub, int two_way, @@ -109,28 +108,31 @@ public: // not clear this this is the best place to specify this. The actual // timeout values will be kept in the Policies. + /// Write the contents of the buffer of length len to the connection. virtual ssize_t send (const u_char *buf, size_t len, const ACE_Time_Value *s = 0) = 0; - // Write the contents of the buffer of length len to the connection. + /** + * Read len bytes from into buf. + * @@ The ACE_Time_Value *s is just a place holder for now. It is + * not clear this this is the best place to specify this. The actual + * timeout values will be kept in the Policies. + */ virtual ssize_t recv (char *buf, size_t len, const ACE_Time_Value *s = 0) = 0; - // Read len bytes from into buf. - // @@ The ACE_Time_Value *s is just a place holder for now. It is - // not clear this this is the best place to specify this. The actual - // timeout values will be kept in the Policies. + /// Fill into <output> the right headers to make a request. virtual void start_request (TAO_ORB_Core *orb_core, TAO_Target_Specification &spec, TAO_OutputCDR &output, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); - // Fill into <output> the right headers to make a request. + /// Fill into <output> the right headers to make a locate request. virtual void start_locate (TAO_ORB_Core *orb_core, TAO_Target_Specification &spec, TAO_Operation_Details &opdetails, @@ -138,91 +140,100 @@ public: CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); - // Fill into <output> the right headers to make a locate request. + /** + * Depending on the concurrency strategy used by the transport it + * may be required to setup state to receive a reply before the + * request is sent. + * Using this method, instead of send(), allows the transport (and + * wait strategy) to take appropiate action. + */ virtual int send_request (TAO_Stub *stub, TAO_ORB_Core *orb_core, TAO_OutputCDR &stream, int twoway, ACE_Time_Value *max_time_wait) = 0; - // Depending on the concurrency strategy used by the transport it - // may be required to setup state to receive a reply before the - // request is sent. - // Using this method, instead of send(), allows the transport (and - // wait strategy) to take appropiate action. + /// This is a request for the transport object to write a request + /// header before it sends out a request virtual CORBA::Boolean send_request_header (TAO_Operation_Details &op_details, TAO_Target_Specification &spec, TAO_OutputCDR &msg) = 0; - // This is a request for the transport object to write a request - // header before it sends out a request + /// This method formats the stream and then sends the message on the + /// transport. virtual int send_message (TAO_OutputCDR &stream, TAO_Stub *stub = 0, int twoway = 1, ACE_Time_Value *max_time_wait = 0) = 0; - // This method formats the stream and then sends the message on the - // transport. + /// Access the ORB that owns this connection. TAO_ORB_Core *orb_core (void) const; - // Access the ORB that owns this connection. + /// Get the TMS used by this Transport object. TAO_Transport_Mux_Strategy *tms (void) const; - // Get the TMS used by this Transport object. + /// Return the Wait strategy used by the Transport. TAO_Wait_Strategy *wait_strategy (void) const; - // Return the Wait strategy used by the Transport. + /** + * Read and process the message on the connection. If <block> is 1, + * then reply is read in a blocking manner. Once the message has + * been successfully read, the message is processed by delegating + * the responsibility to the underlying messaging object. + */ virtual int read_process_message (ACE_Time_Value *max_wait_time = 0, int block = 0); - // Read and process the message on the connection. If <block> is 1, - // then reply is read in a blocking manner. Once the message has - // been successfully read, the message is processed by delegating - // the responsibility to the underlying messaging object. + /** + * Register the handler with the reactor. Will be called by the Wait + * Strategy if Reactor is used for that strategy. Default + * implementation out here returns -1 setting <errno> to ENOTSUP. + */ virtual int register_handler (void); - // Register the handler with the reactor. Will be called by the Wait - // Strategy if Reactor is used for that strategy. Default - // implementation out here returns -1 setting <errno> to ENOTSUP. // = Setting the Transport object in Idle state. These methods are // routed through the TMS object. The TMS strategies implement the // methods accordingly. + /// Request has been just sent, but the reply is not received. Idle + /// the transport now. virtual int idle_after_send (void); - // Request has been just sent, but the reply is not received. Idle - // the transport now. + /// Request is sent and the reply is received. Idle the transport + /// now. virtual int idle_after_reply (void); - // Request is sent and the reply is received. Idle the transport - // now. + /** + * Return the TSS leader follower condition variable used in the + * Wait Strategy. Muxed Leader Follower implementation returns a + * valid condition variable, others return 0. + */ virtual ACE_SYNCH_CONDITION *leader_follower_condition_variable (void); - // Return the TSS leader follower condition variable used in the - // Wait Strategy. Muxed Leader Follower implementation returns a - // valid condition variable, others return 0. + /// Queue for buffering transport messages. virtual TAO_Transport_Buffering_Queue &buffering_queue (void); - // Queue for buffering transport messages. + /// Timer id associated with buffering. long buffering_timer_id (void) const; void buffering_timer_id (long); - // Timer id associated with buffering. + /// Timeout value associated with buffering. const ACE_Time_Value &buffering_timeout_value (void) const; void buffering_timeout_value (const ACE_Time_Value &time); - // Timeout value associated with buffering. + /// Send any messages that have been buffered. ssize_t send_buffered_messages (const ACE_Time_Value *max_wait_time = 0); - // Send any messages that have been buffered. + /** + * Initialising the messaging object. This would be used by the + * connector side. On the acceptor side the connection handler + * would take care of the messaging objects. + */ virtual int messaging_init (CORBA::Octet major, CORBA::Octet minor); - // Initialising the messaging object. This would be used by the - // connector side. On the acceptor side the connection handler - // would take care of the messaging objects. void dequeue_all (void); @@ -248,176 +259,190 @@ private: ACE_UNIMPLEMENTED_FUNC (void operator= (const TAO_Transport&)) protected: + /// IOP protocol tag. CORBA::ULong tag_; - // IOP protocol tag. + /// Global orbcore resource. TAO_ORB_Core *orb_core_; - // Global orbcore resource. + /// Strategy to decide whether multiple requests can be sent over the + /// same connection or the connection is exclusive for a request. TAO_Transport_Mux_Strategy *tms_; - // Strategy to decide whether multiple requests can be sent over the - // same connection or the connection is exclusive for a request. + /// Strategy for waiting for the reply after sending the request. TAO_Wait_Strategy *ws_; - // Strategy for waiting for the reply after sending the request. + /// Queue for buffering transport messages. TAO_Transport_Buffering_Queue *buffering_queue_; - // Queue for buffering transport messages. + /// Buffering timer id. long buffering_timer_id_; - // Buffering timer id. + /// Buffering timeout value. ACE_Time_Value buffering_timeout_value_; - // Buffering timeout value. }; // **************************************************************** +/** + * @class TAO_Acceptor + * + * @brief Abstract Acceptor class used for pluggable protocols. + * + * Base class for the Acceptor bridge calss. + */ class TAO_Export TAO_Acceptor { - // = TITLE - // Abstract Acceptor class used for pluggable protocols. - // - // = DESCRIPTION - // Base class for the Acceptor bridge calss. public: TAO_Acceptor (CORBA::ULong tag); + /// Destructor virtual ~TAO_Acceptor (void); - // Destructor + /// The tag, each concrete class will have a specific tag value. CORBA::ULong tag (void) const; - // The tag, each concrete class will have a specific tag value. + /// The priority for this endpoint. CORBA::Short priority (void) const; - // The priority for this endpoint. + /// Method to initialize acceptor for address. virtual int open (TAO_ORB_Core *orb_core, int version_major, int version_minor, const char *address, const char *options = 0) = 0; - // Method to initialize acceptor for address. + /** + * Open an acceptor with the given protocol version on a default + * endpoint + * @@ This method should be pure virtual, but in order to maintain + * some form of backward compatibilty, a default implementation + * is provided. Ideally, that default implementation should be + * removed in the near future. + */ virtual int open_default (TAO_ORB_Core *, int version_major, int version_minor, const char *options = 0) = 0; - // Open an acceptor with the given protocol version on a default - // endpoint - // @@ This method should be pure virtual, but in order to maintain - // some form of backward compatibilty, a default implementation - // is provided. Ideally, that default implementation should be - // removed in the near future. + /// Closes the acceptor virtual int close (void) = 0; - // Closes the acceptor + /// Create the corresponding profile for this endpoint. virtual int create_mprofile (const TAO_ObjectKey &object_key, TAO_MProfile &mprofile) = 0; - // Create the corresponding profile for this endpoint. + /// Return 1 if the <endpoint> has the same address as the acceptor. virtual int is_collocated (const TAO_Endpoint* endpoint) = 0; - // Return 1 if the <endpoint> has the same address as the acceptor. + /** + * Returns the number of endpoints this acceptor is listening on. This + * is used for determining how many profiles will be generated + * for this acceptor. + */ virtual CORBA::ULong endpoint_count (void) = 0; - // Returns the number of endpoints this acceptor is listening on. This - // is used for determining how many profiles will be generated - // for this acceptor. + /** + * This method fetches the <key> from the <profile>. Protocols that + * are pluggable can send data that are specific in the + * <profile_data> field encapsulated as a octet stream. This method + * allows those protocols to get the object key from the + * encapsulation. + */ virtual int object_key (IOP::TaggedProfile &profile, TAO_ObjectKey &key) = 0; - // This method fetches the <key> from the <profile>. Protocols that - // are pluggable can send data that are specific in the - // <profile_data> field encapsulated as a octet stream. This method - // allows those protocols to get the object key from the - // encapsulation. protected: + /// The priority for this endpoint CORBA::Short priority_; - // The priority for this endpoint private: + /// IOP protocol tag. CORBA::ULong tag_; - // IOP protocol tag. }; +/** + * @class TAO_Connector + * + * @brief Generic Connector interface definitions. + * + * Base class for connector bridge object. + */ class TAO_Export TAO_Connector { - // = TITLE - // Generic Connector interface definitions. - // - // = DESCRIPTION - // Base class for connector bridge object. public: + /// default constructor. TAO_Connector (CORBA::ULong tag); - // default constructor. + /// the destructor. virtual ~TAO_Connector (void); - // the destructor. + /** + * The tag identifying the specific ORB transport layer protocol. + * For example TAO_TAG_IIOP_PROFILE = 0. The tag is used in the + * IOR to identify the type of profile included. IOR -> {{tag0, + * profile0} {tag1, profole1} ...} GIOP.h defines typedef + * CORBA::ULong TAO_IOP_Profile_ID; + */ CORBA::ULong tag (void) const; - // The tag identifying the specific ORB transport layer protocol. - // For example TAO_TAG_IIOP_PROFILE = 0. The tag is used in the - // IOR to identify the type of profile included. IOR -> {{tag0, - // profile0} {tag1, profole1} ...} GIOP.h defines typedef - // CORBA::ULong TAO_IOP_Profile_ID; + /// Parse a string containing a URL style IOR and return an + /// MProfile. int make_mprofile (const char *ior, TAO_MProfile &mprofile, CORBA::Environment &ACE_TRY_ENV); - // Parse a string containing a URL style IOR and return an - // MProfile. + /// Initialize object and register with reactor. virtual int open (TAO_ORB_Core *orb_core) = 0; - // Initialize object and register with reactor. + /// Shutdown Connector bridge and concreate Connector. virtual int close (void) = 0; - // Shutdown Connector bridge and concreate Connector. + /** + * To support pluggable we need to abstract away the connect() + * method so it can be called from the GIOP code independant of the + * actual transport protocol in use. + */ virtual int connect (TAO_Connection_Descriptor_Interface *desc, TAO_Transport *&, ACE_Time_Value *max_wait_time, CORBA::Environment &ACE_TRY_ENV) = 0; - // To support pluggable we need to abstract away the connect() - // method so it can be called from the GIOP code independant of the - // actual transport protocol in use. + /// Initial set of connections to be established. virtual int preconnect (const char *preconnections) = 0; - // Initial set of connections to be established. + /// Create a profile for this protocol and initialize it based on the + /// encapsulation in <cdr> virtual TAO_Profile *create_profile (TAO_InputCDR& cdr) = 0; - // Create a profile for this protocol and initialize it based on the - // encapsulation in <cdr> + /// Check that the prefix of the provided endpoint is valid for use + /// with a given pluggable protocol. virtual int check_prefix (const char *endpoint) = 0; - // Check that the prefix of the provided endpoint is valid for use - // with a given pluggable protocol. + /// Return the object key delimiter to use or expect. virtual char object_key_delimiter (void) const = 0; - // Return the object key delimiter to use or expect. protected: + /// Create a profile with a given endpoint. virtual void make_profile (const char *endpoint, TAO_Profile *&, CORBA::Environment &ACE_TRY_ENV) = 0; - // Create a profile with a given endpoint. + /// Set the ORB Core pointer void orb_core (TAO_ORB_Core *orb_core); - // Set the ORB Core pointer + /// Return the TAO_ORB_Core pointer TAO_ORB_Core *orb_core (void); - // Return the TAO_ORB_Core pointer private: + /// IOP protocol tag. CORBA::ULong tag_; - // IOP protocol tag. + /// Pointer to our ORB core TAO_ORB_Core *orb_core_; - // Pointer to our ORB core }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/Pluggable_Messaging.h b/TAO/tao/Pluggable_Messaging.h index ee3a71f876e..6e7b19a896a 100644 --- a/TAO/tao/Pluggable_Messaging.h +++ b/TAO/tao/Pluggable_Messaging.h @@ -1,21 +1,18 @@ // -*- C++ -*- -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Pluggable_Messaging.h -// -// = DESCRIPTION -// Interface for the TAO pluggable messaging framework. -// -// = AUTHOR -// Balachandran Natarajan <bala@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file Pluggable_Messaging.h + * + * $Id$ + * + * Interface for the TAO pluggable messaging framework. + * + * + * @author Balachandran Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + // #ifndef TAO_PLUGGABLE_MESSAGING_H #define TAO_PLUGGABLE_MESSAGING_H @@ -48,87 +45,95 @@ class TAO_OutputCDR; // I am going to take a closer look on this after my MS defense - // Bala +/** + * @class TAO_Pluggable_Messaging + * + * @brief Generic definitions Messaging class. + * + * This interface tries to define generic methods that could be + * different messaging protocols + */ class TAO_Export TAO_Pluggable_Messaging { - // = TITLE - // Generic definitions Messaging class. - // - // = DESCRIPTION - // This interface tries to define generic methods that could be - // different messaging protocols public: + /// Dtor virtual ~TAO_Pluggable_Messaging (void); - // Dtor + /// Write the RequestHeader in to the <cdr> stream. The underlying + /// implementation of the mesaging should do the right thing. virtual int generate_request_header ( TAO_Operation_Details &op, TAO_Target_Specification &spec, TAO_OutputCDR &cdr) = 0; - // Write the RequestHeader in to the <cdr> stream. The underlying - // implementation of the mesaging should do the right thing. + /// Write the RequestHeader in to the <cdr> stream. virtual int generate_locate_request_header ( TAO_Operation_Details &op, TAO_Target_Specification &spec, TAO_OutputCDR &cdr) = 0; - // Write the RequestHeader in to the <cdr> stream. + /** + * Write the reply header + * The reply header is a part of any messaging protocol. The + * messaging protocol implementation would implement the way the + * reply header is written. + */ virtual int generate_reply_header ( TAO_OutputCDR &cdr, TAO_Pluggable_Reply_Params ¶ms) = 0; - // Write the reply header - // The reply header is a part of any messaging protocol. The - // messaging protocol implementation would implement the way the - // reply header is written. + /** + * Write the locate reply header + * The locate reply header is a part of any messaging protocol. The + * messaging protocol implementation would implement the way the + * locate reply header is written. + */ virtual int generate_locate_reply_header ( TAO_OutputCDR &cdr, TAO_Pluggable_Reply_Params ¶ms) = 0; - // Write the locate reply header - // The locate reply header is a part of any messaging protocol. The - // messaging protocol implementation would implement the way the - // locate reply header is written. + /** + * This method reads the message on the connection. Returns 0 when + * there is short read on the connection. Returns 1 when the full + * message is read and handled. Returns -1 on errors. If <block> is + * 1, then reply is read in a blocking manner. <bytes> indicates the + * number of bytes that needs to be read from the connection. + */ virtual int read_message (TAO_Transport *transport, int block = 0, ACE_Time_Value *max_wait_time = 0) = 0; - // This method reads the message on the connection. Returns 0 when - // there is short read on the connection. Returns 1 when the full - // message is read and handled. Returns -1 on errors. If <block> is - // 1, then reply is read in a blocking manner. <bytes> indicates the - // number of bytes that needs to be read from the connection. + /// Format the message in the <cdr>. May not be needed in + /// general. virtual int format_message (TAO_OutputCDR &cdr) = 0; - // Format the message in the <cdr>. May not be needed in - // general. + /// Get the message type that was received. virtual TAO_Pluggable_Message_Type message_type (void) = 0; - // Get the message type that was received. + /// Do any initialisations that may be needed. virtual void init (CORBA::Octet major, CORBA::Octet minor) = 0; - // Do any initialisations that may be needed. + /// Reset teh messaging object virtual void reset (int reset_flag = 1) = 0; - // Reset teh messaging object + /// Parse the request message, make an upcall and send the reply back + /// to the "request initiator" virtual int process_request_message (TAO_Transport *transport, TAO_ORB_Core *orb_core) = 0; - // Parse the request message, make an upcall and send the reply back - // to the "request initiator" + /// Parse the reply message that we received and return the reply + /// information though <reply_info> virtual int process_reply_message ( TAO_Pluggable_Reply_Params &reply_info) = 0; - // Parse the reply message that we received and return the reply - // information though <reply_info> + /// Generate a reply message with the exception <ex>. virtual int generate_exception_reply ( TAO_OutputCDR &cdr, TAO_Pluggable_Reply_Params ¶ms, CORBA::Exception &x) = 0; - // Generate a reply message with the exception <ex>. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/Pluggable_Messaging_Utils.h b/TAO/tao/Pluggable_Messaging_Utils.h index 837ee4b6a99..017b3f35383 100644 --- a/TAO/tao/Pluggable_Messaging_Utils.h +++ b/TAO/tao/Pluggable_Messaging_Utils.h @@ -1,21 +1,18 @@ // -*- C++ -*- -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Pluggable_Messaging_Utils.h -// -// = DESCRIPTION -// Utility classes for the TAO pluggable messaging framework. -// -// = AUTHOR -// Balachandran Natarajan <bala@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file Pluggable_Messaging_Utils.h + * + * $Id$ + * + * Utility classes for the TAO pluggable messaging framework. + * + * + * @author Balachandran Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_PLUGGABLE_MESSAGING_UTILS_H #define TAO_PLUGGABLE_MESSAGING_UTILS_H @@ -29,57 +26,63 @@ #include "tao/CDR.h" +/** + * @class TAO_Pluggable_Reply_Params + * + * @brief TAO_Pluggable_Connector_Params + * + * This represents a set of data that would be received by the + * connector from the acceptor. + */ class TAO_Export TAO_Pluggable_Reply_Params { - // = TITLE - // TAO_Pluggable_Connector_Params - // - // = DESCRIPTION - // This represents a set of data that would be received by the - // connector from the acceptor. public: + /// Constructor. TAO_Pluggable_Reply_Params (TAO_ORB_Core *orb_core); - // Constructor. + /// The IOP service context list. IOP::ServiceContextList svc_ctx_; - // The IOP service context list. + /// The request id for which the reply we (connector) has received. CORBA::ULong request_id_; - // The request id for which the reply we (connector) has received. // @@ Bala: this is (again) an GIOPism (to coin a word). Other // protocol may choose to send different *messages* instead. // @@ Carlos: I agree. Please see above. + /// The reply status. CORBA::ULong reply_status_; - // The reply status. + /** + * Since this class no longer contains an NVList, this is the + * way to determine if the request was DSI, so we can use Carlos' + * service context list no-deep-copy optimization. + */ CORBA::Boolean is_dsi_; - // Since this class no longer contains an NVList, this is the - // way to determine if the request was DSI, so we can use Carlos' - // service context list no-deep-copy optimization. + /// Info required for DSI optimization that pads the outgoing + /// CDR stream according to the alignment of the NVList. ptr_arith_t dsi_nvlist_align_; - // Info required for DSI optimization that pads the outgoing - // CDR stream according to the alignment of the NVList. + /** + * Get and Set methods for the service context list that we dont + * own. This is useful for cases where the application objects own + * a service context list and would like to pass on their contents + * without a copy. + */ IOP::ServiceContextList &service_context_notowned (void); void service_context_notowned (IOP::ServiceContextList *svc); - // Get and Set methods for the service context list that we dont - // own. This is useful for cases where the application objects own - // a service context list and would like to pass on their contents - // without a copy. + /// A flag that indicates if there is any data is going to get + /// marshalled in the reply CORBA::Boolean argument_flag_; - // A flag that indicates if there is any data is going to get - // marshalled in the reply + /// The stream with the non-demarshalled reply. This stream will be + /// passed up to the stubs to demarshall the parameter values. TAO_InputCDR input_cdr_; - // The stream with the non-demarshalled reply. This stream will be - // passed up to the stubs to demarshall the parameter values. private: + /// The service context list that we don't own. IOP::ServiceContextList *service_context_; - // The service context list that we don't own. }; // @@ Bala: this is a GIOPism too, there is no such thing as locate diff --git a/TAO/tao/PolicyS.h b/TAO/tao/PolicyS.h index 92f9c5bb43c..70b87da46b6 100644 --- a/TAO/tao/PolicyS.h +++ b/TAO/tao/PolicyS.h @@ -1,16 +1,16 @@ /* -*- C++ -*- $Id$ */ -// ================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// GIOPS.h -// -// = DESCRIPTION -// The file is almost empty and only present to keep other IDL files -// that include Policy.pidl happy. -// ================================================================ +//============================================================================= +/** + * @file PolicyS.h + * + * $Id$ + * + * The file is almost empty and only present to keep other IDL files + * that include Policy.pidl happy. + * + */ +//============================================================================= + #ifndef TAO_PIDL_POLICY_S_H #define TAO_PIDL_POLICY_S_H #include "tao/PolicyC.h" diff --git a/TAO/tao/Policy_Manager.h b/TAO/tao/Policy_Manager.h index 6aa07dc3cb1..680038cca93 100644 --- a/TAO/tao/Policy_Manager.h +++ b/TAO/tao/Policy_Manager.h @@ -1,21 +1,18 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Policy_Manager.h -// -// = DESCRIPTION -// An implementation for the CORBA::PolicyManager interface. -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file Policy_Manager.h + * + * $Id$ + * + * An implementation for the CORBA::PolicyManager interface. + * + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_POLICY_MANAGER_H #define TAO_POLICY_MANAGER_H @@ -51,55 +48,57 @@ class TAO_PriorityBandedConnectionPolicy; class TAO_ServerProtocolPolicy; class TAO_ClientProtocolPolicy; +/** + * @class TAO_Policy_Manager_Impl + * + * @brief The policy manager implementation. + * + * This class is used to implement both the CORBA::PolicyManager + * and the CORBA::PolicyCurrent interfaces. + */ class TAO_Export TAO_Policy_Manager_Impl { - // - // = TITLE - // The policy manager implementation. - // - // = DESCRIPTION - // This class is used to implement both the CORBA::PolicyManager - // and the CORBA::PolicyCurrent interfaces. - // friend class TAO_Policy_Manager; public: + /// Constructor TAO_Policy_Manager_Impl (void); - // Constructor + /// Destructor ~TAO_Policy_Manager_Impl (void); - // Destructor + /// Copy the state from <source>, it uses the copy() operator to + /// obtain independent copies of all the policies. void copy_from (TAO_Policy_Manager_Impl* source, CORBA::Environment &ACE_TRY_ENV); - // Copy the state from <source>, it uses the copy() operator to - // obtain independent copies of all the policies. + /** + * Modify the list of policies to include <policies>. + * If <set_add> is CORBA::SET_OVERRIDE then we replace all the old + * policies. If it is CORBA::ADD_OVERRIDE we simply add the policies + * in <policies>. + * No attempt is made to validate the policies for consistency. + */ void set_policy_overrides (const CORBA::PolicyList & policies, CORBA::SetOverrideType set_add, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); - // Modify the list of policies to include <policies>. - // If <set_add> is CORBA::SET_OVERRIDE then we replace all the old - // policies. If it is CORBA::ADD_OVERRIDE we simply add the policies - // in <policies>. - // No attempt is made to validate the policies for consistency. + /// Get the values (if any) for the policies in <types>, if <types> + /// is an empty list the method returns *all* the current policies. CORBA::PolicyList * get_policy_overrides (const CORBA::PolicyTypeSeq & types, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); - // Get the values (if any) for the policies in <types>, if <types> - // is an empty list the method returns *all* the current policies. + /// Obtain a single policy. CORBA::Policy_ptr get_policy (CORBA::PolicyType policy, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); - // Obtain a single policy. // = Direct accesors to the policy implementations, for speedy // lookups. @@ -141,9 +140,9 @@ private: ACE_UNIMPLEMENTED_FUNC (TAO_Policy_Manager_Impl operator=(const TAO_Policy_Manager_Impl&)) ACE_UNIMPLEMENTED_FUNC (TAO_Policy_Manager_Impl(const TAO_Policy_Manager_Impl&)) + /// Remove and destroy all the policy objects owned by this policy + /// manager. void cleanup_i (CORBA::Environment &ACE_TRY_ENV); - // Remove and destroy all the policy objects owned by this policy - // manager. private: // The known policies are kept as pointers to the implementation @@ -177,11 +176,11 @@ private: #endif /* TAO_HAS_RT_CORBA == 1 */ + /// Other policies that are not optimized for fast querying CORBA::PolicyList other_policies_; - // Other policies that are not optimized for fast querying + /// The number of non-nil policies CORBA::ULong count_; - // The number of non-nil policies }; // **************************************************************** @@ -191,14 +190,14 @@ class TAO_Export TAO_Policy_Manager : public TAO_Local_RefCounted_Object { public: + /// constructor TAO_Policy_Manager (void); - // constructor + /// Obtain a single policy. CORBA::Policy_ptr get_policy (CORBA::PolicyType policy, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); - // Obtain a single policy. // = The CORBA::PolicyManager operations @@ -245,11 +244,11 @@ public: #endif /* TAO_HAS_RT_CORBA == 1 */ private: + /// Protect access ACE_SYNCH_MUTEX mutex_; - // Protect access + /// The implementation. TAO_Policy_Manager_Impl impl_; - // The implementation. }; // **************************************************************** @@ -257,11 +256,11 @@ private: class TAO_Export TAO_Policy_Current_Impl { public: + /// Obtain a single policy. CORBA::Policy_ptr get_policy (CORBA::PolicyType policy, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); - // Obtain a single policy. // = The CORBA::PolicyManager operations @@ -300,8 +299,8 @@ public: #endif /* TAO_HAS_RT_CORBA == 1 */ private: + /// The implementation. TAO_Policy_Manager_Impl manager_impl_; - // The implementation. }; // **************************************************************** @@ -311,15 +310,15 @@ class TAO_Export TAO_Policy_Current : public TAO_Local_RefCounted_Object { public: + /// Constructor TAO_Policy_Current (void); - // Constructor + /// Obtain a single policy. CORBA::Policy_ptr get_policy ( CORBA::PolicyType policy, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); - // Obtain a single policy. // = The CORBA::PolicyManager operations diff --git a/TAO/tao/Pool_Per_Endpoint.h b/TAO/tao/Pool_Per_Endpoint.h index ea8265c3bde..e6b03aabac6 100644 --- a/TAO/tao/Pool_Per_Endpoint.h +++ b/TAO/tao/Pool_Per_Endpoint.h @@ -1,17 +1,14 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Pool_Per_Endpoint.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file Pool_Per_Endpoint.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_POOL_PER_ENDPOINT_H #define TAO_POOL_PER_ENDPOINT_H @@ -26,51 +23,52 @@ #include "ace/Task.h" +/** + * @class TAO_Pool_Per_Endpoint + * + * @brief The Pool_Per_Endpoint concurrency strategy. + * + * This strategy creates a separate thread pool for each endpoint + * in the system. It is a helper class to manage and create the + * required threads. + * It should be used with the Reactor_Per_Endpoint registry + * configured. + */ class TAO_Export TAO_Pool_Per_Endpoint : public ACE_Task_Base { - // = TITLE - // The Pool_Per_Endpoint concurrency strategy. - // - // = DESCRIPTION - // This strategy creates a separate thread pool for each endpoint - // in the system. It is a helper class to manage and create the - // required threads. - // It should be used with the Reactor_Per_Endpoint registry - // configured. - // public: + /// Constructor TAO_Pool_Per_Endpoint (CORBA::ORB_ptr orb, int policy = ACE_SCHED_OTHER, int poolsize = 1, int flags = THR_BOUND|THR_NEW_LWP|THR_JOINABLE); - // Constructor + /// The destructor virtual ~TAO_Pool_Per_Endpoint (void); - // The destructor + /// Run all the threads and wait until they finish void run (CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Run all the threads and wait until they finish // = The Task_Base entry point int svc (void); private: + /// The ORB. CORBA::ORB_var orb_; - // The ORB. + /// The scheduling policy to activate the threads. int policy_; - // The scheduling policy to activate the threads. + /// The number of threads on each pool. int poolsize_; - // The number of threads on each pool. + /// The flags used to create the threads int flags_; - // The flags used to create the threads + /// The thread manager. ACE_Thread_Manager thread_manager_; - // The thread manager. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/PortableInterceptor.h b/TAO/tao/PortableInterceptor.h index b365ad4fe0b..32f4802e086 100644 --- a/TAO/tao/PortableInterceptor.h +++ b/TAO/tao/PortableInterceptor.h @@ -1,30 +1,27 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ======================================================================== -// -// = LIBRARY -// TAO -// -// = FILENAME -// PortableInterceptor.h -// -// = DESCRIPTION -// This file contains two helper classes to simplify the support of -// interceptors in tao_idl generated code. All the helper classes -// implementations are in PortableInterceptor.i file. -// -// A series of TAO_INTERCEPTOR* macros are also defined in the file. -// These macros allows us to disable/enable support of interceptors -// easily. -// -// -// = AUTHOR -// Nanbor Wang <nanbor@cs.wustl.edu> -// Kirthika Parameswaran <kirthika@cs.wustl.edu> -// Ossama Othman <ossama@uci.edu> -// -// ======================================================================== + +//============================================================================= +/** + * @file PortableInterceptor.h + * + * $Id$ + * + * This file contains two helper classes to simplify the support of + * interceptors in tao_idl generated code. All the helper classes + * implementations are in PortableInterceptor.i file. + * + * A series of TAO_INTERCEPTOR* macros are also defined in the file. + * These macros allows us to disable/enable support of interceptors + * easily. + * + * + * + * @author Nanbor Wang <nanbor@cs.wustl.edu> + * @author Kirthika Parameswaran <kirthika@cs.wustl.edu> + * @author Ossama Othman <ossama@uci.edu> + */ +//============================================================================= + #ifndef TAO_PORTABLE_INTERCEPTOR_H #define TAO_PORTABLE_INTERCEPTOR_H @@ -56,14 +53,16 @@ #include "tao/PortableInterceptorC.h" #include "tao/Interceptor_List.h" +/** + * @class TAO_ClientRequestInterceptor_Adapter + * + * @brief TAO_ClientRequestInterceptor_Adapter + * + * A convenient helper class to invoke registered client request + * interceptor(s) in tao_idl generated code. + */ class TAO_Export TAO_ClientRequestInterceptor_Adapter { - // = TITLE - // TAO_ClientRequestInterceptor_Adapter - // - // = DESCRIPTION - // A convenient helper class to invoke registered client request - // interceptor(s) in tao_idl generated code. public: @@ -72,9 +71,9 @@ public: ~TAO_ClientRequestInterceptor_Adapter (void); + //@{ + /// @name PortableInterceptor Client Side Interception Points /** - * @name PortableInterceptor Client Side Interception Points - * * Each of these methods corresponds to a client side interception * point. There are no "intermediate" interception points on the * client side, only "starting" and "ending" interception points. @@ -83,7 +82,7 @@ public: * The "send_poll()" and "receive_other()" PortableInterceptor * interception points are missing. */ - //@{ + /// This method implements one of the "starting" client side /// interception points. void send_request (PortableInterceptor::ClientRequestInfo_ptr ri, @@ -124,14 +123,16 @@ private: }; +/** + * @class TAO_ServerRequestInterceptor_Adapter + * + * @brief TAO_ServerRequestInterceptor_Adapter + * + * A convenient helper class to invoke registered server request + * interceptor(s) in tao_idl generated code. + */ class TAO_Export TAO_ServerRequestInterceptor_Adapter { - // = TITLE - // TAO_ServerRequestInterceptor_Adapter - // - // = DESCRIPTION - // A convenient helper class to invoke registered server request - // interceptor(s) in tao_idl generated code. public: @@ -140,6 +141,7 @@ public: ~TAO_ServerRequestInterceptor_Adapter (void); + ///@{ /** * @name PortableInterceptor Client Side Interception Points * @@ -150,7 +152,6 @@ public: * The "receive_request_service_contexts()" and "send_other()" * PortableInterceptor interception points are missing. */ - //@{ /** * This method implements the "starting" server side interception * point. diff --git a/TAO/tao/PortableInterceptorC.h b/TAO/tao/PortableInterceptorC.h index a6db12b1ff6..4a424a219f4 100644 --- a/TAO/tao/PortableInterceptorC.h +++ b/TAO/tao/PortableInterceptorC.h @@ -61,7 +61,7 @@ TAO_NAMESPACE PortableInterceptor class Interceptor; typedef Interceptor *Interceptor_ptr; - + #endif /* end #if !defined */ @@ -72,17 +72,17 @@ TAO_NAMESPACE PortableInterceptor { public: Interceptor_var (void); // default constructor - Interceptor_var (Interceptor_ptr p) : ptr_ (p) {} + Interceptor_var (Interceptor_ptr p) : ptr_ (p) {} Interceptor_var (const Interceptor_var &); // copy constructor ~Interceptor_var (void); // destructor - + Interceptor_var &operator= (Interceptor_ptr); Interceptor_var &operator= (const Interceptor_var &); Interceptor_ptr operator-> (void) const; - + operator const Interceptor_ptr &() const; operator Interceptor_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn Interceptor_ptr in (void) const; Interceptor_ptr &inout (void); Interceptor_ptr &out (void); @@ -115,7 +115,7 @@ TAO_NAMESPACE PortableInterceptor operator Interceptor_ptr &(); Interceptor_ptr &ptr (void); Interceptor_ptr operator-> (void); - + private: Interceptor_ptr &ptr_; }; @@ -139,12 +139,12 @@ class TAO_Export Interceptor : public virtual CORBA_Object static Interceptor_ptr _duplicate (Interceptor_ptr obj); static Interceptor_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static Interceptor_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static Interceptor_ptr _nil (void) @@ -160,7 +160,7 @@ class TAO_Export Interceptor : public virtual CORBA_Object )) = 0; virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; protected: @@ -186,36 +186,36 @@ class TAO_Export Interceptor : public virtual CORBA_Object ForwardRequest (void); // Default constructor. - + ForwardRequest (const ForwardRequest &); // Copy constructor. - + ~ForwardRequest (void); // Destructor. - + static void _tao_any_destructor (void*); - + ForwardRequest &operator= (const ForwardRequest &); - + virtual void _raise (void); virtual void _tao_encode ( TAO_OutputCDR &, CORBA::Environment & ) const; - + virtual void _tao_decode ( TAO_InputCDR &, CORBA::Environment & ); - + static ForwardRequest *_downcast (CORBA::Exception *); ForwardRequest ( const CORBA::Object_ptr _tao_forward, CORBA::Boolean _tao_permanent ); - + // = TAO extension. static CORBA::Exception *_alloc (void); virtual CORBA::TypeCode_ptr _type (void) const; @@ -256,29 +256,29 @@ class TAO_Export Interceptor : public virtual CORBA_Object InvalidSlot (void); // Default constructor. - + InvalidSlot (const InvalidSlot &); // Copy constructor. - + ~InvalidSlot (void); // Destructor. - + static void _tao_any_destructor (void*); - + InvalidSlot &operator= (const InvalidSlot &); - + virtual void _raise (void); virtual void _tao_encode ( TAO_OutputCDR &, CORBA::Environment & ) const; - + virtual void _tao_decode ( TAO_InputCDR &, CORBA::Environment & ); - + static InvalidSlot *_downcast (CORBA::Exception *); @@ -298,7 +298,7 @@ class TAO_Export Interceptor : public virtual CORBA_Object class Current; typedef Current *Current_ptr; - + #endif /* end #if !defined */ @@ -309,17 +309,17 @@ class TAO_Export Interceptor : public virtual CORBA_Object { public: Current_var (void); // default constructor - Current_var (Current_ptr p) : ptr_ (p) {} + Current_var (Current_ptr p) : ptr_ (p) {} Current_var (const Current_var &); // copy constructor ~Current_var (void); // destructor - + Current_var &operator= (Current_ptr); Current_var &operator= (const Current_var &); Current_ptr operator-> (void) const; - + operator const Current_ptr &() const; operator Current_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn Current_ptr in (void) const; Current_ptr &inout (void); Current_ptr &out (void); @@ -352,7 +352,7 @@ class TAO_Export Interceptor : public virtual CORBA_Object operator Current_ptr &(); Current_ptr &ptr (void); Current_ptr operator-> (void); - + private: Current_ptr &ptr_; }; @@ -376,12 +376,12 @@ class TAO_Export Current: public virtual CORBA::Current static Current_ptr _duplicate (Current_ptr obj); static Current_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static Current_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static Current_ptr _nil (void) @@ -391,7 +391,7 @@ class TAO_Export Current: public virtual CORBA::Current virtual CORBA::Any * get_slot ( PortableInterceptor::SlotId id, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -402,7 +402,7 @@ class TAO_Export Current: public virtual CORBA::Current virtual void set_slot ( PortableInterceptor::SlotId id, const CORBA::Any & data, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -411,7 +411,7 @@ class TAO_Export Current: public virtual CORBA::Current )) = 0; virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; protected: @@ -431,7 +431,7 @@ class TAO_Export Current: public virtual CORBA::Current class RequestInfo; typedef RequestInfo *RequestInfo_ptr; - + #endif /* end #if !defined */ @@ -442,17 +442,17 @@ class TAO_Export Current: public virtual CORBA::Current { public: RequestInfo_var (void); // default constructor - RequestInfo_var (RequestInfo_ptr p) : ptr_ (p) {} + RequestInfo_var (RequestInfo_ptr p) : ptr_ (p) {} RequestInfo_var (const RequestInfo_var &); // copy constructor ~RequestInfo_var (void); // destructor - + RequestInfo_var &operator= (RequestInfo_ptr); RequestInfo_var &operator= (const RequestInfo_var &); RequestInfo_ptr operator-> (void) const; - + operator const RequestInfo_ptr &() const; operator RequestInfo_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn RequestInfo_ptr in (void) const; RequestInfo_ptr &inout (void); RequestInfo_ptr &out (void); @@ -485,7 +485,7 @@ class TAO_Export Current: public virtual CORBA::Current operator RequestInfo_ptr &(); RequestInfo_ptr &ptr (void); RequestInfo_ptr operator-> (void); - + private: RequestInfo_ptr &ptr_; }; @@ -509,12 +509,12 @@ class TAO_Export RequestInfo : public virtual CORBA_Object static RequestInfo_ptr _duplicate (RequestInfo_ptr obj); static RequestInfo_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static RequestInfo_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static RequestInfo_ptr _nil (void) @@ -523,7 +523,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object } virtual CORBA::ULong request_id ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -531,7 +531,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object )) = 0; virtual char * operation ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -539,7 +539,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object )) = 0; virtual Dynamic::ParameterList * arguments ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -547,7 +547,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object )) = 0; virtual Dynamic::ExceptionList * exceptions ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -555,7 +555,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object )) = 0; virtual Dynamic::ContextList * contexts ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -563,7 +563,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object )) = 0; virtual Dynamic::RequestContext * operation_context ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -571,7 +571,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object )) = 0; virtual CORBA::Any * result ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -579,7 +579,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object )) = 0; virtual CORBA::Boolean response_expected ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -589,7 +589,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object #if (TAO_HAS_CORBA_MESSAGING == 1) virtual Messaging::SyncScope sync_scope ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -599,7 +599,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object #endif /* TAO_HAS_CORBA_MESSAGING == 1 */ virtual PortableInterceptor::ReplyStatus reply_status ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -607,7 +607,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object )) = 0; virtual CORBA::Object_ptr forward_reference ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -616,7 +616,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object virtual CORBA::Any * get_slot ( PortableInterceptor::SlotId id, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -626,7 +626,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object virtual IOP::ServiceContext * get_request_service_context ( IOP::ServiceId id, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -635,7 +635,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object virtual IOP::ServiceContext * get_reply_service_context ( IOP::ServiceId id, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -643,7 +643,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object )) = 0; virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; protected: @@ -663,7 +663,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object class ClientRequestInfo; typedef ClientRequestInfo *ClientRequestInfo_ptr; - + #endif /* end #if !defined */ @@ -674,17 +674,17 @@ class TAO_Export RequestInfo : public virtual CORBA_Object { public: ClientRequestInfo_var (void); // default constructor - ClientRequestInfo_var (ClientRequestInfo_ptr p) : ptr_ (p) {} + ClientRequestInfo_var (ClientRequestInfo_ptr p) : ptr_ (p) {} ClientRequestInfo_var (const ClientRequestInfo_var &); // copy constructor ~ClientRequestInfo_var (void); // destructor - + ClientRequestInfo_var &operator= (ClientRequestInfo_ptr); ClientRequestInfo_var &operator= (const ClientRequestInfo_var &); ClientRequestInfo_ptr operator-> (void) const; - + operator const ClientRequestInfo_ptr &() const; operator ClientRequestInfo_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn ClientRequestInfo_ptr in (void) const; ClientRequestInfo_ptr &inout (void); ClientRequestInfo_ptr &out (void); @@ -717,7 +717,7 @@ class TAO_Export RequestInfo : public virtual CORBA_Object operator ClientRequestInfo_ptr &(); ClientRequestInfo_ptr &ptr (void); ClientRequestInfo_ptr operator-> (void); - + private: ClientRequestInfo_ptr &ptr_; }; @@ -741,12 +741,12 @@ class TAO_Export ClientRequestInfo: public virtual RequestInfo static ClientRequestInfo_ptr _duplicate (ClientRequestInfo_ptr obj); static ClientRequestInfo_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static ClientRequestInfo_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static ClientRequestInfo_ptr _nil (void) @@ -755,7 +755,7 @@ class TAO_Export ClientRequestInfo: public virtual RequestInfo } virtual CORBA::Object_ptr target ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -763,7 +763,7 @@ class TAO_Export ClientRequestInfo: public virtual RequestInfo )) = 0; virtual CORBA::Object_ptr effective_target ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -771,7 +771,7 @@ class TAO_Export ClientRequestInfo: public virtual RequestInfo )) = 0; virtual IOP::TaggedProfile * effective_profile ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -779,7 +779,7 @@ class TAO_Export ClientRequestInfo: public virtual RequestInfo )) = 0; virtual CORBA::Any * received_exception ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -787,7 +787,7 @@ class TAO_Export ClientRequestInfo: public virtual RequestInfo )) = 0; virtual char * received_exception_id ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -820,7 +820,7 @@ class TAO_Export ClientRequestInfo: public virtual RequestInfo )) = 0; virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; protected: @@ -840,7 +840,7 @@ class TAO_Export ClientRequestInfo: public virtual RequestInfo class ServerRequestInfo; typedef ServerRequestInfo *ServerRequestInfo_ptr; - + #endif /* end #if !defined */ @@ -851,17 +851,17 @@ class TAO_Export ClientRequestInfo: public virtual RequestInfo { public: ServerRequestInfo_var (void); // default constructor - ServerRequestInfo_var (ServerRequestInfo_ptr p) : ptr_ (p) {} + ServerRequestInfo_var (ServerRequestInfo_ptr p) : ptr_ (p) {} ServerRequestInfo_var (const ServerRequestInfo_var &); // copy constructor ~ServerRequestInfo_var (void); // destructor - + ServerRequestInfo_var &operator= (ServerRequestInfo_ptr); ServerRequestInfo_var &operator= (const ServerRequestInfo_var &); ServerRequestInfo_ptr operator-> (void) const; - + operator const ServerRequestInfo_ptr &() const; operator ServerRequestInfo_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn ServerRequestInfo_ptr in (void) const; ServerRequestInfo_ptr &inout (void); ServerRequestInfo_ptr &out (void); @@ -894,7 +894,7 @@ class TAO_Export ClientRequestInfo: public virtual RequestInfo operator ServerRequestInfo_ptr &(); ServerRequestInfo_ptr &ptr (void); ServerRequestInfo_ptr operator-> (void); - + private: ServerRequestInfo_ptr &ptr_; }; @@ -918,12 +918,12 @@ class TAO_Export ServerRequestInfo: public virtual RequestInfo static ServerRequestInfo_ptr _duplicate (ServerRequestInfo_ptr obj); static ServerRequestInfo_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static ServerRequestInfo_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static ServerRequestInfo_ptr _nil (void) @@ -995,7 +995,7 @@ class TAO_Export ServerRequestInfo: public virtual RequestInfo )) = 0; virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; protected: @@ -1015,7 +1015,7 @@ class TAO_Export ServerRequestInfo: public virtual RequestInfo class ClientRequestInterceptor; typedef ClientRequestInterceptor *ClientRequestInterceptor_ptr; - + #endif /* end #if !defined */ @@ -1026,17 +1026,17 @@ class TAO_Export ServerRequestInfo: public virtual RequestInfo { public: ClientRequestInterceptor_var (void); // default constructor - ClientRequestInterceptor_var (ClientRequestInterceptor_ptr p) : ptr_ (p) {} + ClientRequestInterceptor_var (ClientRequestInterceptor_ptr p) : ptr_ (p) {} ClientRequestInterceptor_var (const ClientRequestInterceptor_var &); // copy constructor ~ClientRequestInterceptor_var (void); // destructor - + ClientRequestInterceptor_var &operator= (ClientRequestInterceptor_ptr); ClientRequestInterceptor_var &operator= (const ClientRequestInterceptor_var &); ClientRequestInterceptor_ptr operator-> (void) const; - + operator const ClientRequestInterceptor_ptr &() const; operator ClientRequestInterceptor_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn ClientRequestInterceptor_ptr in (void) const; ClientRequestInterceptor_ptr &inout (void); ClientRequestInterceptor_ptr &out (void); @@ -1069,7 +1069,7 @@ class TAO_Export ServerRequestInfo: public virtual RequestInfo operator ClientRequestInterceptor_ptr &(); ClientRequestInterceptor_ptr &ptr (void); ClientRequestInterceptor_ptr operator-> (void); - + private: ClientRequestInterceptor_ptr &ptr_; }; @@ -1093,12 +1093,12 @@ class TAO_Export ClientRequestInterceptor: public virtual Interceptor static ClientRequestInterceptor_ptr _duplicate (ClientRequestInterceptor_ptr obj); static ClientRequestInterceptor_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static ClientRequestInterceptor_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static ClientRequestInterceptor_ptr _nil (void) @@ -1117,7 +1117,7 @@ class TAO_Export ClientRequestInterceptor: public virtual Interceptor virtual void send_poll ( PortableInterceptor::ClientRequestInfo_ptr ri - TAO_ENV_ARG_DECL_WITH_DEFAULTS + TAO_ENV_ARG_DECL_WITH_DEFAULTS ) ACE_THROW_SPEC (( CORBA::SystemException @@ -1150,7 +1150,7 @@ class TAO_Export ClientRequestInterceptor: public virtual Interceptor )) = 0; virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; protected: @@ -1170,7 +1170,7 @@ class TAO_Export ClientRequestInterceptor: public virtual Interceptor class ServerRequestInterceptor; typedef ServerRequestInterceptor *ServerRequestInterceptor_ptr; - + #endif /* end #if !defined */ @@ -1181,17 +1181,17 @@ class TAO_Export ClientRequestInterceptor: public virtual Interceptor { public: ServerRequestInterceptor_var (void); // default constructor - ServerRequestInterceptor_var (ServerRequestInterceptor_ptr p) : ptr_ (p) {} + ServerRequestInterceptor_var (ServerRequestInterceptor_ptr p) : ptr_ (p) {} ServerRequestInterceptor_var (const ServerRequestInterceptor_var &); // copy constructor ~ServerRequestInterceptor_var (void); // destructor - + ServerRequestInterceptor_var &operator= (ServerRequestInterceptor_ptr); ServerRequestInterceptor_var &operator= (const ServerRequestInterceptor_var &); ServerRequestInterceptor_ptr operator-> (void) const; - + operator const ServerRequestInterceptor_ptr &() const; operator ServerRequestInterceptor_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn ServerRequestInterceptor_ptr in (void) const; ServerRequestInterceptor_ptr &inout (void); ServerRequestInterceptor_ptr &out (void); @@ -1224,7 +1224,7 @@ class TAO_Export ClientRequestInterceptor: public virtual Interceptor operator ServerRequestInterceptor_ptr &(); ServerRequestInterceptor_ptr &ptr (void); ServerRequestInterceptor_ptr operator-> (void); - + private: ServerRequestInterceptor_ptr &ptr_; }; @@ -1248,12 +1248,12 @@ class TAO_Export ServerRequestInterceptor: public virtual Interceptor static ServerRequestInterceptor_ptr _duplicate (ServerRequestInterceptor_ptr obj); static ServerRequestInterceptor_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static ServerRequestInterceptor_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static ServerRequestInterceptor_ptr _nil (void) @@ -1298,7 +1298,7 @@ class TAO_Export ServerRequestInterceptor: public virtual Interceptor virtual void send_other ( PortableInterceptor::ServerRequestInfo_ptr ri - TAO_ENV_ARG_DECL_WITH_DEFAULTS + TAO_ENV_ARG_DECL_WITH_DEFAULTS ) ACE_THROW_SPEC (( CORBA::SystemException, @@ -1306,7 +1306,7 @@ class TAO_Export ServerRequestInterceptor: public virtual Interceptor )) = 0; virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; protected: @@ -1326,7 +1326,7 @@ class TAO_Export ServerRequestInterceptor: public virtual Interceptor class IORInfo; typedef IORInfo *IORInfo_ptr; - + #endif /* end #if !defined */ @@ -1337,17 +1337,17 @@ class TAO_Export ServerRequestInterceptor: public virtual Interceptor { public: IORInfo_var (void); // default constructor - IORInfo_var (IORInfo_ptr p) : ptr_ (p) {} + IORInfo_var (IORInfo_ptr p) : ptr_ (p) {} IORInfo_var (const IORInfo_var &); // copy constructor ~IORInfo_var (void); // destructor - + IORInfo_var &operator= (IORInfo_ptr); IORInfo_var &operator= (const IORInfo_var &); IORInfo_ptr operator-> (void) const; - + operator const IORInfo_ptr &() const; operator IORInfo_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IORInfo_ptr in (void) const; IORInfo_ptr &inout (void); IORInfo_ptr &out (void); @@ -1380,7 +1380,7 @@ class TAO_Export ServerRequestInterceptor: public virtual Interceptor operator IORInfo_ptr &(); IORInfo_ptr &ptr (void); IORInfo_ptr operator-> (void); - + private: IORInfo_ptr &ptr_; }; @@ -1404,12 +1404,12 @@ class TAO_Export IORInfo : public virtual CORBA_Object static IORInfo_ptr _duplicate (IORInfo_ptr obj); static IORInfo_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IORInfo_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IORInfo_ptr _nil (void) @@ -1443,7 +1443,7 @@ class TAO_Export IORInfo : public virtual CORBA_Object )) = 0; virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; protected: @@ -1463,7 +1463,7 @@ class TAO_Export IORInfo : public virtual CORBA_Object class IORInterceptor; typedef IORInterceptor *IORInterceptor_ptr; - + #endif /* end #if !defined */ @@ -1474,17 +1474,17 @@ class TAO_Export IORInfo : public virtual CORBA_Object { public: IORInterceptor_var (void); // default constructor - IORInterceptor_var (IORInterceptor_ptr p) : ptr_ (p) {} + IORInterceptor_var (IORInterceptor_ptr p) : ptr_ (p) {} IORInterceptor_var (const IORInterceptor_var &); // copy constructor ~IORInterceptor_var (void); // destructor - + IORInterceptor_var &operator= (IORInterceptor_ptr); IORInterceptor_var &operator= (const IORInterceptor_var &); IORInterceptor_ptr operator-> (void) const; - + operator const IORInterceptor_ptr &() const; operator IORInterceptor_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn IORInterceptor_ptr in (void) const; IORInterceptor_ptr &inout (void); IORInterceptor_ptr &out (void); @@ -1517,7 +1517,7 @@ class TAO_Export IORInfo : public virtual CORBA_Object operator IORInterceptor_ptr &(); IORInterceptor_ptr &ptr (void); IORInterceptor_ptr operator-> (void); - + private: IORInterceptor_ptr &ptr_; }; @@ -1541,12 +1541,12 @@ class TAO_Export IORInterceptor: public virtual Interceptor static IORInterceptor_ptr _duplicate (IORInterceptor_ptr obj); static IORInterceptor_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IORInterceptor_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static IORInterceptor_ptr _nil (void) @@ -1563,7 +1563,7 @@ class TAO_Export IORInterceptor: public virtual Interceptor )) = 0; virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; protected: @@ -1583,7 +1583,7 @@ class TAO_Export IORInterceptor: public virtual Interceptor class PolicyFactory; typedef PolicyFactory *PolicyFactory_ptr; - + #endif /* end #if !defined */ @@ -1594,17 +1594,17 @@ class TAO_Export IORInterceptor: public virtual Interceptor { public: PolicyFactory_var (void); // default constructor - PolicyFactory_var (PolicyFactory_ptr p) : ptr_ (p) {} + PolicyFactory_var (PolicyFactory_ptr p) : ptr_ (p) {} PolicyFactory_var (const PolicyFactory_var &); // copy constructor ~PolicyFactory_var (void); // destructor - + PolicyFactory_var &operator= (PolicyFactory_ptr); PolicyFactory_var &operator= (const PolicyFactory_var &); PolicyFactory_ptr operator-> (void) const; - + operator const PolicyFactory_ptr &() const; operator PolicyFactory_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn PolicyFactory_ptr in (void) const; PolicyFactory_ptr &inout (void); PolicyFactory_ptr &out (void); @@ -1637,7 +1637,7 @@ class TAO_Export IORInterceptor: public virtual Interceptor operator PolicyFactory_ptr &(); PolicyFactory_ptr &ptr (void); PolicyFactory_ptr operator-> (void); - + private: PolicyFactory_ptr &ptr_; }; @@ -1661,12 +1661,12 @@ class TAO_Export PolicyFactory : public virtual CORBA_Object static PolicyFactory_ptr _duplicate (PolicyFactory_ptr obj); static PolicyFactory_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static PolicyFactory_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static PolicyFactory_ptr _nil (void) @@ -1685,7 +1685,7 @@ class TAO_Export PolicyFactory : public virtual CORBA_Object )) = 0; virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; protected: @@ -1705,7 +1705,7 @@ class TAO_Export PolicyFactory : public virtual CORBA_Object class ORBInitInfo; typedef ORBInitInfo *ORBInitInfo_ptr; - + #endif /* end #if !defined */ @@ -1716,17 +1716,17 @@ class TAO_Export PolicyFactory : public virtual CORBA_Object { public: ORBInitInfo_var (void); // default constructor - ORBInitInfo_var (ORBInitInfo_ptr p) : ptr_ (p) {} + ORBInitInfo_var (ORBInitInfo_ptr p) : ptr_ (p) {} ORBInitInfo_var (const ORBInitInfo_var &); // copy constructor ~ORBInitInfo_var (void); // destructor - + ORBInitInfo_var &operator= (ORBInitInfo_ptr); ORBInitInfo_var &operator= (const ORBInitInfo_var &); ORBInitInfo_ptr operator-> (void) const; - + operator const ORBInitInfo_ptr &() const; operator ORBInitInfo_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn ORBInitInfo_ptr in (void) const; ORBInitInfo_ptr &inout (void); ORBInitInfo_ptr &out (void); @@ -1759,7 +1759,7 @@ class TAO_Export PolicyFactory : public virtual CORBA_Object operator ORBInitInfo_ptr &(); ORBInitInfo_ptr &ptr (void); ORBInitInfo_ptr operator-> (void); - + private: ORBInitInfo_ptr &ptr_; }; @@ -1783,12 +1783,12 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object static ORBInitInfo_ptr _duplicate (ORBInitInfo_ptr obj); static ORBInitInfo_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static ORBInitInfo_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static ORBInitInfo_ptr _nil (void) @@ -1799,7 +1799,7 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object typedef char * ObjectId; typedef CORBA::String_var ObjectId_var; typedef CORBA::String_out ObjectId_out; - + #if !defined (_PORTABLEINTERCEPTOR_ORBINITINFO_DUPLICATENAME_CH_) #define _PORTABLEINTERCEPTOR_ORBINITINFO_DUPLICATENAME_CH_ @@ -1810,33 +1810,33 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object DuplicateName (void); // Default constructor. - + DuplicateName (const DuplicateName &); // Copy constructor. - + ~DuplicateName (void); // Destructor. - + DuplicateName &operator= (const DuplicateName &); - + virtual void _raise (void); virtual void _tao_encode ( TAO_OutputCDR &, CORBA::Environment & ) const; - + virtual void _tao_decode ( TAO_InputCDR &, CORBA::Environment & ); - + static DuplicateName *_downcast (CORBA::Exception *); DuplicateName ( const char * _tao_name ); - + // = TAO extension. static CORBA::Exception *_alloc (void); }; // Exception PortableInterceptor::ORBInitInfo::DuplicateName. @@ -1854,27 +1854,27 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object InvalidName (void); // Default constructor. - + InvalidName (const InvalidName &); // Copy constructor. - + ~InvalidName (void); // Destructor. - + InvalidName &operator= (const InvalidName &); - + virtual void _raise (void); virtual void _tao_encode ( TAO_OutputCDR &, CORBA::Environment & ) const; - + virtual void _tao_decode ( TAO_InputCDR &, CORBA::Environment & ); - + static InvalidName *_downcast (CORBA::Exception *); @@ -1886,7 +1886,7 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object #endif /* end #if !defined */ virtual CORBA::StringSeq * arguments ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -1894,7 +1894,7 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object )) = 0; virtual char * orb_id ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -1904,7 +1904,7 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object virtual void register_initial_reference ( const char * id, CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -1914,7 +1914,7 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object virtual CORBA::Object_ptr resolve_initial_references ( const char * id, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -1924,7 +1924,7 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object virtual void add_client_request_interceptor ( PortableInterceptor::ClientRequestInterceptor_ptr interceptor, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -1934,7 +1934,7 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object virtual void add_server_request_interceptor ( PortableInterceptor::ServerRequestInterceptor_ptr interceptor, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -1944,7 +1944,7 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object virtual void add_ior_interceptor ( PortableInterceptor::IORInterceptor_ptr interceptor, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -1953,7 +1953,7 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object )) = 0; virtual PortableInterceptor::SlotId allocate_slot_id ( - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -1963,7 +1963,7 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object virtual void register_policy_factory ( CORBA::PolicyType type, PortableInterceptor::PolicyFactory_ptr policy_factory, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ) ACE_THROW_SPEC (( @@ -1971,7 +1971,7 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object )) = 0; virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; protected: @@ -1991,7 +1991,7 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object class ORBInitializer; typedef ORBInitializer *ORBInitializer_ptr; - + #endif /* end #if !defined */ @@ -2002,17 +2002,17 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object { public: ORBInitializer_var (void); // default constructor - ORBInitializer_var (ORBInitializer_ptr p) : ptr_ (p) {} + ORBInitializer_var (ORBInitializer_ptr p) : ptr_ (p) {} ORBInitializer_var (const ORBInitializer_var &); // copy constructor ~ORBInitializer_var (void); // destructor - + ORBInitializer_var &operator= (ORBInitializer_ptr); ORBInitializer_var &operator= (const ORBInitializer_var &); ORBInitializer_ptr operator-> (void) const; - + operator const ORBInitializer_ptr &() const; operator ORBInitializer_ptr &(); - // in, inout, out, _retn + // in, inout, out, _retn ORBInitializer_ptr in (void) const; ORBInitializer_ptr &inout (void); ORBInitializer_ptr &out (void); @@ -2045,7 +2045,7 @@ class TAO_Export ORBInitInfo : public virtual CORBA_Object operator ORBInitializer_ptr &(); ORBInitializer_ptr &ptr (void); ORBInitializer_ptr operator-> (void); - + private: ORBInitializer_ptr &ptr_; }; @@ -2069,12 +2069,12 @@ class TAO_Export ORBInitializer : public virtual CORBA_Object static ORBInitializer_ptr _duplicate (ORBInitializer_ptr obj); static ORBInitializer_ptr _narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static ORBInitializer_ptr _unchecked_narrow ( CORBA::Object_ptr obj, - CORBA::Environment &ACE_TRY_ENV = + CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); static ORBInitializer_ptr _nil (void) @@ -2099,7 +2099,7 @@ class TAO_Export ORBInitializer : public virtual CORBA_Object )) = 0; virtual void *_tao_QueryInterface (ptr_arith_t type); - + virtual const char* _interface_repository_id (void) const; protected: diff --git a/TAO/tao/Principal.h b/TAO/tao/Principal.h index 955bd743f4c..29c2fb0fc9d 100644 --- a/TAO/tao/Principal.h +++ b/TAO/tao/Principal.h @@ -1,21 +1,18 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// principal.h -// -// = DESCRIPTION -// The CORBA_Principal pseudo-object implementation. -// -// = AUTHOR -// Copyright 1994-1995 by Sun Microsystems Inc. -// -// ============================================================================ + +//============================================================================= +/** + * @file Principal.h + * + * $Id$ + * + * The CORBA_Principal pseudo-object implementation. + * + * + * @author Copyright 1994-1995 by Sun Microsystems Inc. + */ +//============================================================================= + #ifndef TAO_PRINCIPAL_H #define TAO_PRINCIPAL_H @@ -29,13 +26,16 @@ #include "OctetSeqC.h" +/** + * @class CORBA_Principal + * + * @brief A "Principal" identifies an authenticated entity in the + * network administration framework. Identities are used to + * control acccess (authorization) as well as in audit trails + * (accountability). + */ class TAO_Export CORBA_Principal { - // = TITLE - // A "Principal" identifies an authenticated entity in the - // network administration framework. Identities are used to - // control acccess (authorization) as well as in audit trails - // (accountability). public: // To applications, the identifier is an opaque ID. @@ -68,12 +68,12 @@ private: CORBA_Principal (const CORBA::Principal_ptr &); private: + /// Number of outstanding references to this object. CORBA::ULong refcount_; - // Number of outstanding references to this object. + /// Protect the reference count, this is OK because we do no + /// duplicates or releases on the critical path. ACE_SYNCH_MUTEX refcount_mutex_; - // Protect the reference count, this is OK because we do no - // duplicates or releases on the critical path. #if defined (__GNUG__) // G++ (even 2.6.3) stupidly thinks instances can't be created. @@ -82,20 +82,20 @@ private: #endif /* __GNUG__ */ }; +/** + * @class CORBA_Principal_var + * + * @brief The T_var class for Principal + * + * As any other pseudo object Principal must have a T_var class, + * the interface an semantics are specified in the CORBA spec. + * = NOTE + * We use CORBA_Principal_ptr as the _ptr type instead of + * CORBA::Principal_ptr, this is an attempt to reduced the cyclic + * dependencies in TAO. + */ class TAO_Export CORBA_Principal_var { - // = TITLE - // The T_var class for Principal - // - // = DESCRIPTION - // As any other pseudo object Principal must have a T_var class, - // the interface an semantics are specified in the CORBA spec. - // - // = NOTE - // We use CORBA_Principal_ptr as the _ptr type instead of - // CORBA::Principal_ptr, this is an attempt to reduced the cyclic - // dependencies in TAO. - // public: CORBA_Principal_var (void); CORBA_Principal_var (CORBA_Principal_ptr); @@ -106,9 +106,9 @@ public: CORBA_Principal_var &operator= (const CORBA_Principal_var &); CORBA_Principal_ptr operator-> (void) const; + /// in, inout, out, _retn operator const CORBA_Principal_ptr &() const; operator CORBA_Principal_ptr &(); - // in, inout, out, _retn CORBA_Principal_ptr in (void) const; CORBA_Principal_ptr &inout (void); CORBA_Principal_ptr &out (void); @@ -119,20 +119,20 @@ private: CORBA_Principal_ptr ptr_; }; +/** + * @class CORBA_Principal_out + * + * @brief The T_out class for Principal + * + * As any other pseudo object Principal must have a T_out class, + * the interface an semantics are specified in the CORBA spec. + * = NOTE + * We use CORBA_Principal_ptr as the _ptr type instead of + * CORBA::Principal_ptr, this is an attempt to reduced the cyclic + * dependencies in TAO. + */ class TAO_Export CORBA_Principal_out { - // = TITLE - // The T_out class for Principal - // - // = DESCRIPTION - // As any other pseudo object Principal must have a T_out class, - // the interface an semantics are specified in the CORBA spec. - // - // = NOTE - // We use CORBA_Principal_ptr as the _ptr type instead of - // CORBA::Principal_ptr, this is an attempt to reduced the cyclic - // dependencies in TAO. - // public: CORBA_Principal_out (CORBA_Principal_ptr &); CORBA_Principal_out (CORBA_Principal_var &); diff --git a/TAO/tao/Priority_Mapping.h b/TAO/tao/Priority_Mapping.h index c5bede588ac..f1989cf7ff8 100644 --- a/TAO/tao/Priority_Mapping.h +++ b/TAO/tao/Priority_Mapping.h @@ -1,21 +1,18 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Priority_Mapping.h -// -// = DESCRIPTION -// Declares the Priority_Mapping interface, as defined in the -// RT-CORBA spec. -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// ============================================================================ +//============================================================================= +/** + * @file Priority_Mapping.h + * + * $Id$ + * + * Declares the Priority_Mapping interface, as defined in the + * RT-CORBA spec. + * + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_PRIORITY_MAPPING_H #define TAO_PRIORITY_MAPPING_H @@ -31,21 +28,21 @@ #include "tao/RTCORBAC.h" +/** + * @class TAO_Priority_Mapping + * + * @brief The interface for priority mapping. + * + * Check the RT-CORBA spec (orbos/99-02-12) secions 4.5.2 + */ class TAO_Export TAO_Priority_Mapping { - // - // = TITLE - // The interface for priority mapping. - // - // = DESCRIPTION - // Check the RT-CORBA spec (orbos/99-02-12) secions 4.5.2 - // public: + /// Default constructor TAO_Priority_Mapping (void); - // Default constructor + /// The destructor virtual ~TAO_Priority_Mapping (void); - // The destructor virtual CORBA::Boolean to_native (RTCORBA::Priority corba_priority, diff --git a/TAO/tao/Priority_Mapping_Manager.h b/TAO/tao/Priority_Mapping_Manager.h index 2c04a0df55d..eedfeee3a6e 100644 --- a/TAO/tao/Priority_Mapping_Manager.h +++ b/TAO/tao/Priority_Mapping_Manager.h @@ -1,21 +1,14 @@ /* -*- C++ -*- */ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = DESCRIPTION -// . -// -// = FILENAME -// Priority_Mapping_Manager.h -// -// = AUTHOR -// Marina Spivak (marina@cs.wustl.edu) -// -// ============================================================================ +//============================================================================= +/** + * @file Priority_Mapping_Manager.h + * + * $Id$ + * + * @author Marina Spivak (marina@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_PRIORITY_MAPPING_MANAGER_H #define TAO_PRIORITY_MAPPING_MANAGER_H @@ -56,19 +49,19 @@ class TAO_Export TAO_Priority_Mapping_Manager : // public: + /// Constructor. TAO_Priority_Mapping_Manager (void); - // Constructor. + /// Destructor. ~TAO_Priority_Mapping_Manager (void); - // Destructor. // = Interface methods. + /// void mapping (RTCORBA::PriorityMapping * mapping); - // + /// RTCORBA::PriorityMapping *mapping (void); - // public: #if !defined(__GNUC__) || !defined (ACE_HAS_GNUG_PRE_2_8) @@ -118,9 +111,9 @@ public: TAO_Priority_Mapping_Manager_var &operator= (const TAO_Priority_Mapping_Manager_var &); TAO_Priority_Mapping_Manager_ptr operator-> (void) const; + /// in, inout, out, _retn operator const TAO_Priority_Mapping_Manager_ptr &() const; operator TAO_Priority_Mapping_Manager_ptr &(); - // in, inout, out, _retn TAO_Priority_Mapping_Manager_ptr in (void) const; TAO_Priority_Mapping_Manager_ptr &inout (void); TAO_Priority_Mapping_Manager_ptr &out (void); @@ -128,8 +121,8 @@ public: TAO_Priority_Mapping_Manager_ptr ptr (void) const; private: + /// Unimplemented - prevents widening assignment. TAO_Priority_Mapping_Manager_ptr ptr_; - // Unimplemented - prevents widening assignment. TAO_Priority_Mapping_Manager_var (const TAO_Base_var &rhs); TAO_Priority_Mapping_Manager_var &operator= (const TAO_Base_var &rhs); }; diff --git a/TAO/tao/Private_Connection_Descriptor.h b/TAO/tao/Private_Connection_Descriptor.h index 8ed9447f9af..dd7138f789e 100644 --- a/TAO/tao/Private_Connection_Descriptor.h +++ b/TAO/tao/Private_Connection_Descriptor.h @@ -1,18 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Private_Connection_Descriptor.h -// -// = AUTHOR -// Marina Spivak <marina@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Private_Connection_Descriptor.h + * + * $Id$ + * + * @author Marina Spivak <marina@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_PRIVATE_CONNECTION_DESCRIPTOR_H #define TAO_PRIVATE_CONNECTION_DESCRIPTOR_H @@ -32,7 +29,7 @@ class TAO_Export TAO_Private_Connection_Descriptor: public TAO_Connection_Descriptor_Interface { // = TITLE - // Concrete connection descriptor. + // Concrete connection descriptor. // // = DESCRIPTION // @@ -52,7 +49,7 @@ public: // = Abstract TAO_Connection_Descriptor methods to be implemented by - // subclasses. + // subclasses. virtual TAO_Connection_Descriptor_Interface *duplicate (void); @@ -65,12 +62,14 @@ private: // Descriptor should not be copied, except using the <duplicate> method. ACE_UNIMPLEMENTED_FUNC (TAO_Private_Connection_Descriptor (const TAO_Private_Connection_Descriptor&)) - ACE_UNIMPLEMENTED_FUNC (void operator= (const TAO_Private_Connection_Descriptor&)) + ACE_UNIMPLEMENTED_FUNC (void operator= (const TAO_Private_Connection_Descriptor&)) + /** + * Unique identifier of the object to which private connection + * identified with this descriptor belongs. The value of + * <object_id_> is the TAO_Stub* of the object. + */ long object_id_; - // Unique identifier of the object to which private connection - // identified with this descriptor belongs. The value of - // <object_id_> is the TAO_Stub* of the object. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/Profile.h b/TAO/tao/Profile.h index 963b835aba4..992a2338d27 100644 --- a/TAO/tao/Profile.h +++ b/TAO/tao/Profile.h @@ -1,18 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Profile.h -// -// = AUTHOR -// Fred Kuhns <fredk@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Profile.h + * + * $Id$ + * + * @author Fred Kuhns <fredk@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_PROFILE_H #define TAO_PROFILE_H @@ -33,129 +30,138 @@ class TAO_Stub; class TAO_Endpoint; class TAO_ORB_Core; +/** + * @class TAO_Profile + * + * @brief Defines the Profile interface + * + * An abstract base class for representing object location + * information. This is based on the CORBA IOR definitions. + */ class TAO_Export TAO_Profile { - // = TITLE - // Defines the Profile interface - // - // = DESCRIPTION - // An abstract base class for representing object location - // information. This is based on the CORBA IOR definitions. - // public: + /// Constructor TAO_Profile (CORBA::ULong tag, TAO_ORB_Core *orb_core, const TAO_GIOP_Version &version); - // Constructor + /// If you have a virtual method you need a virtual dtor. virtual ~TAO_Profile (void); - // If you have a virtual method you need a virtual dtor. + /// The tag, each concrete class will have a specific tag value. CORBA::ULong tag (void) const; - // The tag, each concrete class will have a specific tag value. + /// Return a pointer to this profile's version. This object + /// maintains ownership. const TAO_GIOP_Version &version (void) const; - // Return a pointer to this profile's version. This object - // maintains ownership. + /// Get a poiter to the TAO_ORB_Core TAO_ORB_Core *orb_core (void) const; - // Get a poiter to the TAO_ORB_Core + /// Increase the reference count by one on this object. CORBA::ULong _incr_refcnt (void); - // Increase the reference count by one on this object. + /// Decrement the object's reference count. When this count goes to + /// 0 this object will be deleted. CORBA::ULong _decr_refcnt (void); - // Decrement the object's reference count. When this count goes to - // 0 this object will be deleted. + /// Keep a pointer to the forwarded profile void forward_to (TAO_MProfile *mprofiles); - // Keep a pointer to the forwarded profile + /// MProfile accessor TAO_MProfile* forward_to (void); - // MProfile accessor + /// Access the tagged components, notice that they they could be + /// empty (or ignored) for non-GIOP protocols (and even for GIOP-1.0) const TAO_Tagged_Components& tagged_components (void) const; TAO_Tagged_Components& tagged_components (void); - // Access the tagged components, notice that they they could be - // empty (or ignored) for non-GIOP protocols (and even for GIOP-1.0) /// Add the given tagged component to the profile. void add_tagged_component (const IOP::TaggedComponent &component, CORBA::Environment &ACE_TRY_ENV); + /// The object key delimiter. virtual char object_key_delimiter (void) const = 0; - // The object key delimiter. + /// Initialize this object using the given input string. + /// Supports URL style of object references virtual int parse_string (const char *string, CORBA::Environment &ACE_TRY_ENV) = 0; - // Initialize this object using the given input string. - // Supports URL style of object references + /// Return a string representation for this profile. client must + /// deallocate memory. virtual char* to_string (CORBA::Environment &ACE_TRY_ENV) = 0; - // Return a string representation for this profile. client must - // deallocate memory. + /// Initialize this object using the given CDR octet string. virtual int decode (TAO_InputCDR& cdr) = 0; - // Initialize this object using the given CDR octet string. + /// Encode this profile in a stream, i.e. marshal it. virtual int encode (TAO_OutputCDR &stream) const = 0; - // Encode this profile in a stream, i.e. marshal it. + /** + * Encodes this profile's endpoints into a tagged component. + * This is done only if RTCORBA is enabled, since currently this is + * the only case when we have more than one endpoint per profile. + */ virtual int encode_endpoints (void) = 0; - // Encodes this profile's endpoints into a tagged component. - // This is done only if RTCORBA is enabled, since currently this is - // the only case when we have more than one endpoint per profile. + /// @@ deprecated. return a reference to the Object Key. virtual const TAO_ObjectKey &object_key (void) const = 0; - // @@ deprecated. return a reference to the Object Key. + /// Obtain the object key, return 0 if the profile cannot be parsed. + /// The memory is owned by the caller! virtual TAO_ObjectKey *_key (void) const = 0; - // Obtain the object key, return 0 if the profile cannot be parsed. - // The memory is owned by the caller! + /** + * Return pointer to this profile's endpoint. If the profile + * contains more than one endpoint, i.e., a list, the method returns + * the head of the list. + */ virtual TAO_Endpoint *endpoint (void) = 0; - // Return pointer to this profile's endpoint. If the profile - // contains more than one endpoint, i.e., a list, the method returns - // the head of the list. + /// Return how many endpoints this profile contains. virtual size_t endpoint_count (void) = 0; - // Return how many endpoints this profile contains. + /** + * Return true if this profile is equivalent to other_profile. Two + * profiles are equivalent iff their tag, object_key, version and + * all endpoints are the same. + */ virtual CORBA::Boolean is_equivalent (const TAO_Profile* other_profile) = 0; - // Return true if this profile is equivalent to other_profile. Two - // profiles are equivalent iff their tag, object_key, version and - // all endpoints are the same. + /// Return a hash value for this object. virtual CORBA::ULong hash (CORBA::ULong max, CORBA::Environment &ACE_TRY_ENV) = 0; - // Return a hash value for this object. + /** + * This method is used to get the IOP::taggedProfile. The profile + * information that is received from the server side would have + * already been decoded. So this method will just make a + * IOP::TaggedProfile struct from the existing information and + * return the reference to that. This method is necessary for GIOP + * 1.2. + */ virtual IOP::TaggedProfile &create_tagged_profile (void) = 0; - // This method is used to get the IOP::taggedProfile. The profile - // information that is received from the server side would have - // already been decoded. So this method will just make a - // IOP::TaggedProfile struct from the existing information and - // return the reference to that. This method is necessary for GIOP - // 1.2. + /// This method sets the client exposed policies, i.e., the ones + /// propagated in the IOR, for this profile. virtual void policies (CORBA::PolicyList *policy_list); - // This method sets the client exposed policies, i.e., the ones - // propagated in the IOR, for this profile. + /// Accessor for the client exposed policies of this profile. virtual CORBA::PolicyList& policies (void); - // Accessor for the client exposed policies of this profile. + /// Sets the TAO_Stub to which this profile is associated. virtual void the_stub (TAO_Stub *stub); - // Sets the TAO_Stub to which this profile is associated. + /// Gets the TAO_MProfile that holds the TAO_Profile instance. virtual TAO_Stub* the_stub (void); - // Gets the TAO_MProfile that holds the TAO_Profile instance. private: + /// this object keeps ownership of this object TAO_MProfile *forward_to_i (void); - // this object keeps ownership of this object /// Verify that the current ORB's configuration supports tagged /// components in IORs. @@ -171,21 +177,21 @@ private: protected: + /// IIOP version number. TAO_GIOP_Version version_; - // IIOP version number. + /// The tagged components TAO_Tagged_Components tagged_components_; - // The tagged components + /// Flag indicating whether the lazy decoding of the client exposed + /// policies has taken place. CORBA::Boolean are_policies_parsed_; - // Flag indicating whether the lazy decoding of the client exposed - // policies has taken place. + /// Pointer to the TAO_Stub to which this profile is related. TAO_Stub *stub_; - // Pointer to the TAO_Stub to which this profile is related. + /// Client exposed policies of this profile. CORBA::PolicyList *policy_list_; - // Client exposed policies of this profile. // NOTE: In this implementation it is assumed that the <policy_list> // is exactly the same for each profile. @@ -196,42 +202,43 @@ protected: private: + /// IOP protocol tag. CORBA::ULong tag_; - // IOP protocol tag. + /// Pointer to the ORB core TAO_ORB_Core *orb_core_; - // Pointer to the ORB core + /// the TAO_MProfile which contains the profiles for the forwarded + /// object. TAO_MProfile* forward_to_; - // the TAO_MProfile which contains the profiles for the forwarded - // object. + /// Mutex to protect reference count. ACE_SYNCH_MUTEX refcount_lock_; - // Mutex to protect reference count. + /// Number of outstanding references to this object. CORBA::ULong refcount_; - // Number of outstanding references to this object. }; +/** + * @class TAO_Unknown_Profile + * + * @brief A TAO_Profile class to handle foreign profiles. + * + * The CORBA spec implies that ORBs must be prepared to save and + * pass around profiles for protocols it does not recognize. It is + * not mandatory to *use* those profiles but they shouldn't be + * dropped. + * This class stores the information required to marshal and + * demarshal an unknown profile, but simply returns an error if + * any of the TAO internal methods are invoked. + */ class TAO_Export TAO_Unknown_Profile : public TAO_Profile { - // = TITLE - // A TAO_Profile class to handle foreign profiles. - // - // = DESCRIPTION - // The CORBA spec implies that ORBs must be prepared to save and - // pass around profiles for protocols it does not recognize. It is - // not mandatory to *use* those profiles but they shouldn't be - // dropped. - // This class stores the information required to marshal and - // demarshal an unknown profile, but simply returns an error if - // any of the TAO internal methods are invoked. - // public: + /// Create the profile TAO_Unknown_Profile (CORBA::ULong tag, TAO_ORB_Core *orb_core); - // Create the profile // = The TAO_Profile methods look above virtual int parse_string (const char *string, diff --git a/TAO/tao/Protocol_Factory.h b/TAO/tao/Protocol_Factory.h index 054de6bb945..6f3a1bca48c 100644 --- a/TAO/tao/Protocol_Factory.h +++ b/TAO/tao/Protocol_Factory.h @@ -1,19 +1,16 @@ // -*- C++ -*- -// $Id$ - - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Protocol_Factory.h -// -// = AUTHOR -// Fred Kuhns <fredk@cs.wustl.edu> -// -// ============================================================================ + + +//============================================================================= +/** + * @file Protocol_Factory.h + * + * $Id$ + * + * @author Fred Kuhns <fredk@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_PROTOCOL_FACTORY_H #define TAO_PROTOCOL_FACTORY_H @@ -37,40 +34,42 @@ public: TAO_Protocol_Factory (CORBA::ULong tag); virtual ~TAO_Protocol_Factory (void); + /// Initialization hook. virtual int init (int argc, char *argv[]); - // Initialization hook. + /// The protocol tag, each concrete class will have a specific tag + /// value. CORBA::ULong tag (void) const; - // The protocol tag, each concrete class will have a specific tag - // value. + /// Verify prefix is a match virtual int match_prefix (const ACE_CString &prefix); - // Verify prefix is a match + /// Returns the prefix used by the protocol. virtual const char *prefix (void) const; - // Returns the prefix used by the protocol. + /// Return the character used to mark where an endpoint ends and + /// where its options begin. virtual char options_delimiter (void) const; - // Return the character used to mark where an endpoint ends and - // where its options begin. // Factory methods + /// Create an acceptor virtual TAO_Acceptor *make_acceptor (void); - // Create an acceptor + /// Create a connector virtual TAO_Connector *make_connector (void); - // Create a connector + /** + * Some protocols should not create a default endpoint unless the + * user specifies a -ORBEndpoint option. For example, local IPC + * (aka UNIX domain sockets) is unable to remove the rendesvouz + * point if the server crashes. For those protocols is better to + * create the endpoint only if the user requests one. + */ virtual int requires_explicit_endpoint (void) const = 0; - // Some protocols should not create a default endpoint unless the - // user specifies a -ORBEndpoint option. For example, local IPC - // (aka UNIX domain sockets) is unable to remove the rendesvouz - // point if the server crashes. For those protocols is better to - // create the endpoint only if the user requests one. private: + /// IOP protocol tag. CORBA::ULong tag_; - // IOP protocol tag. }; #include "ace/post.h" diff --git a/TAO/tao/RT_Current.h b/TAO/tao/RT_Current.h index cf2f0a5d024..e8f149ac82d 100644 --- a/TAO/tao/RT_Current.h +++ b/TAO/tao/RT_Current.h @@ -1,17 +1,14 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// RT_Current.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file RT_Current.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_RT_CURRENT_H #define TAO_RT_CURRENT_H @@ -46,11 +43,11 @@ class TAO_Export TAO_RT_Current : // Allows setting/getting the priority of the current thread. // public: + /// Default constructor. TAO_RT_Current (TAO_ORB_Core *orb_core); - // Default constructor. + /// The destructor. virtual ~TAO_RT_Current (void); - // The destructor. virtual RTCORBA::Priority the_priority (CORBA::Environment &ACE_TRY_ENV = @@ -64,8 +61,8 @@ public: private: + /// ORB Core that owns us. TAO_ORB_Core *orb_core_; - // ORB Core that owns us. }; diff --git a/TAO/tao/RT_Mutex.h b/TAO/tao/RT_Mutex.h index ba5b79d8afb..033e9f10a00 100644 --- a/TAO/tao/RT_Mutex.h +++ b/TAO/tao/RT_Mutex.h @@ -1,21 +1,14 @@ /* -*- C++ -*- */ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = DESCRIPTION -// Implementation of RTCORBA::Mutex interface. -// -// = FILENAME -// RT_Mutex.h -// -// = AUTHOR -// Marina Spivak (marina@cs.wustl.edu) -// -// ============================================================================ +//============================================================================= +/** + * @file RT_Mutex.h + * + * $Id$ + * + * @author Marina Spivak (marina@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_RT_MUTEX_H #define TAO_RT_MUTEX_H @@ -50,11 +43,11 @@ class TAO_Export TAO_RT_Mutex : // Placeholder for mutex implementation. // public: + /// Constructor. TAO_RT_Mutex (void); - // Constructor. + /// Destructor. virtual ~TAO_RT_Mutex (void); - // Destructor. virtual void lock (CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ()) diff --git a/TAO/tao/RT_ORB.h b/TAO/tao/RT_ORB.h index f3ca45ef5ac..5e2642fdeca 100644 --- a/TAO/tao/RT_ORB.h +++ b/TAO/tao/RT_ORB.h @@ -1,21 +1,14 @@ /* -*- C++ -*- */ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = DESCRIPTION -// Implementation class for the RTORB (from RTCORBA.pidl). -// -// = FILENAME -// RT_ORB.h -// -// = AUTHOR -// Marina Spivak (marina@cs.wustl.edu) -// -// ============================================================================ +//============================================================================= +/** + * @file RT_ORB.h + * + * $Id$ + * + * @author Marina Spivak (marina@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_RT_ORB_H #define TAO_RT_ORB_H @@ -53,11 +46,11 @@ class TAO_Export TAO_RT_ORB : // public: + /// Constructor. TAO_RT_ORB (void); - // Constructor. + /// Destructor. virtual ~TAO_RT_ORB (void); - // Destructor. virtual RTCORBA::Mutex_ptr create_mutex (CORBA::Environment &ACE_TRY_ENV = diff --git a/TAO/tao/RT_ORBInitializer.h b/TAO/tao/RT_ORBInitializer.h index 3340e4b946f..4fed55d1ef5 100644 --- a/TAO/tao/RT_ORBInitializer.h +++ b/TAO/tao/RT_ORBInitializer.h @@ -1,19 +1,15 @@ // -*- C++ -*- -// -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// RT_ORBInitializer.h -// -// = AUTHOR -// Ossama Othman <ossama@uci.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file RT_ORBInitializer.h + * + * $Id$ + * + * @author Ossama Othman <ossama@uci.edu> + */ +//============================================================================= + #ifndef TAO_RT_ORB_INITIALIZER_H #define TAO_RT_ORB_INITIALIZER_H @@ -57,11 +53,11 @@ public: private: + ////< Register RTCORBA policy factories. void register_policy_factories ( PortableInterceptor::ORBInitInfo_ptr info TAO_ENV_ARG_DECL ); - ///< Register RTCORBA policy factories. }; diff --git a/TAO/tao/RT_PolicyFactory.h b/TAO/tao/RT_PolicyFactory.h index 824bc169483..18e0759618a 100644 --- a/TAO/tao/RT_PolicyFactory.h +++ b/TAO/tao/RT_PolicyFactory.h @@ -1,20 +1,16 @@ // -*- C++ -*- -// -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// RT_PolicyFactory.h -// -// = AUTHOR -// Angelo Corsaro <corsaro@cs.wustl.edu> -// Ossama Othman <ossama@uci.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file RT_PolicyFactory.h + * + * $Id$ + * + * @author Angelo Corsaro <corsaro@cs.wustl.edu> + * @author Ossama Othman <ossama@uci.edu> + */ +//============================================================================= + #ifndef TAO_RT_POLICY_FACTORY_H #define TAO_RT_POLICY_FACTORY_H diff --git a/TAO/tao/RT_Policy_i.h b/TAO/tao/RT_Policy_i.h index f674d862300..fbfc2982a11 100644 --- a/TAO/tao/RT_Policy_i.h +++ b/TAO/tao/RT_Policy_i.h @@ -1,21 +1,14 @@ /* -*- C++ -*- */ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = DESCRIPTION -// Implementation classes for the RT CORBA 1.0 policies. -// -// = FILENAME -// RT_Policy_i.h -// -// = AUTHOR -// Marina Spivak (marina@cs.wustl.edu) -// -// ============================================================================ +//============================================================================= +/** + * @file RT_Policy_i.h + * + * $Id$ + * + * @author Marina Spivak (marina@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_RT_POLICY_I_H #define TAO_RT_POLICY_I_H @@ -42,31 +35,34 @@ #endif /* _MSC_VER */ +/** + * @class TAO_PriorityModelPolicy + * + * @brief RTCORBA::PriorityModelPolicy implementation + * + * This policy controls how the priority at which a server handles + * requests from clients is determined. + */ class TAO_Export TAO_PriorityModelPolicy : public RTCORBA::PriorityModelPolicy, public TAO_Local_RefCounted_Object { - // = TITLE - // RTCORBA::PriorityModelPolicy implementation - // - // = DESCRIPTION - // This policy controls how the priority at which a server handles - // requests from clients is determined. - // public: + /// Constructor. TAO_PriorityModelPolicy (RTCORBA::PriorityModel priority_model, RTCORBA::Priority server_priority); - // Constructor. + /// Copy constructor. TAO_PriorityModelPolicy (const TAO_PriorityModelPolicy &rhs); - // Copy constructor. + /// Destructor. virtual ~TAO_PriorityModelPolicy (void); - // Destructor. + /** + * Accessor for the <priority_model_> attribute. This method is + * used internally by the orb. This is a more efficient + * (non-virtual, no exception handling) relative of the idl interface + * implementation <priority_model> below. + */ RTCORBA::PriorityModel get_priority_model (void); - // Accessor for the <priority_model_> attribute. This method is - // used internally by the orb. This is a more efficient - // (non-virtual, no exception handling) relative of the idl interface - // implementation <priority_model> below. virtual RTCORBA::PriorityModel priority_model (CORBA::Environment &ACE_TRY_ENV = @@ -91,45 +87,46 @@ public: TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); + /// This method writes a CDR representation of the object state. virtual CORBA::Boolean _tao_encode (TAO_OutputCDR &out_cdr); - // This method writes a CDR representation of the object state. + /// This method reads the object state from a CDR representation. virtual CORBA::Boolean _tao_decode (TAO_InputCDR &in_cdr); - // This method reads the object state from a CDR representation. protected: + /// This constructor is used by TAO_RT_PolicyFactory when decoding + /// policies from tagged components in an IOR. friend class TAO_RT_PolicyFactory; TAO_PriorityModelPolicy (void); - // This constructor is used by TAO_RT_PolicyFactory when decoding - // policies from tagged components in an IOR. private: + /// Attributes. RTCORBA::PriorityModel priority_model_; RTCORBA::Priority server_priority_; - // Attributes. }; //************************************************************************* +/** + * @class TAO_ThreadpoolPolicy + * + * @brief RTCORBA::ThreadpoolPolicy implementation + * + * This policy controls which threadpool is associated with a POA. + */ class TAO_Export TAO_ThreadpoolPolicy : public RTCORBA::ThreadpoolPolicy, public TAO_Local_RefCounted_Object { - // = TITLE - // RTCORBA::ThreadpoolPolicy implementation - // - // = DESCRIPTION - // This policy controls which threadpool is associated with a POA. - // public: + /// Constructor. TAO_ThreadpoolPolicy (RTCORBA::ThreadpoolId id); - // Constructor. + /// Copy constructor. TAO_ThreadpoolPolicy (const TAO_ThreadpoolPolicy &rhs); - // Copy constructor. + /// Destructor. virtual ~TAO_ThreadpoolPolicy (void); - // Destructor. virtual RTCORBA::ThreadpoolId threadpool (CORBA::Environment &ACE_TRY_ENV = @@ -151,31 +148,32 @@ public: private: + /// Attribute. RTCORBA::ThreadpoolId id_; - // Attribute. }; //************************************************************************* +/** + * @class TAO_PrivateConnectionPolicy + * + * @brief RTCORBA::PrivateConnectionPolicy implementation + * + * This policy controls whether the transport connection for the + * Object is private, i.e., not available for carrying out invocations on + * other objects. + */ class TAO_Export TAO_PrivateConnectionPolicy : public RTCORBA::PrivateConnectionPolicy, public TAO_Local_RefCounted_Object { - // = TITLE - // RTCORBA::PrivateConnectionPolicy implementation - // - // = DESCRIPTION - // This policy controls whether the transport connection for the - // Object is private, i.e., not available for carrying out invocations on - // other objects. - // public: + /// Constructor. TAO_PrivateConnectionPolicy (void); - // Constructor. + /// Copy constructor. TAO_PrivateConnectionPolicy (const TAO_PrivateConnectionPolicy &rhs); - // Copy constructor. + /// Destructor. virtual ~TAO_PrivateConnectionPolicy (void); - // Destructor. virtual CORBA::PolicyType policy_type (CORBA::Environment &ACE_TRY_ENV = @@ -193,33 +191,36 @@ public: //************************************************************************* +/** + * @class TAO_PriorityBandedConnectionPolicy + * + * @brief RTCORBA::PriorityBandedConnectionPolicy implementation + * + * RT CORBA provides facility for a client to communicate with a + * server via multiple connections, aka bands, with each connection handling + * invocations that are made at a different CORBA priority. + * This policy allows the specification of the number of such + * bands and their priorities. + */ class TAO_Export TAO_PriorityBandedConnectionPolicy : public RTCORBA::PriorityBandedConnectionPolicy, public TAO_Local_RefCounted_Object { - // = TITLE - // RTCORBA::PriorityBandedConnectionPolicy implementation - // - // = DESCRIPTION - // RT CORBA provides facility for a client to communicate with a - // server via multiple connections, aka bands, with each connection handling - // invocations that are made at a different CORBA priority. - // This policy allows the specification of the number of such - // bands and their priorities. - // public: + /// Constructor. TAO_PriorityBandedConnectionPolicy (const RTCORBA::PriorityBands &bands); - // Constructor. + /// Copy constructor. TAO_PriorityBandedConnectionPolicy (const TAO_PriorityBandedConnectionPolicy &rhs); - // Copy constructor. + /// Destructor. virtual ~TAO_PriorityBandedConnectionPolicy (void); - // Destructor. + /** + * Accessor to the underlying priority bands of the policy (does not + * make a copy like the idl accessor <priority_bands> implementation + * below.) + */ RTCORBA::PriorityBands &priority_bands_rep (void); - // Accessor to the underlying priority bands of the policy (does not - // make a copy like the idl accessor <priority_bands> implementation - // below.) virtual RTCORBA::PriorityBands * priority_bands (CORBA::Environment &ACE_TRY_ENV = @@ -239,50 +240,53 @@ public: TAO_default_environment ()) ACE_THROW_SPEC ((CORBA::SystemException)); + /// This method writes a CDR representation of the current object. virtual CORBA::Boolean _tao_encode (TAO_OutputCDR &out_cdr); - // This method writes a CDR representation of the current object. + /// This method reads the object state from a CDR representation. virtual CORBA::Boolean _tao_decode (TAO_InputCDR &in_cdr); - // This method reads the object state from a CDR representation. protected: + /// This constructor is used by TAO_RT_PolicyFactory when decoding + /// policies from tagged components in an IOR. friend class TAO_RT_PolicyFactory; TAO_PriorityBandedConnectionPolicy (void); - // This constructor is used by TAO_RT_PolicyFactory when decoding - // policies from tagged components in an IOR. private: + /// Attribute. RTCORBA::PriorityBands priority_bands_; - // Attribute. }; //************************************************************************* +/** + * @class TAO_ServerProtocolPolicy + * + * @brief RTCORBA::ServerProtocolPolicy implementation + * + * This policy controls selection and configuration of + * communication protocols on the server-side of the RT ORB. + */ class TAO_Export TAO_ServerProtocolPolicy : public RTCORBA::ServerProtocolPolicy, public TAO_Local_RefCounted_Object { - // = TITLE - // RTCORBA::ServerProtocolPolicy implementation - // - // = DESCRIPTION - // This policy controls selection and configuration of - // communication protocols on the server-side of the RT ORB. - // public: + /// Constructor. TAO_ServerProtocolPolicy (const RTCORBA::ProtocolList &protocols); - // Constructor. + /// Copy constructor. TAO_ServerProtocolPolicy (const TAO_ServerProtocolPolicy &rhs); - // Copy constructor. + /// Destructor. virtual ~TAO_ServerProtocolPolicy (void); - // Destructor. + /** + * Accessor to the underlying protocols list of the policy (does not + * make a copy like the idl accessor <protocols> implementation + * below.) + */ RTCORBA::ProtocolList & protocols_rep (void); - // Accessor to the underlying protocols list of the policy (does not - // make a copy like the idl accessor <protocols> implementation - // below.) virtual RTCORBA::ProtocolList * protocols (CORBA::Environment &ACE_TRY_ENV = @@ -304,35 +308,38 @@ public: private: + /// Attribute. RTCORBA::ProtocolList protocols_; - // Attribute. }; //************************************************************************* +/** + * @class TAO_ClientProtocolPolicy + * + * @brief RTCORBA::ClientProtocolPolicy implementation + * + * This policy controls selection and configuration of + * communication protocols on the client-side of the RT ORB. + */ class TAO_Export TAO_ClientProtocolPolicy : public RTCORBA::ClientProtocolPolicy, public TAO_Local_RefCounted_Object { - // = TITLE - // RTCORBA::ClientProtocolPolicy implementation - // - // = DESCRIPTION - // This policy controls selection and configuration of - // communication protocols on the client-side of the RT ORB. - // public: + /// Constructor. TAO_ClientProtocolPolicy (const RTCORBA::ProtocolList &protocols); - // Constructor. + /// Copy constructor. TAO_ClientProtocolPolicy (const TAO_ClientProtocolPolicy &rhs); - // Copy constructor. + /// Destructor. virtual ~TAO_ClientProtocolPolicy (void); - // Destructor. + /** + * Accessor to the underlying protocols list of the policy (does not + * make a copy like the idl accessor <protocols> implementation + * below.) + */ RTCORBA::ProtocolList & protocols_rep (void); - // Accessor to the underlying protocols list of the policy (does not - // make a copy like the idl accessor <protocols> implementation - // below.) virtual RTCORBA::ProtocolList * protocols (CORBA::Environment &ACE_TRY_ENV = @@ -354,23 +361,23 @@ public: // = CDR Encoder/Decoder. + /// This method writes a CDR representation of the current object. virtual CORBA::Boolean _tao_encode (TAO_OutputCDR &out_cdr); - // This method writes a CDR representation of the current object. + /// This method reads the object state from a CDR representation. virtual CORBA::Boolean _tao_decode (TAO_InputCDR &in_cdr); - // This method reads the object state from a CDR representation. protected: + /// This constructor is used by TAO_RT_PolicyFactory when decoding + /// policies from tagged components in an IOR. friend class TAO_RT_PolicyFactory; TAO_ClientProtocolPolicy (void); - // This constructor is used by TAO_RT_PolicyFactory when decoding - // policies from tagged components in an IOR. private: + /// Attribute. RTCORBA::ProtocolList protocols_; - // Attribute. }; //************************************************************************* @@ -385,6 +392,7 @@ class TAO_Export TAO_TCP_Properties : public RTCORBA::TCPProtocolProperties, pub // Stores TCP Protocol configuration properties. // public: + /// Constructor. TAO_TCP_Properties (CORBA::Long send_buffer_size = ACE_DEFAULT_MAX_SOCKET_BUFSIZ, CORBA::Long recv_buffer_size = @@ -392,10 +400,9 @@ public: CORBA::Boolean keep_alive = 1, CORBA::Boolean dont_route = 0, CORBA::Boolean no_delay = 1); - // Constructor. + /// Destructor. virtual ~TAO_TCP_Properties (void); - // Destructor. virtual CORBA::Long send_buffer_size (CORBA::Environment &ACE_TRY_ENV = @@ -445,11 +452,11 @@ public: ACE_THROW_SPEC (()); + /// This method writes a CDR representation of TCPProtocolProperties. virtual CORBA::Boolean _tao_encode (TAO_OutputCDR &out_cdr); - // This method writes a CDR representation of TCPProtocolProperties. + /// This method reads the object state from a CDR representation. virtual CORBA::Boolean _tao_decode (TAO_InputCDR &in_cdr); - // This method reads the object state from a CDR representation. private: // = Attributes. @@ -463,15 +470,16 @@ private: //************************************************************************* +/** + * @class TAO_Unix_Domain_Properties + * + * @brief RTCORBA::UnixDomainProtocolProperties implementation. + * + * Stores Unix Domain Sockets (Local IPC) Protocol configuration + * properties. + */ class TAO_Export TAO_Unix_Domain_Properties : public RTCORBA::UnixDomainProtocolProperties, public TAO_Local_RefCounted_Object { - // = TITLE - // RTCORBA::UnixDomainProtocolProperties implementation. - // - // = DESCRIPTION - // Stores Unix Domain Sockets (Local IPC) Protocol configuration - // properties. - // public: TAO_Unix_Domain_Properties (CORBA::Long send_buffer_size = ACE_DEFAULT_MAX_SOCKET_BUFSIZ, @@ -480,8 +488,8 @@ public: // Constructor. + /// Destructor. virtual ~TAO_Unix_Domain_Properties (void); - // Destructor. virtual CORBA::Long send_buffer_size (CORBA::Environment &ACE_TRY_ENV = @@ -503,20 +511,24 @@ public: TAO_default_environment ()) ACE_THROW_SPEC (()); + /** + * This method writes the CDR encapsulation of an instance of + * UnixDomainProperties. This Protocol Property in TAO specific, + * so there is no order of encapsulation specified in the + * RT CORBA Spec. The current implementation encodes the field + * according to the order of declaration (i.e. first is encoded + * send_buffer_size and then recv_buffer_size). + */ virtual CORBA::Boolean _tao_encode (TAO_OutputCDR &out_cdr); - // This method writes the CDR encapsulation of an instance of - // UnixDomainProperties. This Protocol Property in TAO specific, - // so there is no order of encapsulation specified in the - // RT CORBA Spec. The current implementation encodes the field - // according to the order of declaration (i.e. first is encoded - // send_buffer_size and then recv_buffer_size). + /** + * This method reads an instance of UnixDomainProperties from + * a CDR encapsulation. This Protocol Property in TAO specific, + * so there is no order of encapsulation specified in the + * RT CORBA Spec. The current implementation expect the field + * according to the order of declaration. + */ virtual CORBA::Boolean _tao_decode (TAO_InputCDR &in_cdr); - // This method reads an instance of UnixDomainProperties from - // a CDR encapsulation. This Protocol Property in TAO specific, - // so there is no order of encapsulation specified in the - // RT CORBA Spec. The current implementation expect the field - // according to the order of declaration. private: @@ -527,21 +539,22 @@ private: //************************************************************************* +/** + * @class TAO_SMEM_Properties + * + * @brief RTCORBA::SharedMemoryProtocolProperties implementation. + * + * Stores Shared Memory Protocol configuration + * properties. + */ class TAO_Export TAO_SMEM_Properties : public RTCORBA::SharedMemoryProtocolProperties, public TAO_Local_RefCounted_Object { - // = TITLE - // RTCORBA::SharedMemoryProtocolProperties implementation. - // - // = DESCRIPTION - // Stores Shared Memory Protocol configuration - // properties. - // public: + /// Constructor. TAO_SMEM_Properties (void); - // Constructor. + /// Destructor. virtual ~TAO_SMEM_Properties (void); - // Destructor. // = IDL interface methods. @@ -575,19 +588,23 @@ public: TAO_default_environment ()) ACE_THROW_SPEC (()); + /** + * This method writes the CDR encapsulation of an instance of + * SMEMProperties. This Protocol Property in TAO specific, + * so there is no order of encapsulation specified in the + * RT CORBA Spec. The current implementation encodes the field + * according to the order of declaration. + */ virtual CORBA::Boolean _tao_encode (TAO_OutputCDR &out_cdr); - // This method writes the CDR encapsulation of an instance of - // SMEMProperties. This Protocol Property in TAO specific, - // so there is no order of encapsulation specified in the - // RT CORBA Spec. The current implementation encodes the field - // according to the order of declaration. + /** + * This method reads an instance of SMEMProperties from + * a CDR encapsulation. This Protocol Property in TAO specific, + * so there is no order of encapsulation specified in the + * RT CORBA Spec. The current implementation expect the field + * according to the order of declaration. + */ virtual CORBA::Boolean _tao_decode (TAO_InputCDR &in_cdr); - // This method reads an instance of SMEMProperties from - // a CDR encapsulation. This Protocol Property in TAO specific, - // so there is no order of encapsulation specified in the - // RT CORBA Spec. The current implementation expect the field - // according to the order of declaration. private: @@ -621,21 +638,25 @@ class TAO_Export TAO_Protocol_Properties_Factory { public: + /** + * Creates the proper transport ProtocolProperties subclass that matches + * the IOP::ProfileId. + * NOTE: Each IOP::ProfileId corresponds to two sets of protocol + * properties: one describes the transport protocol and the other + * describes the ORB messaging protocol. + */ static RTCORBA::ProtocolProperties* create_transport_protocol_property (IOP::ProfileId id); - // Creates the proper transport ProtocolProperties subclass that matches - // the IOP::ProfileId. - // NOTE: Each IOP::ProfileId corresponds to two sets of protocol - // properties: one describes the transport protocol and the other - // describes the ORB messaging protocol. + /** + * Creates the proper orb ProtocolProperties subclass for + * IOP::ProfileId. + * NOTE: Each IOP::ProfileId corresponds to two sets of protocol + * properties: one describes the transport protocol and the other + * describes the ORB messaging protocol. + */ static RTCORBA::ProtocolProperties* create_orb_protocol_property (IOP::ProfileId id); - // Creates the proper orb ProtocolProperties subclass for - // IOP::ProfileId. - // NOTE: Each IOP::ProfileId corresponds to two sets of protocol - // properties: one describes the transport protocol and the other - // describes the ORB messaging protocol. protected: TAO_Protocol_Properties_Factory (void); diff --git a/TAO/tao/Reactor_Registry.h b/TAO/tao/Reactor_Registry.h index f9e7e1a7e50..211534621af 100644 --- a/TAO/tao/Reactor_Registry.h +++ b/TAO/tao/Reactor_Registry.h @@ -1,17 +1,14 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Reactor_Registry.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file Reactor_Registry.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_REACTOR_REGISTRY_H #define TAO_REACTOR_REGISTRY_H @@ -28,54 +25,56 @@ class TAO_Leader_Follower; class TAO_Acceptor; class ACE_Reactor; +/** + * @class TAO_Reactor_Registry + * + * @brief The interface for the concurrency strategy. + * + * The ORB concurrency strategy is responsible for assigning + * reactors to threads, keeping the relationship between threads + * and their leader-follower groups and activating (if required) + * the server-side Svc_Handlers. + */ class TAO_Export TAO_Reactor_Registry { - // - // = TITLE - // The interface for the concurrency strategy. - // - // = DESCRIPTION - // The ORB concurrency strategy is responsible for assigning - // reactors to threads, keeping the relationship between threads - // and their leader-follower groups and activating (if required) - // the server-side Svc_Handlers. - // public: + /// Default constructor TAO_Reactor_Registry (void); - // Default constructor + /// The destructor virtual ~TAO_Reactor_Registry (void); - // The destructor + /// The ORB core for this concurrency strategy. TAO_ORB_Core *orb_core (void) const; - // The ORB core for this concurrency strategy. + /// Initialize the Reactor Registry virtual void open (TAO_ORB_Core *orb_core); - // Initialize the Reactor Registry + /// Return the reactor for the current thread virtual ACE_Reactor *reactor (void) = 0; - // Return the reactor for the current thread + /// Return the reactor for a given acceptor virtual ACE_Reactor *reactor (TAO_Acceptor *acceptor) = 0; - // Return the reactor for a given acceptor + /// Return the Leader-Follower group for the current thread virtual TAO_Leader_Follower &leader_follower (void) = 0; - // Return the Leader-Follower group for the current thread + /// Return the Leader-Follower group for a given acceptor virtual TAO_Leader_Follower &leader_follower (TAO_Acceptor *acceptor) = 0; - // Return the Leader-Follower group for a given acceptor + /** + * The strategy is allowed to store TSS resources using a + * place-holder in the ORB_Core class. The ORB_Core the calls back + * to do the final cleanup. + */ virtual void destroy_tss_cookie (void* cookie) = 0; - // The strategy is allowed to store TSS resources using a - // place-holder in the ORB_Core class. The ORB_Core the calls back - // to do the final cleanup. + /// Wakeup all the reactors virtual int shutdown_all (void) = 0; - // Wakeup all the reactors private: + /// The orb_core TAO_ORB_Core *orb_core_; - // The orb_core }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/Remote_Object_Proxy_Broker.h b/TAO/tao/Remote_Object_Proxy_Broker.h index ce515adbb9a..3141570c538 100644 --- a/TAO/tao/Remote_Object_Proxy_Broker.h +++ b/TAO/tao/Remote_Object_Proxy_Broker.h @@ -1,23 +1,20 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Remote_Object_Proxy_Broker.h -// -// = DESCRIPTION -// This files contains the Remote Proxy Broker implementation -// for the CORBA Object. -// -// = AUTHOR -// Angelo Corsaro <corsaro@cs.wustl.edu> -// -// ============================================================================ - -#ifndef TAO_REMOTE_OBJECT_PROXY_BROKER_H_ + +//============================================================================= +/** + * @file Remote_Object_Proxy_Broker.h + * + * $Id$ + * + * This files contains the Remote Proxy Broker implementation + * for the CORBA Object. + * + * + * @author Angelo Corsaro <corsaro@cs.wustl.edu> + */ +//============================================================================= + + +#ifndef TAO_REMOTE_OBJECT_PROXY_BROKER_H_ #define TAO_REMOTE_OBJECT_PROXY_BROKER_H_ // -- ACE Include -- @@ -30,7 +27,7 @@ #if !defined (ACE_LACKS_PRAGMA_ONCE) # pragma once -#endif // ACE_LACKS_PRAGMA_ONCE +#endif /* ACE_LACKS_PRAGMA_ONCE */ class TAO_Export TAO_Remote_Object_Proxy_Broker : public TAO_Object_Proxy_Broker { @@ -51,7 +48,3 @@ TAO_Remote_Object_Proxy_Broker *the_tao_remote_object_proxy_broker (void); #include "ace/post.h" #endif /* TAO_REMOTE_Object_PROXY_BROKER_H_ */ - - - - diff --git a/TAO/tao/Remote_Object_Proxy_Impl.h b/TAO/tao/Remote_Object_Proxy_Impl.h index dc40e6c0424..586f2c93cf5 100644 --- a/TAO/tao/Remote_Object_Proxy_Impl.h +++ b/TAO/tao/Remote_Object_Proxy_Impl.h @@ -1,21 +1,18 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Remote_Object_Proxy_Impl.h -// -// = DESCRIPTION -// This files contains the definition of the remote proxy -// for the CORBA::Object class. -// -// = AUTHOR -// Angelo Corsaro <corsaro@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Remote_Object_Proxy_Impl.h + * + * $Id$ + * + * This files contains the definition of the remote proxy + * for the CORBA::Object class. + * + * + * @author Angelo Corsaro <corsaro@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_REMOTE_OBJECT_PROXY_IMPL_H_ #define TAO_REMOTE_OBJECT_PROXY_IMPL_H_ @@ -25,14 +22,15 @@ #include "tao/Object_Proxy_Impl.h" +/** + * @class TAO_Remote_Object_Proxy_Impl + * + * @brief TAO_Remote_Object_Proxy_Impl + * + * This class implements the remote proxy for the CORBA::Object class. + */ class TAO_Export TAO_Remote_Object_Proxy_Impl : public virtual TAO_Object_Proxy_Impl { - // = TITLE - // TAO_Remote_Object_Proxy_Impl - // - // = DESCRIPTION - // This class implements the remote proxy for the CORBA::Object class. - // public: TAO_Remote_Object_Proxy_Impl (void); diff --git a/TAO/tao/Reply_Dispatcher.h b/TAO/tao/Reply_Dispatcher.h index d0cb5ccb364..56bb57aeec8 100644 --- a/TAO/tao/Reply_Dispatcher.h +++ b/TAO/tao/Reply_Dispatcher.h @@ -1,19 +1,19 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = DESCRIPTION -// Define the interface for the Reply_Dispatcher strategies. -// -// = AUTHOR -// Alexander Babu Arulanthu <alex@cs.wustl.edu> -// -// ============================================================================ + + +//============================================================================= +/** + * @file Reply_Dispatcher.h + * + * $Id$ + * + * Define the interface for the Reply_Dispatcher strategies. + * + * + * @author Alexander Babu Arulanthu <alex@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_REPLY_DISPATCHER_H #define TAO_REPLY_DISPATCHER_H @@ -31,63 +31,70 @@ class TAO_GIOP_Version; class TAO_Transport; class TAO_Pluggable_Reply_Params; +/** + * @class TAO_Reply_Dispatcher + * + * + * Different invocation modes process the Reply messages in + * different ways. Traditional synchronous replies simply receive + * the message and wake up the waiting thread (if any). + * Asynchronous Method Invocation (Callbacks) must process the + * message in the thread that receives it. + * Deferred Synchronous (DII) and AMI in the Poller mode save the + * reply for later processing in the application. + * The lower level components in the ORB only deal with this + * abstract interface, when the invocation is made the right type + * of Reply Dispatcher is instantiated and registered with the + * Transport object. + */ class TAO_Export TAO_Reply_Dispatcher { - // = TITLE - // - // = DESCRIPTION - // Different invocation modes process the Reply messages in - // different ways. Traditional synchronous replies simply receive - // the message and wake up the waiting thread (if any). - // Asynchronous Method Invocation (Callbacks) must process the - // message in the thread that receives it. - // Deferred Synchronous (DII) and AMI in the Poller mode save the - // reply for later processing in the application. - // The lower level components in the ORB only deal with this - // abstract interface, when the invocation is made the right type - // of Reply Dispatcher is instantiated and registered with the - // Transport object. - // public: + /// Constructor. TAO_Reply_Dispatcher (void); - // Constructor. + /// Destructor. virtual ~TAO_Reply_Dispatcher (void); - // Destructor. + /** + * Dispatch the reply. Return 1 on sucess, -1 on error. + * @@ TODO Pluggable Messaging: this method has too many arguments, + * the "Right Thing"[tm] is for the Transport Object to create a + * "ClientReply" that encapsulates all we need to process a + * reply. Naturally it is possible that different messaging + * protocols implement different variants of such ClientReply + * class. + */ virtual int dispatch_reply (TAO_Pluggable_Reply_Params ¶ms) = 0; - // Dispatch the reply. Return 1 on sucess, -1 on error. - // @@ TODO Pluggable Messaging: this method has too many arguments, - // the "Right Thing"[tm] is for the Transport Object to create a - // "ClientReply" that encapsulates all we need to process a - // reply. Naturally it is possible that different messaging - // protocols implement different variants of such ClientReply - // class. + /// Get the reply status. CORBA::ULong reply_status (void) const; - // Get the reply status. // @@ Commented for the time being - Bala // virtual TAO_GIOP_Message_State *message_state (void) = 0; // Get the Message State into which the reply has been read. + /** + * The dispatcher has been bound. + * Some dispatchers need to retain state to cooperate with other + * components, such as the waiting strategy. + */ virtual void dispatcher_bound (TAO_Transport*) = 0; - // The dispatcher has been bound. - // Some dispatchers need to retain state to cooperate with other - // components, such as the waiting strategy. + /** + * The used for the pending reply has been closed. + * No reply is expected. + * @@ TODO: If the connection was closed due to a CloseConnection + * message then we could re-issue the request instead of raising + * the exception, it would a matter of simply adding a boolean + * argument to this function. + */ virtual void connection_closed (void) = 0; - // The used for the pending reply has been closed. - // No reply is expected. - // @@ TODO: If the connection was closed due to a CloseConnection - // message then we could re-issue the request instead of raising - // the exception, it would a matter of simply adding a boolean - // argument to this function. protected: + /// Reply or LocateReply status. CORBA::ULong reply_status_; - // Reply or LocateReply status. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/Resource_Factory.h b/TAO/tao/Resource_Factory.h index 13c77cc1602..523aaaea637 100644 --- a/TAO/tao/Resource_Factory.h +++ b/TAO/tao/Resource_Factory.h @@ -1,19 +1,15 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Resource_Factory.h -// -// = AUTHOR -// Chris Cleeland -// Carlos O'Ryan -// -// ============================================================================ + +//============================================================================= +/** + * @file Resource_Factory.h + * + * $Id$ + * + * @author Chris CleelandCarlos O'Ryan + */ +//============================================================================= + #ifndef TAO_RESOURCE_FACTORY_H #define TAO_RESOURCE_FACTORY_H @@ -41,23 +37,23 @@ class TAO_Priority_Mapping; class TAO_Export TAO_Protocol_Item { public: + /// creator method, the protocol name can only be set when the + /// object is created. TAO_Protocol_Item (const ACE_CString &name); - // creator method, the protocol name can only be set when the - // object is created. + /// destructor that deallocates the factory object if the + /// Protocol_Item retains ownership. ~TAO_Protocol_Item (void); - // destructor that deallocates the factory object if the - // Protocol_Item retains ownership. + /// return a reference to the character representation of the protocol + /// factories name. const ACE_CString &protocol_name (void); - // return a reference to the character representation of the protocol - // factories name. + /// return a pointer to the protocol factory. TAO_Protocol_Factory *factory (void); - // return a pointer to the protocol factory. + /// set the factory pointer's value. void factory (TAO_Protocol_Factory *factory, int owner = 0); - // set the factory pointer's value. private: // Prohibited @@ -65,14 +61,14 @@ private: ACE_UNIMPLEMENTED_FUNC (void operator= (const TAO_Protocol_Item&)) private: + /// protocol factory name. ACE_CString name_; - // protocol factory name. + /// pointer to factory object. TAO_Protocol_Factory *factory_; - // pointer to factory object. + /// whether we own (and therefore have to delete) the factory object. int factory_owner_; - // whether we own (and therefore have to delete) the factory object. }; // typedefs for containers containing the list of loaded protocol @@ -85,15 +81,16 @@ typedef ACE_Unbounded_Set_Iterator<TAO_Protocol_Item*> // **************************************************************** +/** + * @class TAO_Resource_Factory + * + * @brief Factory which manufacturers resources for use by the ORB Core. + * + * This class is a factory/repository for critical ORB Core + * resources. + */ class TAO_Export TAO_Resource_Factory : public ACE_Service_Object { - // = TITLE - // Factory which manufacturers resources for use by the ORB Core. - // - // = DESCRIPTION - // This class is a factory/repository for critical ORB Core - // resources. - // public: enum Caching_Strategy @@ -117,74 +114,80 @@ public: // = Resource Retrieval + /// @@ Backwards compatibility, return 1 if the ORB core should use + /// TSS resources virtual int use_tss_resources (void) const; - // @@ Backwards compatibility, return 1 if the ORB core should use - // TSS resources + /// @@ Backwards compatibility, return 1 if the ORB core should use + /// Locked_Data_Blocks virtual int use_locked_data_blocks (void) const; - // @@ Backwards compatibility, return 1 if the ORB core should use - // Locked_Data_Blocks + /// Create the reactor holder, an strategy to control the number of + /// reactors in the ORB virtual TAO_Reactor_Registry *get_reactor_registry (void); - // Create the reactor holder, an strategy to control the number of - // reactors in the ORB + /// Return an <ACE_Reactor> to be utilized. virtual ACE_Reactor *get_reactor (void); - // Return an <ACE_Reactor> to be utilized. + /// Reclaim reactor resources (e.g. deallocate, etc). virtual void reclaim_reactor (ACE_Reactor *reactor); - // Reclaim reactor resources (e.g. deallocate, etc). + /// return a reference to the acceptor registry. virtual TAO_Acceptor_Registry *get_acceptor_registry (void); - // return a reference to the acceptor registry. + /// Return an Connector to be utilized. virtual TAO_Connector_Registry *get_connector_registry (void); - // Return an Connector to be utilized. + /// Access the input CDR allocators. virtual ACE_Allocator* input_cdr_dblock_allocator (void); virtual ACE_Allocator* input_cdr_buffer_allocator (void); - // Access the input CDR allocators. + /// Access the output CDR allocators. virtual ACE_Allocator* output_cdr_dblock_allocator (void); virtual ACE_Allocator* output_cdr_buffer_allocator (void); - // Access the output CDR allocators. + /** + * The protocol factory list is implemented in this class since + * a) it will be a global resource and + * b) it is initialized at start up and then not altered. + * Returns a container holding the list of loaded protocols. + */ virtual TAO_ProtocolFactorySet *get_protocol_factories (void); - // The protocol factory list is implemented in this class since - // a) it will be a global resource and - // b) it is initialized at start up and then not altered. - // Returns a container holding the list of loaded protocols. + /** + * this method will loop through the protocol list and + * using the protocol name field this method will + * retrieve a pointer to the associated protocol factory + * from the service configurator. It is assumed + * that only one thread will call this method at ORB initialization. + * NON-THREAD-SAFE + */ virtual int init_protocol_factories (void); - // this method will loop through the protocol list and - // using the protocol name field this method will - // retrieve a pointer to the associated protocol factory - // from the service configurator. It is assumed - // that only one thread will call this method at ORB initialization. - // NON-THREAD-SAFE + /// This accesses the connection caching strategy we use for managing + /// purging of unused entries from the connection cache on demnad. virtual Caching_Strategy connection_caching_strategy_type (void) const; - // This accesses the connection caching strategy we use for managing - // purging of unused entries from the connection cache on demnad. + /// This denotes the amount of entries to remove from the connection + /// cache. virtual double purge_percentage (void) const; - // This denotes the amount of entries to remove from the connection - // cache. + /// Configure the priority mapping for the ORB virtual TAO_Priority_Mapping *get_priority_mapping (void); - // Configure the priority mapping for the ORB virtual int get_parser_names (char **&names, int &number_of_names); + /// Creates the lock for the lock needed in the Cache Map virtual ACE_Lock *create_cached_connection_lock (void); - // Creates the lock for the lock needed in the Cache Map protected: + /** + * Loads the default protocols. This method is used so that the + * advanced_resource.cpp can call the one in default_resource.cpp + * without calling unnecessary functions. + */ virtual int load_default_protocols (void); - // Loads the default protocols. This method is used so that the - // advanced_resource.cpp can call the one in default_resource.cpp - // without calling unnecessary functions. }; #include "ace/post.h" diff --git a/TAO/tao/Sequence.h b/TAO/tao/Sequence.h index bea630de1f4..625381fd345 100644 --- a/TAO/tao/Sequence.h +++ b/TAO/tao/Sequence.h @@ -1,19 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// sequence.h -// -// = AUTHOR -// -// Carlos O'Ryan and Aniruddha Gokhale -// -// ============================================================================ + +//============================================================================= +/** + * @file Sequence.h + * + * $Id$ + * + * @author Carlos O'Ryan and Aniruddha Gokhale + */ +//============================================================================= + #ifndef TAO_SEQUENCE_H #define TAO_SEQUENCE_H @@ -30,71 +26,77 @@ class CORBA_Object; class CORBA_Environment; +/** + * @class TAO_Base_Sequence + * + * @brief Base class for TAO sequences. + * + * This class provides a common interface for all IDL sequences, + * hence the interpreted marshal engine can manipulate them in a + * type safe manner. + */ class TAO_Export TAO_Base_Sequence { - // = TITLE - // Base class for TAO sequences. - // - // = DESCRIPTION - // This class provides a common interface for all IDL sequences, - // hence the interpreted marshal engine can manipulate them in a - // type safe manner. public: + /// We give access to TAO_Marshal_Sequence, this allows a safe yet + /// small footprint implementation of the marshal engine. friend class TAO_Marshal_Sequence; - // We give access to TAO_Marshal_Sequence, this allows a safe yet - // small footprint implementation of the marshal engine. + /// destructor. virtual ~TAO_Base_Sequence (void); - // destructor. + /// return the maximum length of the sequence CORBA::ULong maximum (void) const; - // return the maximum length of the sequence + /** + * Ensure that the buffer contains space for at least <length> + * elements. The constructor must be called for any new elements, + * the old ones (if any) must be copied into the buffer using + * operator= and then their destructors must be called. Finally the + * old buffer must be released. + */ virtual void _allocate_buffer (CORBA::ULong length) = 0; - // Ensure that the buffer contains space for at least <length> - // elements. The constructor must be called for any new elements, - // the old ones (if any) must be copied into the buffer using - // operator= and then their destructors must be called. Finally the - // old buffer must be released. + /// Must deallocate the buffer and then set it to zero. virtual void _deallocate_buffer (void) = 0; - // Must deallocate the buffer and then set it to zero. + /** + * Some sequences (of objects and strings) require some cleanup if + * the sequence is shrunk. The spec requires the destructor to + * release the objects only from position <0> to <length-1>; so + * shrink and then delete could result in a memory leak. + */ virtual void _shrink_buffer (CORBA::ULong new_length, CORBA::ULong old_length); - // Some sequences (of objects and strings) require some cleanup if - // the sequence is shrunk. The spec requires the destructor to - // release the objects only from position <0> to <length-1>; so - // shrink and then delete could result in a memory leak. + /// Used for sequences of objects to downcast a recently demarshalled + /// object reference into the right type. virtual void _downcast (void *target, CORBA_Object *src, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Used for sequences of objects to downcast a recently demarshalled - // object reference into the right type. + /// Used for sequences of object to convert from the derived type + /// into the Object class. virtual CORBA_Object *_upcast (void *src) const; - // Used for sequences of object to convert from the derived type - // into the Object class. protected: + /// Default constructor. TAO_Base_Sequence (void); - // Default constructor. + /// Constructor with control of ownership. TAO_Base_Sequence (CORBA::ULong maximum, CORBA::ULong length, void *buffer, CORBA::Boolean release = 0); - // Constructor with control of ownership. + /// Assume ownership and set length to 0. TAO_Base_Sequence (CORBA::ULong maximum, void *buffer); - // Assume ownership and set length to 0. // = orbos/98-01-11 proposed extensions. + /// Returns the state of the sequence release flag. CORBA::Boolean release (void) const; - // Returns the state of the sequence release flag. public: @@ -109,118 +111,130 @@ public: protected: + /// The maximum number of elements the buffer can contain. CORBA::ULong maximum_; - // The maximum number of elements the buffer can contain. + /// The current number of elements in the buffer. CORBA::ULong length_; - // The current number of elements in the buffer. + /// The buffer with all the elements, casting must be done in derived + /// classes. void *buffer_; - // The buffer with all the elements, casting must be done in derived - // classes. + /// If true then the sequence should release the buffer when it is + /// destroyed. CORBA::Boolean release_; - // If true then the sequence should release the buffer when it is - // destroyed. }; // **************************************************************** +/** + * @class TAO_Unbounded_Base_Sequence + * + * @brief Base class for all bounded sequences. + * + * This class implements part of the funcionality common to all + * bounded sequences, using this intermediate class instead of + * virtual methods on TAO_Base_Sequence give us a slight + * improvement of performance, but also reduces the amount of + * generated code in the templates. + */ class TAO_Export TAO_Unbounded_Base_Sequence : public TAO_Base_Sequence { - // = TITLE - // Base class for all bounded sequences. - // - // = DESCRIPTION - // This class implements part of the funcionality common to all - // bounded sequences, using this intermediate class instead of - // virtual methods on TAO_Base_Sequence give us a slight - // improvement of performance, but also reduces the amount of - // generated code in the templates. public: + /** + * = SPEC {16.11.2} + * For an unbounded sequence, setting the length to a larger value + * than the current length may reallocate the sequence + * data. Reallocation is conceptually equivalent to creating a new + * sequence of the desired new length, copying the old sequence + * elements zero through length into the new sequence, and then + * assigning the old sequence to be the same as the new sequence. + */ void length (CORBA::ULong length); - // = SPEC {16.11.2} - // For an unbounded sequence, setting the length to a larger value - // than the current length may reallocate the sequence - // data. Reallocation is conceptually equivalent to creating a new - // sequence of the desired new length, copying the old sequence - // elements zero through length into the new sequence, and then - // assigning the old sequence to be the same as the new sequence. + /** + * return the current length, it cannot go into the base class due + * to the C++ name lookup rules (if you don't know what I'm talking + * about, then try moving it there). + */ CORBA::ULong length (void) const; - // return the current length, it cannot go into the base class due - // to the C++ name lookup rules (if you don't know what I'm talking - // about, then try moving it there). + /// destructor. virtual ~TAO_Unbounded_Base_Sequence (void); - // destructor. protected: + /// Default constructor. TAO_Unbounded_Base_Sequence (void); - // Default constructor. + /// Constructor with control of ownership. TAO_Unbounded_Base_Sequence (CORBA::ULong maximum, CORBA::ULong length, void *buffer, CORBA::Boolean release = 0); - // Constructor with control of ownership. + /// Assume ownership and set length to 0. TAO_Unbounded_Base_Sequence (CORBA::ULong maximum, void *buffer); - // Assume ownership and set length to 0. }; // **************************************************************** +/** + * @class TAO_Bounded_Base_Sequence + * + * @brief Base class for all bounded sequences. + * + * This class implements part of the funcionality common to all + * bounded sequences, using this intermediate class instead of + * virtual methods on TAO_Base_Sequence give us a slight + * improvement of performance, but also reduces the amount of + * generated code in the templates. + */ class TAO_Export TAO_Bounded_Base_Sequence : public TAO_Base_Sequence { - // = TITLE - // Base class for all bounded sequences. - // - // = DESCRIPTION - // This class implements part of the funcionality common to all - // bounded sequences, using this intermediate class instead of - // virtual methods on TAO_Base_Sequence give us a slight - // improvement of performance, but also reduces the amount of - // generated code in the templates. public: + /// set the length, for this sequences this call is ignored if the + /// new length is greater that the maximum. void length (CORBA::ULong length); - // set the length, for this sequences this call is ignored if the - // new length is greater that the maximum. + /** + * return the current length, it cannot go into the base class due + * to the C++ name lookup rules (if you don't know what I'm talking + * about, then try moving it there). + */ CORBA::ULong length (void) const; - // return the current length, it cannot go into the base class due - // to the C++ name lookup rules (if you don't know what I'm talking - // about, then try moving it there). + /// destructor. virtual ~TAO_Bounded_Base_Sequence (void); - // destructor. protected: + /// Default constructor. TAO_Bounded_Base_Sequence (void); - // Default constructor. + /// Constructor with control of ownership. TAO_Bounded_Base_Sequence (CORBA::ULong maximum, CORBA::ULong length, void *buffer, CORBA::Boolean release = 0); - // Constructor with control of ownership. + /// Assume ownership and set length to 0. TAO_Bounded_Base_Sequence (CORBA::ULong maximum, void *buffer); - // Assume ownership and set length to 0. }; // **************************************************************** +/** + * @class TAO_Unbounded_String_Sequence + =TITLE + * Unbounded sequence of strings. + * =DESCRIPTION + * IDL sequences of strings must automatically duplicate and + * release their members based on some global <release> flag. + */ class TAO_Export TAO_Unbounded_String_Sequence : public TAO_Unbounded_Base_Sequence { - // =TITLE - // Unbounded sequence of strings. - // - // =DESCRIPTION - // IDL sequences of strings must automatically duplicate and - // release their members based on some global <release> flag. // = SPEC // 16.8 Mapping for Structured Types @@ -231,95 +245,109 @@ class TAO_Export TAO_Unbounded_String_Sequence : public TAO_Unbounded_Base_Seque public: // = Operations for the Unbounded_ObjectSequence + /** + * {orbos/97-05-15:16.8} + * The default constructor initializes object reference members to + * appropriately typed nil object references and string members to + * NULL; all other members are initialized via their default + * constructors. + * + * {orbos/97-05-15:16.11} + * For both bounded and unbounded sequences, the default constructor + * (as shown in the example above) sets the sequence length equal to + * 0. + */ TAO_Unbounded_String_Sequence (void); - // {orbos/97-05-15:16.8} - // The default constructor initializes object reference members to - // appropriately typed nil object references and string members to - // NULL; all other members are initialized via their default - // constructors. - // - // {orbos/97-05-15:16.11} - // For both bounded and unbounded sequences, the default constructor - // (as shown in the example above) sets the sequence length equal to - // 0. + /** + * Unbounded sequences provide a constructor that allows only the + * initial value of the maximum length to be set (the ``maximum + * constructor'' shown in the example above). This allows + * applications to control how much buffer space is initially + * allocated by the sequence. This constructor also sets the length + * to 0 and the release flag to TRUE. + */ TAO_Unbounded_String_Sequence (CORBA::ULong maximum); - // Unbounded sequences provide a constructor that allows only the - // initial value of the maximum length to be set (the ``maximum - // constructor'' shown in the example above). This allows - // applications to control how much buffer space is initially - // allocated by the sequence. This constructor also sets the length - // to 0 and the release flag to TRUE. + /** + * The ``T *data'' constructor (as shown in the example above) + * allows the length and contents of a bounded or unbounded sequence + * to be set. For unbounded sequences, it also allows the initial + * value of the maximum length to be set. For this constructor, + * ownership of the contents vector is determined by the release + * parameter---FALSE means the caller owns the storage, while TRUE + * means that the sequence assumes ownership of the storage. + * If release is TRUE, the contents vector must have been allocated + * using the sequence allocbuf function, and the sequence will pass + * it to freebuf when finished with it. + */ TAO_Unbounded_String_Sequence (CORBA::ULong maximum, CORBA::ULong length, char **data, CORBA::Boolean release=0); - // The ``T *data'' constructor (as shown in the example above) - // allows the length and contents of a bounded or unbounded sequence - // to be set. For unbounded sequences, it also allows the initial - // value of the maximum length to be set. For this constructor, - // ownership of the contents vector is determined by the release - // parameter---FALSE means the caller owns the storage, while TRUE - // means that the sequence assumes ownership of the storage. - // If release is TRUE, the contents vector must have been allocated - // using the sequence allocbuf function, and the sequence will pass - // it to freebuf when finished with it. + /** + * The copy constructor performs a deep copy from the existing + * structure to create a new structure, including calling _duplicate + * on all object reference members and performing the necessary + * heap allocations for all string members. + * + * The copy constructor creates a new sequence with the same maximum + * and length as the given sequence, copies each of its current + * elements (items zero through length-1), and sets the release + * flag to TRUE. + */ TAO_Unbounded_String_Sequence(const TAO_Unbounded_String_Sequence&); - // The copy constructor performs a deep copy from the existing - // structure to create a new structure, including calling _duplicate - // on all object reference members and performing the necessary - // heap allocations for all string members. - // - // The copy constructor creates a new sequence with the same maximum - // and length as the given sequence, copies each of its current - // elements (items zero through length-1), and sets the release - // flag to TRUE. + /// The destructor releases all object reference members and frees + /// all string members. ~TAO_Unbounded_String_Sequence (void); - // The destructor releases all object reference members and frees - // all string members. + /** + * The assignment operator first releases all object reference + * members and frees all string members, and then performs a + * deepcopy to create a new structure. + * + * The assignment operator deepcopies its parameter, releasing + * old storage if necessary. It behaves as if the original sequence + * is destroyed via its destructor and then the source sequence + * copied using the copy constructor. If release=TRUE, the + * destructor destroys each of the current elements (items zero + * through length--1). + * For an unbounded sequence, if a reallocation is necessary due to + * a change in the length and the sequence was created using the + * release=TRUE parameter in its constructor, the sequence will + * deallocate the old storage. If release is FALSE under these + * circumstances, old storage will not be freed before the + * reallocation is performed. After reallocation, the release flag + * is always set to TRUE. + */ TAO_Unbounded_String_Sequence &operator= (const TAO_Unbounded_String_Sequence &); - // The assignment operator first releases all object reference - // members and frees all string members, and then performs a - // deepcopy to create a new structure. - // - // The assignment operator deepcopies its parameter, releasing - // old storage if necessary. It behaves as if the original sequence - // is destroyed via its destructor and then the source sequence - // copied using the copy constructor. If release=TRUE, the - // destructor destroys each of the current elements (items zero - // through length--1). - // For an unbounded sequence, if a reallocation is necessary due to - // a change in the length and the sequence was created using the - // release=TRUE parameter in its constructor, the sequence will - // deallocate the old storage. If release is FALSE under these - // circumstances, old storage will not be freed before the - // reallocation is performed. After reallocation, the release flag - // is always set to TRUE. + /// read-write accessor TAO_SeqElem_String_Manager operator[] (CORBA::ULong slot) const; - // read-write accessor + /** + * The allocbuf function allocates a vector of T elements that can + * be passed to the T *data constructor. The length of the vector is + * given by the nelems function argument. The allocbuf function + * initializes each element using its default constructor, except + * for strings, which are initialized to null pointers, and object + * references, which are initialized to suitably typed nil object + * references. A null pointer is returned if allocbuf for some + * reason cannot allocate the requested vector. Vectors allocated by + * allocbuf should be freed using the freebuf function. + */ static char* *allocbuf (CORBA::ULong); - // The allocbuf function allocates a vector of T elements that can - // be passed to the T *data constructor. The length of the vector is - // given by the nelems function argument. The allocbuf function - // initializes each element using its default constructor, except - // for strings, which are initialized to null pointers, and object - // references, which are initialized to suitably typed nil object - // references. A null pointer is returned if allocbuf for some - // reason cannot allocate the requested vector. Vectors allocated by - // allocbuf should be freed using the freebuf function. + /** + * The freebuf function ensures that the destructor for each element + * is called before the buffer is destroyed, except for string + * elements, which are freed using string_free(), and object + * reference elements, which are freed using release(). The freebuf + * function will ignore null pointers passed to it. + */ static void freebuf (char **); - // The freebuf function ensures that the destructor for each element - // is called before the buffer is destroyed, except for string - // elements, which are freed using string_free(), and object - // reference elements, which are freed using release(). The freebuf - // function will ignore null pointers passed to it. // = Fast buffer accessors. char **get_buffer (CORBA::Boolean orphan = 0); @@ -334,14 +362,16 @@ public: // **************************************************************** +/** + * @class TAO_Unbounded_WString_Sequence + =TITLE + * Unbounded sequence of wstrings. + * =DESCRIPTION + * IDL sequences of wstrings must automatically duplicate and + * release their members based on some global <release> flag. + */ class TAO_Export TAO_Unbounded_WString_Sequence : public TAO_Unbounded_Base_Sequence { - // =TITLE - // Unbounded sequence of wstrings. - // - // =DESCRIPTION - // IDL sequences of wstrings must automatically duplicate and - // release their members based on some global <release> flag. // = SPEC // 16.8 Mapping for Structured Types @@ -352,95 +382,109 @@ class TAO_Export TAO_Unbounded_WString_Sequence : public TAO_Unbounded_Base_Sequ public: // = Operations for the Unbounded_ObjectSequence + /** + * {orbos/97-05-15:16.8} + * The default constructor initializes object reference members to + * appropriately typed nil object references and wstring members to + * NULL; all other members are initialized via their default + * constructors. + * + * {orbos/97-05-15:16.11} + * For both bounded and unbounded sequences, the default constructor + * (as shown in the example above) sets the sequence length equal to + * 0. + */ TAO_Unbounded_WString_Sequence (void); - // {orbos/97-05-15:16.8} - // The default constructor initializes object reference members to - // appropriately typed nil object references and wstring members to - // NULL; all other members are initialized via their default - // constructors. - // - // {orbos/97-05-15:16.11} - // For both bounded and unbounded sequences, the default constructor - // (as shown in the example above) sets the sequence length equal to - // 0. + /** + * Unbounded sequences provide a constructor that allows only the + * initial value of the maximum length to be set (the ``maximum + * constructor'' shown in the example above). This allows + * applications to control how much buffer space is initially + * allocated by the sequence. This constructor also sets the length + * to 0 and the release flag to TRUE. + */ TAO_Unbounded_WString_Sequence (CORBA::ULong maximum); - // Unbounded sequences provide a constructor that allows only the - // initial value of the maximum length to be set (the ``maximum - // constructor'' shown in the example above). This allows - // applications to control how much buffer space is initially - // allocated by the sequence. This constructor also sets the length - // to 0 and the release flag to TRUE. + /** + * The ``T *data'' constructor (as shown in the example above) + * allows the length and contents of a bounded or unbounded sequence + * to be set. For unbounded sequences, it also allows the initial + * value of the maximum length to be set. For this constructor, + * ownership of the contents vector is determined by the release + * parameter---FALSE means the caller owns the storage, while TRUE + * means that the sequence assumes ownership of the storage. + * If release is TRUE, the contents vector must have been allocated + * using the sequence allocbuf function, and the sequence will pass + * it to freebuf when finished with it. + */ TAO_Unbounded_WString_Sequence (CORBA::ULong maximum, CORBA::ULong length, CORBA::WChar **data, CORBA::Boolean release=0); - // The ``T *data'' constructor (as shown in the example above) - // allows the length and contents of a bounded or unbounded sequence - // to be set. For unbounded sequences, it also allows the initial - // value of the maximum length to be set. For this constructor, - // ownership of the contents vector is determined by the release - // parameter---FALSE means the caller owns the storage, while TRUE - // means that the sequence assumes ownership of the storage. - // If release is TRUE, the contents vector must have been allocated - // using the sequence allocbuf function, and the sequence will pass - // it to freebuf when finished with it. + /** + * The copy constructor performs a deep copy from the existing + * structure to create a new structure, including calling _duplicate + * on all object reference members and performing the necessary + * heap allocations for all string members. + * + * The copy constructor creates a new sequence with the same maximum + * and length as the given sequence, copies each of its current + * elements (items zero through length-1), and sets the release + * flag to TRUE. + */ TAO_Unbounded_WString_Sequence (const TAO_Unbounded_WString_Sequence&); - // The copy constructor performs a deep copy from the existing - // structure to create a new structure, including calling _duplicate - // on all object reference members and performing the necessary - // heap allocations for all string members. - // - // The copy constructor creates a new sequence with the same maximum - // and length as the given sequence, copies each of its current - // elements (items zero through length-1), and sets the release - // flag to TRUE. + /// The destructor releases all object reference members and frees + /// all string members. ~TAO_Unbounded_WString_Sequence (void); - // The destructor releases all object reference members and frees - // all string members. + /** + * The assignment operator first releases all object reference + * members and frees all wstring members, and then performs a + * deepcopy to create a new structure. + * + * The assignment operator deepcopies its parameter, releasing + * old storage if necessary. It behaves as if the original sequence + * is destroyed via its destructor and then the source sequence + * copied using the copy constructor. If release=TRUE, the + * destructor destroys each of the current elements (items zero + * through length--1). + * For an unbounded sequence, if a reallocation is necessary due to + * a change in the length and the sequence was created using the + * release=TRUE parameter in its constructor, the sequence will + * deallocate the old storage. If release is FALSE under these + * circumstances, old storage will not be freed before the + * reallocation is performed. After reallocation, the release flag + * is always set to TRUE. + */ TAO_Unbounded_WString_Sequence &operator= (const TAO_Unbounded_WString_Sequence &); - // The assignment operator first releases all object reference - // members and frees all wstring members, and then performs a - // deepcopy to create a new structure. - // - // The assignment operator deepcopies its parameter, releasing - // old storage if necessary. It behaves as if the original sequence - // is destroyed via its destructor and then the source sequence - // copied using the copy constructor. If release=TRUE, the - // destructor destroys each of the current elements (items zero - // through length--1). - // For an unbounded sequence, if a reallocation is necessary due to - // a change in the length and the sequence was created using the - // release=TRUE parameter in its constructor, the sequence will - // deallocate the old storage. If release is FALSE under these - // circumstances, old storage will not be freed before the - // reallocation is performed. After reallocation, the release flag - // is always set to TRUE. + /// read-write accessor TAO_SeqElem_WString_Manager operator[] (CORBA::ULong slot) const; - // read-write accessor + /** + * The allocbuf function allocates a vector of T elements that can + * be passed to the T *data constructor. The length of the vector is + * given by the nelems function argument. The allocbuf function + * initializes each element using its default constructor, except + * for strings, which are initialized to null pointers, and object + * references, which are initialized to suitably typed nil object + * references. A null pointer is returned if allocbuf for some + * reason cannot allocate the requested vector. Vectors allocated by + * allocbuf should be freed using the freebuf function. + */ static CORBA::WChar* *allocbuf (CORBA::ULong); - // The allocbuf function allocates a vector of T elements that can - // be passed to the T *data constructor. The length of the vector is - // given by the nelems function argument. The allocbuf function - // initializes each element using its default constructor, except - // for strings, which are initialized to null pointers, and object - // references, which are initialized to suitably typed nil object - // references. A null pointer is returned if allocbuf for some - // reason cannot allocate the requested vector. Vectors allocated by - // allocbuf should be freed using the freebuf function. + /** + * The freebuf function ensures that the destructor for each element + * is called before the buffer is destroyed, except for string + * elements, which are freed using wstring_free(), and object + * reference elements, which are freed using release(). The freebuf + * function will ignore null pointers passed to it. + */ static void freebuf (CORBA::WChar **); - // The freebuf function ensures that the destructor for each element - // is called before the buffer is destroyed, except for string - // elements, which are freed using wstring_free(), and object - // reference elements, which are freed using release(). The freebuf - // function will ignore null pointers passed to it. // = Fast buffer accessors. CORBA::WChar **get_buffer (CORBA::Boolean orphan = 0); @@ -463,23 +507,25 @@ template<class T> class TAO_Unbounded_Sequence; // template should also see the specialization. ACE_TEMPLATE_SPECIALIZATION +/** + * @class TAO_Unbounded_Sequence<CORBA::Octet> + * + * @brief An unbounded sequence of Octets + * + * Marshalling and demarshalling octet sequences can be highly + * optimize, for instance at demarshalling we don't require a copy + * from the CDR buffer to the octet sequence buffer, we can simply + * hold a duplicate of the underlying ACE_Message_Block. + * Specializing the TAO_Unbounded_Sequence<T> parametric + * class, is an excellent way to achieve this optimizations. + */ class TAO_Export TAO_Unbounded_Sequence<CORBA::Octet> : public TAO_Unbounded_Base_Sequence { - // = TITLE - // An unbounded sequence of Octets - // - // = DESCRIPTION - // Marshalling and demarshalling octet sequences can be highly - // optimize, for instance at demarshalling we don't require a copy - // from the CDR buffer to the octet sequence buffer, we can simply - // hold a duplicate of the underlying ACE_Message_Block. - // Specializing the TAO_Unbounded_Sequence<T> parametric - // class, is an excellent way to achieve this optimizations. - // public: + /// For efficient marshalling and demarshalling. friend class TAO_Marshal_Sequence; - // For efficient marshalling and demarshalling. + /// see TAO_Unbounded_Sequence in "Sequence_T.h" TAO_Unbounded_Sequence (void); TAO_Unbounded_Sequence (CORBA::ULong max); TAO_Unbounded_Sequence (CORBA::ULong max, @@ -487,38 +533,41 @@ public: CORBA::Octet *data, CORBA::Boolean release = 0); virtual ~TAO_Unbounded_Sequence (void); - // see TAO_Unbounded_Sequence in "Sequence_T.h" + /// Use in the implementation of insertion and extraction operators + /// from CORBA::Any static void _tao_any_destructor (void*); - // Use in the implementation of insertion and extraction operators - // from CORBA::Any + /** + * The copy constructor and assignment operators *do* copy the data, + * though we could simply duplicate the ref count in the + * ACE_Message_Block this will change the semantics for this + * operations. + */ TAO_Unbounded_Sequence (const TAO_Unbounded_Sequence<CORBA::Octet> &); TAO_Unbounded_Sequence<CORBA::Octet>& operator= (const TAO_Unbounded_Sequence<CORBA::Octet> &); - // The copy constructor and assignment operators *do* copy the data, - // though we could simply duplicate the ref count in the - // ACE_Message_Block this will change the semantics for this - // operations. + /** + * See the general description in "Sequence_T.h" + * NOTE: This last two methods can be rendered useless in certain + * cases, see below. + */ CORBA::Octet &operator[] (CORBA::ULong); const CORBA::Octet &operator[] (CORBA::ULong) const; - // See the general description in "Sequence_T.h" - // NOTE: This last two methods can be rendered useless in certain - // cases, see below. // = Static operations. + /// Allocate storage for the sequence, please note that the storage + /// is always held in a ACE_Message_Block. static CORBA::Octet *allocbuf (CORBA::ULong); - // Allocate storage for the sequence, please note that the storage - // is always held in a ACE_Message_Block. + /// Free the storage. static void freebuf (CORBA::Octet *); - // Free the storage. + /// Implement the methods for all the sequence, please seee + /// TAO_Base_Sequence. virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); - // Implement the methods for all the sequence, please seee - // TAO_Base_Sequence. // = Fast buffer accessors. CORBA::Octet *get_buffer (CORBA::Boolean orphan = 0); @@ -526,28 +575,28 @@ public: // NOTE: This last two methods can be rendered useless in certain // cases, see below. + /// See the general description of this methods in "Sequence_T.h". void replace (CORBA::ULong max, CORBA::ULong length, CORBA::Octet *data, CORBA::Boolean release = 0); - // See the general description of this methods in "Sequence_T.h". // = TAO extensions #if (TAO_NO_COPY_OCTET_SEQUENCES == 1) + /// Returns the underlying message block, the caller must *not* + /// release the copy. ACE_Message_Block* mb (void) const; - // Returns the underlying message block, the caller must *not* - // release the copy. + /// Create a sequence of octets from a single message block (i.e. it + /// ignores any chaining in the meesage block). TAO_Unbounded_Sequence (CORBA::ULong length, const ACE_Message_Block* mb); - // Create a sequence of octets from a single message block (i.e. it - // ignores any chaining in the meesage block). + /// Replaces the current buffer with <mb>, using only <length> bytes. + /// It takes a duplicate of <mb> so the user still owns it. void replace (CORBA::ULong length, const ACE_Message_Block* mb); - // Replaces the current buffer with <mb>, using only <length> bytes. - // It takes a duplicate of <mb> so the user still owns it. // // NOTE: diff --git a/TAO/tao/Sequence_T.h b/TAO/tao/Sequence_T.h index 34b0247e5a3..7cec8c0c899 100644 --- a/TAO/tao/Sequence_T.h +++ b/TAO/tao/Sequence_T.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// sequence_T.h -// -// = AUTHOR -// Carlos O'Ryan and Aniruddha Gokhale -// -// ============================================================================ + +//============================================================================= +/** + * @file Sequence_T.h + * + * $Id$ + * + * @author Carlos O'Ryan and Aniruddha Gokhale + */ +//============================================================================= + #ifndef TAO_SEQUENCE_T_H #define TAO_SEQUENCE_T_H @@ -20,199 +17,217 @@ #include "tao/Sequence.h" +/** + * @class TAO_Unbounded_Sequence + * + * @brief Parametrized implementation of IDL unbounded sequences. + * + * This class completes the implementation for TAO_Base_Sequence + * for the unbounded case. + */ template <class T> class TAO_Unbounded_Sequence : public TAO_Unbounded_Base_Sequence { - // = TITLE - // Parametrized implementation of IDL unbounded sequences. - // - // = DESCRIPTION - // This class completes the implementation for TAO_Base_Sequence - // for the unbounded case. public: // = Initialization and termination methods. + /// Default constructor. TAO_Unbounded_Sequence (void); - // Default constructor. + /// Constructor using a maximum length value. TAO_Unbounded_Sequence (CORBA::ULong max); - // Constructor using a maximum length value. + /** + * Constructor using the data and memory management flag. Memory + * *must* be allocated using the ::allocbuf static method, since in + * the future this classes may use a global ACE_Allocator. + */ TAO_Unbounded_Sequence (CORBA::ULong max, CORBA::ULong length, T *data, CORBA::Boolean release = 0); - // Constructor using the data and memory management flag. Memory - // *must* be allocated using the ::allocbuf static method, since in - // the future this classes may use a global ACE_Allocator. + /// Copy constructor. TAO_Unbounded_Sequence (const TAO_Unbounded_Sequence<T> &); - // Copy constructor. + /// Assignment operator. TAO_Unbounded_Sequence<T> &operator= (const TAO_Unbounded_Sequence<T> &); - // Assignment operator. + /// Dtor. ~TAO_Unbounded_Sequence (void); - // Dtor. // = Accessors. + /// operator [] T &operator[] (CORBA::ULong); - // operator [] + /// operator [] const T &operator[] (CORBA::ULong) const; - // operator [] // = Static operations. + /// Allocate storage for the sequence. static T *allocbuf (CORBA::ULong); - // Allocate storage for the sequence. + /// Free the sequence. static void freebuf (T *); - // Free the sequence. + /// Implement the TAO_Base_Sequence methods (see Sequence.h) virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); - // Implement the TAO_Base_Sequence methods (see Sequence.h) // = orbos/98-01-11 proposed extensions. + /** + * Allows read-write access to the underlying buffer. If <orphan> + * is FALSE the sequence returns a pointer to its buffer, allocating + * one if it has not yet done so. The number of elements in the + * buffer can be determined from the sequence <length> accessor. + * + * If the <orphan> argument to <get_buffer> is FALSE, the sequence + * maintains ownership of the underlying buffer. Elements in the + * returned buffer may be directly replaced by the caller. For + * sequences of strings, wide strings, and object references, the + * caller must use the sequence <release> accessor to determine + * whether elements should be freed (using <string_free>, + * <wstring_free>, or <CORBA::release> for strings, wide straings, + * and object references, respective) before being directly assigned + * to. + * + * If the <orphan> argument to <get_buffer> is TRUE, the sequence + * yields ownership of the buffer to the caller. If <orphan> is + * TRUE and the sequence does not own its buffer (i.e., its + * <release> flag is FALSE), the return value is a null pointer. If + * the buffer is taken from the sequence using this form of + * <get_buffer>, the sequence reverts to the same state it would + * have if constructed using its default constructor. The caller + * becomes responsible for eventually freeing each element of the + * returned buffer (for strings, wide string, and object + * references), and then freeing the returned buffer itself using + * <freebuf>. + */ T *get_buffer (CORBA::Boolean orphan = 0); - // Allows read-write access to the underlying buffer. If <orphan> - // is FALSE the sequence returns a pointer to its buffer, allocating - // one if it has not yet done so. The number of elements in the - // buffer can be determined from the sequence <length> accessor. - // - // If the <orphan> argument to <get_buffer> is FALSE, the sequence - // maintains ownership of the underlying buffer. Elements in the - // returned buffer may be directly replaced by the caller. For - // sequences of strings, wide strings, and object references, the - // caller must use the sequence <release> accessor to determine - // whether elements should be freed (using <string_free>, - // <wstring_free>, or <CORBA::release> for strings, wide straings, - // and object references, respective) before being directly assigned - // to. - // - // If the <orphan> argument to <get_buffer> is TRUE, the sequence - // yields ownership of the buffer to the caller. If <orphan> is - // TRUE and the sequence does not own its buffer (i.e., its - // <release> flag is FALSE), the return value is a null pointer. If - // the buffer is taken from the sequence using this form of - // <get_buffer>, the sequence reverts to the same state it would - // have if constructed using its default constructor. The caller - // becomes responsible for eventually freeing each element of the - // returned buffer (for strings, wide string, and object - // references), and then freeing the returned buffer itself using - // <freebuf>. + /** + * This function allows read-only access to the sequence buffer. + * The sequence returns its buffer, allocating one of one has not + * yet been allocated. No direct modification of the returned + * buffer by the caller is permitted. + */ const T *get_buffer (void) const; - // This function allows read-only access to the sequence buffer. - // The sequence returns its buffer, allocating one of one has not - // yet been allocated. No direct modification of the returned - // buffer by the caller is permitted. + /** + * Allows the buffer underlying a sequence to be replaced. The + * parameters to <replace> are identical in type, order, and purpose + * to those for the <T *data> constructor for the sequence. + */ void replace (CORBA::ULong max, CORBA::ULong length, T *data, CORBA::Boolean release = 0); - // Allows the buffer underlying a sequence to be replaced. The - // parameters to <replace> are identical in type, order, and purpose - // to those for the <T *data> constructor for the sequence. }; +/** + * @class TAO_Bounded_Sequence + * + * @brief Parametric bounded sequence. + * + * This class completes the implementation for TAO_Base_Sequence + * for the bounded case. + */ template <class T, size_t MAX> class TAO_Bounded_Sequence : public TAO_Bounded_Base_Sequence { - // = TITLE - // Parametric bounded sequence. - // - // = DESCRIPTION - // This class completes the implementation for TAO_Base_Sequence - // for the bounded case. public: // = Initialization and termination methods. + /// Default constructor. TAO_Bounded_Sequence (void); - // Default constructor. + /// Constructor using the data and memory management flag. TAO_Bounded_Sequence (CORBA::ULong length, T *data, CORBA::Boolean release=0); - // Constructor using the data and memory management flag. + /// Copy constructor. TAO_Bounded_Sequence (const TAO_Bounded_Sequence<T,MAX> &); - // Copy constructor. + /// Assignment operator. TAO_Bounded_Sequence<T,MAX> &operator= (const TAO_Bounded_Sequence<T,MAX> &); - // Assignment operator. + /// Dtor. ~TAO_Bounded_Sequence (void); - // Dtor. // = Accessors. + /// operator [] T &operator[] (CORBA::ULong); - // operator [] + /// operator [] const T &operator[] (CORBA::ULong) const; - // operator [] // = Static operations. + /// Allocate storage for the sequence. static T *allocbuf (CORBA::ULong); - // Allocate storage for the sequence. + /// Free the sequence. static void freebuf (T *); - // Free the sequence. + /// allocate a buffer of the requested length. The buffer is allocated for the + /// right type virtual void _allocate_buffer (CORBA::ULong length); - // allocate a buffer of the requested length. The buffer is allocated for the - // right type + /// deallocate the buffer virtual void _deallocate_buffer (void); - // deallocate the buffer // = orbos/98-01-11 proposed extensions. + /** + * Allows read-write access to the underlying buffer. If <orphan> + * is FALSE the sequence returns a pointer to its buffer, allocating + * one if it has not yet done so. The size of the returned buffer + * is equal to the sequence bound, which can be determined with the + * <maximum> accessor. The number of elements in the buffer can be + * determined from the sequence <length> accessor. + * + * If the <orphan> argument to <get_buffer> is FALSE, the sequence + * maintains ownership of the underlying buffer. Elements in the + * returned buffer may be directly replaced by the caller. For + * sequences of strings, wide strings, and object references, the + * caller must use the sequence <release> accessor to determine + * whether elements should be freed (using <string_free>, + * <wstring_free>, or <CORBA::release> for strings, wide straings, + * and object references, respective) before being directly assigned + * to. + * + * If the <orphan> argument to <get_buffer> is TRUE, the sequence + * yields ownership of the buffer to the caller. If <orphan> is + * TRUE and the sequence does not own its buffer (i.e., its + * <release> flag is FALSE), the return value is a null pointer. If + * the buffer is taken from the sequence using this form of + * <get_buffer>, the sequence reverts to the same state it would + * have if constructed using its default constructor. The caller + * becomes responsible for eventually freeing each element of the + * returned buffer (for strings, wide string, and object + * references), and then freeing the returned buffer itself using + * <freebuf>. + */ T *get_buffer (CORBA::Boolean orphan = 0); - // Allows read-write access to the underlying buffer. If <orphan> - // is FALSE the sequence returns a pointer to its buffer, allocating - // one if it has not yet done so. The size of the returned buffer - // is equal to the sequence bound, which can be determined with the - // <maximum> accessor. The number of elements in the buffer can be - // determined from the sequence <length> accessor. - // - // If the <orphan> argument to <get_buffer> is FALSE, the sequence - // maintains ownership of the underlying buffer. Elements in the - // returned buffer may be directly replaced by the caller. For - // sequences of strings, wide strings, and object references, the - // caller must use the sequence <release> accessor to determine - // whether elements should be freed (using <string_free>, - // <wstring_free>, or <CORBA::release> for strings, wide straings, - // and object references, respective) before being directly assigned - // to. - // - // If the <orphan> argument to <get_buffer> is TRUE, the sequence - // yields ownership of the buffer to the caller. If <orphan> is - // TRUE and the sequence does not own its buffer (i.e., its - // <release> flag is FALSE), the return value is a null pointer. If - // the buffer is taken from the sequence using this form of - // <get_buffer>, the sequence reverts to the same state it would - // have if constructed using its default constructor. The caller - // becomes responsible for eventually freeing each element of the - // returned buffer (for strings, wide string, and object - // references), and then freeing the returned buffer itself using - // <freebuf>. + /** + * This function allows read-only access to the sequence buffer. + * The sequence returns its buffer, allocating one of one has not + * yet been allocated. No direct modification of the returned + * buffer by the caller is permitted. + */ const T *get_buffer (void) const; - // This function allows read-only access to the sequence buffer. - // The sequence returns its buffer, allocating one of one has not - // yet been allocated. No direct modification of the returned - // buffer by the caller is permitted. + /** + * Allows the buffer underlying a sequence to be replaced. The + * parameters to <replace> are identical in type, order, and purpose + * to those for the <T *data> constructor for the sequence. + */ void replace (CORBA::ULong max, CORBA::ULong length, T *data, CORBA::Boolean release = 0); - // Allows the buffer underlying a sequence to be replaced. The - // parameters to <replace> are identical in type, order, and purpose - // to those for the <T *data> constructor for the sequence. }; // ************************************************************* @@ -224,36 +239,33 @@ template<size_t MAX> class TAO_Bounded_String_Sequence; // ************************************************************* + /** + * @class TAO_Object_Manager + * + * @brief Manager for Objects. + * + * The mapping for sequences of objects (and other pseudo objects) + * requires an auxiliar class or <Manager> to handle the reference + * count on the object, (a kind of smart pointer). + * The main difference with respect to T_var classes is that + * automatic release is not controlled on a per-item basis, but + * for the sequence as a whole. + * Further the class must implement "transparent" assignment into + * the sequence, for instance, operator[] returns a managed + * object, but: + * object_sequence[i] = foo; + * must change the state of the sequence. + * This class implements the generic object manager and is used to + * instantiate the proper sequence types. + * = NOTES + * It has been proposed that the class should be parametric on + * both T and T_ptr, IMHO this is no necesary: though the IDL spec + * says that T_ptr *could* map to a type different to T* in the + * particular case of TAO it does map to <T*>. + */ template<class T, class T_var> class TAO_Object_Manager { - // = TITLE - // Manager for Objects. - // - // = DESCRIPTION - // The mapping for sequences of objects (and other pseudo objects) - // requires an auxiliar class or <Manager> to handle the reference - // count on the object, (a kind of smart pointer). - // The main difference with respect to T_var classes is that - // automatic release is not controlled on a per-item basis, but - // for the sequence as a whole. - // Further the class must implement "transparent" assignment into - // the sequence, for instance, operator[] returns a managed - // object, but: - // - // object_sequence[i] = foo; - // - // must change the state of the sequence. - // - // This class implements the generic object manager and is used to - // instantiate the proper sequence types. - // - // = NOTES - // It has been proposed that the class should be parametric on - // both T and T_ptr, IMHO this is no necesary: though the IDL spec - // says that T_ptr *could* map to a type different to T* in the - // particular case of TAO it does map to <T*>. - // friend class TAO_Unbounded_Object_Sequence<T,T_var>; public: // @@ Use partial template specialization here to give access only @@ -262,74 +274,81 @@ public: // class TAO_Bounded_Object_Sequence<T,MAX>; // = Initialization and termination methods. + /** + * Copy constructor, the semantics are non-trivial: + * + The referenced element is duplicated or not according to the + * release value on the <rhs>. + * + In any case a new reference to the same object is created. + */ TAO_Object_Manager (const TAO_Object_Manager<T,T_var> &rhs); - // Copy constructor, the semantics are non-trivial: - // + The referenced element is duplicated or not according to the - // release value on the <rhs>. - // + In any case a new reference to the same object is created. + /** + * Constructor from address of an element, it should be private and + * only TAO_*_Object_Sequence would use it, but we have some + * problems with friendship and templates. + */ TAO_Object_Manager (T **, CORBA::Boolean release); - // Constructor from address of an element, it should be private and - // only TAO_*_Object_Sequence would use it, but we have some - // problems with friendship and templates. + /// Destructor, only releases the object if <release_> is true. ~TAO_Object_Manager (void); - // Destructor, only releases the object if <release_> is true. + /** + * Assignment from another managed type, only release if + * <this->release_> is true. + * @@ TODO what happens if rhs.release_ is true an this->relase_ is + * false? + */ TAO_Object_Manager<T,T_var> &operator= (const TAO_Object_Manager<T,T_var> &rhs); - // Assignment from another managed type, only release if - // <this->release_> is true. - // @@ TODO what happens if rhs.release_ is true an this->relase_ is - // false? + /// Assignment from T *. TAO_Object_Manager<T,T_var> &operator= (T *); - // Assignment from T *. + /// Assignment from T *. TAO_Object_Manager<T,T_var> &operator= (T_var &); - // Assignment from T *. + /// Return pointer. T * operator-> (void) const; - // Return pointer. + /// Cast (read-only). operator const T *() const; - // Cast (read-only). + /// Cast. operator T *&(); - // Cast. + /// Cast (read-only) so that assignment from a structured + /// type to a T_var will make a copy. operator const T_var() const; - // Cast (read-only) so that assignment from a structured - // type to a T_var will make a copy. + /// for in parameter. T *in (void) const; - // for in parameter. + /// for inout parameter. T *&inout (void); - // for inout parameter. + /// for out parameter. T *&out (void); - // for out parameter. + /// for return type T *_retn (void); - // for return type private: + /// data member, notice that it is a pointer, to implement the + /// reference behavior for assignment. T **ptr_; - // data member, notice that it is a pointer, to implement the - // reference behavior for assignment. + /// release flag based on parent's flag CORBA::Boolean release_; - // release flag based on parent's flag }; + /** + * @class TAO_Pseudo_Object_Manager + * + * @brief Manager for Pseudo Objects. + * + */ template<class T, class T_var> class TAO_Pseudo_Object_Manager { - // = TITLE - // Manager for Pseudo Objects. - // - // = DESCRIPTION - // friend class TAO_Unbounded_Pseudo_Sequence<T,T_var>; public: // @@ Use partial template specialization here to give access only @@ -338,74 +357,82 @@ public: // class TAO_Bounded_Object_Sequence<T,MAX>; // = Initialization and termination methods. + /** + * Copy constructor, the semantics are non-trivial: + * + The referenced element is duplicated or not according to the + * release value on the <rhs>. + * + In any case a new reference to the same object is created. + */ TAO_Pseudo_Object_Manager (const TAO_Pseudo_Object_Manager<T,T_var> &rhs); - // Copy constructor, the semantics are non-trivial: - // + The referenced element is duplicated or not according to the - // release value on the <rhs>. - // + In any case a new reference to the same object is created. + /** + * Constructor from address of an element, it should be private and + * only TAO_*_Object_Sequence would use it, but we have some + * problems with friendship and templates. + */ TAO_Pseudo_Object_Manager (T **, CORBA::Boolean release); - // Constructor from address of an element, it should be private and - // only TAO_*_Object_Sequence would use it, but we have some - // problems with friendship and templates. + /// Destructor, only releases the object if <release_> is true. ~TAO_Pseudo_Object_Manager (void); - // Destructor, only releases the object if <release_> is true. + /** + * Assignment from another managed type, only release if + * <this->release_> is true. + * @@ TODO what happens if rhs.release_ is true an this->relase_ is + * false? + */ TAO_Pseudo_Object_Manager<T,T_var> &operator= (const TAO_Pseudo_Object_Manager<T,T_var> &rhs); - // Assignment from another managed type, only release if - // <this->release_> is true. - // @@ TODO what happens if rhs.release_ is true an this->relase_ is - // false? + /// Assignment from T *. TAO_Pseudo_Object_Manager<T,T_var> &operator= (T *); - // Assignment from T *. + /// Assignment from T *. TAO_Pseudo_Object_Manager<T,T_var> &operator= (T_var &); - // Assignment from T *. + /// Return pointer. T * operator-> (void) const; - // Return pointer. + /// Cast (read-only). operator const T *() const; - // Cast (read-only). + /// Cast. operator T *&(); - // Cast. + /// for in parameter. T *in (void) const; - // for in parameter. + /// for inout parameter. T *&inout (void); - // for inout parameter. + /// for out parameter. T *&out (void); - // for out parameter. + /// for return type T *_retn (void); - // for return type private: + /// data member, notice that it is a pointer, to implement the + /// reference behavior for assignment. T **ptr_; - // data member, notice that it is a pointer, to implement the - // reference behavior for assignment. + /// release flag based on parent's flag CORBA::Boolean release_; - // release flag based on parent's flag }; // ************************************************************* +/** + * @class TAO_Unbounded_Object_Sequence + * + * @brief Parametric sequence for types that require managers. + * + * Some IDL types require that sequences on them have a "manager" + * class, in charge of handling the object lifetime, examples are + * pseudo objects, object references and strings. + */ template<class T,class T_var> class TAO_Unbounded_Object_Sequence : public TAO_Unbounded_Base_Sequence { - // = TITLE - // Parametric sequence for types that require managers. - // - // = DESCRIPTION - // Some IDL types require that sequences on them have a "manager" - // class, in charge of handling the object lifetime, examples are - // pseudo objects, object references and strings. // = SPEC // 16.8 Mapping for Structured Types @@ -416,96 +443,112 @@ class TAO_Unbounded_Object_Sequence : public TAO_Unbounded_Base_Sequence public: // = Initialization and termination methods. + /** + * {orbos/97-05-15:16.8} + * The default constructor initializes object reference members to + * appropriately typed nil object references and string members to + * NULL; all other members are initialized via their default + * constructors. + * + * {orbos/97-05-15:16.11} + * For both bounded and unbounded sequences, the default constructor + * (as shown in the example above) sets the sequence length equal to + * 0. + */ TAO_Unbounded_Object_Sequence (void); - // {orbos/97-05-15:16.8} - // The default constructor initializes object reference members to - // appropriately typed nil object references and string members to - // NULL; all other members are initialized via their default - // constructors. - // - // {orbos/97-05-15:16.11} - // For both bounded and unbounded sequences, the default constructor - // (as shown in the example above) sets the sequence length equal to - // 0. + /** + * Unbounded sequences provide a constructor that allows only the + * initial value of the maximum length to be set (the ``maximum + * constructor'' shown in the example above). This allows + * applications to control how much buffer space is initially + * allocated by the sequence. This constructor also sets the length + * to 0 and the release flag to TRUE. + */ TAO_Unbounded_Object_Sequence (CORBA::ULong max); - // Unbounded sequences provide a constructor that allows only the - // initial value of the maximum length to be set (the ``maximum - // constructor'' shown in the example above). This allows - // applications to control how much buffer space is initially - // allocated by the sequence. This constructor also sets the length - // to 0 and the release flag to TRUE. + /** + * The ``T *data'' constructor (as shown in the example above) + * allows the length and contents of a bounded or unbounded sequence + * to be set. For unbounded sequences, it also allows the initial + * value of the maximum length to be set. For this constructor, + * ownership of the contents vector is determined by the release + * parameter---FALSE means the caller owns the storage, while TRUE + * means that the sequence assumes ownership of the storage. + * If release is TRUE, the contents vector must have been allocated + * using the sequence allocbuf function, and the sequence will pass + * it to freebuf when finished with it. + */ TAO_Unbounded_Object_Sequence (CORBA::ULong maximum, CORBA::ULong length, T* *data, CORBA::Boolean release=0); - // The ``T *data'' constructor (as shown in the example above) - // allows the length and contents of a bounded or unbounded sequence - // to be set. For unbounded sequences, it also allows the initial - // value of the maximum length to be set. For this constructor, - // ownership of the contents vector is determined by the release - // parameter---FALSE means the caller owns the storage, while TRUE - // means that the sequence assumes ownership of the storage. - // If release is TRUE, the contents vector must have been allocated - // using the sequence allocbuf function, and the sequence will pass - // it to freebuf when finished with it. + /** + * The copy constructor performs a deep copy from the existing + * structure to create a new structure, including calling _duplicate + * on all object reference members and performing the necessary + * heap allocations for all string members. + * + * The copy constructor creates a new sequence with the same maximum + * and length as the given sequence, copies each of its current + * elements (items zero through length-1), and sets the release + * flag to TRUE. + */ TAO_Unbounded_Object_Sequence(const TAO_Unbounded_Object_Sequence<T,T_var> &); - // The copy constructor performs a deep copy from the existing - // structure to create a new structure, including calling _duplicate - // on all object reference members and performing the necessary - // heap allocations for all string members. - // - // The copy constructor creates a new sequence with the same maximum - // and length as the given sequence, copies each of its current - // elements (items zero through length-1), and sets the release - // flag to TRUE. + /// The destructor releases all object reference memebrs and frees + /// all string members. ~TAO_Unbounded_Object_Sequence (void); - // The destructor releases all object reference memebrs and frees - // all string members. + /** + * The assignment operator first releases all object reference + * members and frees all string members, and then performs a + * deepcopy to create a new structure. + * + * The assignment operator deepcopies its parameter, releasing old + * storage if necessary. It behaves as if the original sequence is + * destroyed via its destructor and then the source sequence copied + * using the copy constructor. If release=TRUE, the destructor + * destroys each of the current elements (items zero through + * length--1). For an unbounded sequence, if a reallocation is + * necessary due to a change in the length and the sequence was + * created using the release=TRUE parameter in its constructor, the + * sequence will deallocate the old storage. If release is FALSE + * under these circumstances, old storage will not be freed before + * the reallocation is performed. After reallocation, the release + * flag is always set to TRUE. + */ TAO_Unbounded_Object_Sequence<T,T_var> &operator= (const TAO_Unbounded_Object_Sequence <T,T_var> &); - // The assignment operator first releases all object reference - // members and frees all string members, and then performs a - // deepcopy to create a new structure. - // - // The assignment operator deepcopies its parameter, releasing old - // storage if necessary. It behaves as if the original sequence is - // destroyed via its destructor and then the source sequence copied - // using the copy constructor. If release=TRUE, the destructor - // destroys each of the current elements (items zero through - // length--1). For an unbounded sequence, if a reallocation is - // necessary due to a change in the length and the sequence was - // created using the release=TRUE parameter in its constructor, the - // sequence will deallocate the old storage. If release is FALSE - // under these circumstances, old storage will not be freed before - // the reallocation is performed. After reallocation, the release - // flag is always set to TRUE. + /// read-write accessor TAO_Object_Manager<T,T_var> operator[] (CORBA::ULong slot) const; - // read-write accessor + /** + * The allocbuf function allocates a vector of T elements that can + * be passed to the T *data constructor. The length of the vector is + * given by the nelems function argument. The allocbuf function + * initializes each element using its default constructor, except + * for strings, which are initialized to null pointers, and object + * references, which are initialized to suitably typed nil object + * references. A null pointer is returned if allocbuf for some + * reason cannot allocate the requested vector. Vectors allocated by + * allocbuf should be freed using the freebuf function. + */ static T **allocbuf (CORBA::ULong); - // The allocbuf function allocates a vector of T elements that can - // be passed to the T *data constructor. The length of the vector is - // given by the nelems function argument. The allocbuf function - // initializes each element using its default constructor, except - // for strings, which are initialized to null pointers, and object - // references, which are initialized to suitably typed nil object - // references. A null pointer is returned if allocbuf for some - // reason cannot allocate the requested vector. Vectors allocated by - // allocbuf should be freed using the freebuf function. + /** + * The freebuf function ensures that the destructor for each element + * is called before the buffer is destroyed, except for string + * elements, which are freed using string_free(), and object + * reference elements, which are freed using release(). The freebuf + * function will ignore null pointers passed to it. + */ static void freebuf (T **); - // The freebuf function ensures that the destructor for each element - // is called before the buffer is destroyed, except for string - // elements, which are freed using string_free(), and object - // reference elements, which are freed using release(). The freebuf - // function will ignore null pointers passed to it. // The Base_Sequence functions, please see "tao/Sequence.h" + /// No default to workaround egcs problem with templates and + /// namespaces virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); virtual void _shrink_buffer (CORBA::ULong new_length, @@ -514,57 +557,60 @@ public: CORBA_Object* src, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // No default to workaround egcs problem with templates and - // namespaces virtual CORBA_Object* _upcast (void* src) const; }; // ************************************************************* +/** + * @class TAO_Bounded_Object_Sequence + * + * @brief Parametric sequence for types that require managers. + * + * Please see the documentation for the unbounded case. + */ template<class T, class T_var, size_t MAX> class TAO_Bounded_Object_Sequence : public TAO_Bounded_Base_Sequence { - // = TITLE - // Parametric sequence for types that require managers. - // - // = DESCRIPTION - // Please see the documentation for the unbounded case. - // public: // = Initialization and termination methods. + /** + * For bounded sequences, the maximum length is part of the type and + * cannot be set or modified, while for unbounded sequences, the + * default constructor also sets the maximum length to 0. The + * default constructor for a bounded sequence always allocates a + * contents vector, so it always sets the release flag to TRUE. + */ TAO_Bounded_Object_Sequence (void); - // For bounded sequences, the maximum length is part of the type and - // cannot be set or modified, while for unbounded sequences, the - // default constructor also sets the maximum length to 0. The - // default constructor for a bounded sequence always allocates a - // contents vector, so it always sets the release flag to TRUE. + /// Constructor from data. TAO_Bounded_Object_Sequence (CORBA::ULong length, T* *value, CORBA::Boolean release=0); - // Constructor from data. + /// Copy constructor. TAO_Bounded_Object_Sequence (const TAO_Bounded_Object_Sequence<T,T_var,MAX> &); - // Copy constructor. + /// destructor ~TAO_Bounded_Object_Sequence (void); - // destructor + /// Assignment from another Bounded sequence. TAO_Bounded_Object_Sequence &operator= (const TAO_Bounded_Object_Sequence<T,T_var,MAX> &); - // Assignment from another Bounded sequence. + /// Read-write accessor. TAO_Object_Manager<T,T_var> operator[] (CORBA::ULong slot) const; - // Read-write accessor. + /// Allocate storage for a sequence.. static T **allocbuf (CORBA::ULong length); - // Allocate storage for a sequence.. + /// Free a buffer allocated by allocbuf() and release each element on + /// it. static void freebuf (T **buffer); - // Free a buffer allocated by allocbuf() and release each element on - // it. // The Base_Sequence functions, please see "tao/sequence.h" + /// No default to workaround egcs problem with templates and + /// namespaces virtual void _allocate_buffer (CORBA::ULong length); virtual void _deallocate_buffer (void); virtual void _shrink_buffer (CORBA::ULong new_length, @@ -573,62 +619,64 @@ public: CORBA_Object* src, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // No default to workaround egcs problem with templates and - // namespaces virtual CORBA_Object* _upcast (void* src) const; }; // ************************************************************* +/** + * @class TAO_Unbounded_Pseudo_Sequence + * + * @brief Parametric sequence for pseudo objects. + * + * Some IDL types (including pseudo objects) require that + * sequences on them have a "manager" class, in charge of handling + * the object lifetime. + * This parametric class implements those sequences. In general + * the sequence is similar to Object_Sequente, except for some + * TAO internal details. The complete documentation of each method + * is provided in TAO_Unbounded_Object_Sequece + */ template<class T,class T_var> class TAO_Unbounded_Pseudo_Sequence : public TAO_Unbounded_Base_Sequence { - // = TITLE - // Parametric sequence for pseudo objects. - // - // = DESCRIPTION - // Some IDL types (including pseudo objects) require that - // sequences on them have a "manager" class, in charge of handling - // the object lifetime. - // This parametric class implements those sequences. In general - // the sequence is similar to Object_Sequente, except for some - // TAO internal details. The complete documentation of each method - // is provided in TAO_Unbounded_Object_Sequece public: // = Initialization and termination methods. + /// default ctor TAO_Unbounded_Pseudo_Sequence (void); - // default ctor + /// Constructor with a "hint" for the maximum capacity. TAO_Unbounded_Pseudo_Sequence (CORBA::ULong max); - // Constructor with a "hint" for the maximum capacity. + /// Constructor with a given buffer. TAO_Unbounded_Pseudo_Sequence (CORBA::ULong maximum, CORBA::ULong length, T* *data, CORBA::Boolean release=0); - // Constructor with a given buffer. + /// Copy ctor, deep copies. TAO_Unbounded_Pseudo_Sequence(const TAO_Unbounded_Pseudo_Sequence<T,T_var> &); - // Copy ctor, deep copies. + /// dtor releases all the contained elements. ~TAO_Unbounded_Pseudo_Sequence (void); - // dtor releases all the contained elements. + /** + * The assignment operator first releases all object reference + * members and frees all string members, and then performs a + * deepcopy to create a new structure. + */ TAO_Unbounded_Pseudo_Sequence<T,T_var> &operator= (const TAO_Unbounded_Pseudo_Sequence <T,T_var> &); - // The assignment operator first releases all object reference - // members and frees all string members, and then performs a - // deepcopy to create a new structure. + /// read-write accessor TAO_Pseudo_Object_Manager<T,T_var> operator[] (CORBA::ULong slot) const; - // read-write accessor + /// The allocbuf function allocates a vector of T elements that can + /// be passed to the T *data constructor. static T **allocbuf (CORBA::ULong); - // The allocbuf function allocates a vector of T elements that can - // be passed to the T *data constructor. + /// Release all the elements. static void freebuf (T **); - // Release all the elements. // The Base_Sequence functions, please see "tao/Sequence.h" virtual void _allocate_buffer (CORBA::ULong length); @@ -639,44 +687,45 @@ public: // ************************************************************* +/** + * @class TAO_Bounded_Pseudo_Sequence + * + * @brief Bounded version of TAO_Unbounded_Pseudo_Sequence. + * + * Please see the documentation for the unbounded case. + */ template<class T, class T_var, size_t MAX> class TAO_Bounded_Pseudo_Sequence : public TAO_Bounded_Base_Sequence { - // = TITLE - // Bounded version of TAO_Unbounded_Pseudo_Sequence. - // - // = DESCRIPTION - // Please see the documentation for the unbounded case. - // public: // = Initialization and termination methods. + /// default ctor. TAO_Bounded_Pseudo_Sequence (void); - // default ctor. + /// Constructor from data. TAO_Bounded_Pseudo_Sequence (CORBA::ULong length, T* *value, CORBA::Boolean release=0); - // Constructor from data. + /// Copy constructor. TAO_Bounded_Pseudo_Sequence (const TAO_Bounded_Pseudo_Sequence<T,T_var,MAX> &); - // Copy constructor. + /// destructor ~TAO_Bounded_Pseudo_Sequence (void); - // destructor + /// Assignment from another Bounded sequence. TAO_Bounded_Pseudo_Sequence &operator= (const TAO_Bounded_Pseudo_Sequence<T,T_var,MAX> &); - // Assignment from another Bounded sequence. + /// Read-write accessor. TAO_Pseudo_Object_Manager<T,T_var> operator[] (CORBA::ULong slot) const; - // Read-write accessor. + /// Allocate storage for a sequence.. static T **allocbuf (CORBA::ULong length); - // Allocate storage for a sequence.. + /// Free a buffer allocated by allocbuf() and release each element on + /// it. static void freebuf (T **buffer); - // Free a buffer allocated by allocbuf() and release each element on - // it. // The Base_Sequence functions, please see "tao/sequence.h" virtual void _allocate_buffer (CORBA::ULong length); @@ -687,275 +736,308 @@ public: // ************************************************************* +/** + * @class TAO_Unbounded_Array_Sequence + * + * @brief Parametric sequence for arrays. + * + * The IDL mapping for arrays includes some unique allocation, + * deallocation, and copying functions, and precludes + * direct assignment of one array to another. Also, the + * Any and CDR operators use a special class derived from + * the array. For these reasons, we use a special class for + * sequences of arrays, parametrized on the array element type. + */ template<class T, class T_var> class TAO_Unbounded_Array_Sequence : public TAO_Unbounded_Base_Sequence { - // = TITLE - // Parametric sequence for arrays. - // - // = DESCRIPTION - // The IDL mapping for arrays includes some unique allocation, - // deallocation, and copying functions, and precludes - // direct assignment of one array to another. Also, the - // Any and CDR operators use a special class derived from - // the array. For these reasons, we use a special class for - // sequences of arrays, parametrized on the array element type. public: // = Initialization and termination methods. + /// default ctor TAO_Unbounded_Array_Sequence (void); - // default ctor + /// Constructor with a "hint" for the maximum capacity. TAO_Unbounded_Array_Sequence (CORBA::ULong max); - // Constructor with a "hint" for the maximum capacity. + /// Constructor with a given buffer. TAO_Unbounded_Array_Sequence (CORBA::ULong maximum, CORBA::ULong length, T *data, CORBA::Boolean release=0); - // Constructor with a given buffer. + /// Copy ctor, deep copies. TAO_Unbounded_Array_Sequence(const TAO_Unbounded_Array_Sequence<T, T_var> &); - // Copy ctor, deep copies. + /// dtor releases all the contained elements. ~TAO_Unbounded_Array_Sequence (void); - // dtor releases all the contained elements. + /** + * The assignment operator first releases all object reference + * members and frees all string members, and then performs a + * deepcopy to create a new structure. + */ TAO_Unbounded_Array_Sequence<T, T_var> &operator= ( const TAO_Unbounded_Array_Sequence <T, T_var> & ); - // The assignment operator first releases all object reference - // members and frees all string members, and then performs a - // deepcopy to create a new structure. // = Accessors. + /// operator [] T &operator[] (CORBA::ULong); - // operator [] + /// operator [] const T &operator[] (CORBA::ULong) const; - // operator [] + /// The allocbuf function allocates a vector of T elements that can + /// be passed to the T *data constructor. static T *allocbuf (CORBA::ULong); - // The allocbuf function allocates a vector of T elements that can - // be passed to the T *data constructor. + /// Release all the elements. static void freebuf (T *); - // Release all the elements. + /// allocate a buffer of the requested length. The buffer is allocated for the + /// right type virtual void _allocate_buffer (CORBA::ULong length); - // allocate a buffer of the requested length. The buffer is allocated for the - // right type + /// deallocate the buffer virtual void _deallocate_buffer (void); - // deallocate the buffer // = orbos/98-01-11 proposed extensions. + /** + * Allows read-write access to the underlying buffer. If <orphan> + * is FALSE the sequence returns a pointer to its buffer, allocating + * one if it has not yet done so. The number of elements in the + * buffer can be determined from the sequence <length> accessor. + * + * If the <orphan> argument to <get_buffer> is FALSE, the sequence + * maintains ownership of the underlying buffer. Elements in the + * returned buffer may be directly replaced by the caller. + * + * If the <orphan> argument to <get_buffer> is TRUE, the sequence + * yields ownership of the buffer to the caller. If <orphan> is + * TRUE and the sequence does not own its buffer (i.e., its + * <release> flag is FALSE), the return value is a null pointer. If + * the buffer is taken from the sequence using this form of + * <get_buffer>, the sequence reverts to the same state it would + * have if constructed using its default constructor. The caller + * becomes responsible for eventually freeing each element of the + * returned buffer (for strings, wide string, and object + * references), and then freeing the returned buffer itself using + * <freebuf>. + */ T *get_buffer (CORBA::Boolean orphan = 0); - // Allows read-write access to the underlying buffer. If <orphan> - // is FALSE the sequence returns a pointer to its buffer, allocating - // one if it has not yet done so. The number of elements in the - // buffer can be determined from the sequence <length> accessor. - // - // If the <orphan> argument to <get_buffer> is FALSE, the sequence - // maintains ownership of the underlying buffer. Elements in the - // returned buffer may be directly replaced by the caller. - // - // If the <orphan> argument to <get_buffer> is TRUE, the sequence - // yields ownership of the buffer to the caller. If <orphan> is - // TRUE and the sequence does not own its buffer (i.e., its - // <release> flag is FALSE), the return value is a null pointer. If - // the buffer is taken from the sequence using this form of - // <get_buffer>, the sequence reverts to the same state it would - // have if constructed using its default constructor. The caller - // becomes responsible for eventually freeing each element of the - // returned buffer (for strings, wide string, and object - // references), and then freeing the returned buffer itself using - // <freebuf>. + /** + * This function allows read-only access to the sequence buffer. + * The sequence returns its buffer, allocating one of one has not + * yet been allocated. No direct modification of the returned + * buffer by the caller is permitted. + */ const T *get_buffer (void) const; - // This function allows read-only access to the sequence buffer. - // The sequence returns its buffer, allocating one of one has not - // yet been allocated. No direct modification of the returned - // buffer by the caller is permitted. + /** + * Allows the buffer underlying a sequence to be replaced. The + * parameters to <replace> are identical in type, order, and purpose + * to those for the <T *data> constructor for the sequence. + */ void replace (CORBA::ULong max, CORBA::ULong length, T *data, CORBA::Boolean release = 0); - // Allows the buffer underlying a sequence to be replaced. The - // parameters to <replace> are identical in type, order, and purpose - // to those for the <T *data> constructor for the sequence. }; // ************************************************************* +/** + * @class TAO_Bounded_Array_Sequence + * + * @brief Bounded version of TAO_Unbounded_Array_Sequence. + * + * Please see the documentation for the unbounded case. + */ template<class T, class T_var, size_t MAX> class TAO_Bounded_Array_Sequence : public TAO_Bounded_Base_Sequence { - // = TITLE - // Bounded version of TAO_Unbounded_Array_Sequence. - // - // = DESCRIPTION - // Please see the documentation for the unbounded case. - // public: // = Initialization and termination methods. + /// default ctor. TAO_Bounded_Array_Sequence (void); - // default ctor. + /// Constructor from data. TAO_Bounded_Array_Sequence (CORBA::ULong length, T *value, CORBA::Boolean release=0); - // Constructor from data. + /// Copy constructor. TAO_Bounded_Array_Sequence (const TAO_Bounded_Array_Sequence<T, T_var, MAX> &); - // Copy constructor. + /// destructor ~TAO_Bounded_Array_Sequence (void); - // destructor + /// Assignment from another Bounded sequence. TAO_Bounded_Array_Sequence &operator= (const TAO_Bounded_Array_Sequence<T, T_var, MAX> &); - // Assignment from another Bounded sequence. // = Accessors. + /// operator [] T &operator[] (CORBA::ULong); - // operator [] + /// operator [] const T &operator[] (CORBA::ULong) const; - // operator [] + /// Allocate storage for a sequence.. static T *allocbuf (CORBA::ULong length); - // Allocate storage for a sequence.. + /// Free a buffer allocated by allocbuf() and release each element on + /// it. static void freebuf (T *buffer); - // Free a buffer allocated by allocbuf() and release each element on - // it. + /// allocate a buffer of the requested length. The buffer is allocated for the + /// right type virtual void _allocate_buffer (CORBA::ULong length); - // allocate a buffer of the requested length. The buffer is allocated for the - // right type + /// deallocate the buffer virtual void _deallocate_buffer (void); - // deallocate the buffer // = orbos/98-01-11 proposed extensions. + /** + * Allows read-write access to the underlying buffer. If <orphan> + * is FALSE the sequence returns a pointer to its buffer, allocating + * one if it has not yet done so. The number of elements in the + * buffer can be determined from the sequence <length> accessor. + * + * If the <orphan> argument to <get_buffer> is FALSE, the sequence + * maintains ownership of the underlying buffer. Elements in the + * returned buffer may be directly replaced by the caller. + * + * If the <orphan> argument to <get_buffer> is TRUE, the sequence + * yields ownership of the buffer to the caller. If <orphan> is + * TRUE and the sequence does not own its buffer (i.e., its + * <release> flag is FALSE), the return value is a null pointer. If + * the buffer is taken from the sequence using this form of + * <get_buffer>, the sequence reverts to the same state it would + * have if constructed using its default constructor. The caller + * becomes responsible for eventually freeing each element of the + * returned buffer (for strings, wide string, and object + * references), and then freeing the returned buffer itself using + * <freebuf>. + */ T *get_buffer (CORBA::Boolean orphan = 0); - // Allows read-write access to the underlying buffer. If <orphan> - // is FALSE the sequence returns a pointer to its buffer, allocating - // one if it has not yet done so. The number of elements in the - // buffer can be determined from the sequence <length> accessor. - // - // If the <orphan> argument to <get_buffer> is FALSE, the sequence - // maintains ownership of the underlying buffer. Elements in the - // returned buffer may be directly replaced by the caller. - // - // If the <orphan> argument to <get_buffer> is TRUE, the sequence - // yields ownership of the buffer to the caller. If <orphan> is - // TRUE and the sequence does not own its buffer (i.e., its - // <release> flag is FALSE), the return value is a null pointer. If - // the buffer is taken from the sequence using this form of - // <get_buffer>, the sequence reverts to the same state it would - // have if constructed using its default constructor. The caller - // becomes responsible for eventually freeing each element of the - // returned buffer (for strings, wide string, and object - // references), and then freeing the returned buffer itself using - // <freebuf>. + /** + * This function allows read-only access to the sequence buffer. + * The sequence returns its buffer, allocating one of one has not + * yet been allocated. No direct modification of the returned + * buffer by the caller is permitted. + */ const T *get_buffer (void) const; - // This function allows read-only access to the sequence buffer. - // The sequence returns its buffer, allocating one of one has not - // yet been allocated. No direct modification of the returned - // buffer by the caller is permitted. + /** + * Allows the buffer underlying a sequence to be replaced. The + * parameters to <replace> are identical in type, order, and purpose + * to those for the <T *data> constructor for the sequence. + */ void replace (CORBA::ULong max, CORBA::ULong length, T *data, CORBA::Boolean release = 0); - // Allows the buffer underlying a sequence to be replaced. The - // parameters to <replace> are identical in type, order, and purpose - // to those for the <T *data> constructor for the sequence. }; // ************************************************************* +/** + * @class TAO_Bounded_String_Sequence + * + * @brief Bounded sequence of strings. + * + * As its unbounded counterpart it duplicates and releases strings + * (via CORBA::string_dup and CORBA::string_free) under the + * control of a per sequence flag, but the capacity of the + * sequence is bound on the type. + */ template<size_t MAX> class TAO_Bounded_String_Sequence : public TAO_Bounded_Base_Sequence { - // = TITLE - // Bounded sequence of strings. - // - // = DESCRIPTION - // As its unbounded counterpart it duplicates and releases strings - // (via CORBA::string_dup and CORBA::string_free) under the - // control of a per sequence flag, but the capacity of the - // sequence is bound on the type. public: + /** + * {SPEC} + * For bounded sequences, the maximum length is part of the type and + * cannot be set or modified, while for unbounded sequences, the + * default constructor also sets the maximum length to 0. The + * default constructor for a bounded sequence always allocates a + * contents vector, so it always sets the release flag to TRUE. + */ TAO_Bounded_String_Sequence (void); - // {SPEC} - // For bounded sequences, the maximum length is part of the type and - // cannot be set or modified, while for unbounded sequences, the - // default constructor also sets the maximum length to 0. The - // default constructor for a bounded sequence always allocates a - // contents vector, so it always sets the release flag to TRUE. + /** + * {SPEC} + * The ``T *data'' constructor (as shown in the example above) + * allows the length and contents of a bounded or unbounded sequence + * to be set. For unbounded sequences, it also allows the initial + * value of the maximum length to be set. For this constructor, + * ownership of the contents vector is determined by the release + * parameter---FALSE means the caller owns the storage, while TRUE + * means that the sequence assumes ownership of the storage. + * + * If release is TRUE, the contents vector must have been allocated + * using the sequence allocbuf function, and the sequence will pass + * it to freebuf when finished with it. + */ TAO_Bounded_String_Sequence (CORBA::ULong length, char* *value, CORBA::Boolean release = 0); - // {SPEC} - // The ``T *data'' constructor (as shown in the example above) - // allows the length and contents of a bounded or unbounded sequence - // to be set. For unbounded sequences, it also allows the initial - // value of the maximum length to be set. For this constructor, - // ownership of the contents vector is determined by the release - // parameter---FALSE means the caller owns the storage, while TRUE - // means that the sequence assumes ownership of the storage. - // - // If release is TRUE, the contents vector must have been allocated - // using the sequence allocbuf function, and the sequence will pass - // it to freebuf when finished with it. + /** + * {SPEC} + * Management Functions'' on page 16. The copy constructor creates a + * new sequence with the same maximum and length as the given + * sequence, copies each of its current elements (items zero through + * length--1), and sets the release flag to TRUE. + */ TAO_Bounded_String_Sequence (const TAO_Bounded_String_Sequence<MAX> &); - // {SPEC} - // Management Functions'' on page 16. The copy constructor creates a - // new sequence with the same maximum and length as the given - // sequence, copies each of its current elements (items zero through - // length--1), and sets the release flag to TRUE. + /** + * {SPEC} + * The assignment operator deep copies its parameter, releasing + * old storage if necessary. It behaves as if the original sequence + * is destroyed via its destructor and then the source sequence + * copied using the copy constructor. + */ TAO_Bounded_String_Sequence &operator= (const TAO_Bounded_String_Sequence<MAX> &); - // {SPEC} - // The assignment operator deep copies its parameter, releasing - // old storage if necessary. It behaves as if the original sequence - // is destroyed via its destructor and then the source sequence - // copied using the copy constructor. + /** + * {SPEC} + * If release=TRUE, the destructor destroys each of the current + * elements (items zero through length-1). + */ ~TAO_Bounded_String_Sequence (void); - // {SPEC} - // If release=TRUE, the destructor destroys each of the current - // elements (items zero through length-1). + /// read-write accessor TAO_SeqElem_String_Manager operator[] (CORBA::ULong slot) const; - // read-write accessor + /** + * {SPEC} + * The allocbuf function allocates a vector of T elements that can + * be passed to the T *data constructor. The length of the vector is + * given by the nelems function argument. The allocbuf function + * initializes each element using its default constructor, except + * for strings, which are initialized to null pointers, and object + * references, which are initialized to suitably typed nil object + * references. A null pointer is returned if allocbuf for some + * reason cannot allocate the requested vector. Vectors allocated by + * allocbuf should be freed using the freebuf function. + */ static char **allocbuf (CORBA::ULong length); - // {SPEC} - // The allocbuf function allocates a vector of T elements that can - // be passed to the T *data constructor. The length of the vector is - // given by the nelems function argument. The allocbuf function - // initializes each element using its default constructor, except - // for strings, which are initialized to null pointers, and object - // references, which are initialized to suitably typed nil object - // references. A null pointer is returned if allocbuf for some - // reason cannot allocate the requested vector. Vectors allocated by - // allocbuf should be freed using the freebuf function. + /** + * {SPEC} + * The freebuf function ensures that the destructor for each element + * is called before the buffer is destroyed, except for string + * elements, which are freed using string_free(), and object + * reference elements, which are freed using release(). The freebuf + * function will ignore null pointers passed to it. + */ static void freebuf (char **buffer); - // {SPEC} - // The freebuf function ensures that the destructor for each element - // is called before the buffer is destroyed, except for string - // elements, which are freed using string_free(), and object - // reference elements, which are freed using release(). The freebuf - // function will ignore null pointers passed to it. // Functions to create, destroy, and adjust the underlying buffer. virtual void _allocate_buffer (CORBA::ULong length); @@ -966,83 +1048,99 @@ public: // ************************************************************* +/** + * @class TAO_Bounded_WString_Sequence + * + * @brief Bounded sequence of wstrings. + * + * As its unbounded counterpart it duplicates and releases strings + * (via CORBA::wstring_dup and CORBA::wstring_free) under the + * control of a per sequence flag, but the capacity of the + * sequence is bound on the type. + */ template<size_t MAX> class TAO_Bounded_WString_Sequence : public TAO_Bounded_Base_Sequence { - // = TITLE - // Bounded sequence of wstrings. - // - // = DESCRIPTION - // As its unbounded counterpart it duplicates and releases strings - // (via CORBA::wstring_dup and CORBA::wstring_free) under the - // control of a per sequence flag, but the capacity of the - // sequence is bound on the type. public: + /** + * {SPEC} + * For bounded sequences, the maximum length is part of the type and + * cannot be set or modified, while for unbounded sequences, the + * default constructor also sets the maximum length to 0. The + * default constructor for a bounded sequence always allocates a + * contents vector, so it always sets the release flag to TRUE. + */ TAO_Bounded_WString_Sequence (void); - // {SPEC} - // For bounded sequences, the maximum length is part of the type and - // cannot be set or modified, while for unbounded sequences, the - // default constructor also sets the maximum length to 0. The - // default constructor for a bounded sequence always allocates a - // contents vector, so it always sets the release flag to TRUE. + /** + * {SPEC} + * The ``T *data'' constructor (as shown in the example above) + * allows the length and contents of a bounded or unbounded sequence + * to be set. For unbounded sequences, it also allows the initial + * value of the maximum length to be set. For this constructor, + * ownership of the contents vector is determined by the release + * parameter---FALSE means the caller owns the storage, while TRUE + * means that the sequence assumes ownership of the storage. + * + * If release is TRUE, the contents vector must have been allocated + * using the sequence allocbuf function, and the sequence will pass + * it to freebuf when finished with it. + */ TAO_Bounded_WString_Sequence (CORBA::ULong length, CORBA::WChar* *value, CORBA::Boolean release = 0); - // {SPEC} - // The ``T *data'' constructor (as shown in the example above) - // allows the length and contents of a bounded or unbounded sequence - // to be set. For unbounded sequences, it also allows the initial - // value of the maximum length to be set. For this constructor, - // ownership of the contents vector is determined by the release - // parameter---FALSE means the caller owns the storage, while TRUE - // means that the sequence assumes ownership of the storage. - // - // If release is TRUE, the contents vector must have been allocated - // using the sequence allocbuf function, and the sequence will pass - // it to freebuf when finished with it. + /** + * {SPEC} + * Management Functions'' on page 16. The copy constructor creates a + * new sequence with the same maximum and length as the given + * sequence, copies each of its current elements (items zero through + * length--1), and sets the release flag to TRUE. + */ TAO_Bounded_WString_Sequence (const TAO_Bounded_WString_Sequence<MAX> &); - // {SPEC} - // Management Functions'' on page 16. The copy constructor creates a - // new sequence with the same maximum and length as the given - // sequence, copies each of its current elements (items zero through - // length--1), and sets the release flag to TRUE. + /** + * {SPEC} + * The assignment operator deep copies its parameter, releasing + * old storage if necessary. It behaves as if the original sequence + * is destroyed via its destructor and then the source sequence + * copied using the copy constructor. + */ TAO_Bounded_WString_Sequence &operator= (const TAO_Bounded_WString_Sequence<MAX> &); - // {SPEC} - // The assignment operator deep copies its parameter, releasing - // old storage if necessary. It behaves as if the original sequence - // is destroyed via its destructor and then the source sequence - // copied using the copy constructor. + /** + * {SPEC} + * If release=TRUE, the destructor destroys each of the current + * elements (items zero through length-1). + */ ~TAO_Bounded_WString_Sequence (void); - // {SPEC} - // If release=TRUE, the destructor destroys each of the current - // elements (items zero through length-1). + /// read-write accessor TAO_SeqElem_WString_Manager operator[] (CORBA::ULong slot) const; - // read-write accessor + /** + * {SPEC} + * The allocbuf function allocates a vector of T elements that can + * be passed to the T *data constructor. The length of the vector is + * given by the nelems function argument. The allocbuf function + * initializes each element using its default constructor, except + * for (w)strings, which are initialized to null pointers, and object + * references, which are initialized to suitably typed nil object + * references. A null pointer is returned if allocbuf for some + * reason cannot allocate the requested vector. Vectors allocated by + * allocbuf should be freed using the freebuf function. + */ static CORBA::WChar **allocbuf (CORBA::ULong length); - // {SPEC} - // The allocbuf function allocates a vector of T elements that can - // be passed to the T *data constructor. The length of the vector is - // given by the nelems function argument. The allocbuf function - // initializes each element using its default constructor, except - // for (w)strings, which are initialized to null pointers, and object - // references, which are initialized to suitably typed nil object - // references. A null pointer is returned if allocbuf for some - // reason cannot allocate the requested vector. Vectors allocated by - // allocbuf should be freed using the freebuf function. + /** + * {SPEC} + * The freebuf function ensures that the destructor for each element + * is called before the buffer is destroyed, except for string + * elements, which are freed using wstring_free(), and object + * reference elements, which are freed using release(). The freebuf + * function will ignore null pointers passed to it. + */ static void freebuf (CORBA::WChar **buffer); - // {SPEC} - // The freebuf function ensures that the destructor for each element - // is called before the buffer is destroyed, except for string - // elements, which are freed using wstring_free(), and object - // reference elements, which are freed using release(). The freebuf - // function will ignore null pointers passed to it. // Functions to create, destroy, and adjust the underlying buffer. virtual void _allocate_buffer (CORBA::ULong length); diff --git a/TAO/tao/Server_Strategy_Factory.h b/TAO/tao/Server_Strategy_Factory.h index 5a84536432b..0c0366957d0 100644 --- a/TAO/tao/Server_Strategy_Factory.h +++ b/TAO/tao/Server_Strategy_Factory.h @@ -1,18 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Server_Strategy_Factory.h -// -// = AUTHOR -// Chris Cleeland -// -// ============================================================================ + +//============================================================================= +/** + * @file Server_Strategy_Factory.h + * + * $Id$ + * + * @author Chris Cleeland + */ +//============================================================================= + #ifndef TAO_SERVER_STRATEGY_FACTORY_H #define TAO_SERVER_STRATEGY_FACTORY_H @@ -38,13 +35,16 @@ enum TAO_Demux_Strategy TAO_USER_DEFINED }; +/** + * @class TAO_Server_Strategy_Factory + * + * @brief Base class for the server's abstract factory that manufactures + * various strategies of special utility to it. This simply + * serves as an interface to a subclass that REALLY gets + * specified and loaded by the Service Configurator. + */ class TAO_Export TAO_Server_Strategy_Factory : public ACE_Service_Object { - // = TITLE - // Base class for the server's abstract factory that manufactures - // various strategies of special utility to it. This simply - // serves as an interface to a subclass that REALLY gets - // specified and loaded by the Service Configurator. public: struct Active_Object_Map_Creation_Parameters @@ -86,45 +86,49 @@ public: }; // = Initialization and termination methods. + /// Constructor. TAO_Server_Strategy_Factory (void); - // Constructor. + /// Destructor. virtual ~TAO_Server_Strategy_Factory(void); - // Destructor. + /** + * Call <open> on various strategies. This is not performed in + * <init> so that the other portions of the ORB have a chance to + * "settle" in their initialization since the streategies herein + * might need some of that information. + */ virtual int open (TAO_ORB_Core* orb_core); - // Call <open> on various strategies. This is not performed in - // <init> so that the other portions of the ORB have a chance to - // "settle" in their initialization since the streategies herein - // might need some of that information. + /// Enable POA locking? virtual int enable_poa_locking (void); - // Enable POA locking? + /// Are server connections active (i.e. run in their own thread) virtual int activate_server_connections (void); - // Are server connections active (i.e. run in their own thread) + /** + * Obtain the timeout value used by the thread-per-connection server + * threads to poll the shutdown flag in the ORB. + * Return -1 if the ORB should use the compile-time defaults. + * If the return value is zero then the threads block without + * timeouts. + */ virtual int thread_per_connection_timeout (ACE_Time_Value &timeout); - // Obtain the timeout value used by the thread-per-connection server - // threads to poll the shutdown flag in the ORB. - // Return -1 if the ORB should use the compile-time defaults. - // If the return value is zero then the threads block without - // timeouts. + /// The thread activation parameters virtual int server_connection_thread_flags (void); virtual int server_connection_thread_count (void); - // The thread activation parameters + /// Creates and returns a lock for the event loop. virtual ACE_Lock *create_event_loop_lock (void); - // Creates and returns a lock for the event loop. + /// Return the active object map creation parameters. virtual const Active_Object_Map_Creation_Parameters &active_object_map_creation_parameters (void) const; - // Return the active object map creation parameters. protected: + /// Active object map creation parameters. Active_Object_Map_Creation_Parameters active_object_map_creation_parameters_; - // Active object map creation parameters. }; #include "ace/post.h" diff --git a/TAO/tao/Service_Callbacks.h b/TAO/tao/Service_Callbacks.h index e6f0ebf6245..d3947fbd3b4 100644 --- a/TAO/tao/Service_Callbacks.h +++ b/TAO/tao/Service_Callbacks.h @@ -1,21 +1,18 @@ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Service_Callbacks.h -// -// = DESCRIPTION -// This is a generic interface that would be used to override many -// of the default functionalities that the ORB provides by the -// services if they have been loaded in to the ORB_Core -// -// = AUTHOR -// Bala Natarajan <bala@cs.wustl.edu> -// ============================================================================ +//============================================================================= +/** + * @file Service_Callbacks.h + * + * $Id$ + * + * This is a generic interface that would be used to override many + * of the default functionalities that the ORB provides by the + * services if they have been loaded in to the ORB_Core + * + * + * @author Bala Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_SERVICE_CALLBACK_H #define TAO_SERVICE_CALLBACK_H #include "ace/pre.h" @@ -33,74 +30,82 @@ class TAO_GIOP_Invocation; class TAO_Server_Request; class TAO_Message_State_Factory; +/** + * @class TAO_Service_Callbacks + * + * @brief An Abstract Base class for the hooks in the ORB. + * + * This class (would) define all the hooks that may be needed by + * the ORB to override some of its default behaviour. The methods + * can be potentially used to call service level specific + * processing that may be required. + */ class TAO_Export TAO_Service_Callbacks { - // = TITLE - // An Abstract Base class for the hooks in the ORB. - // - // = DESCRIPTION - // This class (would) define all the hooks that may be needed by - // the ORB to override some of its default behaviour. The methods - // can be potentially used to call service level specific - // processing that may be required. public: + /// Dtor virtual ~TAO_Service_Callbacks (void); - // Dtor + /// Select the profile from MProfile as the needs of the services + /// may be. Return the profile in <pfile> virtual CORBA::Boolean select_profile (TAO_MProfile *mprofile, TAO_Profile *&pfile); - // Select the profile from MProfile as the needs of the services - // may be. Return the profile in <pfile> + /// Select the profile from MProfile as the needs of the services + /// may be. Return the profile in <pfile> virtual CORBA::Boolean reselect_profile (TAO_Stub *stub, TAO_Profile *&pfile); - // Select the profile from MProfile as the needs of the services - // may be. Return the profile in <pfile> + /// Reset the profile flags that the services could have virtual void reset_profile_flags (void); - // Reset the profile flags that the services could have + /// Check whether <obj> is nil or not. virtual CORBA::Boolean object_is_nil (CORBA::Object_ptr obj); - // Check whether <obj> is nil or not. + /// Allow the services to add service specific service contexr + /// information. virtual void service_context_list (TAO_Stub *&stub, IOP::ServiceContextList &service_list, CORBA::Boolean restart, CORBA::Environment &ACE_TRY_ENV); - // Allow the services to add service specific service contexr - // information. + /// Allow the service layer to decide whether the COMM_FAILURE + /// exception should be thrown or a reinvocation is needed virtual int raise_comm_failure (TAO_GIOP_Invocation *invoke, TAO_Profile *profile, CORBA::Environment &ACE_TRY_ENV); - // Allow the service layer to decide whether the COMM_FAILURE - // exception should be thrown or a reinvocation is needed + /// Allow the service layer to decide whether the TRANSIENT + /// exception should be thrown or a reinvocation is needed virtual int raise_transient_failure (TAO_GIOP_Invocation *invoke, TAO_Profile *profile, CORBA::Environment &ACE_TRY_ENV); - // Allow the service layer to decide whether the TRANSIENT - // exception should be thrown or a reinvocation is needed + /** + * Send the message state to the FT service for logging. This hook + * sends the message state after the server receives the + * message. The message at this point has been verified that it is a + * GIOP message. + */ virtual void service_log_msg_rcv (TAO_Message_State_Factory &state); - // Send the message state to the FT service for logging. This hook - // sends the message state after the server receives the - // message. The message at this point has been verified that it is a - // GIOP message. + /** + * Send the message state to the FT service for logging. This hook + * sends the message state after the POA receives upcall but just + * before the call has been dispatched to the servant + */ virtual void service_log_msg_pre_upcall (TAO_ServerRequest &req); - // Send the message state to the FT service for logging. This hook - // sends the message state after the POA receives upcall but just - // before the call has been dispatched to the servant + /** + * Send the message state to the FT service for logging. This hook + * sends the message state just before the reply is ready to be + * dispatched. + */ virtual void service_log_msg_post_upcall (TAO_ServerRequest &req); - // Send the message state to the FT service for logging. This hook - // sends the message state just before the reply is ready to be - // dispatched. }; diff --git a/TAO/tao/Services.h b/TAO/tao/Services.h index 3ba6d5241a9..226ddef03e2 100644 --- a/TAO/tao/Services.h +++ b/TAO/tao/Services.h @@ -1,19 +1,17 @@ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Service_Detail.h -// -// = DESCRIPTION -// -// Service_Detail stubs. This code generated by the The ACE ORB (TAO) IDL -// Compiler and was then hand crafted -// -// ============================================================================ +//============================================================================= +/** + * @file Services.h + * + * $Id$ + * + * + * Service_Detail stubs. This code generated by the The ACE ORB (TAO) IDL + * Compiler and was then hand crafted + * + * + */ +//============================================================================= + #ifndef TAO_SERVICES_H #define TAO_SERVICES_H @@ -150,10 +148,10 @@ class CORBA_ServiceDetail_var CORBA_ServiceDetail *operator-> (void); const CORBA_ServiceDetail *operator-> (void) const; + /// in, inout, out, _retn operator const CORBA_ServiceDetail &() const; operator CORBA_ServiceDetail &(); operator CORBA_ServiceDetail &() const; - // in, inout, out, _retn const CORBA_ServiceDetail &in (void) const; CORBA_ServiceDetail &inout (void); CORBA_ServiceDetail *&out (void); @@ -177,8 +175,8 @@ class CORBA_ServiceDetail_out CORBA_ServiceDetail *operator-> (void); private: + /// assignment from T_var not allowed CORBA_ServiceDetail *&ptr_; - // assignment from T_var not allowed void operator= (const CORBA_ServiceDetail_var &); }; @@ -480,10 +478,10 @@ class CORBA_ServiceInformation_var CORBA_ServiceInformation *operator-> (void); const CORBA_ServiceInformation *operator-> (void) const; + /// in, inout, out, _retn operator const CORBA_ServiceInformation &() const; operator CORBA_ServiceInformation &(); operator CORBA_ServiceInformation &() const; - // in, inout, out, _retn const CORBA_ServiceInformation &in (void) const; CORBA_ServiceInformation &inout (void); CORBA_ServiceInformation *&out (void); @@ -508,8 +506,8 @@ class CORBA_ServiceInformation_out CORBA_ServiceInformation *operator-> (void); private: + /// assignment from T_var not allowed CORBA_ServiceInformation *&ptr_; - // assignment from T_var not allowed void operator= (const CORBA_ServiceInformation_var &); }; diff --git a/TAO/tao/Services_Activate.h b/TAO/tao/Services_Activate.h index da60f55bc4d..79bf4b6531b 100644 --- a/TAO/tao/Services_Activate.h +++ b/TAO/tao/Services_Activate.h @@ -1,20 +1,17 @@ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Service_Callbacks.h -// -// = DESCRIPTION -// This is a generic interface that would be used to activate -// the services that are loaded through the svc.conf file -// -// = AUTHOR -// Bala Natarajan <bala@cs.wustl.edu> -// ============================================================================ +//============================================================================= +/** + * @file Services_Activate.h + * + * $Id$ + * + * This is a generic interface that would be used to activate + * the services that are loaded through the svc.conf file + * + * + * @author Bala Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_SERVICES_ACTIVATE_H #define TAO_SERVICES_ACTIVATE_H #include "ace/pre.h" @@ -31,28 +28,31 @@ class TAO_ORB_Core; class TAO_Service_Callbacks; +/** + * @class TAO_Services_Activate + * + * @brief A class to dynamically load callback implementations in to an + * ORB. + * + * Many services and components of the ORB whose default behaviour + * needs to be changed can use this class to activate the Callback + * hooks. These hooks can then be called by the ORB at the right + * points. + * @@ TODO + */ class TAO_Export TAO_Services_Activate : public ACE_Service_Object { - // = TITLE - // A class to dynamically load callback implementations in to an - // ORB. - // - // = DESCRIPTION - // Many services and components of the ORB whose default behaviour - // needs to be changed can use this class to activate the Callback - // hooks. These hooks can then be called by the ORB at the right - // points. - // @@ TODO - // public: + /// The destructor virtual ~TAO_Services_Activate (void); - // The destructor + /** + * Create and activate the service callbacks into the orb. + * This method cannot throw any exception, but it can return a nil + * object to indicate an error condition. + */ virtual TAO_Service_Callbacks* activate_services (TAO_ORB_Core *orb) ACE_THROW_SPEC (()) = 0; - // Create and activate the service callbacks into the orb. - // This method cannot throw any exception, but it can return a nil - // object to indicate an error condition. }; diff --git a/TAO/tao/Single_Reactor.h b/TAO/tao/Single_Reactor.h index f41ff3432c2..7cb88d60a8b 100644 --- a/TAO/tao/Single_Reactor.h +++ b/TAO/tao/Single_Reactor.h @@ -1,17 +1,14 @@ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Single_Reactor.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// ============================================================================ +//============================================================================= +/** + * @file Single_Reactor.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_SINGLE_REACTOR_H #define TAO_SINGLE_REACTOR_H @@ -25,24 +22,25 @@ class TAO_Leader_Follower; +/** + * @class TAO_Single_Reactor + * + * @brief The Single_Reactor concurrency strategy. + * + * This strategy creates a different reactor for each priority + * level, threads at the right priority level run the event loop + * on that reactor. + * Multiple threads can share the same reactor, usually using the + * thread-pool strategy. + */ class TAO_Export TAO_Single_Reactor : public TAO_Reactor_Registry { - // = TITLE - // The Single_Reactor concurrency strategy. - // - // = DESCRIPTION - // This strategy creates a different reactor for each priority - // level, threads at the right priority level run the event loop - // on that reactor. - // Multiple threads can share the same reactor, usually using the - // thread-pool strategy. - // public: + /// Default constructor TAO_Single_Reactor (void); - // Default constructor + /// The destructor virtual ~TAO_Single_Reactor (void); - // The destructor // = The TAO_Reactor_Registry methods, please check the // documentation in tao/Reactor_Registry.h @@ -55,8 +53,8 @@ public: virtual int shutdown_all (void); private: + /// The leader follower TAO_Leader_Follower *leader_follower_; - // The leader follower }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/StringSeqC.h b/TAO/tao/StringSeqC.h index f7ce72fc4bf..4f4169423da 100644 --- a/TAO/tao/StringSeqC.h +++ b/TAO/tao/StringSeqC.h @@ -62,20 +62,20 @@ class CORBA_StringSeq_var; // CORBA_StringSeq // ************************************************************* -class TAO_Export CORBA_StringSeq : public +class TAO_Export CORBA_StringSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) TAO_Unbounded_String_Sequence #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_String_Sequence -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: CORBA_StringSeq (void); // default ctor CORBA_StringSeq (CORBA::ULong max); // uses max size CORBA_StringSeq ( - CORBA::ULong max, - CORBA::ULong length, - char * *buffer, + CORBA::ULong max, + CORBA::ULong length, + char * *buffer, CORBA::Boolean release = 0 ); CORBA_StringSeq (const CORBA_StringSeq &); // copy ctor @@ -105,20 +105,20 @@ public: CORBA_StringSeq_var (CORBA_StringSeq *); CORBA_StringSeq_var (const CORBA_StringSeq_var &); // copy constructor ~CORBA_StringSeq_var (void); // destructor - + CORBA_StringSeq_var &operator= (CORBA_StringSeq *); CORBA_StringSeq_var &operator= (const CORBA_StringSeq_var &); CORBA_StringSeq *operator-> (void); const CORBA_StringSeq *operator-> (void) const; - + operator const CORBA_StringSeq &() const; operator CORBA_StringSeq &(); operator CORBA_StringSeq &() const; operator CORBA_StringSeq *&(); // variable-size base types only - + TAO_SeqElem_String_Manager operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const CORBA_StringSeq &in (void) const; CORBA_StringSeq &inout (void); CORBA_StringSeq *&out (void); @@ -148,7 +148,7 @@ public: CORBA_StringSeq *&ptr (void); CORBA_StringSeq *operator-> (void); TAO_SeqElem_String_Manager operator[] (CORBA::ULong index); - + private: CORBA_StringSeq *&ptr_; // assignment from T_var not allowed @@ -171,20 +171,20 @@ class CORBA_WStringSeq_var; // CORBA_WStringSeq // ************************************************************* -class TAO_Export CORBA_WStringSeq : public +class TAO_Export CORBA_WStringSeq : public #if !defined (TAO_USE_SEQUENCE_TEMPLATES) TAO_Unbounded_WString_Sequence #else /* TAO_USE_SEQUENCE_TEMPLATES */ TAO_Unbounded_WString_Sequence -#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ +#endif /* !TAO_USE_SEQUENCE_TEMPLATES */ { public: CORBA_WStringSeq (void); // default ctor CORBA_WStringSeq (CORBA::ULong max); // uses max size CORBA_WStringSeq ( - CORBA::ULong max, - CORBA::ULong length, - CORBA::WChar * *buffer, + CORBA::ULong max, + CORBA::ULong length, + CORBA::WChar * *buffer, CORBA::Boolean release = 0 ); CORBA_WStringSeq (const CORBA_WStringSeq &); // copy ctor @@ -214,20 +214,20 @@ public: CORBA_WStringSeq_var (CORBA_WStringSeq *); CORBA_WStringSeq_var (const CORBA_WStringSeq_var &); // copy constructor ~CORBA_WStringSeq_var (void); // destructor - + CORBA_WStringSeq_var &operator= (CORBA_WStringSeq *); CORBA_WStringSeq_var &operator= (const CORBA_WStringSeq_var &); CORBA_WStringSeq *operator-> (void); const CORBA_WStringSeq *operator-> (void) const; - + operator const CORBA_WStringSeq &() const; operator CORBA_WStringSeq &(); operator CORBA_WStringSeq &() const; operator CORBA_WStringSeq *&(); // variable-size base types only - + TAO_SeqElem_WString_Manager operator[] (CORBA::ULong index); - - // in, inout, out, _retn + + // in, inout, out, _retn const CORBA_WStringSeq &in (void) const; CORBA_WStringSeq &inout (void); CORBA_WStringSeq *&out (void); @@ -257,7 +257,7 @@ public: CORBA_WStringSeq *&ptr (void); CORBA_WStringSeq *operator-> (void); TAO_SeqElem_WString_Manager operator[] (CORBA::ULong index); - + private: CORBA_WStringSeq *&ptr_; // assignment from T_var not allowed diff --git a/TAO/tao/Stub.h b/TAO/tao/Stub.h index 31bc070b8ce..d15ca555f3e 100644 --- a/TAO/tao/Stub.h +++ b/TAO/tao/Stub.h @@ -1,33 +1,30 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Stub.h -// -// = DESCRIPTION -// -// Data structures used by static and dynamic stubs, and to a -// lesser degree by skeletons -// -// Header file for Win32 C/C++/COM interface to one kind of CORBA -// remote invocation framework. This is for use by -// compiler-generated code, not by portable applications! -// -// These constitute the stub API to this "ORB Core." Such -// interfaces are not specified by OMG, and may differ between -// different ORBs. This one has the particular advantage that -// stubs can be quite small. -// -// = AUTHOR -// Copyright 1994-1995 by Sun Microsystems, Inc. -// -// ============================================================================ + +//============================================================================= +/** + * @file Stub.h + * + * $Id$ + * + * + * Data structures used by static and dynamic stubs, and to a + * lesser degree by skeletons + * + * Header file for Win32 C/C++/COM interface to one kind of CORBA + * remote invocation framework. This is for use by + * compiler-generated code, not by portable applications! + * + * These constitute the stub API to this "ORB Core." Such + * interfaces are not specified by OMG, and may differ between + * different ORBs. This one has the particular advantage that + * stubs can be quite small. + * + * + * @author Copyright 1994-1995 by Sun Microsystems, Inc. + */ +//============================================================================= + #ifndef TAO_STUB_H #define TAO_STUB_H @@ -92,33 +89,35 @@ struct TAO_Exception_Data // The allocator for this exception. }; +/** + * @class TAO_Stub + * + * @brief TAO_Stub + * + * Per-objref data includes the (protocol-specific) Profile, which + * is handled by placing it into a subclass of this type along + * with data that may be used in protocol-specific caching + * schemes. + * The type ID (the data specified by CORBA 2.0 that gets exposed + * "on the wire", and in stringified objrefs) is held by this + * module. + * The stub APIs are member functions of this + * type. + */ class TAO_Export TAO_Stub { - // = TITLE - // TAO_Stub - // - // = DESCRIPTION - // Per-objref data includes the (protocol-specific) Profile, which - // is handled by placing it into a subclass of this type along - // with data that may be used in protocol-specific caching - // schemes. - // - // The type ID (the data specified by CORBA 2.0 that gets exposed - // "on the wire", and in stringified objrefs) is held by this - // module. - // - // The stub APIs are member functions of this - // type. public: #if (TAO_HAS_CORBA_MESSAGING == 1) + /** + * Returns the effective policy if <type> is a known client-exposed + * policy type. Returns the effective override for all other policy + * types. + */ CORBA::Policy_ptr get_policy (CORBA::PolicyType type, CORBA::Environment &ACE_TRY_ENV = TAO_default_environment () ); - // Returns the effective policy if <type> is a known client-exposed - // policy type. Returns the effective override for all other policy - // types. CORBA::Policy_ptr get_client_policy (CORBA::PolicyType type, CORBA::Environment &ACE_TRY_ENV = @@ -143,17 +142,17 @@ public: #if (TAO_HAS_RT_CORBA == 1) + /// Returns the RTCORBA::PriorityModelPolicy exported + /// in object's IOR. TAO_PriorityModelPolicy *exposed_priority_model (void); - // Returns the RTCORBA::PriorityModelPolicy exported - // in object's IOR. + /// Returns the RTCORBA::PriorityBandedConnectionPolicy exported + /// in object's IOR. TAO_PriorityBandedConnectionPolicy *exposed_priority_banded_connection (void); - // Returns the RTCORBA::PriorityBandedConnectionPolicy exported - // in object's IOR. + /// Returns the RTCORBA::ClientProtocolPolicy exported + /// in object's IOR. TAO_ClientProtocolPolicy *exposed_client_protocol (void); - // Returns the RTCORBA::ClientProtocolPolicy exported - // in object's IOR. # endif /*TAO_HAS_RT_CORBA == 1*/ @@ -208,151 +207,165 @@ public: #endif /* TAO_HAS_RT_CORBA == 1 */ + /// Return the sync strategy to be used in by the transport. + /// Selection will be based on the SyncScope policies. TAO_Sync_Strategy &sync_strategy (void); - // Return the sync strategy to be used in by the transport. - // Selection will be based on the SyncScope policies. + /// All objref representations carry around a type ID. CORBA::String_var type_id; - // All objref representations carry around a type ID. + /** + * All objref representations know how to hash themselves and + * compare themselves for equivalence to others. It's easily + * possible to have two objrefs that are distinct copies of data + * that refers/points to the same remote object (i.e. are + * equivalent). + */ CORBA::ULong hash (CORBA::ULong maximum, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // All objref representations know how to hash themselves and - // compare themselves for equivalence to others. It's easily - // possible to have two objrefs that are distinct copies of data - // that refers/points to the same remote object (i.e. are - // equivalent). + /// Implement the is_equivalent() method for the CORBA::Object CORBA::Boolean is_equivalent (CORBA::Object_ptr other_obj); - // Implement the is_equivalent() method for the CORBA::Object // Our Constructors ... + /// Construct from a repository ID and a list of profiles. TAO_Stub (const char *repository_id, const TAO_MProfile &profiles, TAO_ORB_Core *orb_core); - // Construct from a repository ID and a list of profiles. // = Memory management. CORBA::ULong _incr_refcnt (void); CORBA::ULong _decr_refcnt (void); // Manage the base (non-forwarded) profiles. + /// returns a pointer to the profile_in_use object. This object + /// retains ownership of this profile. TAO_Profile *profile_in_use (void) ; - // returns a pointer to the profile_in_use object. This object - // retains ownership of this profile. + /** + * Copy of the profile list, user must free memory when done. + * although the user can call make_profiles() then reorder + * the list and give it back to TAO_Stub. + */ TAO_MProfile *make_profiles (void); - // Copy of the profile list, user must free memory when done. - // although the user can call make_profiles() then reorder - // the list and give it back to TAO_Stub. + /// Obtain a reference to the basic profile set. const TAO_MProfile& base_profiles (void) const; - // Obtain a reference to the basic profile set. + /// Obtain a reference to the basic profile set. TAO_MProfile& base_profiles (void); - // Obtain a reference to the basic profile set. // Manage forward and base profiles. + /** + * THREAD SAFE. If forward_profiles is null then this will + * get the next profile in the base_profiles list. If forward is not null + * then this will get the next profile for the list of forwarding + * profiles. If all profiles have been tried then 0 is returned and + * profile_in_use_ is set to the first profile in the base_profiles + * list. + */ TAO_Profile *next_profile (void); - // THREAD SAFE. If forward_profiles is null then this will - // get the next profile in the base_profiles list. If forward is not null - // then this will get the next profile for the list of forwarding - // profiles. If all profiles have been tried then 0 is returned and - // profile_in_use_ is set to the first profile in the base_profiles - // list. + /// NON-THREAD SAFE version of next_profile (void) TAO_Profile *next_profile_i (void); - // NON-THREAD SAFE version of next_profile (void) + /** + * THREAD SAFE + * this method will reset the base profile list to reference the first + * profile and if there are anmy existing forward profiles they are + * reset. + */ void reset_profiles (void); - // THREAD SAFE - // this method will reset the base profile list to reference the first - // profile and if there are anmy existing forward profiles they are - // reset. + /// NON-THREAD SAFE version of reset_profiles (void); void reset_profiles_i (void); - // NON-THREAD SAFE version of reset_profiles (void); + /// Returns 1 if a forward profile has successfully been used. + /// profile_success_ && forward_profiles_ CORBA::Boolean valid_forward_profile (void); - // Returns 1 if a forward profile has successfully been used. - // profile_success_ && forward_profiles_ + /// NON-THREAD-SAFE. Will set profile_success_ to 0. void set_valid_profile (void); - // NON-THREAD-SAFE. Will set profile_success_ to 0. + /// Returns TRUE if a connection was successful with at least + /// one profile. CORBA::Boolean valid_profile (void); - // Returns TRUE if a connection was successful with at least - // one profile. + /// Initialize the base_profiles_ and set profile_in_use_ to + /// reference the first profile. TAO_Profile *base_profiles (const TAO_MProfile& mprofiles); - // Initialize the base_profiles_ and set profile_in_use_ to - // reference the first profile. + /** + * THREAD SAFE. + * Set the forward_profiles. This object will assume ownership of + * this TAO_MProfile object!! + */ void add_forward_profiles (const TAO_MProfile &mprofiles); - // THREAD SAFE. - // Set the forward_profiles. This object will assume ownership of - // this TAO_MProfile object!! + /** + * THREAD SAFE + * Used to get the next profile after the one being used has + * failed during the initial connect or send of the message! + */ CORBA::Boolean next_profile_retry (void); - // THREAD SAFE - // Used to get the next profile after the one being used has - // failed during the initial connect or send of the message! + /// Accessor. TAO_ORB_Core* orb_core (void) const; - // Accessor. + /// This returns a duplicated ORB pointer. CORBA::ORB_ptr servant_orb_ptr (void); - // This returns a duplicated ORB pointer. + /// This returns the ORB var itself (generally for temporary use). CORBA::ORB_var &servant_orb_var (void); - // This returns the ORB var itself (generally for temporary use). + /** + * Accesor and mutator for the servant ORB. Notice that the muatator + * assumes the ownership of the passed in ORB and the accesor does not + * return a copy of the orb since the accessing of the ORB is considered + * temporary. + */ void servant_orb (CORBA::ORB_ptr orb); - // Accesor and mutator for the servant ORB. Notice that the muatator - // assumes the ownership of the passed in ORB and the accesor does not - // return a copy of the orb since the accessing of the ORB is considered - // temporary. + /// Set the addressing mode. void addressing_mode (CORBA::Short addr_mode); - // Set the addressing mode. + /// Return the Addressing mode. CORBA::Short addressing_mode (void); - // Return the Addressing mode. + /// Make a call on to services to see whether they have some + /// preferences on selecting the right profiles. CORBA::Boolean service_profile_selection (void); - // Make a call on to services to see whether they have some - // preferences on selecting the right profiles. private: + /// Makes a copy of the profile and frees the existing profile_in_use. + /// NOT THREAD SAFE TAO_Profile *set_profile_in_use_i (TAO_Profile *pfile); - // Makes a copy of the profile and frees the existing profile_in_use. - // NOT THREAD SAFE + /// NON-THREAD-SAFE. Utility method which resets or initializes + /// the base_profile list and forward flags. void reset_base (); - // NON-THREAD-SAFE. Utility method which resets or initializes - // the base_profile list and forward flags. + /// NON-THREAD-SAFE. Utility method which unrolls (removes or pops) + /// the top most forwarding profile list. void forward_back_one (void); - // NON-THREAD-SAFE. Utility method which unrolls (removes or pops) - // the top most forwarding profile list. + /// NOT THREAD-SAFE. Utility method which pops all forward profile + /// lists and resets the forward_profiles_ pointer. void reset_forward (); - // NOT THREAD-SAFE. Utility method which pops all forward profile - // lists and resets the forward_profiles_ pointer. + /// Destructor is to be called only through _decr_refcnt(). ~TAO_Stub (void); - // Destructor is to be called only through _decr_refcnt(). + /// NON-THREAD-SAFE. utility method for next_profile. TAO_Profile *next_forward_profile (void); - // NON-THREAD-SAFE. utility method for next_profile. #if (TAO_HAS_RT_CORBA == 1) private: + /// Helper method used to parse the policies. void parse_policies (void); - // Helper method used to parse the policies. void exposed_priority_model (CORBA::Policy_ptr policy); @@ -378,48 +391,50 @@ private: #endif /* TAO_HAS_RT_CORBA == 1 */ private: + /// Ordered list of profiles for this object. TAO_MProfile base_profiles_; - // Ordered list of profiles for this object. + /// The list of forwarding profiles. This is actually implemented as a + /// linked list of TAO_MProfile objects. TAO_MProfile *forward_profiles_; - // The list of forwarding profiles. This is actually implemented as a - // linked list of TAO_MProfile objects. + /// This is the profile that we are currently sending/receiving with. TAO_Profile *profile_in_use_; - // This is the profile that we are currently sending/receiving with. + /// Mutex to protect access to the forwarding profile. ACE_Lock* profile_lock_ptr_; - // Mutex to protect access to the forwarding profile. + /// Have we successfully talked to the forward profile yet? size_t profile_success_; - // Have we successfully talked to the forward profile yet? + /// Mutex to protect reference count. ACE_SYNCH_MUTEX refcount_lock_; - // Mutex to protect reference count. + /// Number of outstanding references to this object. CORBA::ULong refcount_; - // Number of outstanding references to this object. + /// The ORB. TAO_ORB_Core* orb_core_; - // The ORB. + /// ORB required for reference counting. This will help us keep the + /// ORB around until the CORBA::Object we represent dies. CORBA::ORB_var orb_; - // ORB required for reference counting. This will help us keep the - // ORB around until the CORBA::Object we represent dies. + /** + * If this stub refers to a collocated object then we need to hold on to + * the servant's ORB (which may be different from the client ORB) so that, + * 1. we know that the ORB will stay alive long enough, and, + * 2. we can search for the servant/POA's status starting from + * the ORB's RootPOA. + */ CORBA::ORB_var servant_orb_; - // If this stub refers to a collocated object then we need to hold on to - // the servant's ORB (which may be different from the client ORB) so that, - // 1. we know that the ORB will stay alive long enough, and, - // 2. we can search for the servant/POA's status starting from - // the ORB's RootPOA. + /// The policy overrides in this object, if nil then use the default + /// policies. TAO_Policy_Manager_Impl *policies_; - // The policy overrides in this object, if nil then use the default - // policies. + /// The addressing mode. CORBA::Short addressing_mode_; - // The addressing mode. // = Disallow copy constructor and assignment operator. ACE_UNIMPLEMENTED_FUNC (TAO_Stub (const TAO_Stub &)) @@ -433,11 +448,14 @@ private: }; // Define a TAO_Stub auto_ptr class. +/** + * @class TAO_Stub_Auto_Ptr + * + * @brief Implements the draft C++ standard auto_ptr abstraction. + * This class allows one to work Stub Objects *Only*! + */ class TAO_Export TAO_Stub_Auto_Ptr { - // = TITLE - // Implements the draft C++ standard auto_ptr abstraction. - // This class allows one to work Stub Objects *Only*! public: // = Initialization and termination methods. /* explicit */ TAO_Stub_Auto_Ptr (TAO_Stub *p = 0); diff --git a/TAO/tao/Sync_Strategies.h b/TAO/tao/Sync_Strategies.h index 650aa24ecc4..1de28ea856d 100644 --- a/TAO/tao/Sync_Strategies.h +++ b/TAO/tao/Sync_Strategies.h @@ -1,21 +1,18 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Sync_Strategies.h -// -// = DESCRIPTION -// Sync Strategies for the ORB Messaging layer. -// -// = AUTHOR -// Irfan Pyarali -// -// ============================================================================ + +//============================================================================= +/** + * @file Sync_Strategies.h + * + * $Id$ + * + * Sync Strategies for the ORB Messaging layer. + * + * + * @author Irfan Pyarali + */ +//============================================================================= + #ifndef TAO_SYNC_STRATEGIES_H #define TAO_SYNC_STRATEGIES_H diff --git a/TAO/tao/Synch_Reply_Dispatcher.h b/TAO/tao/Synch_Reply_Dispatcher.h index 8973799f37a..c3bd6f114a8 100644 --- a/TAO/tao/Synch_Reply_Dispatcher.h +++ b/TAO/tao/Synch_Reply_Dispatcher.h @@ -1,19 +1,19 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = DESCRIPTION -// Dispatch the reply appropriately. -// -// = AUTHOR -// Alexander Babu Arulanthu <alex@cs.wustl.edu> -// -// ============================================================================ + + +//============================================================================= +/** + * @file Synch_Reply_Dispatcher.h + * + * $Id$ + * + * Dispatch the reply appropriately. + * + * + * @author Alexander Babu Arulanthu <alex@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_SYNCH_REPLY_DISPATCHER_H #define TAO_SYNCH_REPLY_DISPATCHER_H @@ -29,27 +29,28 @@ class TAO_Wait_Strategy; class TAO_Pluggable_Reply_Params; +/** + * @class TAO_Synch_Reply_Dispatcher + * + * @brief Reply dispatcher for Synchoronous Method Invocation (SMI)s. + * + */ class TAO_Export TAO_Synch_Reply_Dispatcher : public TAO_Reply_Dispatcher { - // = TITLE - // Reply dispatcher for Synchoronous Method Invocation (SMI)s. - // - // = DESCRIPTION - // public: + /// Constructor. TAO_Synch_Reply_Dispatcher (TAO_ORB_Core *orb_core, IOP::ServiceContextList &sc); - // Constructor. + /// Destructor. virtual ~TAO_Synch_Reply_Dispatcher (void); - // Destructor. + /// Return the reply CDR. TAO_InputCDR &reply_cdr (void); - // Return the reply CDR. + /// A flag to check if the reply int &reply_received (void); - // A flag to check if the reply virtual int dispatch_reply (TAO_Pluggable_Reply_Params ¶ms); @@ -61,8 +62,8 @@ public: virtual void connection_closed (void); protected: + /// The service context list IOP::ServiceContextList &reply_service_info_; - // The service context list private: // TAO_GIOP_Message_State message_state_; @@ -72,25 +73,27 @@ private: // protocol. But for the present let us close our eyes till we are // able to iterate on a use case - Bala. + /// Flag that indicates the reply has been received. int reply_received_; - // Flag that indicates the reply has been received. + /// Cache the ORB Core pointer. TAO_ORB_Core *orb_core_; - // Cache the ORB Core pointer. + /// Save the wait strategy to signal the waiting threads (if + /// appropriate). TAO_Wait_Strategy *wait_strategy_; - // Save the wait strategy to signal the waiting threads (if - // appropriate). + /// CDR stream which has the reply information that needs to be + /// demarshalled by the stubs TAO_InputCDR reply_cdr_; - // CDR stream which has the reply information that needs to be - // demarshalled by the stubs + /** + * The condition variable used to signal the waiting thread in the + * Leader/Followers model. The variable is acquired in the thread + * that binds the Reply_Dispatcher to its transport, and then passed + * to the Waiting_Strategy to do the signalling, if needed. + */ ACE_SYNCH_CONDITION *leader_follower_condition_variable_; - // The condition variable used to signal the waiting thread in the - // Leader/Followers model. The variable is acquired in the thread - // that binds the Reply_Dispatcher to its transport, and then passed - // to the Waiting_Strategy to do the signalling, if needed. }; #include "ace/post.h" diff --git a/TAO/tao/TAO_Server_Request.h b/TAO/tao/TAO_Server_Request.h index 80703f5b050..462f5e169f6 100644 --- a/TAO/tao/TAO_Server_Request.h +++ b/TAO/tao/TAO_Server_Request.h @@ -1,22 +1,21 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// TAO_Server_Request.h -// -// = DESCRIPTION -// Header file for CORBA's Server Skeleton Interface's -// "Server Request" type. -// -// = AUTHOR -// Copyright 1994-1995 by Sun Microsystems, Inc. and Chris Cleeland. -// Modifications by Aniruddha Gokhale based on CORBAv2.2 Feb 98 -// ============================================================================ + +//============================================================================= +/** + * @file TAO_Server_Request.h + * + * $Id$ + * + * Header file for CORBA's Server Skeleton Interface's + * "Server Request" type. + * + * + * @author Copyright 1994-1995 by Sun Microsystems, Inc. + * @author Chris Cleeland. + * @author Aniruddha Gokhale + */ +//============================================================================= + #ifndef TAO_GIOP_SERVER_REQUEST_H #define TAO_GIOP_SERVER_REQUEST_H @@ -38,14 +37,16 @@ class TAO_Pluggable_Messaging; class TAO_Transport; +/** + * @class TAO_ServerRequest + * + * @brief Class representing a ServerRequest object. + * DESCRIPTION + * Encapsulates CDR, transport and pluggable messaging + * components on the server side. + */ class TAO_Export TAO_ServerRequest { - // = TITLE - // Class representing a ServerRequest object. - // - // DESCRIPTION - // Encapsulates CDR, transport and pluggable messaging - // components on the server side. public: // Constructors. @@ -66,58 +67,58 @@ public: TAO_ORB_Core *orb_core, int &parse_error); + /// Destructor. virtual ~TAO_ServerRequest (void); - // Destructor. // = Request attributes. + /// Return the operation name. const char *operation (void) const; - // Return the operation name. + /// Set the operation name. void operation (ACE_CString &operation); - // Set the operation name. + /// Set the operation name. void operation (const char * name, int release); - // Set the operation name. + /// Return the legnth of the operation. unsigned int operation_length (void) const; - // Return the legnth of the operation. // = TAO extensions. + /// Return the underlying ORB. CORBA::ORB_ptr orb (void); - // Return the underlying ORB. + /// Return the ORB core pointer member. TAO_ORB_Core *orb_core (void); - // Return the ORB core pointer member. + /// Start a Reply message. void init_reply (void); - // Start a Reply message. + /// Retrieve the incoming stream. TAO_InputCDR &incoming (void); - // Retrieve the incoming stream. + /// Retrieve the outgoing stream. TAO_OutputCDR &outgoing (void); - // Retrieve the outgoing stream. + /// Is the response expected? CORBA::Boolean response_expected (void) const; - // Is the response expected? + /// Should the reply be deferred? CORBA::Boolean deferred_reply (void) const; - // Should the reply be deferred? + /// Set the response expected flag. void response_expected (CORBA::Boolean response); - // Set the response expected flag. + /// Should we return before dispatching the servant? CORBA::Boolean sync_with_server (void) const; - // Should we return before dispatching the servant? + /// Set the sync_with_server flag. void sync_with_server (CORBA::Boolean sync_flag); - // Set the sync_with_server flag. + /// Used with reliable oneway requests. void send_no_exception_reply (void); - // Used with reliable oneway requests. // CORBA::Principal_ptr principal (void) const; @@ -131,102 +132,106 @@ public: CORBA::ULong request_id (void); void request_id (CORBA::ULong req); + /// Get the forward_location. CORBA::Object_ptr forward_location (void); - // Get the forward_location. + /// Get the exception type. CORBA::ULong exception_type (void); - // Get the exception type. + /// Set the exception type. void exception_type (CORBA::ULong except_type); - // Set the exception type. + /// void requesting_principal (CORBA_Principal_ptr principal); + /// Set the requesting principal. /**** Deprecated in CORBA 2.4 *****/ - // void requesting_principal (CORBA_Principal_ptr principal); - // Set the requesting principal. + /// Set the requesting principal void requesting_principal (const CORBA_OctetSeq & principal); - // Set the requesting principal + /// Return the reference to the tagged profile TAO_Tagged_Profile &profile (void); - // Return the reference to the tagged profile void tao_send_reply (void); void tao_send_reply_exception (CORBA::Exception&); + /// Set the boolean member to 1. void is_dsi (void); - // Set the boolean member to 1. + /// Set the member. void dsi_nvlist_align (ptr_arith_t alignment); - // Set the member. + /// Get/Set operations for the argument_flag void argument_flag (CORBA::Boolean flag); CORBA::Boolean argument_flag (void); - // Get/Set operations for the argument_flag private: TAO_Pluggable_Messaging *mesg_base_; + /// Operation name. ACE_CString operation_; - // Operation name. CORBA::Object_var forward_location_; + /// Incoming stream. TAO_InputCDR *incoming_; - // Incoming stream. + /// Outgoing stream. TAO_OutputCDR *outgoing_; - // Outgoing stream. + /// Transport class. TAO_Transport *transport_; - // Transport class. + /// 0: oneway (SYNC_NONE or SYNC_WITH_TRANSPORT) + /// 1: twoway, or oneway (SYNC_WITH_SERVER or SYNC_WITH_TARGET) CORBA::Boolean response_expected_; - // 0: oneway (SYNC_NONE or SYNC_WITH_TRANSPORT) - // 1: twoway, or oneway (SYNC_WITH_SERVER or SYNC_WITH_TARGET) + /** + * 0: Reply would be sent by the object of this class which is the + * default. + * 1: Reply would not be prepared by this class and it would be + * deferred for somebody. + */ CORBA::Boolean deferred_reply_; - // 0: Reply would be sent by the object of this class which is the - // default. - // 1: Reply would not be prepared by this class and it would be - // deferred for somebody. + /// 1: oneway (SYNC_WITH_SERVER) + /// 0: anything else CORBA::Boolean sync_with_server_; - // 1: oneway (SYNC_WITH_SERVER) - // 0: anything else // TAO_GIOP_ReplyStatusType exception_type_; + /// Exception type (will be NO_EXCEPTION in the majority of the cases). CORBA::ULong exception_type_; - // Exception type (will be NO_EXCEPTION in the majority of the cases). + /// A pointer to the ORB Core for the context where the request was + /// created. TAO_ORB_Core *orb_core_; - // A pointer to the ORB Core for the context where the request was - // created. + /// The service context for the request (CORBA Reference?). IOP::ServiceContextList service_info_; - // The service context for the request (CORBA Reference?). + /// Unique identifier for a request. CORBA::ULong request_id_; - // Unique identifier for a request. + /// The tagged profile that has the addressing information. TAO_Tagged_Profile profile_; - // The tagged profile that has the addressing information. + /// Identifies the requester. CORBA_OctetSeq_var requesting_principal_; - // Identifies the requester. + /// Did we get passed to a CORBA::ServerRequest? CORBA::Boolean is_dsi_; - // Did we get passed to a CORBA::ServerRequest? + /// Used to pad CDR stream if we have used DSI. ptr_arith_t dsi_nvlist_align_; - // Used to pad CDR stream if we have used DSI. + /** + * An argument flag to indicate whether there is any data that is + * going to get marshalled along as a reply. The default will be 1 + * which indicates that we have some data that needs to be sent back + * to the client. + */ CORBA::Boolean argument_flag_; - // An argument flag to indicate whether there is any data that is - // going to get marshalled along as a reply. The default will be 1 - // which indicates that we have some data that needs to be sent back - // to the client. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/TAO_Singleton.h b/TAO/tao/TAO_Singleton.h index f6dc4d6c024..1bfc9091c7b 100644 --- a/TAO/tao/TAO_Singleton.h +++ b/TAO/tao/TAO_Singleton.h @@ -1,23 +1,19 @@ // -*- C++ -*- -// -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// TAO_Singleton.h -// -// = DESCRIPTION -// Header file for the TAO-specific Singleton implementation. -// Based entirely on tao/TAO_Singleton.*. -// -// = AUTHOR -// Ossama Othman <ossama@uci.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file TAO_Singleton.h + * + * $Id$ + * + * Header file for the TAO-specific Singleton implementation. + * Based entirely on tao/TAO_Singleton.*. + * + * + * @author Ossama Othman <ossama@uci.edu> + */ +//============================================================================= + #ifndef TAO_SINGLETON_H #define TAO_SINGLETON_H @@ -31,84 +27,88 @@ #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class TAO_Singleton + * + * @brief TAO-specific Singleton class + * + * TAO_Singletons are used by TAO to register TAO-specific + * singleton instances with the TAO_Object_Manager. This + * ensures that TAO singletons are isolated from ACE's + * Object_Manager, thus allowing TAO to be safely dynamically + * unloaded. + */ template <class TYPE, class ACE_LOCK> class TAO_Singleton : public ACE_Cleanup { - // = TITLE - // TAO-specific Singleton class - // - // = DESCRIPTION - // TAO_Singletons are used by TAO to register TAO-specific - // singleton instances with the TAO_Object_Manager. This - // ensures that TAO singletons are isolated from ACE's - // Object_Manager, thus allowing TAO to be safely dynamically - // unloaded. public: + /// Global access point to the Singleton. static TYPE *instance (void); - // Global access point to the Singleton. + /// Cleanup method, used by <ace_cleanup_destroyer> to destroy the + /// singleton. virtual void cleanup (void *param = 0); - // Cleanup method, used by <ace_cleanup_destroyer> to destroy the - // singleton. + /// Dump the state of the object. static void dump (void); - // Dump the state of the object. protected: + /// Default constructor. TAO_Singleton (void); - // Default constructor. + /// Contained instance. TYPE instance_; - // Contained instance. #if !defined (ACE_LACKS_STATIC_DATA_MEMBER_TEMPLATES) + /// Pointer to the Singleton (ACE_Cleanup) instance. static TAO_Singleton<TYPE, ACE_LOCK> *singleton_; - // Pointer to the Singleton (ACE_Cleanup) instance. #endif /* ACE_LACKS_STATIC_DATA_MEMBER_TEMPLATES */ + /// Get pointer to the TAO Singleton instance. static TAO_Singleton<TYPE, ACE_LOCK> *&instance_i (void); - // Get pointer to the TAO Singleton instance. }; +/** + * @class TAO_TSS_Singleton + * + * @brief TAO-specific Singleton class + * + * TAO_Singletons are used by TAO to register TAO-specific + * singleton instances with the TAO_Object_Manager. This + * ensures that TAO singletons are isolated from ACE's + * Object_Manager, thus allowing TAO to be safely dynamically + * unloaded. + */ template <class TYPE, class ACE_LOCK> class TAO_TSS_Singleton : public ACE_Cleanup { - // = TITLE - // TAO-specific Singleton class - // - // = DESCRIPTION - // TAO_Singletons are used by TAO to register TAO-specific - // singleton instances with the TAO_Object_Manager. This - // ensures that TAO singletons are isolated from ACE's - // Object_Manager, thus allowing TAO to be safely dynamically - // unloaded. public: + /// Global access point to the Singleton. static TYPE *instance (void); - // Global access point to the Singleton. + /// Cleanup method, used by <ace_cleanup_destroyer> to destroy the + /// singleton. virtual void cleanup (void *param = 0); - // Cleanup method, used by <ace_cleanup_destroyer> to destroy the - // singleton. + /// Dump the state of the object. static void dump (void); - // Dump the state of the object. protected: + /// Default constructor. TAO_TSS_Singleton (void); - // Default constructor. + /// Contained instance. ACE_TSS_TYPE (TYPE) instance_; - // Contained instance. #if !defined (ACE_LACKS_STATIC_DATA_MEMBER_TEMPLATES) + /// Pointer to the Singleton (ACE_Cleanup) instance. static TAO_TSS_Singleton<TYPE, ACE_LOCK> *singleton_; - // Pointer to the Singleton (ACE_Cleanup) instance. #endif /* ACE_LACKS_STATIC_DATA_MEMBER_TEMPLATES */ + /// Get pointer to the TAO TSS Singleton instance. static TAO_TSS_Singleton<TYPE, ACE_LOCK> *&instance_i (void); - // Get pointer to the TAO TSS Singleton instance. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/TAO_Singleton_Manager.h b/TAO/tao/TAO_Singleton_Manager.h index 97faf5dda2d..f0233eab8ec 100644 --- a/TAO/tao/TAO_Singleton_Manager.h +++ b/TAO/tao/TAO_Singleton_Manager.h @@ -1,24 +1,20 @@ // -*- C++ -*- -// -// $Id$ - - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// TAO_Singleton_Manager.h -// -// = DESCRIPTION -// Header file for the TAO-specific Singleton Manager. Based -// entirely on ace/Object_Manager.{h,i,cpp}. -// -// = AUTHOR -// Ossama Othman <ossama@uci.edu> -// -// ============================================================================ + + +//============================================================================= +/** + * @file TAO_Singleton_Manager.h + * + * $Id$ + * + * Header file for the TAO-specific Singleton Manager. Based + * entirely on ace/Object_Manager.{h,i,cpp}. + * + * + * @author Ossama Othman <ossama@uci.edu> + */ +//============================================================================= + #ifndef TAO_OBJECT_MANAGER_H #define TAO_OBJECT_MANAGER_H @@ -42,46 +38,51 @@ extern "C" void TAO_Singleton_Manager_cleanup_destroyer (void *, void *); +/** + * @class TAO_Singleton_Manager + * + * @brief Manager for TAO library services and singleton cleanup. + * + * The <TAO_Singleton_Manager> is basically simplified version of + * the ACE_Object_Manager. It is designed specifically to + * manage singletons created by TAO. For example, Singleton + * instances created by TAO will be automatically registered + * with the Singleton instance of this Singleton Manager. + * This class is necessary to ensure that TAO-specific + * Singletons are centrally isolated. The idea is that + * destruction of the instance of the <TAO_Singleton_Manager> + * triggers destruction of all objects/services registered with + * it. + */ class TAO_Export TAO_Singleton_Manager : public ACE_Object_Manager_Base { - // = TITLE - // Manager for TAO library services and singleton cleanup. - // - // = DESCRIPTION - // The <TAO_Singleton_Manager> is basically simplified version of - // the ACE_Object_Manager. It is designed specifically to - // manage singletons created by TAO. For example, Singleton - // instances created by TAO will be automatically registered - // with the Singleton instance of this Singleton Manager. - // - // This class is necessary to ensure that TAO-specific - // Singletons are centrally isolated. The idea is that - // destruction of the instance of the <TAO_Singleton_Manager> - // triggers destruction of all objects/services registered with - // it. friend void TAO_Singleton_Manager_cleanup_destroyer (void *, void *); public: + /// Explicitly initialize. virtual int init (void); - // Explicitly initialize. + /** + * Explicitly initialize the TAO_Singleton_Manager, in addition to + * explicitly registering (or not registering) with the + * ACE_Object_Manager. + */ int init (int register_with_object_manager); - // Explicitly initialize the TAO_Singleton_Manager, in addition to - // explicitly registering (or not registering) with the - // ACE_Object_Manager. + /// Explicitly destroy. virtual int fini (void); - // Explicitly destroy. + /** + * Returns 1 before the <TAO_Singleton_Manager> has been + * constructed. See <ACE_Object_Manager::starting_up> for more + * information. + */ static int starting_up (void); - // Returns 1 before the <TAO_Singleton_Manager> has been - // constructed. See <ACE_Object_Manager::starting_up> for more - // information. + /// Returns 1 after the <TAO_Singleton_Manager> has been destroyed. + /// See <ACE_Object_Manager::shutting_down> for more information. static int shutting_down (void); - // Returns 1 after the <TAO_Singleton_Manager> has been destroyed. - // See <ACE_Object_Manager::shutting_down> for more information. enum Preallocated_Object { @@ -100,44 +101,48 @@ public: }; // Unique identifiers for preallocated objects. + /// Accesses a default signal set used, for example, in + /// <ACE_Sig_Guard> methods. static sigset_t *default_mask (void); - // Accesses a default signal set used, for example, in - // <ACE_Sig_Guard> methods. + /// Returns the current thread hook for the process. static ACE_Thread_Hook *thread_hook (void); - // Returns the current thread hook for the process. + /// Returns the existing thread hook and assign a <new_thread_hook>. static ACE_Thread_Hook *thread_hook (ACE_Thread_Hook *new_thread_hook); - // Returns the existing thread hook and assign a <new_thread_hook>. + /// Accessor to singleton instance. static TAO_Singleton_Manager *instance (void); - // Accessor to singleton instance. + /** + * Register an ACE_Cleanup object for cleanup at process + * termination. The object is deleted via the + * <ace_cleanup_destroyer>. If you need more flexiblity, see the + * <other at_exit> method below. For OS's that do not have + * processes, cleanup takes place at the end of <main>. Returns 0 + * on success. On failure, returns -1 and sets errno to: EAGAIN if + * shutting down, ENOMEM if insufficient virtual memory, or EEXIST + * if the object (or array) had already been registered. + */ static int at_exit (ACE_Cleanup *object, void *param = 0); - // Register an ACE_Cleanup object for cleanup at process - // termination. The object is deleted via the - // <ace_cleanup_destroyer>. If you need more flexiblity, see the - // <other at_exit> method below. For OS's that do not have - // processes, cleanup takes place at the end of <main>. Returns 0 - // on success. On failure, returns -1 and sets errno to: EAGAIN if - // shutting down, ENOMEM if insufficient virtual memory, or EEXIST - // if the object (or array) had already been registered. + /** + * Register an object (or array) for cleanup at process termination. + * "cleanup_hook" points to a (global, or static member) function + * that is called for the object or array when it to be destroyed. + * It may perform any necessary cleanup specific for that object or + * its class. "param" is passed as the second parameter to the + * "cleanup_hook" function; the first parameter is the object (or + * array) to be destroyed. "cleanup_hook", for example, may delete + * the object (or array). For OS's that do not have processes, this + * function is the same as <at_thread_exit>. Returns 0 on success. + * On failure, returns -1 and sets errno to: EAGAIN if shutting + * down, ENOMEM if insufficient virtual memory, or EEXIST if the + * object (or array) had already been registered. + */ static int at_exit (void *object, ACE_CLEANUP_FUNC cleanup_hook, void *param); - // Register an object (or array) for cleanup at process termination. - // "cleanup_hook" points to a (global, or static member) function - // that is called for the object or array when it to be destroyed. - // It may perform any necessary cleanup specific for that object or - // its class. "param" is passed as the second parameter to the - // "cleanup_hook" function; the first parameter is the object (or - // array) to be destroyed. "cleanup_hook", for example, may delete - // the object (or array). For OS's that do not have processes, this - // function is the same as <at_thread_exit>. Returns 0 on success. - // On failure, returns -1 and sets errno to: EAGAIN if shutting - // down, ENOMEM if insufficient virtual memory, or EEXIST if the - // object (or array) had already been registered. private: // Force allocation on the heap. @@ -148,34 +153,34 @@ private: TAO_Singleton_Manager (const TAO_Singleton_Manager &); TAO_Singleton_Manager &operator= (const TAO_Singleton_Manager &); + /// Register an object or array for deletion at program termination. + /// See description of static version above for return values. int at_exit_i (void *object, ACE_CLEANUP_FUNC cleanup_hook, void *param); - // Register an object or array for deletion at program termination. - // See description of static version above for return values. private: + /// Singleton instance pointer. static TAO_Singleton_Manager *instance_; - // Singleton instance pointer. + /// Table of preallocated objects. static void *preallocated_object[TAO_PREALLOCATED_OBJECTS]; - // Table of preallocated objects. + /// Default signal set used, for example, in ACE_Sig_Guard. sigset_t *default_mask_; - // Default signal set used, for example, in ACE_Sig_Guard. + /// Thread hook that's used by this process. ACE_Thread_Hook *thread_hook_; - // Thread hook that's used by this process. + /// For at_exit support. ACE_OS_Exit_Info exit_info_; - // For at_exit support. + /// Indicates if TAO_Singleton_Manager is registered with the + /// ACE_Object_Manager. int registered_with_object_manager_; - // Indicates if TAO_Singleton_Manager is registered with the - // ACE_Object_Manager. #if defined (ACE_MT_SAFE) && (ACE_MT_SAFE != 0) + /// Lock that is used to guard internal structures. ACE_Recursive_Thread_Mutex *internal_lock_; - // Lock that is used to guard internal structures. #endif /* ACE_MT_SAFE */ }; diff --git a/TAO/tao/Tagged_Components.h b/TAO/tao/Tagged_Components.h index 43d54e4dc11..fc93c8aa667 100644 --- a/TAO/tao/Tagged_Components.h +++ b/TAO/tao/Tagged_Components.h @@ -1,18 +1,15 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Tagged_Components.h -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// ============================================================================ + +//============================================================================= +/** + * @file Tagged_Components.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + */ +//============================================================================= + #ifndef TAO_TAGGED_COMPONENTS_H #define TAO_TAGGED_COMPONENTS_H @@ -27,115 +24,117 @@ #include "tao/CONV_FRAMEC.h" class TAO_Profile; +/** + * @class TAO_Tagged_Components + * + * @brief The policy manager implementation. + * + * This class is used to manipulate and access the <components> + * field of an IIOP profile (and other GIOP profiles). + * The definition for that field is simply a sequence of the + * following structures: + * typedef unsigned long ComponentId; + * struct TaggedComponent { + * ComponentId tag; + * sequence<octet> component_data; + * }; + * the real motivation is to minimize the marshaling and + * demarshaling of the <component_data> field for certain critical + * components. + */ class TAO_Export TAO_Tagged_Components { - // - // = TITLE - // The policy manager implementation. - // - // = DESCRIPTION - // This class is used to manipulate and access the <components> - // field of an IIOP profile (and other GIOP profiles). - // The definition for that field is simply a sequence of the - // following structures: - // - // typedef unsigned long ComponentId; - // struct TaggedComponent { - // ComponentId tag; - // sequence<octet> component_data; - // }; - // - // the real motivation is to minimize the marshaling and - // demarshaling of the <component_data> field for certain critical - // components. - // public: + /// Constructor TAO_Tagged_Components (void); - // Constructor // = Standard OMG that require fast access. + /// The the IOP::TAG_ORB_TYPE component value void set_orb_type (CORBA::ULong orb_type); - // The the IOP::TAG_ORB_TYPE component value + /// Gets the IOP::TAG_ORB_TYPE component value, return 0 if the + /// component is not present. int get_orb_type (CORBA::ULong& orb_type) const; - // Gets the IOP::TAG_ORB_TYPE component value, return 0 if the - // component is not present. + /** + * The the IOP::TAG_CODE_SETS component value, the first version + * copies the data, the second version steal all the sequence + * buffers. + */ void set_code_sets (const CONV_FRAME::CodeSetComponentInfo &); void set_code_sets (CONV_FRAME::CodeSetComponentInfo &); - // The the IOP::TAG_CODE_SETS component value, the first version - // copies the data, the second version steal all the sequence - // buffers. + /// Gets a reference of the IOP::TAG_CODE_SETS component value, + /// return 0 if the component is not present. int get_code_sets (const CONV_FRAME::CodeSetComponentInfo* &) const; - // Gets a reference of the IOP::TAG_CODE_SETS component value, - // return 0 if the component is not present. + /// Gets a copy of the IOP::TAG_CODE_SETS component value, return 0 + /// if the component is not present. int get_code_sets (CONV_FRAME::CodeSetComponentInfo &) const; - // Gets a copy of the IOP::TAG_CODE_SETS component value, return 0 - // if the component is not present. // = Generic components + /// Insert the component into the list, making a copy of the octet + /// sequence. void set_component (const IOP::TaggedComponent& component); - // Insert the component into the list, making a copy of the octet - // sequence. + /// Insert the component into the list, but efficiently stealing the + /// contents of the octet sequence. void set_component (IOP::TaggedComponent& component); - // Insert the component into the list, but efficiently stealing the - // contents of the octet sequence. + /// Get a copy of the component identified by <component.tag>, return + /// 0 if the component is not present. int get_component (IOP::TaggedComponent& component) const; - // Get a copy of the component identified by <component.tag>, return - // 0 if the component is not present. // = Marshaling and demarshaling + /// Marshal and demarshal the list. int encode (TAO_OutputCDR& cdr) const; int decode (TAO_InputCDR& cdr); - // Marshal and demarshal the list. + /** + * Read/Write access to the underlying + * MutipleComponentProfile. Added by request from Chris Hafey + * <chris@stentorsoft.com> + */ IOP::MultipleComponentProfile &components (void); - // Read/Write access to the underlying - // MutipleComponentProfile. Added by request from Chris Hafey - // <chris@stentorsoft.com> private: + /// Helper method to implement set_code_sets() void set_code_sets_i (CONV_FRAME::CodeSetComponent &lhs, CONV_FRAME::CodeSetComponent &rhs); - // Helper method to implement set_code_sets() + /// Helper methods to implement set_component() void set_known_component_i (const IOP::TaggedComponent& component); void set_component_i (const IOP::TaggedComponent& component); void set_component_i (IOP::TaggedComponent& component); void add_component_i (const IOP::TaggedComponent& component); void add_component_i (IOP::TaggedComponent& component); void set_component_i (IOP::ComponentId tag, TAO_OutputCDR &cdr); - // Helper methods to implement set_component() + /// Helper methods to implement set_component() int get_known_component_i (IOP::TaggedComponent& component) const; int get_component_i (IOP::TaggedComponent& component) const; - // Helper methods to implement set_component() + /// Is <tag> a well-known component? int known_tag (IOP::ComponentId tag) const; - // Is <tag> a well-known component? + /// Does <tag> show up only once? int unique_tag (IOP::ComponentId tag) const; - // Does <tag> show up only once? private: + /// The ORB_TYPE component value CORBA::ULong orb_type_; - // The ORB_TYPE component value + /// The ORB_TYPE component value CONV_FRAME::CodeSetComponentInfo code_sets_; - // The ORB_TYPE component value // CORBA::Short tao_priority_; // The TAO_PRIORITY priorities + /// The rest of the components, to be compliant we cannot drop a + /// bunch of them. IOP::MultipleComponentProfile components_; - // The rest of the components, to be compliant we cannot drop a - // bunch of them. // A flag for each component... CORBA::Octet orb_type_set_; diff --git a/TAO/tao/Tagged_Profile.h b/TAO/tao/Tagged_Profile.h index a4b32168368..620ad39e385 100644 --- a/TAO/tao/Tagged_Profile.h +++ b/TAO/tao/Tagged_Profile.h @@ -1,18 +1,15 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Tagged_Profile.h -// -// = AUTHOR -// Bala Natarajan <bala@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Tagged_Profile.h + * + * $Id$ + * + * @author Bala Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_TAGGED_PROFILE_H #define TAO_TAGGED_PROFILE_H @@ -27,71 +24,69 @@ #include "tao/GIOPC.h" +/** + * @class TAO_Tagged_Profile + * + * @brief Implementation of one of the GIOP 1.2 Target Address + * recognition mode + * + * This class is used to manipulate and access the profile_data + * field of an IIOP profile (and other GIOP profiles). + * The definition for that field is simply a sequence of the + * following structures: + * struct ProfileBody + * { + * Version iiop_version; + * string host; + * unsigned short port; + * sequence<octet> object_key; + * sequence <IOP::TaggedComponent> components; + * }; + * the real motivation is to store the details sent by a client + * and use only the object key which is relevant to a TAO server + * as on date. + */ class TAO_Export TAO_Tagged_Profile { - // - // = TITLE - // Implementation of one of the GIOP 1.2 Target Address - // recognition mode - // - // = DESCRIPTION - // This class is used to manipulate and access the profile_data - // field of an IIOP profile (and other GIOP profiles). - // The definition for that field is simply a sequence of the - // following structures: - // - // struct ProfileBody - // { - // Version iiop_version; - // string host; - // unsigned short port; - // sequence<octet> object_key; - // sequence <IOP::TaggedComponent> components; - // }; - // - // the real motivation is to store the details sent by a client - // and use only the object key which is relevant to a TAO server - // as on date. - // public: + /// Ctor TAO_Tagged_Profile (TAO_ORB_Core *orb_core); - // Ctor - + + /// Return the object key TAO_ObjectKey &object_key (void); - // Return the object key + /// Save the object key void object_key (TAO_ObjectKey &object_key); - // Save the object key + /// Return a const object key const TAO_ObjectKey &object_key (void) const; - // Return a const object key + /// get the tagged_profile IOP::TaggedProfile &tagged_profile (void); - // get the tagged_profile - + + /// get the addressing info GIOP::IORAddressingInfo &addressing_info (void); - // get the addressing info + /// Extract the object key from the TaggedProfile and store it in + /// <object_key_> CORBA::Boolean extract_object_key (IOP::TaggedProfile &profile); - // Extract the object key from the TaggedProfile and store it in - // <object_key_> private: + /// Our ORB Core TAO_ORB_Core *orb_core_; - // Our ORB Core + /// The object key TAO_ObjectKey object_key_; - // The object key + /// The Tagged profile. This class would have the Tagged Profile IOP::TaggedProfile profile_; - // The Tagged profile. This class would have the Tagged Profile - + + /// The addressing info GIOP::IORAddressingInfo addr_info_; - // The addressing info - + // The above two declarations are not used in TAO as on date. It is // here so that we can use this anyday. The object_key extracted - // from these would still be available in <object_key_>. + // from these would still be available in <object_key_>. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/TimeBaseC.h b/TAO/tao/TimeBaseC.h index 15bea6f943d..811fbd1f848 100644 --- a/TAO/tao/TimeBaseC.h +++ b/TAO/tao/TimeBaseC.h @@ -1,22 +1,19 @@ /* -*- C++ -*- */ -// -// $Id$ -// -// ================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// TimeBaseC.h -// -// = DESCRIPTION -// Generated from TimeBase.pidl, the common time representation for -// Time in CORBA. -// The code was generated by the IDL compiler and then hand-crafted -// to reduce the includes interdependencies. -// -// ================================================================ +//============================================================================= +/** + * @file TimeBaseC.h + * + * $Id$ + * + * Generated from TimeBase.pidl, the common time representation for + * Time in CORBA. + * The code was generated by the IDL compiler and then hand-crafted + * to reduce the includes interdependencies. + * + * + */ +//============================================================================= + #ifndef TAO_IDL_TIMEBASEC_H #define TAO_IDL_TIMEBASEC_H diff --git a/TAO/tao/TimeBaseS.h b/TAO/tao/TimeBaseS.h index 806cd719de4..6c7fd306dd5 100644 --- a/TAO/tao/TimeBaseS.h +++ b/TAO/tao/TimeBaseS.h @@ -1,21 +1,18 @@ /* -*- C++ -*- */ -// -// $Id$ -// -// ================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// TimeBaseS.h -// -// = DESCRIPTION -// Generated from TimeBase.pidl -// The file is almost empty and only present to keep other IDL files -// that include TimeBase.pidl happy. -// -// ================================================================ +//============================================================================= +/** + * @file TimeBaseS.h + * + * $Id$ + * + * Generated from TimeBase.pidl + * The file is almost empty and only present to keep other IDL files + * that include TimeBase.pidl happy. + * + * + */ +//============================================================================= + #ifndef TAO_IDL_TIMEBASES_H #define TAO_IDL_TIMEBASES_H diff --git a/TAO/tao/TimeBaseS_T.h b/TAO/tao/TimeBaseS_T.h index a213511445f..aade293dbdb 100644 --- a/TAO/tao/TimeBaseS_T.h +++ b/TAO/tao/TimeBaseS_T.h @@ -1,19 +1,16 @@ /* -*- C++ -*- */ -// -// $Id$ -// -// ================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// TimeBaseS_T.cpp -// -// = DESCRIPTION -// Generated from TimeBase.pidl -// -// ================================================================ +//============================================================================= +/** + * @file TimeBaseS_T.h + * + * $Id$ + * + * Generated from TimeBase.pidl + * + * + */ +//============================================================================= + #ifndef TAO_IDL_TIMEBASES_T_H #define TAO_IDL_TIMEBASES_T_H diff --git a/TAO/tao/Timeprobe.h b/TAO/tao/Timeprobe.h index 3eaa6408c84..54de56e641f 100644 --- a/TAO/tao/Timeprobe.h +++ b/TAO/tao/Timeprobe.h @@ -1,4 +1,14 @@ -// $Id$ + +//============================================================================= +/** + * @file Timeprobe.h + * + * $Id$ + * + * @author Irfan Pyarali <irfan@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_TIMEPROBE_H #define TAO_TIMEPROBE_H diff --git a/TAO/tao/Transport_Mux_Strategy.h b/TAO/tao/Transport_Mux_Strategy.h index 094974b61e2..447f40ce344 100644 --- a/TAO/tao/Transport_Mux_Strategy.h +++ b/TAO/tao/Transport_Mux_Strategy.h @@ -1,15 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = AUTHOR -// Alexander Babu Arulanthu <alex@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Transport_Mux_Strategy.h + * + * $Id$ + * + * @author Alexander Babu Arulanthu <alex@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_TRANSPORT_MUX_STRATEGY_H #define TAO_TRANSPORT_MUX_STRATEGY_H @@ -25,46 +25,48 @@ class TAO_Reply_Dispatcher; class TAO_Transport; class TAO_Pluggable_Reply_Params; +/** + * @class TAO_Transport_Mux_Strategy + * + * @brief Strategy to determine whether the connection should be + * multiplexed for multiple requests or it is exclusive for a + * single request at a time. + * + */ class TAO_Export TAO_Transport_Mux_Strategy { - // = TITLE - // - // Strategy to determine whether the connection should be - // multiplexed for multiple requests or it is exclusive for a - // single request at a time. - // - // = DESCRIPTION - // public: + /// Base class constructor. TAO_Transport_Mux_Strategy (TAO_Transport *transport); - // Base class constructor. + /// Base class destructor. virtual ~TAO_Transport_Mux_Strategy (void); - // Base class destructor. + /// Generate and return an unique request id for the current + /// invocation. virtual CORBA::ULong request_id (void) = 0; - // Generate and return an unique request id for the current - // invocation. // = Bind and Find methods for the <Request ID, ReplyDispatcher> // pairs. + /// Bind the dispatcher with the request id. Commonalities in the + /// derived class implementations is kept here. virtual int bind_dispatcher (CORBA::ULong request_id, TAO_Reply_Dispatcher *rd); - // Bind the dispatcher with the request id. Commonalities in the - // derived class implementations is kept here. + /** + * Unbind the dispatcher, the client is no longer waiting for the + * request, for example, because the request timedout. + * The strategy can (must) cleanup any resources associated with the + * request. + * A later reply for that request should be ignored. + */ virtual void unbind_dispatcher (CORBA::ULong request_id); - // Unbind the dispatcher, the client is no longer waiting for the - // request, for example, because the request timedout. - // The strategy can (must) cleanup any resources associated with the - // request. - // A later reply for that request should be ignored. + /// Dispatch the reply for <request_id>, cleanup any resources + /// allocated for that request. virtual int dispatch_reply (TAO_Pluggable_Reply_Params ¶ms) = 0; - // Dispatch the reply for <request_id>, cleanup any resources - // allocated for that request. // = "Factory methods" to obtain the CDR stream, in the Muxed case // the factory simply allocates a new one, in the Exclusive case @@ -76,21 +78,21 @@ public: // virtual void destroy_message_state (TAO_GIOP_Message_State *) = 0; // Destroy a CDR stream. + /// Request has been just sent, but the reply is not received. Idle + /// the transport now. virtual int idle_after_send (void) = 0; - // Request has been just sent, but the reply is not received. Idle - // the transport now. + /// Request is sent and the reply is received. Idle the transport + /// now. virtual int idle_after_reply (void) = 0; - // Request is sent and the reply is received. Idle the transport - // now. + /// The transport object has closed the connection, inform all Reply + /// dispatchers and waiting strategies. virtual void connection_closed (void) = 0; - // The transport object has closed the connection, inform all Reply - // dispatchers and waiting strategies. protected: + /// Cache the transport reference. TAO_Transport *transport_; - // Cache the transport reference. }; #include "ace/post.h" diff --git a/TAO/tao/Typecode.cpp b/TAO/tao/Typecode.cpp index 7bb876aa3e5..3f115659501 100644 --- a/TAO/tao/Typecode.cpp +++ b/TAO/tao/Typecode.cpp @@ -1744,16 +1744,16 @@ CORBA_TypeCode::private_member_name (CORBA::ULong slot, this->private_state_->tc_member_name_list_ [i] )) ACE_THROW_RETURN (CORBA::BAD_TYPECODE (), (char *)0); - + this->private_state_->tc_member_name_list_known_ = 1; - + if (slot < mcount) return this->private_state_->tc_member_name_list_[slot]; else ACE_THROW_RETURN (CORBA::TypeCode::Bounds (), (char *)0); } ACE_NOTREACHED (break;) - + case CORBA::tk_except: case CORBA::tk_struct: // index from 0 { @@ -1775,12 +1775,12 @@ CORBA_TypeCode::private_member_name (CORBA::ULong slot, } this->private_state_->tc_member_name_list_known_ = 1; - + if (slot < mcount) return this->private_state_->tc_member_name_list_[slot]; else ACE_THROW_RETURN (CORBA::TypeCode::Bounds (), (char *)0); - + } ACE_NOTREACHED (break;) @@ -1824,7 +1824,7 @@ CORBA_TypeCode::private_member_name (CORBA::ULong slot, } this->private_state_->tc_member_name_list_known_ = 1; - + if (slot < mcount) return this->private_state_->tc_member_name_list_[slot]; else diff --git a/TAO/tao/Typecode.h b/TAO/tao/Typecode.h index 95ced4d4dc8..aaac251ade8 100644 --- a/TAO/tao/Typecode.h +++ b/TAO/tao/Typecode.h @@ -1,21 +1,17 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Typecode.h -// -// = DESCRIPTION -// Header file CORBA's "TypeCode" type. -// -// = AUTHOR -// Copyright 1994-1995 by Sun Microsystems, Inc. -// -// ============================================================================ +//============================================================================= +/** + * @file Typecode.h + * + * $Id$ + * + * Header file CORBA's "TypeCode" type. + * + * @author Copyright 1994-1995 by Sun Microsystems, Inc. + */ +//============================================================================= + #ifndef TAO_TYPECODE_H #define TAO_TYPECODE_H @@ -43,26 +39,26 @@ class TAO_OutputCDR; class TC_Private_State; +/** + * @class CORBA_TypeCode + * + * @brief The CORBA TypeCode class. It maintains the in-memory + * representation of any OMG CORBA IDL data type. + * + * Implements the CORBA::TypeCode interface specified by CORBA 2.0 + * spec. Typecodes essentially consist of just the CDR octets + * that get marshaled and unmarshaled, and this code knows how to + * parse those octets and answer questions CORBA's TypeCode APIs + * require. + * NOTE: This isn't well tuned performance-wise. Given how much + * is variable (byte order, alignment) it's clear tuning has its + * limits with respect to CDR bytecode interpretation. + * THREADING NOTE: Typecodes are readonly data structures, and the + * only mutual exclusion relates to reference counting and + * construction. + */ class TAO_Export CORBA_TypeCode { - // = TITLE - // The CORBA TypeCode class. It maintains the in-memory - // representation of any OMG CORBA IDL data type. - // - // = DESCRIPTION - // Implements the CORBA::TypeCode interface specified by CORBA 2.0 - // spec. Typecodes essentially consist of just the CDR octets - // that get marshaled and unmarshaled, and this code knows how to - // parse those octets and answer questions CORBA's TypeCode APIs - // require. - // - // NOTE: This isn't well tuned performance-wise. Given how much - // is variable (byte order, alignment) it's clear tuning has its - // limits with respect to CDR bytecode interpretation. - // - // THREADING NOTE: Typecodes are readonly data structures, and the - // only mutual exclusion relates to reference counting and - // construction. public: // Two "user exceptions" are defined for manipulating TypeCodes. These @@ -102,108 +98,110 @@ public: static CORBA::TypeCode_ptr _tc_Bounds; static CORBA::TypeCode_ptr _tc_BadKind; + /// Duplicates i.e., increments ref count. static CORBA::TypeCode_ptr _duplicate (CORBA::TypeCode_ptr tc); - // Duplicates i.e., increments ref count. + /// Returns a NULL typecode. static CORBA::TypeCode_ptr _nil (void); - // Returns a NULL typecode. + /// Compares two typecodes. Must be identical in every respect. CORBA::Boolean equal (CORBA::TypeCode_ptr, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // Compares two typecodes. Must be identical in every respect. + /// Conforms to CORBA 2.3.1 (99-10-07). CORBA::Boolean equivalent (CORBA::TypeCode_ptr, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // Conforms to CORBA 2.3.1 (99-10-07). + /// For all TypeCode kinds, returns the "kind" of the typecode. CORBA::TCKind kind (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // For all TypeCode kinds, returns the "kind" of the typecode. + /// For tk_{objref,struct,union,enum,alias,except}. Returns the + /// repository ID, raises BadKind. const char *id (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // For tk_{objref,struct,union,enum,alias,except}. Returns the - // repository ID, raises BadKind. + /// Returns name (), raises (BadKind). const char *name (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // Returns name (), raises (BadKind). + /// Returns member_count (), raises (BadKind). Useful for tk_struct, + /// tk_union, tk_enum, tk_alias, and tk_except. CORBA::ULong member_count (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // Returns member_count (), raises (BadKind). Useful for tk_struct, - // tk_union, tk_enum, tk_alias, and tk_except. + /// Returns member_name (...), raises (BadKind, Bounds); Useful for + /// tk_struct, tk_union, tk_enum, tk_alias, and tk_except. const char *member_name (CORBA::ULong slot, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // Returns member_name (...), raises (BadKind, Bounds); Useful for - // tk_struct, tk_union, tk_enum, tk_alias, and tk_except. + /// Returns member_type (...), raises (BadKind, Bounds); Useful for + /// tk_struct, tk_union, and tk_except. CORBA::TypeCode_ptr member_type (CORBA::ULong slot, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // Returns member_type (...), raises (BadKind, Bounds); Useful for - // tk_struct, tk_union, and tk_except. + /// For tk_union. Returns the label. Raises BadKind, Bounds. CORBA::Any_ptr member_label (CORBA::ULong n, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // For tk_union. Returns the label. Raises BadKind, Bounds. + /// Returns the discriminator type for tk_union. raises (BadKind). CORBA::TypeCode_ptr discriminator_type ( CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ) const; - // Returns the discriminator type for tk_union. raises (BadKind). + /// Returns the default slot for the tk_union. Raises (BadKind). CORBA::Long default_index (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // Returns the default slot for the tk_union. Raises (BadKind). + /// Returns length, raises (BadKind). Used for tk_string, + /// tk_sequence, and tk_array. CORBA::ULong length (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // Returns length, raises (BadKind). Used for tk_string, - // tk_sequence, and tk_array. + /// Returns the content type (element type). Raises (BadKind); Useful + /// for tk_sequence, tk_array, and tk_alias. CORBA::TypeCode_ptr content_type (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // Returns the content type (element type). Raises (BadKind); Useful - // for tk_sequence, tk_array, and tk_alias. // = Creation/refcounting // These aren't really public APIs, but an IDL compiler will need to // be able to create TypeCodes as part of creating stubs. + /// This constructor is used only for built-in TypeCode constants, + /// with no parameters. CORBA_TypeCode (CORBA::TCKind kind); - // This constructor is used only for built-in TypeCode constants, - // with no parameters. + /** + * This constructor is used both for typecode constants and for + * heap-allocated TypeCodes. The two are distinguished by the + * orb_owns_tc flag passed in by the creator. + * + * For simple param lists with a single numeric parameter, only + * 'length' matters. + * + * For complex param lists, or simple param lists for which the + * parameter is a string or typecode, length _and_ buffer matter. + * + * For typecodes that are precomputed from the encapsulation stream + * of the parent, even the "parent" argument matters because this + * implies that all children will share the octet buffers of its + * parent + */ CORBA_TypeCode (CORBA::TCKind kind, size_t length, const char *buffer, CORBA::Boolean orb_owns_tc, CORBA::ULong size, CORBA::TypeCode_ptr parent = 0); - // This constructor is used both for typecode constants and for - // heap-allocated TypeCodes. The two are distinguished by the - // orb_owns_tc flag passed in by the creator. - // - // For simple param lists with a single numeric parameter, only - // 'length' matters. - // - // For complex param lists, or simple param lists for which the - // parameter is a string or typecode, length _and_ buffer matter. - // - // For typecodes that are precomputed from the encapsulation stream - // of the parent, even the "parent" argument matters because this - // implies that all children will share the octet buffers of its - // parent + /// destructor ~CORBA_TypeCode (void); - // destructor enum traverse_status { @@ -223,23 +221,23 @@ public: // here as no-ops so legacy apps won't completely break. They // throw CORBA::NO_IMPLEMENT. + /// Deprecated in the CORBA 2.2 spec and + /// missing altogether from 2.3a (98-12-04), CORBA::Any_ptr parameter (const CORBA::Long slot, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()); - // Deprecated in the CORBA 2.2 spec and - // missing altogether from 2.3a (98-12-04), + /// Deprecated, CORBA 1.2, not fully usable. Returns the number of + /// parameters that the typecode takes. CORBA::ULong param_count (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // Deprecated, CORBA 1.2, not fully usable. Returns the number of - // parameters that the typecode takes. + /// CDR decoding: the >> operator is not enough because we must also + /// respect the parent/child relationship among TypeCodes. static void _tao_decode (const CORBA_TypeCode *parent, TAO_InputCDR &cdr, CORBA_TypeCode *&child, CORBA::Environment &ACE_TRY_ENV); - // CDR decoding: the >> operator is not enough because we must also - // respect the parent/child relationship among TypeCodes. // private: // @@ -248,36 +246,42 @@ public: // This is implemented as a counted set of bytes, in marshaled CDR // format. + /// length of the encapsulated stream size_t length_; - // length of the encapsulated stream + /// the encapsulated stream const char* buffer_; - // the encapsulated stream + /// The byte order in the encapsulated stream. CORBA::Long byte_order_; - // The byte order in the encapsulated stream. + /// the TypeCode kind CORBA::Long kind_; - // the TypeCode kind + /** + * Indirected typecodes share "buffer" with a parent, and hold a + * reference to that parent to ensure its memory is not freed + * inappropriately. + */ CORBA::TypeCode_ptr parent_; - // Indirected typecodes share "buffer" with a parent, and hold a - // reference to that parent to ensure its memory is not freed - // inappropriately. + /** + * my typecode base. Notice that the buffer_ member points to my + * encapsulation. However, for indirected typecodes, the offsets will point + * to my tk_kind field which should be pointed to be tc_base_ + */ const char *tc_base_; - // my typecode base. Notice that the buffer_ member points to my - // encapsulation. However, for indirected typecodes, the offsets will point - // to my tk_kind field which should be pointed to be tc_base_ + /** + * base of the topmost level typecode. Applicable only if I have any + * parents, else it is the same as tc_base. This helps in case we have + * indirections and we need to traverse beyond encapsulation boundaries. + */ const char *root_tc_base_; - // base of the topmost level typecode. Applicable only if I have any - // parents, else it is the same as tc_base. This helps in case we have - // indirections and we need to traverse beyond encapsulation boundaries. + /// skip a typecode encoding in a given CDR stream. This is just a + /// helper function. static CORBA::Boolean skip_typecode (TAO_InputCDR &stream); - // skip a typecode encoding in a given CDR stream. This is just a - // helper function. #if !defined(__GNUC__) || __GNUC__ > 2 || __GNUC_MINOR__ >= 8 typedef CORBA_TypeCode_ptr _ptr_type; @@ -288,167 +292,171 @@ public: private: // = All the private/helper methods + /** + * equal() and equivalent() must both recurse, but their + * behavior is somewhat different (as defined in CORBA 2.3). + * This function allows us to reuse the same code by acting + * as the point of recursion and by adding the equiv_only + * flag, to differentiate the behavior where necessary. + */ CORBA::Boolean equ_common (CORBA::TypeCode_ptr tc, CORBA::Boolean equiv_only, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // equal() and equivalent() must both recurse, but their - // behavior is somewhat different (as defined in CORBA 2.3). - // This function allows us to reuse the same code by acting - // as the point of recursion and by adding the equiv_only - // flag, to differentiate the behavior where necessary. + /// Compares the typecodes. CORBA::Boolean private_equal (CORBA::TypeCode_ptr tc, CORBA::Boolean equiv_only, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // Compares the typecodes. + /// For tk_{objref,struct,union,enum,alias,except}. Returns the + /// repository ID, raises BadKind. const char *private_id (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // For tk_{objref,struct,union,enum,alias,except}. Returns the - // repository ID, raises BadKind. + /// returns name (), raises (BadKind) const char *private_name (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // returns name (), raises (BadKind) + /// returns member_count (), raises (BadKind). Useful for tk_struct, + /// tk_union, tk_enum, tk_alias, and tk_except. CORBA::ULong private_member_count (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // returns member_count (), raises (BadKind). Useful for tk_struct, - // tk_union, tk_enum, tk_alias, and tk_except. + /// returns member_type (...), raises (BadKind, Bounds); Useful for + /// tk_struct, tk_union, and tk_except CORBA::TypeCode_ptr private_member_type ( CORBA::ULong slot, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ) const; - // returns member_type (...), raises (BadKind, Bounds); Useful for - // tk_struct, tk_union, and tk_except + /// returns member_name (...), raises (BadKind, Bounds); Useful for + /// tk_union, tk_struct, tk_except, and tk_enum const char *private_member_name (CORBA::ULong slot, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // returns member_name (...), raises (BadKind, Bounds); Useful for - // tk_union, tk_struct, tk_except, and tk_enum + /// For tk_union. Returns the label. Raises BadKind, Bounds. CORBA::Any_ptr private_member_label (CORBA::ULong n, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // For tk_union. Returns the label. Raises BadKind, Bounds. + /// returns the discriminator type for tk_union, and acquires the lock + /// for the wrapped function below. raises (BadKind) CORBA::TypeCode_ptr private_discriminator_type ( CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ) const; - // returns the discriminator type for tk_union, and acquires the lock - // for the wrapped function below. raises (BadKind) + /// Acquires no lock so it can be called internally from blocks + /// which have a lock. CORBA::TypeCode_ptr private_discriminator_type_i ( CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ) const; - // Acquires no lock so it can be called internally from blocks - // which have a lock. + /// returns the default slot for the tk_union. Raises (BadKind); CORBA::Long private_default_index (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // returns the default slot for the tk_union. Raises (BadKind); + /// returns length, raises (BadKind). Used for tk_string, + /// tk_sequence, and tk_array CORBA::Long private_length (CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // returns length, raises (BadKind). Used for tk_string, - // tk_sequence, and tk_array + /// returns the content type (element type). Raises (BadKind); Useful + /// for tk_sequence, tk_array, and tk_alias CORBA::TypeCode_ptr private_content_type ( CORBA_Environment &ACE_TRY_ENV = TAO_default_environment () ) const; - // returns the content type (element type). Raises (BadKind); Useful - // for tk_sequence, tk_array, and tk_alias // = All the private helpers testing for equality of typecodes + /// test equality for typecodes of objrefs CORBA::Boolean private_equal_objref (CORBA::TypeCode_ptr tc, CORBA::Boolean equiv_only, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // test equality for typecodes of objrefs + /// test equality for typecodes of structs CORBA::Boolean private_equal_struct (CORBA::TypeCode_ptr tc, CORBA::Boolean equiv_only, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // test equality for typecodes of structs + /// test equality for typecodes of unions CORBA::Boolean private_equal_union (CORBA::TypeCode_ptr tc, CORBA::Boolean equiv_only, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // test equality for typecodes of unions + /// test equality for typecodes of enums CORBA::Boolean private_equal_enum (CORBA::TypeCode_ptr tc, CORBA::Boolean equiv_only, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // test equality for typecodes of enums + /// test equality for typecodes of strings CORBA::Boolean private_equal_string (CORBA::TypeCode_ptr tc, CORBA::Boolean equiv_only, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // test equality for typecodes of strings + /// test equality for typecodes of wide strings CORBA::Boolean private_equal_wstring (CORBA::TypeCode_ptr tc, CORBA::Boolean equiv_only, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // test equality for typecodes of wide strings + /// test equality for typecodes of sequences CORBA::Boolean private_equal_sequence (CORBA::TypeCode_ptr tc, CORBA::Boolean equiv_only, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // test equality for typecodes of sequences + /// test equality for typecodes of array CORBA::Boolean private_equal_array (CORBA::TypeCode_ptr tc, CORBA::Boolean equiv_only, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // test equality for typecodes of array + /// test equality for typecodes of typedefs CORBA::Boolean private_equal_alias (CORBA::TypeCode_ptr tc, CORBA::Boolean equiv_only, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // test equality for typecodes of typedefs + /// test equality for typecodes of exceptions CORBA::Boolean private_equal_except (CORBA::TypeCode_ptr tc, CORBA::Boolean equiv_only, CORBA_Environment &ACE_TRY_ENV = TAO_default_environment ()) const; - // test equality for typecodes of exceptions + /// if refcount reaches 0, free this typecode CORBA::ULong refcount_; - // if refcount reaches 0, free this typecode + /// Protect the reference count, this is OK because we do no + /// duplicates or releases on the critical path. ACE_SYNCH_MUTEX refcount_lock_; - // Protect the reference count, this is OK because we do no - // duplicates or releases on the critical path. + /// TAO's approach differs from the SunSoft IIOP. Constant typecodes + /// are owned by the ORB and get freed only when the ORB dies. CORBA::Boolean orb_owns_; - // TAO's approach differs from the SunSoft IIOP. Constant typecodes - // are owned by the ORB and get freed only when the ORB dies. // If "orb_owns" is false, the value is a not a constant typecode // with both the typecode and the buffer allocated (typically, this // will be created by the IDL compiler generated code) + /** + * maintains precomputed state. We need a separate class that + * maintains the precomputed state since most of the TypeCode class + * operations keep the state of the object constant. However, for + * the purpose of precomputation, we need to update the state. We + * cannot update state directly in the TypeCode class as that + * defeats the constness. However, we can keep an object in our + * typecode class that remains constant, but we can update its + * state. + */ TC_Private_State *private_state_; - // maintains precomputed state. We need a separate class that - // maintains the precomputed state since most of the TypeCode class - // operations keep the state of the object constant. However, for - // the purpose of precomputation, we need to update the state. We - // cannot update state directly in the TypeCode class as that - // defeats the constness. However, we can keep an object in our - // typecode class that remains constant, but we can update its - // state. // = No copy constructor or assignment operator supported; @@ -456,30 +464,34 @@ private: CORBA_TypeCode (const CORBA::TypeCode &src); CORBA_TypeCode &operator = (const CORBA::TypeCode &src); + /** + * Original buffer that may possibly be non-aligned. We still need a + * handle to the allocated memory so that all of it can be freed by + * the destructor. + */ char *non_aligned_buffer_; - // Original buffer that may possibly be non-aligned. We still need a - // handle to the allocated memory so that all of it can be freed by - // the destructor. }; +/** + * @class TC_Private_State + * + * @brief Private state of the TypeCode. + * + * Used to store precomputed values + */ class TAO_Export TC_Private_State - // = TITLE - // Private state of the TypeCode. - // - // = DESCRIPTION - // Used to store precomputed values { public: + /// constructor TC_Private_State (CORBA::TCKind kind); - // constructor + /// destructor ~TC_Private_State (void); - // destructor ACE_SYNCH_MUTEX mutex_; + /// our kind that will determine what kind of children we may have CORBA::TCKind tc_kind_; - // our kind that will determine what kind of children we may have // = data members that indicate if the desired quantify // was precomputed or not. @@ -508,15 +520,15 @@ public: CORBA::TypeCode_ptr tc_content_type_; }; +/** + * @class CORBA_TypeCode_var + * + * @brief A smart pointer for TypeCodes. + * + * Implements the _var class for the TypeCode pseudo object. + */ class TAO_Export CORBA_TypeCode_var { - // - // = TITLE - // A smart pointer for TypeCodes. - // - // = DESCRIPTION - // Implements the _var class for the TypeCode pseudo object. - // public: CORBA_TypeCode_var (void); // default constructor CORBA_TypeCode_var (CORBA_TypeCode_ptr); @@ -527,9 +539,9 @@ public: CORBA_TypeCode_var &operator= (const CORBA_TypeCode_var &); CORBA_TypeCode_ptr operator-> (void) const; + /// in, inout, out, _retn operator const CORBA_TypeCode_ptr &() const; operator CORBA_TypeCode_ptr &(); - // in, inout, out, _retn CORBA_TypeCode_ptr in (void) const; CORBA_TypeCode_ptr &inout (void); CORBA_TypeCode_ptr &out (void); @@ -540,15 +552,15 @@ private: CORBA_TypeCode_ptr ptr_; }; +/** + * @class CORBA_TypeCode_out + * + * @brief The _out class for TypeCode. + * + * Implements the _out class for the TypeCode pseudo object. + */ class TAO_Export CORBA_TypeCode_out { - // - // = TITLE - // The _out class for TypeCode. - // - // = DESCRIPTION - // Implements the _out class for the TypeCode pseudo object. - // public: CORBA_TypeCode_out (CORBA_TypeCode_ptr &); CORBA_TypeCode_out (CORBA_TypeCode_var &); @@ -562,29 +574,32 @@ public: private: CORBA_TypeCode_ptr &ptr_; + /// Assignment from _var not allowed CORBA_TypeCode_out &operator= (const CORBA_TypeCode_var &); - // Assignment from _var not allowed }; +/** + * @class TAO_TypeCodes + * + * @brief This class is a namespace for TypeCode-related static data that + * is owned by the ORB. + */ class TAO_Export TAO_TypeCodes { - // = TITLE - // This class is a namespace for TypeCode-related static data that - // is owned by the ORB. public: + /// Runtime initialization of all standard typecodes. + /// Called from <CORBA::ORB_init>. static void init (void); - // Runtime initialization of all standard typecodes. - // Called from <CORBA::ORB_init>. + /// Runtime finalization of all standard typecodes. static void fini (void); - // Runtime finalization of all standard typecodes. private: + /// Flag that denotes that the TAO TypeCode constants have been + /// initialized. static int initialized_; - // Flag that denotes that the TAO TypeCode constants have been - // initialized. }; diff --git a/TAO/tao/ValueBase.h b/TAO/tao/ValueBase.h index f4b8fd11207..05bc6fe1e7b 100644 --- a/TAO/tao/ValueBase.h +++ b/TAO/tao/ValueBase.h @@ -1,18 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// ValueBase.h -// -// = AUTHOR -// Torsten Kuepper <kuepper2@lfa.uni-wuppertal.de> -// -// ============================================================================ + +//============================================================================= +/** + * @file ValueBase.h + * + * $Id$ + * + * @author Torsten Kuepper <kuepper2@lfa.uni-wuppertal.de> + */ +//============================================================================= + #ifndef TAO_VALUEBASE_H #define TAO_VALUEBASE_H @@ -29,58 +26,61 @@ #ifdef TAO_HAS_VALUETYPE +/** + * @class CORBA_ValueBase + * + * @brief Abstract baseclass for Valuetypes + * (see CORBA 2.3 20.17.5) + */ class TAO_Export CORBA_ValueBase { - // = TITLE - // Abstract baseclass for Valuetypes - // (see CORBA 2.3 20.17.5) public: // reference counting + /// %! virtual CORBA::ValueBase* _copy_value (void) = 0; virtual void _add_ref (void) = 0; virtual void _remove_ref (void) = 0; - // %! virtual CORBA::ValueBase* _copy_value (void) = 0; virtual CORBA::ULong _refcount_value (void) = 0; // dynamic casting static CORBA::ValueBase* _downcast (CORBA::ValueBase*); + /// TAO extension virtual const char* _tao_obv_repository_id () const = 0; - // TAO extension // TAO internal -------------------------- + /// Marshal a valuetype (see operator<< in tao_idl generated file + /// how it is called) static CORBA::Boolean _tao_marshal (TAO_OutputCDR &strm, CORBA_ValueBase *_this, ptr_arith_t formal_type_id = 0); - // Marshal a valuetype (see operator<< in tao_idl generated file - // how it is called) + /// Unmarshal a valuetype, if formal type is a pointer to ValueBase static CORBA::Boolean _tao_unmarshal (TAO_InputCDR &strm, CORBA_ValueBase *&_this); - // Unmarshal a valuetype, if formal type is a pointer to ValueBase // static CORBA::Boolean // T::_tao_unmarshal (TAO_InputCDR &, CORBA_ValueBase *&_this) // is typespecific for valuetype T and generated from tao_idl // Use this for unmarshaling. + /// Both used internally and are called from T::_tao_unmarshal () static CORBA::Boolean _tao_unmarshal_pre (TAO_InputCDR &strm, CORBA_ValueFactory_ptr &, CORBA_ValueBase *&, const char * const repo_id); CORBA::Boolean _tao_unmarshal_post (TAO_InputCDR &strm); - // Both used internally and are called from T::_tao_unmarshal () public: // otherwise these cannot be called from a static function virtual void *_tao_obv_narrow (ptr_arith_t) = 0; + /// during marshal jump to the most derived part virtual CORBA::Boolean _tao_marshal_v (TAO_OutputCDR &) = 0; - // during marshal jump to the most derived part + /// called after obtaining the fresh object from create_for_unmarshal () virtual CORBA::Boolean _tao_unmarshal_v (TAO_InputCDR &) = 0; - // called after obtaining the fresh object from create_for_unmarshal () protected: CORBA_ValueBase (void); @@ -94,21 +94,24 @@ private: +/** + * @class CORBA_DefaultValueRefCountBase + * + * @brief Default mix-in for reference count of a valuetype. + */ class TAO_Export CORBA_DefaultValueRefCountBase : public virtual CORBA_ValueBase { - // = TITLE - // Default mix-in for reference count of a valuetype. public: virtual void _add_ref (void); virtual void _remove_ref (void); virtual CORBA::ULong _refcount_value (void); + /// The _tao variants are inline for fast access from T_var + /// (if valuetype T is compiled with optimization for that.) %! (todo) void _tao_add_ref (void); void _tao_remove_ref (void); CORBA::ULong _tao_refcount_value (void); - // The _tao variants are inline for fast access from T_var - // (if valuetype T is compiled with optimization for that.) %! (todo) protected: CORBA_DefaultValueRefCountBase (void); @@ -128,9 +131,12 @@ private: // data // $! todo: debug aids for refcounts +/** + * @class TAO_OBV_GIOP_Flags + CORBA 2.3: 15.3.4 + */ class TAO_OBV_GIOP_Flags { - // CORBA 2.3: 15.3.4 public: static const CORBA::ULong Value_tag_base; static const CORBA::ULong Value_tag_sigbits; diff --git a/TAO/tao/ValueFactory.h b/TAO/tao/ValueFactory.h index 3d13ef36ab0..f7218edacab 100644 --- a/TAO/tao/ValueFactory.h +++ b/TAO/tao/ValueFactory.h @@ -1,18 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// ValueFactory.h -// -// = AUTHOR -// Torsten Kuepper <kuepper2@lfa.uni-wuppertal.de> -// -// ============================================================================ +//============================================================================= +/** + * @file ValueFactory.h + * + * $Id$ + * + * @author Torsten Kuepper <kuepper2@lfa.uni-wuppertal.de> + */ +//============================================================================= + #ifndef TAO_VALUEFACTORY_H #define TAO_VALUEFACTORY_H @@ -46,9 +43,9 @@ public: void _remove_ref (void); // private: %! + /// In a derived class T use return type TAO_OBV_CREATE_RETURN_TYPE (T) + /// (see at definition below) virtual CORBA_ValueBase* create_for_unmarshal (void) = 0; - // In a derived class T use return type TAO_OBV_CREATE_RETURN_TYPE (T) - // (see at definition below) private: CORBA::ULong _tao_reference_count_; diff --git a/TAO/tao/ValueFactory_Map.h b/TAO/tao/ValueFactory_Map.h index 903d9b6a3f6..1d31f872f4e 100644 --- a/TAO/tao/ValueFactory_Map.h +++ b/TAO/tao/ValueFactory_Map.h @@ -1,18 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// ValueFactory_Map.h -// -// = AUTHOR -// Torsten Kuepper <kuepper2@lfa.uni-wuppertal.de> -// -// ============================================================================ + +//============================================================================= +/** + * @file ValueFactory_Map.h + * + * $Id$ + * + * @author Torsten Kuepper <kuepper2@lfa.uni-wuppertal.de> + */ +//============================================================================= + #ifndef TAO_VALUEFACTORY_MAP_H #define TAO_VALUEFACTORY_MAP_H @@ -37,26 +34,31 @@ public: ~TAO_ValueFactory_Map (); + /** + * Associate the factory (int_id) with the repo_id (ext_id). + * Invokes _add_ref () on the factory. + * If previous factory had been bind with this repo_id, this one is + * returned in factory (and the caller holds a reference). + * Returns -1 on failure, 0 on success and 1 if a previous factory + * is found (and returned in factory). + */ int rebind (const char *repo_id, CORBA_ValueFactory_ptr &factory); - // Associate the factory (int_id) with the repo_id (ext_id). - // Invokes _add_ref () on the factory. - // If previous factory had been bind with this repo_id, this one is - // returned in factory (and the caller holds a reference). - // Returns -1 on failure, 0 on success and 1 if a previous factory - // is found (and returned in factory). + /// Removes entry for repo_id from the map and sets factory to + /// the tied one. int unbind (const char *repo_id, CORBA_ValueFactory_ptr &factory); - // Removes entry for repo_id from the map and sets factory to - // the tied one. + /** + * Lookup a matching factory for repo_id. + * Invokes _add_ref () on the factory if found. + * Returns -1 on failure and 0 on success. + */ int find (const char *repo_id, CORBA_ValueFactory_ptr &factory); - // Lookup a matching factory for repo_id. - // Invokes _add_ref () on the factory if found. - // Returns -1 on failure and 0 on success. void dump (void); private: + /// The hash table data structure. typedef ACE_Hash_Map_Manager_Ex<const char *, CORBA_ValueFactory_ptr, ACE_Hash<const char *>, @@ -64,7 +66,6 @@ private: ACE_SYNCH_RW_MUTEX> FACTORY_MAP_MANAGER; FACTORY_MAP_MANAGER map_; - // The hash table data structure. }; /* TAO_ValueFactory_Map */ diff --git a/TAO/tao/Wait_On_Leader_Follower.h b/TAO/tao/Wait_On_Leader_Follower.h index 78bb6e89580..553723d9115 100644 --- a/TAO/tao/Wait_On_Leader_Follower.h +++ b/TAO/tao/Wait_On_Leader_Follower.h @@ -1,15 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = AUTHOR -// Alexander Babu Arulanthu <alex@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Wait_On_Leader_Follower.h + * + * $Id$ + * + * @author Alexander Babu Arulanthu <alex@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_WAIT_ON_LEADER_FOLLOWER_H #define TAO_WAIT_ON_LEADER_FOLLOWER_H @@ -21,29 +21,29 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class TAO_Wait_On_Leader_Follower + * + * @brief Wait according to the Leader-Follower model. Leader does the + * event loop of the Reactor and the Followers wait on the + * condition variable. + * + * This impelementation is to work with the Muxed Transport + * Mechanism. Here the state variables such as <Condition + * Variable> etc cannot be kept in the Wait Strategy, since the + * Wait Strategy is per Transport object and here the Transport + * is Muxed and hence there are multiple threads running in the + * same Transport context. + */ class TAO_Export TAO_Wait_On_Leader_Follower : public TAO_Wait_Strategy { - // = TITLE - // - // Wait according to the Leader-Follower model. Leader does the - // event loop of the Reactor and the Followers wait on the - // condition variable. - // - // = DESCRIPTION - // - // This impelementation is to work with the Muxed Transport - // Mechanism. Here the state variables such as <Condition - // Variable> etc cannot be kept in the Wait Strategy, since the - // Wait Strategy is per Transport object and here the Transport - // is Muxed and hence there are multiple threads running in the - // same Transport context. public: + /// Constructor. TAO_Wait_On_Leader_Follower (TAO_Transport *transport); - // Constructor. + /// Destructor. virtual ~TAO_Wait_On_Leader_Follower (void); - // Destructor. // = Documented in TAO_Wait_Strategy. virtual int sending_request (TAO_ORB_Core *orb_core, diff --git a/TAO/tao/Wait_On_Reactor.h b/TAO/tao/Wait_On_Reactor.h index ac7349f5f97..e51cfe250c6 100644 --- a/TAO/tao/Wait_On_Reactor.h +++ b/TAO/tao/Wait_On_Reactor.h @@ -1,15 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = AUTHOR -// Alexander Babu Arulanthu <alex@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Wait_On_Reactor.h + * + * $Id$ + * + * @author Alexander Babu Arulanthu <alex@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_WAIT_ON_REACTOR_H #define TAO_WAIT_ON_REACTOR_H @@ -21,22 +21,22 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class TAO_Wait_On_Reactor + * + * @brief Wait on the Reactor. Happens in s Single Threaded client + * environment. + * + */ class TAO_Export TAO_Wait_On_Reactor : public TAO_Wait_Strategy { - // = TITLE - // - // Wait on the Reactor. Happens in s Single Threaded client - // environment. - // - // = DESCRIPTION - // public: + /// Constructor. TAO_Wait_On_Reactor (TAO_Transport *transport); - // Constructor. + /// Destructor. virtual ~TAO_Wait_On_Reactor (void); - // Destructor. // = Documented in TAO_Wait_Strategy. diff --git a/TAO/tao/Wait_On_Read.h b/TAO/tao/Wait_On_Read.h index 53cc2bd0e5e..8f8268dba67 100644 --- a/TAO/tao/Wait_On_Read.h +++ b/TAO/tao/Wait_On_Read.h @@ -1,15 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = AUTHOR -// Alexander Babu Arulanthu <alex@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Wait_On_Read.h + * + * $Id$ + * + * @author Alexander Babu Arulanthu <alex@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_WAIT_ON_READ_H #define TAO_WAIT_ON_READ_H @@ -21,20 +21,21 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class TAO_Wait_On_Read + * + * + * Simply block on read() to wait for the reply. + */ class TAO_Export TAO_Wait_On_Read : public TAO_Wait_Strategy { - // = TITLE - // - // = DESCRIPTION - // Simply block on read() to wait for the reply. - // public: + /// Constructor. TAO_Wait_On_Read (TAO_Transport *transport); - // Constructor. + /// Destructor. virtual ~TAO_Wait_On_Read (void); - // Destructor. // = Documented in TAO_Wait_Strategy. diff --git a/TAO/tao/Wait_Strategy.h b/TAO/tao/Wait_Strategy.h index 4827d0b8893..ef52ee4f5e5 100644 --- a/TAO/tao/Wait_Strategy.h +++ b/TAO/tao/Wait_Strategy.h @@ -1,15 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = AUTHOR -// Alexander Babu Arulanthu <alex@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Wait_Strategy.h + * + * $Id$ + * + * @author Alexander Babu Arulanthu <alex@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_WAIT_STRATEGY_H #define TAO_WAIT_STRATEGY_H @@ -24,65 +24,73 @@ class TAO_ORB_Core; class TAO_Transport; +/** + * @class TAO_Wait_Strategy + * + * @brief Strategy for waiting for the reply. + * + */ class TAO_Export TAO_Wait_Strategy { - // = TITLE - // - // Strategy for waiting for the reply. - // - // = DESCRIPTION - // public: + /// Constructor. TAO_Wait_Strategy (TAO_Transport *transport); - // Constructor. + /// Destructor. virtual ~TAO_Wait_Strategy (void); - // Destructor. + /** + * The user is going to send a request, prepare any internal + * variables because the reply may arrive *before* the user calls + * wait. + */ virtual int sending_request (TAO_ORB_Core *orb_core, int two_way); - // The user is going to send a request, prepare any internal - // variables because the reply may arrive *before* the user calls - // wait. + /// Base class virtual method. Wait till the <reply_received> flag is + /// true or the time expires. virtual int wait (ACE_Time_Value *max_wait_time, int &reply_received) = 0; - // Base class virtual method. Wait till the <reply_received> flag is - // true or the time expires. + /// Register the handler needs with the reactor provided that it makes + /// sense for the strategy. virtual int register_handler (void) = 0; - // Register the handler needs with the reactor provided that it makes - // sense for the strategy. + /** + * Return the TSS leader follower condition variable used in the + * Wait Strategy. Muxed Leader Follower implementation returns a + * valid condition variable, others return 0. + * The condition variable is acquired by the Reply_Dispatcher (when + * needed) in the thread that binds it to the right Transport. + * Later (when the reply is finally received) the Reply_Dispatcher + * passes this condition variable back to Waiting_Strategy, that can + * then signal the waiting thread if needed. + */ virtual ACE_SYNCH_CONDITION *leader_follower_condition_variable (void); - // Return the TSS leader follower condition variable used in the - // Wait Strategy. Muxed Leader Follower implementation returns a - // valid condition variable, others return 0. - // The condition variable is acquired by the Reply_Dispatcher (when - // needed) in the thread that binds it to the right Transport. - // Later (when the reply is finally received) the Reply_Dispatcher - // passes this condition variable back to Waiting_Strategy, that can - // then signal the waiting thread if needed. + /** + * This is the callback used by the Reply_Dispatcher to inform the + * Waiting_Strategy that a reply has been completely received, that + * it was already stored in the right place, and that the condition + * variable should be signalled if needed. + * The Waiting_Strategy must set the reply received flag, using + * whatever locks it needs. + */ virtual int reply_dispatched (int &reply_received_flag, ACE_SYNCH_CONDITION *); - // This is the callback used by the Reply_Dispatcher to inform the - // Waiting_Strategy that a reply has been completely received, that - // it was already stored in the right place, and that the condition - // variable should be signalled if needed. - // The Waiting_Strategy must set the reply received flag, using - // whatever locks it needs. + /** + * The connection has been closed by the lower level components in + * the ORB. + * The wait has finished and must result in an error. + */ virtual void connection_closed (int &reply_received_flag, ACE_SYNCH_CONDITION*); - // The connection has been closed by the lower level components in - // the ORB. - // The wait has finished and must result in an error. protected: + /// Transport object. TAO_Transport *transport_; - // Transport object. }; #include "ace/post.h" diff --git a/TAO/tao/WrongTransactionC.h b/TAO/tao/WrongTransactionC.h index b0f30a8a826..ef6687a60ab 100644 --- a/TAO/tao/WrongTransactionC.h +++ b/TAO/tao/WrongTransactionC.h @@ -1,22 +1,21 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// WrongTransactionC.h -// -// = AUTHOR -// -// ****** Code generated by the The ACE ORB (TAO) IDL Compiler ******* -// TAO and the TAO IDL Compiler have been developed by the Center for -// Distributed Object Computing at Washington University, St. Louis. -// -// Information about TAO is available at: -// http://www.cs.wustl.edu/~schmidt/TAO.html + +//============================================================================= +/** + * @file WrongTransactionC.h + * + * $Id$ + * + * ****** Code generated by the The ACE ORB (TAO) IDL Compiler ******* + * TAO and the TAO IDL Compiler have been developed by the Center for + * Distributed Object Computing at Washington University, St. Louis. + * + * Information about TAO is available at: + * http://www.cs.wustl.edu/~schmidt/TAO.html + * + */ +//============================================================================= + #ifndef TAO_IDL_WRONG_TRANSACTIONC_H #define TAO_IDL_WRONG_TRANSACTIONC_H @@ -45,15 +44,17 @@ #pragma warning(disable:4250) #endif /* _MSC_VER */ +/** + * @class CORBA_WrongTransaction + * + * @brief Exception class generated by the TAO IDL compiler. + * + * This exception is thrown if a CORBA Request is implicitly + * associated with a transaction and is found to have an + * error in its parameters when checked at runtime (invocation). + */ class TAO_Export CORBA_WrongTransaction : public CORBA::UserException { -// = TITLE -// Exception class generated by the TAO IDL compiler. -// -// = DESCRIPTION -// This exception is thrown if a CORBA Request is implicitly -// associated with a transaction and is found to have an -// error in its parameters when checked at runtime (invocation). public: CORBA_WrongTransaction (void); // default ctor diff --git a/TAO/tao/corba.h b/TAO/tao/corba.h index 6d30324f5df..74834ab39fc 100644 --- a/TAO/tao/corba.h +++ b/TAO/tao/corba.h @@ -1,26 +1,24 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// corba.h -// -// = DESCRIPTION -// Master Header file for the TAO CORBA ORB. Include only this -// file, to see all public ORB interfaces declared by TAO. -// -// This follows the OMG C++ mapping for compilers that don't -// support C++ exceptions or namespaces. -// -// = AUTHOR -// Copyright 1994-1995 by Sun Microsystems Inc., Chris Cleeland, -// and Douglas C. Schmidt. -// -// ============================================================================ + +//============================================================================= +/** + * @file corba.h + * + * $Id$ + * + * Master Header file for the TAO CORBA ORB. Include only this + * file, to see all public ORB interfaces declared by TAO. + * + * This follows the OMG C++ mapping for compilers that don't + * support C++ exceptions or namespaces. + * + * + * @author Copyright 1994-1995 by Sun Microsystems Inc. + * @author Chris Cleeland + * @author and Douglas C. Schmidt. + */ +//============================================================================= + #ifndef TAO_MASTER_CORBA_H #define TAO_MASTER_CORBA_H @@ -85,7 +83,7 @@ #include "tao/StringSeqC.h" #include "tao/OctetSeqC.h" -#include "tao/PortableInterceptor.h" // This needs to remain visible. +#include "tao/PortableInterceptor.h" /* This needs to remain visible. */ #include "tao/ClientRequestInfo.h" diff --git a/TAO/tao/corbafwd.h b/TAO/tao/corbafwd.h index 7e53349dc1f..291542508bf 100644 --- a/TAO/tao/corbafwd.h +++ b/TAO/tao/corbafwd.h @@ -1,28 +1,25 @@ // -*- C++ -*- -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// corbafwd.h -// -// = DESCRIPTION -// Forward declare the basic types used in the ORB -// implementation. Regular users of the ORB should only include -// tao/corba.h, but the implementation of the ORB itself should -// include this file. That reduces interdependency and speed up -// compilations and recompilations. -// -// = AUTHOR -// Carlos O'Ryan -// Chris Cleeland -// Douglas C. Schmidt -// based on work Copyright 1994-1995 by Sun Microsystems Inc. -// -// ============================================================================ +//============================================================================= +/** + * @file corbafwd.h + * + * $Id$ + * + * Forward declare the basic types used in the ORB + * implementation. Regular users of the ORB should only include + * tao/corba.h, but the implementation of the ORB itself should + * include this file. That reduces interdependency and speed up + * compilations and recompilations. + * + * + * @author Carlos O'Ryan + * @author Chris Cleeland + * @author Douglas C. Schmidt + * @author Copyright 1994-1995 by Sun Microsystems Inc. + */ +//============================================================================= + #ifndef TAO_CORBAFWD_H #define TAO_CORBAFWD_H @@ -46,8 +43,8 @@ // needs to apply throughout an ORB. #if defined (_MSC_VER) || defined (__BORLANDC__) -# ifdef _DEBUG // convert from VC++ convention ... -# define TAO_DEBUG // ... to normal convention +# ifdef _DEBUG /* convert from VC++ convention ... */ +# define TAO_DEBUG /* ... to normal convention */ # endif #endif /* _MSC_VER || __BORLANDC__ */ @@ -288,9 +285,12 @@ class CORBA_DIIPollable_var; class CORBA_DIIPollable_out; typedef CORBA_DIIPollable *CORBA_DIIPollable_ptr; +/** + * @class TAO_OutputCDR; + @@ TODO This should be TAO_TAO_Stub + */ class TAO_InputCDR; class TAO_OutputCDR; -// @@ TODO This should be TAO_TAO_Stub class TAO_Stub; class CORBA_ORB_ObjectIdList; diff --git a/TAO/tao/debug.h b/TAO/tao/debug.h index 472dfa2d5f9..c943ed92ea0 100644 --- a/TAO/tao/debug.h +++ b/TAO/tao/debug.h @@ -1,22 +1,19 @@ -// $Id$ // This may look like C, but it's really -*- C++ -*- -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// debug.h -// -// = DESCRIPTION -// debug/trace support. -// -// = AUTHOR -// Copyright 1994-1995 by Sun Microsystems Inc. -// -// ============================================================================ +//============================================================================= +/** + * @file debug.h + * + * $Id$ + * + * debug/trace support. + * + * + * @author Copyright 1994-1995 by Sun Microsystems Inc. + */ +//============================================================================= + #ifndef TAO_DEBUG_H #define TAO_DEBUG_H diff --git a/TAO/tao/default_client.h b/TAO/tao/default_client.h index ea664af440b..4cadec5cd4a 100644 --- a/TAO/tao/default_client.h +++ b/TAO/tao/default_client.h @@ -1,18 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// default_client.h -// -// = AUTHOR -// Chris Cleeland -// -// ============================================================================ + +//============================================================================= +/** + * @file default_client.h + * + * $Id$ + * + * @author Chris Cleeland + */ +//============================================================================= + #ifndef TAO_DEFAULT_CLIENT_H #define TAO_DEFAULT_CLIENT_H @@ -26,27 +23,30 @@ #include "ace/Service_Config.h" +/** + * @class TAO_Default_Client_Strategy_Factory + * + * @brief This is the "default" client strategy factor for TAO. It + * includes strategies that are configured through command-line + * options so that everything operates as if there were no + * dynamically-linkable strategies. + */ class TAO_Export TAO_Default_Client_Strategy_Factory : public TAO_Client_Strategy_Factory { - // = TITLE - // This is the "default" client strategy factor for TAO. It - // includes strategies that are configured through command-line - // options so that everything operates as if there were no - // dynamically-linkable strategies. public: // = Initialization and termination methods. + /// Constructor. TAO_Default_Client_Strategy_Factory (void); - // Constructor. + /// Destructor. virtual ~TAO_Default_Client_Strategy_Factory (void); - // Destructor. // = Service Configurator hooks. + /// Dynamic linking hook virtual int init (int argc, char* argv[]); - // Dynamic linking hook + /// Parse svc.conf arguments int parse_args (int argc, char* argv[]); - // Parse svc.conf arguments // = Check Client_Strategy_Factory.h for the documentation of the // following methods. @@ -62,8 +62,8 @@ private: TAO_THREAD_LOCK }; + /// the lock type for forwarding IIOP Profile Lock_Type profile_lock_type_; - // the lock type for forwarding IIOP Profile enum Transport_Mux_Strategy { @@ -71,8 +71,8 @@ private: TAO_EXCLUSIVE_TMS }; + /// The client Request Mux Strategy. Transport_Mux_Strategy transport_mux_strategy_; - // The client Request Mux Strategy. enum Wait_Strategy { @@ -81,8 +81,8 @@ private: TAO_WAIT_ON_READ }; + /// The wait-for-reply strategy. Wait_Strategy wait_strategy_; - // The wait-for-reply strategy. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/default_resource.h b/TAO/tao/default_resource.h index e7e65387d66..0886ca7affc 100644 --- a/TAO/tao/default_resource.h +++ b/TAO/tao/default_resource.h @@ -1,19 +1,15 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// default_resource.h -// -// = AUTHOR -// Chris Cleeland -// Carlos O'Ryan -// -// ============================================================================ + +//============================================================================= +/** + * @file default_resource.h + * + * $Id$ + * + * @author Chris CleelandCarlos O'Ryan + */ +//============================================================================= + #ifndef TAO_DEFAULT_RESOURCE_H #define TAO_DEFAULT_RESOURCE_H @@ -30,35 +26,36 @@ class TAO_Object_Adapter; class TAO_IOR_Parser; +/** + * @class TAO_Default_Resource_Factory + * + * @brief TAO's default resource factory + * + * Using a <{resource source specifier}> as a discriminator, the + * factory can return resource instances which are, e.g., global, + * stored in thread-specific storage, stored in shared memory, + * etc. + */ class TAO_Export TAO_Default_Resource_Factory : public TAO_Resource_Factory { - // = TITLE - // TAO's default resource factory - // - // = DESCRIPTION - // Using a <{resource source specifier}> as a discriminator, the - // factory can return resource instances which are, e.g., global, - // stored in thread-specific storage, stored in shared memory, - // etc. - // public: // = Initialization and termination methods. + /// Constructor. TAO_Default_Resource_Factory (void); - // Constructor. + /// Destructor. virtual ~TAO_Default_Resource_Factory (void); - // Destructor. // = Service Configurator hooks. + /// Dynamic linking hook virtual int init (int argc, char* argv[]); - // Dynamic linking hook + /// Parse svc.conf arguments int parse_args (int argc, char* argv[]); - // Parse svc.conf arguments + /// = Member Accessors int get_parser_names (char **&names, int &number_of_names); - // = Member Accessors enum { TAO_ALLOCATOR_THREAD_LOCK @@ -77,8 +74,8 @@ public: TAO_REACTOR_PER_PRIORITY }; + /// Modify and get the source for the CDR allocators int cdr_allocator_source (void); - // Modify and get the source for the CDR allocators // = Resource Retrieval virtual int use_tss_resources (void) const; @@ -93,69 +90,71 @@ public: virtual ACE_Allocator* output_cdr_dblock_allocator (void); virtual ACE_Allocator* output_cdr_buffer_allocator (void); virtual TAO_ProtocolFactorySet *get_protocol_factories (void); - + virtual int init_protocol_factories (void); - + virtual TAO_Resource_Factory::Caching_Strategy connection_caching_strategy_type (void) const; virtual double purge_percentage (void) const; virtual TAO_Priority_Mapping *get_priority_mapping (void); virtual ACE_Lock *create_cached_connection_lock (void); protected: + /// Obtain the reactor implementation virtual ACE_Reactor_Impl *allocate_reactor_impl (void) const; - // Obtain the reactor implementation + /// Add a Parser name to the list of Parser names. int add_to_ior_parser_names (const char *); - // Add a Parser name to the list of Parser names. protected: + /// Flag indicating whether resources should be global or + /// thread-specific. int use_tss_resources_; - // Flag indicating whether resources should be global or - // thread-specific. + /// The type of data blocks that the ORB should use int use_locked_data_blocks_; - // The type of data blocks that the ORB should use + /// The number of the different types of Parsers. int parser_names_count_; - // The number of the different types of Parsers. + /// Array consisting of the names of the parsers char **parser_names_; - // Array consisting of the names of the parsers + /// Index of the current element in the parser_names_ array int index_; - // Index of the current element in the parser_names_ array + /// list of loaded protocol factories. TAO_ProtocolFactorySet protocol_factories_; - // list of loaded protocol factories. + /// Specifies the typeof caching strategy we should use for + /// connection management. TAO_Resource_Factory::Caching_Strategy connection_caching_type_; - // Specifies the typeof caching strategy we should use for - // connection management. + /// Specifies the percentage of entries which should get purged on + /// demand. double purge_percentage_; - // Specifies the percentage of entries which should get purged on - // demand. + /// If <0> then we create reactors with signal handling disabled. int reactor_mask_signals_; - // If <0> then we create reactors with signal handling disabled. + /// The scheduling policy used to initialize the priority mapping + /// strategy. int sched_policy_; - // The scheduling policy used to initialize the priority mapping - // strategy. + /// The type of priority mapping class created by this factory. int priority_mapping_type_; - // The type of priority mapping class created by this factory. + /** + * Flag that is set to 1 if the reactor obtained from the + * get_reactor() method is dynamically allocated. If this flag is + * set to 1, then the reclaim_reactor() method with call the delete + * operator on the given reactor. This flag is necessary to make + * sure that a reactor not allocated by the default resource factory + * is not reclaimed by the default resource factory. Such a + * situation can occur when a resource factory derived from the + * default one overrides the get_reactor() method but does not + * override the reclaim_reactor() method. + */ int dynamically_allocated_reactor_; - // Flag that is set to 1 if the reactor obtained from the - // get_reactor() method is dynamically allocated. If this flag is - // set to 1, then the reclaim_reactor() method with call the delete - // operator on the given reactor. This flag is necessary to make - // sure that a reactor not allocated by the default resource factory - // is not reclaimed by the default resource factory. Such a - // situation can occur when a resource factory derived from the - // default one overrides the get_reactor() method but does not - // override the reclaim_reactor() method. virtual int load_default_protocols (void); @@ -166,8 +165,8 @@ private: TAO_THREAD_LOCK }; + /// Type of lock used by the cached connector. Lock_Type cached_connection_lock_type_; - // Type of lock used by the cached connector. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/default_server.h b/TAO/tao/default_server.h index ad8616f1d9a..0ad1637d996 100644 --- a/TAO/tao/default_server.h +++ b/TAO/tao/default_server.h @@ -1,18 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// default_server.h -// -// = AUTHOR -// Chris Cleeland -// -// ============================================================================ + +//============================================================================= +/** + * @file default_server.h + * + * $Id$ + * + * @author Chris Cleeland + */ +//============================================================================= + #ifndef TAO_DEFAULT_SERVER_FACTORY_H #define TAO_DEFAULT_SERVER_FACTORY_H @@ -26,14 +23,16 @@ #include "ace/Service_Config.h" +/** + * @class TAO_Default_Server_Strategy_Factory + * + * @brief This is the default strategy factory for CORBA servers. It + * allows developers to choose strategies via argument flags. + * This design gives substantial freedom for experimentation. + * + */ class TAO_Export TAO_Default_Server_Strategy_Factory : public TAO_Server_Strategy_Factory { - // = TITLE - // This is the default strategy factory for CORBA servers. It - // allows developers to choose strategies via argument flags. - // This design gives substantial freedom for experimentation. - // - // = DESCRIPTION public: @@ -53,25 +52,27 @@ public: virtual int server_connection_thread_flags (void); virtual int server_connection_thread_count (void); + /** + * If the ORB is single threaded or some form of ORB-per-thread then + * it is more efficient to use a Null_Mutex for the variables + * controlling the event loop (termination). Otherwise a + * Recursive_Thread_Mutex or Thread_Mutex may be required. + */ virtual ACE_Lock *create_event_loop_lock (void); - // If the ORB is single threaded or some form of ORB-per-thread then - // it is more efficient to use a Null_Mutex for the variables - // controlling the event loop (termination). Otherwise a - // Recursive_Thread_Mutex or Thread_Mutex may be required. + /// Parse the arguments, check the documentation in + /// $TAO_ROOT/docs/Options.html for details int parse_args (int argc, char *argv[]); - // Parse the arguments, check the documentation in - // $TAO_ROOT/docs/Options.html for details protected: void tokenize (char *flag_string); protected: + /// Should the server connection handlers run in their own thread? int activate_server_connections_; - // Should the server connection handlers run in their own thread? + /// Default thread flags passed to thr_create(). u_long thread_flags_; - // Default thread flags passed to thr_create(). enum Lock_Type { @@ -79,15 +80,15 @@ protected: TAO_THREAD_LOCK }; + /// The type of lock to be returned by <create_poa_lock()>. Lock_Type poa_lock_type_; - // The type of lock to be returned by <create_poa_lock()>. + /// The type of lock to be returned by <create_event_loop_lock()>. Lock_Type event_loop_lock_type_; - // The type of lock to be returned by <create_event_loop_lock()>. + /// The timeout flag and value for the thread-per-connection model int thread_per_connection_use_timeout_; ACE_Time_Value thread_per_connection_timeout_; - // The timeout flag and value for the thread-per-connection model }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/ifrfwd.h b/TAO/tao/ifrfwd.h index e9c7d02cb5f..934a6db39cd 100644 --- a/TAO/tao/ifrfwd.h +++ b/TAO/tao/ifrfwd.h @@ -1,25 +1,22 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// ifrfwd.h -// -// = DESCRIPTION -// Forward declare the basic types used in the IR -// implementation. This file should be included in -// ORB file headers that use one or more IR namespace -// types. The corresponding source files will include -// InterfaceC.h. -// -// = AUTHOR -// Jeff Parsons -// -// ============================================================================ + +//============================================================================= +/** + * @file ifrfwd.h + * + * $Id$ + * + * Forward declare the basic types used in the IR + * implementation. This file should be included in + * ORB file headers that use one or more IR namespace + * types. The corresponding source files will include + * InterfaceC.h. + * + * + * @author Jeff Parsons + */ +//============================================================================= + #ifndef TAO_IFRFWD_H #define TAO_IFRFWD_H diff --git a/TAO/tao/operation_details.h b/TAO/tao/operation_details.h index b21e3facd54..5da4289ce99 100644 --- a/TAO/tao/operation_details.h +++ b/TAO/tao/operation_details.h @@ -1,108 +1,110 @@ -// This may look like C, but it's really -*- C++ -*- -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// operation_details.h -// -// = AUTHOR -// Bala Natarajan <bala@cs.wustl.edu> -// ============================================================================ - -#ifndef TAO_OPERATION_DETAILS_H -#define TAO_OPERATION_DETAILS_H +// This may look like C, but it's really -*- C++ -*- +//============================================================================= +/** + * @file operation_details.h + * + * $Id$ + * + * @author Bala Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + + +#ifndef TAO_OPERATION_DETAILS_H +#define TAO_OPERATION_DETAILS_H #include "ace/pre.h" #include "tao/corbafwd.h" #include "tao/IOPC.h" #include "tao/target_specification.h" -// @@ Bala: Why is this not part of the RequestHeader?! +// @@ Bala: Why is this not part of the RequestHeader?! +/** + * @class TAO_Operation_Details + * + * @brief Class with operation details + * + * This class stores some of the "operation" details that would be + * required by the invocation classes. this class is in its + * infancy now but I expect this one to grow as we come with + * different varieties of use cases. + */ class TAO_Export TAO_Operation_Details { - // = TITLE - // Class with operation details - // - // = DESCRIPTION - // This class stores some of the "operation" details that would be - // required by the invocation classes. this class is in its - // infancy now but I expect this one to grow as we come with - // different varieties of use cases. public: - TAO_Operation_Details (const char *name, - CORBA::ULong len, - CORBA::Boolean argument_flag); - //Ctor + ///Ctor + TAO_Operation_Details (const char *name, + CORBA::ULong len, + CORBA::Boolean argument_flag); - const char* opname (void) const; - // Operation name + /// Operation name + const char* opname (void) const; + /// Length of the operation name CORBA::ULong opname_len (void) const; - // Length of the operation name + /// Return the flag that indicates whether the operation has any + /// arguments CORBA::Boolean argument_flag (void) const; - // Return the flag that indicates whether the operation has any - // arguments + /// Set the response flags void response_flags (CORBA::Octet flags); - // Set the response flags + /// Get the response flags CORBA::Octet response_flags (void); CORBA::Octet response_flags (void) const; - // Get the response flags - IOP::ServiceContextList &service_info (void); - const IOP::ServiceContextList &service_info (void) const; - // Get the service context list + /// Get the service context list + IOP::ServiceContextList &service_info (void); + const IOP::ServiceContextList &service_info (void) const; - void request_id (CORBA::ULong id); + void request_id (CORBA::ULong id); + /// Get for request id CORBA::ULong request_id (void); CORBA::ULong request_id (void) const; - // Get for request id + /// Get method for the addressing mode TAO_Target_Specification::TAO_Target_Address addressing_mode (void); TAO_Target_Specification::TAO_Target_Address addressing_mode (void) const; - // Get method for the addressing mode + /// Set method for the addressing mode void - addressing_mode (CORBA::Short addr); - // Set method for the addressing mode + addressing_mode (CORBA::Short addr); private: - const char *opname_; - // Name of the operation being invoked. + /// Name of the operation being invoked. + const char *opname_; + /// Precalculated length of opname_. CORBA::ULong opname_len_; - // Precalculated length of opname_. + /// Request ID of this operation. CORBA::ULong request_id_; - // Request ID of this operation. + /** + * Flag that indicates whether the operation has any arguments. If + * there are any arguments the falg will have a value of 1, 0 + * otherwise. + */ CORBA::Boolean argument_flag_; - // Flag that indicates whether the operation has any arguments. If - // there are any arguments the falg will have a value of 1, 0 - // otherwise. + /// Response flags CORBA::Octet response_flags_; - // Response flags + /// The ServiceContextList sent to the server side. Only valid + /// when sending a request. IOP::ServiceContextList service_info_; - // The ServiceContextList sent to the server side. Only valid - // when sending a request. // The first element of header is service context list; - // transactional context would be acquired here using the - // transaction service APIs. Other kinds of context are as yet + // transactional context would be acquired here using the + // transaction service APIs. Other kinds of context are as yet // undefined. // + /// Addressing mode for this request. TAO_Target_Specification::TAO_Target_Address addressing_mode_; - // Addressing mode for this request. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/orbconf.h b/TAO/tao/orbconf.h index bc8824c5359..46a66794fd7 100644 --- a/TAO/tao/orbconf.h +++ b/TAO/tao/orbconf.h @@ -1,24 +1,21 @@ // This may look like C, but it's really -*- C++ -*- -// @ (#) $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// orbconf.h -// -// = DESCRIPTION -// Build configuration file for the Inter-ORB Engine, and application -// level code using it via <corba.hh> -// -// = AUTHOR -// Copyright 1995 by Sun Microsystems, Inc. -// -// TAO-specific changes by Chris Cleeland and Douglas C. Schmidt -// -// ============================================================================ +//============================================================================= +/** + * @file orbconf.h + * + * $Id$ + * + * Build configuration file for the Inter-ORB Engine, and application + * level code using it via <corba.hh> + * + * + * @author Copyright 1995 by Sun Microsystems, Inc. + * @author TAO-specific changes by Chris Cleeland + * @author and Douglas C. Schmidt + */ +//============================================================================= + #ifndef TAO_ORB_CONFIG_H #define TAO_ORB_CONFIG_H @@ -686,7 +683,7 @@ enum MCAST_SERVICEID // CLIENT_PRIORITY_POLICY has been deprecated! It is disabled by // default. It's functionality is replaced by RTCORBA policies, see -// TAO's RTCORBA documentation for more details. +// TAO's RTCORBA documentation for more details. // //To explicitly enable CLIENT_PRIORITY_POLICY support uncomment the //following #define TAO_HAS_CLIENT_PRIORITY_POLICY 1 diff --git a/TAO/tao/params.h b/TAO/tao/params.h index f1a390f11e9..f59bc0c0dc6 100644 --- a/TAO/tao/params.h +++ b/TAO/tao/params.h @@ -1,19 +1,16 @@ /* -*- C++ -*- */ -// $Id$ - - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// params.h -// -// = AUTHOR -// Chris Cleeland -// -// ============================================================================ + + +//============================================================================= +/** + * @file params.h + * + * $Id$ + * + * @author Chris Cleeland + */ +//============================================================================= + #ifndef TAO_PARAMS_H #define TAO_PARAMS_H @@ -53,63 +50,67 @@ typedef ACE_Unbounded_Queue_Iterator<ACE_CString> TAO_EndpointSetIterator; // ------------------------------------------------------------------- +/** + * @class TAO_ORB_Parameters + * + * @brief Parameters that are specific to the ORB. These parameters can + * be for the client, the server, or for both. + * = NOTE + * Some of the functions have inline definitions in the class header + * below. Please do not move them back to the .i file. + * cygnus-2.7.2-960126, distributed with Tornado 1.0.1, can't deal + * with returing a const reference here. It raises an internal + * compiler error at ace/Svc_Handler.cpp:46, of all places. + */ class TAO_Export TAO_ORB_Parameters - // = TITLE - // Parameters that are specific to the ORB. These parameters can - // be for the client, the server, or for both. - // - // = NOTE - // Some of the functions have inline definitions in the class header - // below. Please do not move them back to the .i file. - // cygnus-2.7.2-960126, distributed with Tornado 1.0.1, can't deal - // with returing a const reference here. It raises an internal - // compiler error at ace/Svc_Handler.cpp:46, of all places. { public: + /// Constructor. TAO_ORB_Parameters (void); - // Constructor. + /// Destructor. ~TAO_ORB_Parameters (void); - // Destructor. + /// Specifies the endpoints to pre-establish connections on. int preconnects (ACE_CString &preconnects); TAO_EndpointSet &preconnects (void); void add_preconnect (ACE_CString &preconnect); - // Specifies the endpoints to pre-establish connections on. + /// Specifies the endpoints on which this server is willing to + /// listen for requests. int endpoints (ACE_CString &endpoints); TAO_EndpointSet &endpoints (void); void add_endpoint (ACE_CString &endpoint); - // Specifies the endpoints on which this server is willing to - // listen for requests. + /// Set/Get the port of services locatable through multicast. CORBA::UShort service_port (MCAST_SERVICEID service_id) const; void service_port (MCAST_SERVICEID service_id, CORBA::UShort port); - // Set/Get the port of services locatable through multicast. + /// Get/Set address:port for Multicast Discovery Protocol for + /// the Naming Service. const char *mcast_discovery_endpoint (void) const; void mcast_discovery_endpoint (const char *mde); - // Get/Set address:port for Multicast Discovery Protocol for - // the Naming Service. + /// Set/Get the size to be used for a socket's receive buffer. int sock_rcvbuf_size (void) const; void sock_rcvbuf_size (int); - // Set/Get the size to be used for a socket's receive buffer. + /// Set/Get the size to be used for a socket's send buffer. int sock_sndbuf_size (void) const; void sock_sndbuf_size (int); - // Set/Get the size to be used for a socket's send buffer. + /// Set/Get the status of whether to use TCP_NODELAY or not. int nodelay (void) const; void nodelay (int); - // Set/Get the status of whether to use TCP_NODELAY or not. + /** + * Octet sequences are marshalled without doing any copies, we + * simply append a block to the CDR message block chain. When the + * octet sequence is small enough and there is room in the current + * message block it is more efficient just to copy the buffer. + */ int cdr_memcpy_tradeoff (void) const; void cdr_memcpy_tradeoff (int); - // Octet sequences are marshalled without doing any copies, we - // simply append a block to the CDR message block chain. When the - // octet sequence is small enough and there is room in the current - // message block it is more efficient just to copy the buffer. // @@Deprecated. Will not be used. - Bala // int use_lite_protocol (void) const; @@ -117,19 +118,19 @@ public: // The ORB will use a modified version of GIOP that minimizes the // header size. By default we use the standard GIOP protocol. + /// The ORB will use the dotted decimal notation for addresses. By + /// default we use the full ascii names. int use_dotted_decimal_addresses (void) const; void use_dotted_decimal_addresses (int); - // The ORB will use the dotted decimal notation for addresses. By - // default we use the full ascii names. + /// Set/Get the Init Reference of an arbitrary ObjectID. char *default_init_ref (void) const; void default_init_ref (const char *default_init_ref); - // Set/Get the Init Reference of an arbitrary ObjectID. + /// Disable the OMG standard profile components, useful for + /// homogenous environments. int std_profile_components (void) const; void std_profile_components (int x); - // Disable the OMG standard profile components, useful for - // homogenous environments. private: // Each "endpoint" is of the form: @@ -152,44 +153,44 @@ private: int parse_endpoints (ACE_CString &endpoints, TAO_EndpointSet &endpoints_list); + /// List of endpoints used to pre-establish connections. TAO_EndpointSet preconnects_list_; - // List of endpoints used to pre-establish connections. + /// List of endpoints this server is willing to accept requests + /// on. TAO_EndpointSet endpoints_list_; - // List of endpoints this server is willing to accept requests - // on. + /// Port numbers of the configured services. CORBA::UShort service_port_[NO_OF_MCAST_SERVICES]; - // Port numbers of the configured services. + /// address:port for Multicast Discovery Protocol for the Naming + /// Service. CORBA::String_var mcast_discovery_endpoint_; - // address:port for Multicast Discovery Protocol for the Naming - // Service. + /// List of comma separated prefixes from ORBDefaultInitRef. ACE_CString default_init_ref_; - // List of comma separated prefixes from ORBDefaultInitRef. + /// Size to be used for a socket's receive buffer. int sock_rcvbuf_size_; - // Size to be used for a socket's receive buffer. + /// Size to be used for a socket's send buffer. int sock_sndbuf_size_; - // Size to be used for a socket's send buffer. + /// 1 if we're using TCP_NODELAY and 0 otherwise. int nodelay_; - // 1 if we're using TCP_NODELAY and 0 otherwise. + /// Control the strategy for copying vs. appeding octet sequences in + /// CDR streams. int cdr_memcpy_tradeoff_; - // Control the strategy for copying vs. appeding octet sequences in - // CDR streams. + /// For selecting a liteweight version of the GIOP protocol. int use_lite_protocol_; - // For selecting a liteweight version of the GIOP protocol. + /// For selecting a address notation int use_dotted_decimal_addresses_; - // For selecting a address notation + /// If true then the standard OMG components are not generated. int std_profile_components_; - // If true then the standard OMG components are not generated. }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/qt_resource.h b/TAO/tao/qt_resource.h index 30ff02ede14..59887c2d52e 100644 --- a/TAO/tao/qt_resource.h +++ b/TAO/tao/qt_resource.h @@ -1,18 +1,16 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// qt_resource.h -// -// = AUTHOR -// Hamish Friedlander <ullexco@wave.co.nz> -// integrated in to TAO by Balachandran Natarajan <bala@cs.wustl.edu> -// ============================================================================ + +//============================================================================= +/** + * @file qt_resource.h + * + * $Id$ + * + * @author Hamish Friedlander <ullexco@wave.co.nz> + * @author Balachandran Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + #ifndef _TAO_QTRESOURCE_H #define _TAO_QTRESOURCE_H #include "ace/pre.h" @@ -26,26 +24,28 @@ #include "ace/QtReactor.h" +/** + * @class TAO_QtResource_Factory + * + * @brief TAO's default resource factory + * + * Using a <{resource source specifier}> as a discriminator, the + * factory can return resource instances which are, e.g., global, + * stored in thread-specific storage, stored in shared memory, + * etc. + */ class TAO_Export TAO_QtResource_Factory : public TAO_Default_Resource_Factory { - // = TITLE - // TAO's default resource factory - // - // = DESCRIPTION - // Using a <{resource source specifier}> as a discriminator, the - // factory can return resource instances which are, e.g., global, - // stored in thread-specific storage, stored in shared memory, - // etc. public: TAO_QtResource_Factory (void); + /// Set the context used to create the QtReactor static void set_context (QApplication *qapp) ; - // Set the context used to create the QtReactor protected: + /// Obtain the reactor implementation virtual ACE_Reactor_Impl *allocate_reactor_impl (void) const; - // Obtain the reactor implementation private: static QApplication *qapp_ ; diff --git a/TAO/tao/rtcorbafwd.h b/TAO/tao/rtcorbafwd.h index 46bb4e808ea..2bd0f609af7 100644 --- a/TAO/tao/rtcorbafwd.h +++ b/TAO/tao/rtcorbafwd.h @@ -1,24 +1,21 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// rtcorbafwd.h -// -// = DESCRIPTION -// Forward declare the basic types used in the RT-CORBA namespace. -// As with the CORBA namespace they are too many to just lump them -// in the same file, and having a place where they are only forward -// declared breaks cyclic dependencies. -// -// = AUTHOR -// Carlos O'Ryan -// -// ============================================================================ + +//============================================================================= +/** + * @file rtcorbafwd.h + * + * $Id$ + * + * Forward declare the basic types used in the RT-CORBA namespace. + * As with the CORBA namespace they are too many to just lump them + * in the same file, and having a place where they are only forward + * declared breaks cyclic dependencies. + * + * + * @author Carlos O'Ryan + */ +//============================================================================= + #ifndef TAO_RTCORBAFWD_H #define TAO_RTCORBAFWD_H @@ -46,7 +43,7 @@ TAO_NAMESPACE RTCORBA // = DESCRIPTION // The contents of the RTCORBA module are defined in // orbos/99-02-12, the complete listing is in section 4.16 - // Notice that the name of the namespace was changed from RT_CORBA + // Notice that the name of the namespace was changed from RT_CORBA // to RTCORBA by the corrigendum in: // orbos/99-03-29 diff --git a/TAO/tao/target_specification.h b/TAO/tao/target_specification.h index 907b0d184e5..488511a0ca8 100644 --- a/TAO/tao/target_specification.h +++ b/TAO/tao/target_specification.h @@ -1,21 +1,19 @@ //-*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// target_identifier.h -// -// = DESCRIPTION -// A class that encapsulates the target identification details. -// -// -// = AUTHOR -// Balachandran Natarajan <bala@cs.wustl.edu> -// ============================================================================ + +//============================================================================= +/** + * @file target_specification.h + * + * $Id$ + * + * A class that encapsulates the target identification details. + * + * + * + * @author Balachandran Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_TARGET_SPECIFICATION_H #define TAO_TARGET_SPECIFICATION_H @@ -25,30 +23,32 @@ #include "tao/IOPC.h" +/** + * @class TAO_Target_Specification + * + * @brief A class to encapsulate all the ways of specifying targets. + * + * @@ Bala: do we have examples of how other protocols map object + * keys? + * @@ Carlos: The way HTTP-NG does is not quite intuitive. But + * they too have a sequnce of Octet which more or less fits this + * model. You are also allowed to specify is a Cache Index (14 + * bits). I think that can also be worked out and shouldn't be + * a big deal. + * @@ Bala:What if they pass something around that does not fit + * this model? + * @@ Carlos:As long as we dont know it is ok. But then if we get + * to some point where we have something floating around, + * obviously we would have well defined data structure in + * TAO. BTW, in IMHO it is not possible for me to think the + * myriad data structures that a designer can come up with. So, + * I can look ahead possibily a couple of days but not a life + * time :-) But you have a good question though. Please sont + * remove these discussions. It could be useful for someone + * someday. + */ class TAO_Export TAO_Target_Specification { - // = TITLE - // A class to encapsulate all the ways of specifying targets. - // - // = DESCRIPTION - // @@ Bala: do we have examples of how other protocols map object - // keys? - // @@ Carlos: The way HTTP-NG does is not quite intuitive. But - // they too have a sequnce of Octet which more or less fits this - // model. You are also allowed to specify is a Cache Index (14 - // bits). I think that can also be worked out and shouldn't be - // a big deal. - // @@ Bala:What if they pass something around that does not fit - // this model? - // @@ Carlos:As long as we dont know it is ok. But then if we get - // to some point where we have something floating around, - // obviously we would have well defined data structure in - // TAO. BTW, in IMHO it is not possible for me to think the - // myriad data structures that a designer can come up with. So, - // I can look ahead possibily a couple of days but not a life - // time :-) But you have a good question though. Please sont - // remove these discussions. It could be useful for someone - // someday. // @@ Bala: i hate to be picky on these matters, but you are not // writing a novel or your memoirs, 'I foresee' does not look like @@ -67,8 +67,8 @@ class TAO_Export TAO_Target_Specification // required. public: + /// Ctor TAO_Target_Specification (void); - // Ctor enum TAO_Target_Address { // Note that this could be extended for other protocols @@ -80,38 +80,46 @@ public: // Note: Please do not pass in a identifiers that is allocated on // stack. These methods does not make a copy but holds the pointer // passed in. + /// Set the target specification by giving the object key. void target_specifier (const TAO_ObjectKey &key); - // Set the target specification by giving the object key. + /// Set the target specification by passing in an IOP::TaggedProfile. void target_specifier (IOP::TaggedProfile &profile); - // Set the target specification by passing in an IOP::TaggedProfile. + /** + * Specify the target by passing in the IOP::IOR with a profile + * index. Please see the header file IOPC.h on why a profile index + * is required. + */ void target_specifier (IOP::IOR &ior, CORBA::ULong prof_index); - // Specify the target by passing in the IOP::IOR with a profile - // index. Please see the header file IOPC.h on why a profile index - // is required. + /** + * Returns the object key after a check of the stored specifier. If + * the stored specifier is not of the right type then this would + * return a NULL + */ const TAO_ObjectKey* object_key (void); - // Returns the object key after a check of the stored specifier. If - // the stored specifier is not of the right type then this would - // return a NULL + /** + * Returns the IOP::TaggedProfile after a check of the stored specifier. If + * the stored specifier is not of the right type then this would + * return a NULL + */ const IOP::TaggedProfile *profile (void); - // Returns the IOP::TaggedProfile after a check of the stored specifier. If - // the stored specifier is not of the right type then this would - // return a NULL + /** + * Returns a pointer to IOP::IOR through the parameters and the + * index of the selected profile as a return parameter after a check + * of the stored specifier. If the stored specifier is not of the + * right type then this would return a NULL. + */ CORBA::ULong iop_ior (IOP::IOR *&ior); - // Returns a pointer to IOP::IOR through the parameters and the - // index of the selected profile as a return parameter after a check - // of the stored specifier. If the stored specifier is not of the - // right type then this would return a NULL. + /// Access the TArget_Address specifier TAO_Target_Address specifier (void); - // Access the TArget_Address specifier private: union @@ -122,11 +130,11 @@ private: } u_; // The union of all the possibilities + /// The enum identifier TAO_Target_Address specifier_; - // The enum identifier + /// The profile index CORBA::ULong profile_index_; - // The profile index }; #if defined (__ACE_INLINE__) diff --git a/TAO/tao/try_macros.h b/TAO/tao/try_macros.h index c7c622592ea..e0d55294755 100644 --- a/TAO/tao/try_macros.h +++ b/TAO/tao/try_macros.h @@ -2,42 +2,38 @@ // $Id$ // ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// try_macros.h -// -// = DESCRIPTION -// This file has been depricated. -// -// = AUTHOR -// Copyright by Douglas C. Schmidt. -// -// ***************************************************************** -// * * -// * NOTICE !!! NOTICE !!! NOTICE !!! NOTICE !!! * -// * * -// * The macros in this file is deprecated. * -// * * -// * Please check out $ACE_ROOT/ace/CORBA_macros.h * -// * and $ACE_ROOT/docs/exceptions.html for a new * -// * set of helper macros that replace this file. * -// * * -// * We strongely encourage you to stop using the * -// * macros in this file. You should try to convert * -// * your program to use the new ACE try macros * -// * which are simpler to use and easier to remember. * -// * However, if you still insist on using these old * -// * macros, you can do this by uncomment the "#define * -// * TAO_USES_DEPRECATED_TAO_TRY_MACROS" below. * -// * * -// * Again, we no longer maintain this file and it will * -// * eventually go away. * -// * * -// ***************************************************************** -// +/** + * @file try_macros.h + * + * @brief This file has been deprecated. + * + *<PRE> + * ***************************************************************** + * * * + * * NOTICE !!! NOTICE !!! NOTICE !!! NOTICE !!! * + * * * + * * The macros in this file is deprecated. * + * * * + * * Please check out $ACE_ROOT/ace/CORBA_macros.h * + * * and $ACE_ROOT/docs/exceptions.html for a new * + * * set of helper macros that replace this file. * + * * * + * * We strongely encourage you to stop using the * + * * macros in this file. You should try to convert * + * * your program to use the new ACE try macros * + * * which are simpler to use and easier to remember. * + * * However, if you still insist on using these old * + * * macros, you can do this by uncomment the "#define * + * * TAO_USES_DEPRECATED_TAO_TRY_MACROS" below. * + * * * + * * Again, we no longer maintain this file and it will * + * * eventually go away. * + * * * + * ***************************************************************** + *</PRE> + * + * @author Douglas C. Schmidt. + */ // ============================================================================ #ifndef TAO_TRY_MACROS_H diff --git a/TAO/tao/varbase.h b/TAO/tao/varbase.h index 6e6f2fd4e74..00f4e780455 100644 --- a/TAO/tao/varbase.h +++ b/TAO/tao/varbase.h @@ -1,38 +1,35 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// varbase.h -// -// = DESCRIPTION -// Contains a base class for the object _var classes. -// -// = AUTHOR -// Jeff Parsons. -// -// ============================================================================ +//============================================================================= +/** + * @file varbase.h + * + * $Id$ + * + * Contains a base class for the object _var classes. + * + * + * @author Jeff Parsons. + */ +//============================================================================= + #ifndef TAO_VARBASE_H #define TAO_VARBASE_H #include "ace/pre.h" +/** + * @class TAO_Base_var + * + * @brief TAO_Base_var + * + * Base class for object _var classes. Used to prevent the + * _var class of a CORBA interface from accepting the _var + * of a more derived interface in its copy constructor or + * assignment operator. + */ class TAO_Base_var { -// -// = TITLE -// TAO_Base_var -// -// = DESCRIPTION -// Base class for object _var classes. Used to prevent the -// _var class of a CORBA interface from accepting the _var -// of a more derived interface in its copy constructor or -// assignment operator. -// public: TAO_Base_var (void) {} }; diff --git a/TAO/tao/xt_resource.h b/TAO/tao/xt_resource.h index cf78196f03c..a44c035a8ac 100644 --- a/TAO/tao/xt_resource.h +++ b/TAO/tao/xt_resource.h @@ -1,18 +1,15 @@ // -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// xt_resource.h -// -// = AUTHOR -// Carlos O'Ryan -// -// ============================================================================ + +//============================================================================= +/** + * @file xt_resource.h + * + * $Id$ + * + * @author Carlos O'Ryan + */ +//============================================================================= + #ifndef TAO_XT_RESOURCE_H #define TAO_XT_RESOURCE_H @@ -30,28 +27,29 @@ // **************************************************************** +/** + * @class TAO_XT_Resource_Factory + * + * @brief TAO's default resource factory + * + * Using a <{resource source specifier}> as a discriminator, the + * factory can return resource instances which are, e.g., global, + * stored in thread-specific storage, stored in shared memory, + * etc. + */ class TAO_XT_Resource_Factory : public TAO_Default_Resource_Factory { - // = TITLE - // TAO's default resource factory - // - // = DESCRIPTION - // Using a <{resource source specifier}> as a discriminator, the - // factory can return resource instances which are, e.g., global, - // stored in thread-specific storage, stored in shared memory, - // etc. - // public: // = Initialization and termination methods. + /// Constructor. TAO_XT_Resource_Factory (void); - // Constructor. + /// Set the context used to create the XtReactor static void set_context (XtAppContext context); - // Set the context used to create the XtReactor protected: + /// Obtain the reactor implementation virtual ACE_Reactor_Impl *allocate_reactor_impl (void) const; - // Obtain the reactor implementation private: static XtAppContext context_; |