diff options
Diffstat (limited to 'TAO/orbsvcs/orbsvcs/Event/EC_Event_Channel.h')
| -rw-r--r-- | TAO/orbsvcs/orbsvcs/Event/EC_Event_Channel.h | 308 |
1 files changed, 0 insertions, 308 deletions
diff --git a/TAO/orbsvcs/orbsvcs/Event/EC_Event_Channel.h b/TAO/orbsvcs/orbsvcs/Event/EC_Event_Channel.h deleted file mode 100644 index 5f19fbae273..00000000000 --- a/TAO/orbsvcs/orbsvcs/Event/EC_Event_Channel.h +++ /dev/null @@ -1,308 +0,0 @@ -/* -*- C++ -*- */ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// ORBSVCS Real-time Event Channel -// -// = FILENAME -// EC_Event_Channel -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// = DESCRIPTION -// A new implementation of the Real Time Event Services. -// 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://www.cs.wustl.edu/~schmidt/oopsla.ps.gz -// http://www.cs.wustl.edu/~schmidt/JSAC-98.ps.gz -// -// -// ============================================================================ - -#ifndef TAO_EC_EVENT_CHANNEL_H -#define TAO_EC_EVENT_CHANNEL_H - -#include "EC_Factory.h" - -#if !defined (ACE_LACKS_PRAGMA_ONCE) -# pragma once -#endif /* ACE_LACKS_PRAGMA_ONCE */ - -#include "EC_Defaults.h" -#include "orbsvcs/RtecEventChannelAdminS.h" - -class TAO_ORBSVCS_Export TAO_EC_Event_Channel_Attributes -{ - // = TITLE - // Defines the construction time attributes for the Event - // Channel. - // - // = DESCRIPTION - // The event channel implementation is controlled by two - // mechanisms: - // The EC_Factory that provides the strategies for the EC - // implementation. - // The EC attributes that define constants and values required - // by the EC construction. - // This class encapsulates those constants and values, providing - // an easy mechanism to extend the attributes without requiring - // changes in the EC constructor. - // -public: - TAO_EC_Event_Channel_Attributes (PortableServer::POA_ptr supplier_poa, - PortableServer::POA_ptr consumer_poa); - // The basic constructor. - // The attributes listed as arguments are *required* by the EC, and - // no appropiate defaults are available for them. - - // Most fields are public, there is no need to protect them, in fact - // the user should be able to set any values she wants. - - int consumer_reconnect; - int supplier_reconnect; - // Can consumers or suppliers invoke connect_push_* multiple times? - - int disconnect_callbacks; - // It not zero the event channel will send disconnect callbacks when - // a disconnect method is called on a Proxy. In other words, if a - // consumer calls disconnect_push_supplier() on its proxy the EC - // will invoke disconnect_push_consumer() on the consumer. A - // similar thing is done for suppliers. - // It is a matter of debate what the spec requires for the regular - // event service. - - int busy_hwm; - int max_write_delay; - // Flags for the Consumer Admin - - RtecScheduler::Scheduler_ptr scheduler; - // The scheduling service that we will use with this event channel. - // Notice that this is optional and will only take effect if the EC - // is configured with the right filtering strategies. - -private: - friend class TAO_EC_Event_Channel; - // Only the EC can read the private fields. - - PortableServer::POA_ptr supplier_poa; - PortableServer::POA_ptr consumer_poa; - // The POAs -}; - -class TAO_ORBSVCS_Export TAO_EC_Event_Channel : public POA_RtecEventChannelAdmin::EventChannel -{ - // = TITLE - // The RtecEventChannelAdmin::EventChannel implementation. - // - // = DESCRIPTION - // This class is the Mediator between all the classes in the EC - // implementation, its main task is to redirect the messages to - // the right components, to hold and manage the lifetime of the - // long lived objects (Timer_Module, SupplierAdmin, - // ConsumerAdmin and Dispatching) and to provide a simpler - // interface to the EC_Factory. - // -public: - TAO_EC_Event_Channel (const TAO_EC_Event_Channel_Attributes& attributes, - TAO_EC_Factory* factory = 0, - int own_factory = 0); - // constructor - // If <own_factory> is not 0 it assumes ownership of the factory. - // If the factory is <nil> it uses the Service_Configurator to load - // the Factory, if not found it uses TAO_EC_Default_Resource_Factory - - virtual ~TAO_EC_Event_Channel (void); - // destructor - - virtual void activate (CORBA::Environment &env = TAO_default_environment ()); - // Start the internal threads (if any), etc. - // After this call the EC can be used. - - virtual void shutdown (CORBA::Environment &env = TAO_default_environment ()); - // Shutdown any internal threads, cleanup all the internal - // structures, flush all the messages, etc. - - TAO_EC_Dispatching* dispatching (void) const; - // Access the dispatching module.... - - TAO_EC_Filter_Builder* filter_builder (void) const; - // Access the filter builder.... - - TAO_EC_Supplier_Filter_Builder* supplier_filter_builder (void) const; - // Access the filter builder.... - - TAO_EC_ConsumerAdmin* consumer_admin (void) const; - // Access the consumer admin implementation, useful for controlling - // the activation... - - TAO_EC_SupplierAdmin* supplier_admin (void) const; - // Access the supplier admin implementation, useful for controlling - // the activation... - - TAO_EC_Timeout_Generator* timeout_generator (void) const; - // Access the timer module... - - TAO_EC_Scheduling_Strategy* scheduling_strategy (void) const; - // Access the scheduling strategy - - // = The factory methods, they delegate on the EC_Factory. - TAO_EC_ProxyPushSupplier* create_proxy_push_supplier (void); - void destroy_proxy_push_supplier (TAO_EC_ProxyPushSupplier*); - // Create and destroy a ProxyPushSupplier - - TAO_EC_ProxyPushConsumer* create_proxy_push_consumer (void); - void destroy_proxy_push_consumer (TAO_EC_ProxyPushConsumer*); - // Create and destroy a ProxyPushConsumer - - TAO_EC_ProxyPushSupplier_Set* create_proxy_push_supplier_set (void); - void destroy_proxy_push_supplier_set (TAO_EC_ProxyPushSupplier_Set*); - // Create and destroy a ProxyPushSupplier_Set - - PortableServer::POA_ptr supplier_poa (void); - PortableServer::POA_ptr consumer_poa (void); - // Access the supplier and consumer POAs from the factory. - - ACE_Lock* create_consumer_lock (void); - void destroy_consumer_lock (ACE_Lock*); - ACE_Lock* create_supplier_lock (void); - void destroy_supplier_lock (ACE_Lock*); - // Locking strategies for the ProxyPushConsumer and - // ProxyPushSupplier objects - - ACE_Lock* create_consumer_admin_lock (void); - void destroy_consumer_admin_lock (ACE_Lock*); - ACE_Lock* create_supplier_admin_lock (void); - void destroy_supplier_admin_lock (ACE_Lock*); - // Locking strategies for the ConsumerAdmin and SupplierAdmin - // objects - - virtual void connected (TAO_EC_ProxyPushConsumer*, - CORBA::Environment&); - virtual void disconnected (TAO_EC_ProxyPushConsumer*, - CORBA::Environment&); - // Used to inform the EC that a Consumer has connected or - // disconnected from it. - - virtual void connected (TAO_EC_ProxyPushSupplier*, - CORBA::Environment&); - virtual void disconnected (TAO_EC_ProxyPushSupplier*, - CORBA::Environment&); - // Used to inform the EC that a Supplier has connected or - // disconnected from it. - - // Simple flags to control the EC behavior, set by the application - // at construction time. - - int consumer_reconnect (void) const; - // Can the consumers reconnect to the EC? - - int supplier_reconnect (void) const; - // Can the suppliers reconnect to the EC? - - int disconnect_callbacks (void) const; - // Should we send callback disconnect messages when a proxy is - // disconnected by the client - - RtecScheduler::Scheduler_ptr scheduler (void); - // Obtain the scheduler, the user must release - - int busy_hwm (void) const; - int max_write_delay (void) const; - // Control the concurrency of the delayed connect/disconnect - // operations. - - // = The RtecEventChannelAdmin::EventChannel methods... - virtual RtecEventChannelAdmin::ConsumerAdmin_ptr - for_consumers (CORBA::Environment& env) - ACE_THROW_SPEC ((CORBA::SystemException)); - // The default implementation is: - // this->consumer_admin ()->_this (env); - - virtual RtecEventChannelAdmin::SupplierAdmin_ptr - for_suppliers (CORBA::Environment& env) - ACE_THROW_SPEC ((CORBA::SystemException)); - // The default implementation is: - // this->supplier_admin ()->_this (env); - - virtual void destroy (CORBA::Environment &env) - ACE_THROW_SPEC ((CORBA::SystemException)); - // Commit suicide. - - virtual RtecEventChannelAdmin::Observer_Handle - append_observer (RtecEventChannelAdmin::Observer_ptr, - CORBA::Environment &env) - ACE_THROW_SPEC (( - CORBA::SystemException, - RtecEventChannelAdmin::EventChannel::SYNCHRONIZATION_ERROR, - RtecEventChannelAdmin::EventChannel::CANT_APPEND_OBSERVER)); - virtual void - remove_observer (RtecEventChannelAdmin::Observer_Handle, - CORBA::Environment &env) - ACE_THROW_SPEC (( - CORBA::SystemException, - RtecEventChannelAdmin::EventChannel::SYNCHRONIZATION_ERROR, - RtecEventChannelAdmin::EventChannel::CANT_REMOVE_OBSERVER)); - -private: - PortableServer::POA_var supplier_poa_; - PortableServer::POA_var consumer_poa_; - // The POAs used to activate "supplier-side" and "consumer-side" - // objects. - - TAO_EC_Factory *factory_; - // This is the abstract factory that creates all the objects that - // compose an event channel, the event channel simply acts as a - // Mediator among them. - - int own_factory_; - // Flag that indicates if we own the factory. - - TAO_EC_Dispatching *dispatching_; - // The dispatching "module" - - TAO_EC_Filter_Builder *filter_builder_; - // The filter builder - - TAO_EC_Supplier_Filter_Builder *supplier_filter_builder_; - // The filter builder for suppliers - - TAO_EC_ConsumerAdmin *consumer_admin_; - // The ConsumerAdmin implementation - - TAO_EC_SupplierAdmin *supplier_admin_; - // The SupplierAdmin implementation - - TAO_EC_Timeout_Generator *timeout_generator_; - // The timeout generator - - TAO_EC_ObserverStrategy *observer_strategy_; - // The observer strategy - - RtecScheduler::Scheduler_var scheduler_; - // The scheduler (may be nil) - - TAO_EC_Scheduling_Strategy *scheduling_strategy_; - // The scheduling strategy - - int consumer_reconnect_; - int supplier_reconnect_; - // Consumer/Supplier reconnection flags - - int disconnect_callbacks_; - // If not zero we send callbacks when a proxy is disconnected - - int busy_hwm_; - int max_write_delay_; - // Control the level of concurrency in the supplier sets with - // delayed operations -}; - -#if defined (__ACE_INLINE__) -#include "EC_Event_Channel.i" -#endif /* __ACE_INLINE__ */ - -#endif /* TAO_EC_EVENT_CHANNEL_H */ |