diff options
Diffstat (limited to 'ACE/TAO/orbsvcs/orbsvcs/Event/EC_Timeout_Filter.h')
-rw-r--r-- | ACE/TAO/orbsvcs/orbsvcs/Event/EC_Timeout_Filter.h | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/ACE/TAO/orbsvcs/orbsvcs/Event/EC_Timeout_Filter.h b/ACE/TAO/orbsvcs/orbsvcs/Event/EC_Timeout_Filter.h new file mode 100644 index 00000000000..4fce96dcfeb --- /dev/null +++ b/ACE/TAO/orbsvcs/orbsvcs/Event/EC_Timeout_Filter.h @@ -0,0 +1,114 @@ +// -*- C++ -*- + +/** + * @file EC_Timeout_Filter.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_TIMEOUT_FILTER_H +#define TAO_EC_TIMEOUT_FILTER_H + +#include /**/ "ace/pre.h" + +#include "orbsvcs/Event/EC_Filter.h" + +#if !defined (ACE_LACKS_PRAGMA_ONCE) +# pragma once +#endif /* ACE_LACKS_PRAGMA_ONCE */ + +#include "orbsvcs/Event/EC_QOS_Info.h" + +TAO_BEGIN_VERSIONED_NAMESPACE_DECL + +class TAO_EC_Event_Channel_Base; +class TAO_EC_ProxyPushSupplier; + +/** + * @class TAO_EC_Timeout_Filter + * + * @brief A filter based on event type/source + * + * This filter only accept events with a predefined type/source, + * both the source and the type can be wildcards. + */ +class TAO_RTEvent_Serv_Export TAO_EC_Timeout_Filter : public TAO_EC_Filter +{ +public: + /// Constructor. + TAO_EC_Timeout_Filter (TAO_EC_Event_Channel_Base *event_channel, + TAO_EC_ProxyPushSupplier *supplier, + const TAO_EC_QOS_Info& qos_info, + RtecEventComm::EventType type, + RtecEventComm::Time period); + + /// Destructor. + virtual ~TAO_EC_Timeout_Filter (void); + + /// Return the QOS_Info for this Timeout filter. + const TAO_EC_QOS_Info& qos_info (void) const; + + /// The type of timeout event that we generate. + RtecEventComm::EventType type (void) const; + + /// Callback from the Timeout_Generator + void push_to_proxy (const RtecEventComm::EventSet& event, + TAO_EC_QOS_Info& qos_info); + + // = The TAO_EC_Filter methods, please check the documentation in + // TAO_EC_Filter. + virtual int filter (const RtecEventComm::EventSet& event, + TAO_EC_QOS_Info& qos_info); + virtual int filter_nocopy (RtecEventComm::EventSet& event, + TAO_EC_QOS_Info& qos_info); + virtual void push (const RtecEventComm::EventSet& event, + TAO_EC_QOS_Info& qos_info); + virtual void push_nocopy (RtecEventComm::EventSet& event, + TAO_EC_QOS_Info& qos_info); + virtual void clear (void); + virtual CORBA::ULong max_event_size (void) const; + virtual int can_match (const RtecEventComm::EventHeader& header) const; + virtual int add_dependencies (const RtecEventComm::EventHeader& header, + const TAO_EC_QOS_Info &qos_info); + +private: + TAO_EC_Timeout_Filter (const TAO_EC_Timeout_Filter&); + TAO_EC_Timeout_Filter& operator= (const TAO_EC_Timeout_Filter&); + +private: + /// The event channel. + TAO_EC_Event_Channel_Base* event_channel_; + + /// The supplier that finally receives the timeout event. + TAO_EC_ProxyPushSupplier *supplier_; + + /// Events "generated" by this filter use this QOS_Info. + TAO_EC_QOS_Info qos_info_; + + /// The type of timeout event... + RtecEventComm::EventType type_; + + /// The period for deadline timeouts... + RtecEventComm::Time period_; + + /// The ID of the timeout in the Timeout_Generator, for + /// cancellation. + long id_; +}; + +TAO_END_VERSIONED_NAMESPACE_DECL + +#if defined (__ACE_INLINE__) +#include "orbsvcs/Event/EC_Timeout_Filter.inl" +#endif /* __ACE_INLINE__ */ + +#include /**/ "ace/post.h" + +#endif /* TAO_EC_TIMEOUT_FILTER_H */ |