diff options
Diffstat (limited to 'trunk/TAO/orbsvcs/orbsvcs/Event/EC_Factory.h')
| -rw-r--r-- | trunk/TAO/orbsvcs/orbsvcs/Event/EC_Factory.h | 172 |
1 files changed, 172 insertions, 0 deletions
diff --git a/trunk/TAO/orbsvcs/orbsvcs/Event/EC_Factory.h b/trunk/TAO/orbsvcs/orbsvcs/Event/EC_Factory.h new file mode 100644 index 00000000000..7f4070e8d5d --- /dev/null +++ b/trunk/TAO/orbsvcs/orbsvcs/Event/EC_Factory.h @@ -0,0 +1,172 @@ +// -*- C++ -*- +/** + * @file EC_Factory.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + * + * Based on previous work by Tim Harrison (harrison@cs.wustl.edu) and + * other members of the DOC group. More details can be found in: + * + * http://doc.ece.uci.edu/~coryan/EC/index.html + */ + +#ifndef TAO_EC_FACTORY_H +#define TAO_EC_FACTORY_H + +#include /**/ "ace/pre.h" + +#include /**/ "orbsvcs/Event/event_serv_export.h" + +#if !defined (ACE_LACKS_PRAGMA_ONCE) +# pragma once +#endif /* ACE_LACKS_PRAGMA_ONCE */ + +#include "tao/Versioned_Namespace.h" + +#include "ace/Service_Object.h" + +ACE_BEGIN_VERSIONED_NAMESPACE_DECL +class ACE_Lock; +ACE_END_VERSIONED_NAMESPACE_DECL + +TAO_BEGIN_VERSIONED_NAMESPACE_DECL + +class TAO_EC_Event_Channel_Base; + +class TAO_EC_Dispatching; +class TAO_EC_Filter_Builder; +class TAO_EC_Supplier_Filter_Builder; +class TAO_EC_ConsumerAdmin; +class TAO_EC_SupplierAdmin; +class TAO_EC_ProxyPushConsumer; +class TAO_EC_ProxyPushSupplier; +class TAO_EC_ObserverStrategy; +template<class PROXY> class TAO_ESF_Proxy_Collection; +class TAO_EC_Timeout_Generator; +class TAO_EC_Scheduling_Strategy; +class TAO_EC_ConsumerControl; +class TAO_EC_SupplierControl; + +typedef TAO_ESF_Proxy_Collection<TAO_EC_ProxyPushConsumer> TAO_EC_ProxyPushConsumer_Collection; +typedef TAO_ESF_Proxy_Collection<TAO_EC_ProxyPushSupplier> TAO_EC_ProxyPushSupplier_Collection; + +/** + * @class TAO_EC_Factory + * + * @brief Abstract base class for the Event Channel components. + * + * Defines the EC_Factory interface. + * + * <H2>Memory Management</H2> + * The objects it creates are owned by this class, the client must + * invoke the corresponding destroy() method to release them. + * Some implementations may require a different instance for the + * EC_Factory for each instance of Event_Channel. + */ +class TAO_RTEvent_Serv_Export TAO_EC_Factory : public ACE_Service_Object +{ +public: + /// destructor... + TAO_EC_Factory (void); + virtual ~TAO_EC_Factory (void); + + /// Create and destroy the dispatching module. + virtual TAO_EC_Dispatching* + create_dispatching (TAO_EC_Event_Channel_Base*) = 0; + virtual void + destroy_dispatching (TAO_EC_Dispatching*) = 0; + + /// Create and destroy the filter builder. + virtual TAO_EC_Filter_Builder* + create_filter_builder (TAO_EC_Event_Channel_Base*) = 0; + virtual void + destroy_filter_builder (TAO_EC_Filter_Builder*) = 0; + + /// Create and destroy the filter builder. + virtual TAO_EC_Supplier_Filter_Builder* + create_supplier_filter_builder (TAO_EC_Event_Channel_Base*) = 0; + virtual void + destroy_supplier_filter_builder (TAO_EC_Supplier_Filter_Builder*) = 0; + + /// Create and destroy the consumer admin implementation. + virtual TAO_EC_ConsumerAdmin* + create_consumer_admin (TAO_EC_Event_Channel_Base*) = 0; + virtual void + destroy_consumer_admin (TAO_EC_ConsumerAdmin*) = 0; + + /// Create and destroy the supplier admin implementation. + virtual TAO_EC_SupplierAdmin* + create_supplier_admin (TAO_EC_Event_Channel_Base*) = 0; + virtual void + destroy_supplier_admin (TAO_EC_SupplierAdmin*) = 0; + + /// Create and destroy a ProxyPushSupplier + virtual TAO_EC_ProxyPushSupplier* + create_proxy_push_supplier (TAO_EC_Event_Channel_Base*) = 0; + virtual void + destroy_proxy_push_supplier (TAO_EC_ProxyPushSupplier*) = 0; + + /// Create and destroy a ProxyPushConsumer + virtual TAO_EC_ProxyPushConsumer* + create_proxy_push_consumer (TAO_EC_Event_Channel_Base*) = 0; + virtual void + destroy_proxy_push_consumer (TAO_EC_ProxyPushConsumer*) = 0; + + /// Create and destroy the timer module. + virtual TAO_EC_Timeout_Generator* + create_timeout_generator (TAO_EC_Event_Channel_Base*) = 0; + virtual void + destroy_timeout_generator (TAO_EC_Timeout_Generator*) = 0; + + /// Create and destroy the observer strategy. + virtual TAO_EC_ObserverStrategy* + create_observer_strategy (TAO_EC_Event_Channel_Base*) = 0; + virtual void + destroy_observer_strategy (TAO_EC_ObserverStrategy*) = 0; + + /// Create and destroy the observer strategy. + virtual TAO_EC_Scheduling_Strategy* + create_scheduling_strategy (TAO_EC_Event_Channel_Base*) = 0; + virtual void + destroy_scheduling_strategy (TAO_EC_Scheduling_Strategy*) = 0; + + /// Create and destroy a collection of TAO_EC_ProxyPushConsumers + virtual TAO_EC_ProxyPushConsumer_Collection* + create_proxy_push_consumer_collection (TAO_EC_Event_Channel_Base*) = 0; + virtual void + destroy_proxy_push_consumer_collection (TAO_EC_ProxyPushConsumer_Collection*) = 0; + + /// Create and destroy a collection of TAO_EC_ProxyPushSuppliers + virtual TAO_EC_ProxyPushSupplier_Collection* + create_proxy_push_supplier_collection (TAO_EC_Event_Channel_Base*) = 0; + virtual void + destroy_proxy_push_supplier_collection (TAO_EC_ProxyPushSupplier_Collection*) = 0; + + /// Create and destroy the locking strategies for both + /// ProxyPushConsumers and ProxyPushSuppliers + virtual ACE_Lock* create_consumer_lock (void) = 0; + virtual void destroy_consumer_lock (ACE_Lock*) = 0; + virtual ACE_Lock* create_supplier_lock (void) = 0; + virtual void destroy_supplier_lock (ACE_Lock*) = 0; + + /// The ConsumerControl and SupplierControl strategies are used to + /// discard non-existent consumers and suppliers + virtual TAO_EC_ConsumerControl* + create_consumer_control (TAO_EC_Event_Channel_Base*) = 0; + virtual void + destroy_consumer_control (TAO_EC_ConsumerControl*) = 0; + virtual TAO_EC_SupplierControl* + create_supplier_control (TAO_EC_Event_Channel_Base*) = 0; + virtual void + destroy_supplier_control (TAO_EC_SupplierControl*) = 0; +}; + +TAO_RTEvent_Serv_Export extern unsigned short TAO_EC_debug_level; + +TAO_END_VERSIONED_NAMESPACE_DECL + +#include /**/ "ace/post.h" + +#endif /* TAO_EC_FACTORY_H */ |