diff options
Diffstat (limited to 'TAO/orbsvcs/tests/FT_App/FT_ReplicaFactory_i.h')
| -rw-r--r-- | TAO/orbsvcs/tests/FT_App/FT_ReplicaFactory_i.h | 293 |
1 files changed, 293 insertions, 0 deletions
diff --git a/TAO/orbsvcs/tests/FT_App/FT_ReplicaFactory_i.h b/TAO/orbsvcs/tests/FT_App/FT_ReplicaFactory_i.h new file mode 100644 index 00000000000..a2bc85e5f80 --- /dev/null +++ b/TAO/orbsvcs/tests/FT_App/FT_ReplicaFactory_i.h @@ -0,0 +1,293 @@ +/* -*- C++ -*- */ +//============================================================================= +/** + * @file FT_ReplicaFactory_i.h + * + * $Id$ + * + * This file is part of Fault Tolerant CORBA. + * It declares the implementation of ReplicaFactory which + * creates and manages replicas as an agent for + * the ReplicationManager as defined in the FT CORBA specification. + * + * @author Dale Wilson <wilson_d@ociweb.com> + */ +//============================================================================= + +#ifndef FT_REPLICAFACTORY_H_ +#define FT_REPLICAFACTORY_H_ +#include <ace/ACE.h> +#if !defined (ACE_LACKS_PRAGMA_ONCE) +# pragma once +#endif /* ACE_LACKS_PRAGMA_ONCE */ + +////////////////////////////////// +// Classes declared in this header +class FT_ReplicaFactory_i; + +///////////////////////////////// +// Includes needed by this header +#include <ace/Vector_T.h> +#include "FT_TestReplicaS.h" +#include <ace/Thread_Manager.h> +#include <orbsvcs/FT_ReplicationManagerC.h> + +///////////////////// +// Forward references +class TAO_ORB_Manager; +class FT_TestReplica_i; + +/** + * Implement the GenericFactory interface. + */ +class FT_ReplicaFactory_i +//FT_TEST::ReplicaFactory + : public virtual POA_PortableGroup::GenericFactory +{ + typedef ACE_Vector<FT_TestReplica_i *> ReplicaVec; + typedef ACE_Vector<ACE_CString> StringVec; + + ////////////////////// + // non-CORBA interface +public: + /** + * Default constructor. + */ + FT_ReplicaFactory_i (); + + /** + * Virtual destructor. + */ + virtual ~FT_ReplicaFactory_i (); + + /** + * Parse command line arguments. + * @param argc traditional C argc + * @param argv traditional C argv + * @return zero for success; nonzero is process return code for failure. + */ + int parse_args (int argc, char * argv[]); + + /** + * Initialize this object. + * @param orb our ORB -- we keep var to it. + * @return zero for success; nonzero is process return code for failure. + */ + int init (CORBA::ORB_ptr orb ACE_ENV_ARG_DECL); + + /** + * Prepare to exit. + * @return zero for success; nonzero is process return code for failure. + */ + int fini (ACE_ENV_SINGLE_ARG_DECL); + + int idle(int & result ACE_ENV_ARG_DECL); + + + /** + * Identify this replica factory. + * @return a string to identify this object for logging/console message purposes. + */ + const char * identity () const; + + const char * location () const; + + /** + * Remove pointer to individual replica; delete FT_TestReplica_i. + * See replica life cycle description. + * @param id the numerical id assigned to this replica. + * @param replica a pointer to the Replica object (redundant for safety.) + */ + void remove_replica (CORBA::ULong id, FT_TestReplica_i * replica ACE_ENV_ARG_DECL); + + ////////////////// + // CORBA interface + // See IDL for documentation + + virtual void shutdown (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) + ACE_THROW_SPEC (( + CORBA::SystemException + )); + + ///////////////////////////////////////// + // CORBA interface GenericFactory methods + virtual CORBA::Object_ptr create_object ( + const char * type_id, + const PortableGroup::Criteria & the_criteria, + PortableGroup::GenericFactory::FactoryCreationId_out factory_creation_id + ACE_ENV_ARG_DECL_WITH_DEFAULTS + ) + ACE_THROW_SPEC (( + CORBA::SystemException + , PortableGroup::NoFactory + , PortableGroup::ObjectNotCreated + , PortableGroup::InvalidCriteria + , PortableGroup::InvalidProperty + , PortableGroup::CannotMeetCriteria + )); + + virtual void delete_object ( + const PortableGroup::GenericFactory::FactoryCreationId & factory_creation_id + ACE_ENV_ARG_DECL_WITH_DEFAULTS + ) + ACE_THROW_SPEC (( + CORBA::SystemException + , PortableGroup::ObjectNotFound + )); + + ////////////////////////////////////////// + // CORBA interface PullMonitorable methods + + virtual CORBA::Boolean is_alive (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) + ACE_THROW_SPEC ((CORBA::SystemException)); + + ///////////////////////// + // Implementation methods +private: + /** + * Actual replica creation happens in this method. + * @param name becomes part of the objects identity. + */ + FT_TestReplica_i * create_replica(const char * name ACE_ENV_ARG_DECL); + + /** + * Find or allocate an ID for a new replica + */ + CORBA::ULong allocate_id(); + + /** + * Write this factory's IOR to a file + */ + int write_ior (const char * outputFile, const char * ior); + + /** + * Clean house for factory shut down. + */ + void shutdown_i (); + + /////////////// + // Data Members +private: + + /** + * Protect internal state. + * Mutex should be locked by corba methods, or by + * external (public) methods before calling implementation + * methods. + * Implementation methods should assume the mutex is + * locked if necessary. + */ + ACE_SYNCH_MUTEX internals_; + typedef ACE_Guard<ACE_SYNCH_MUTEX> InternalGuard; + + /** + * The orb + */ + CORBA::ORB_var orb_; + + /** + * The POA used to activate this object. + */ + PortableServer::POA_var poa_; + + /** + * The CORBA object id assigned to this object. + */ + PortableServer::ObjectId_var object_id_; + + /** + * IOR of this object as assigned by poa + */ + CORBA::String_var ior_; + + /** + * A file to which the factory's IOR should be written. + */ + const char * ior_output_file_; + + /** + * A human-readable string to distinguish this from other Notifiers. + */ + ACE_CString identity_; + + /** + * bool: true if we found a replication manager + */ + int have_replication_manager_; + + /** + * The replication manager + */ + + ::FT::ReplicationManager_var replication_manager_; + + + /** + * The factory registry IOR + */ + const char * factory_registry_ior_; + + /** + * The factory registry with which to register. + */ + PortableGroup::FactoryRegistry_var factory_registry_; + + /** + * true if registered with FactoryRegistry + */ + int registered_; // bool + + /** + * A file to which the test replica's IOR will be written + */ + const char * test_output_file_; + + /** + * A name to be used to register the factory with the name service. + */ + const char * ns_name_; + + CosNaming::NamingContext_var naming_context_; + + CosNaming::Name this_name_; + + ///////////////// + // The roles used to register types + StringVec roles_; + + /** + * the PortableGroup::Location within the domain + */ + const char * location_; + + /** + * bool: quit on idle flag. + */ + int quit_on_idle_; + + /** + * bool: use a single call to unregister. + */ + int unregister_by_location_; + + /** + * A vector of Replicas. Note that the Replica ID + * is an index into this vector. + */ + ReplicaVec replicas_; + + /** + * count of entries in Replicas_ that have been deleted. + * Used to determine when the factory is idle and to avoid futile + * searches for empty slots. + */ + size_t empty_slots_; + + /** + * boolean: starts false. Set to true when it's time to quit. + */ + int quit_requested_; + +}; + +#endif /* FT_REPLICAFACTORY_H_ */ |