TAO_RTEvent  2.2.7
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
TAO_EC_Type_Filter Class Reference

A filter based on event type/source. More...

#include <EC_Type_Filter.h>

Inheritance diagram for TAO_EC_Type_Filter:
Inheritance graph
Collaboration diagram for TAO_EC_Type_Filter:
Collaboration graph

Public Member Functions

 TAO_EC_Type_Filter (const RtecEventComm::EventHeader &header)
 Constructor. More...
 
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
 Returns the maximum size of the events pushed by this filter. More...
 
virtual int can_match (const RtecEventComm::EventHeader &header) const
 
virtual int add_dependencies (const RtecEventComm::EventHeader &header, const TAO_EC_QOS_Info &qos_info)
 
- Public Member Functions inherited from TAO_EC_Filter
 TAO_EC_Filter (void)
 constructor... More...
 
virtual ~TAO_EC_Filter (void)
 destructor... More...
 
TAO_EC_Filterparent (void) const
 Obtain the parent of this filter. More...
 
void adopt_child (TAO_EC_Filter *child)
 Become the parent of child. More...
 
virtual ChildrenIterator begin (void) const
 
virtual ChildrenIterator end (void) const
 
virtual int size (void) const
 
virtual void get_qos_info (TAO_EC_QOS_Info &qos_info)
 

Private Member Functions

 TAO_EC_Type_Filter (const TAO_EC_Type_Filter &)
 
TAO_EC_Type_Filteroperator= (const TAO_EC_Type_Filter &)
 
int filter_set (const RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info)
 Filter an EventSet that contains more than one event. More...
 

Private Attributes

RtecEventComm::EventHeader header_
 Encapsulate the type/source that we must match. More...
 

Additional Inherited Members

- Public Types inherited from TAO_EC_Filter
typedef TAO_EC_Filtervalue_type
 
typedef TAO_EC_Filter *const const_value_type
 
typedef const_value_typeChildrenIterator
 
- Static Public Member Functions inherited from TAO_EC_Filter
static int matches (const RtecEventComm::EventHeader &rhs, const RtecEventComm::EventHeader &lhs)
 

Detailed Description

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.

Constructor & Destructor Documentation

TAO_EC_Type_Filter::TAO_EC_Type_Filter ( const RtecEventComm::EventHeader header)

Constructor.

TAO_EC_Type_Filter::TAO_EC_Type_Filter ( const TAO_EC_Type_Filter )
private

Member Function Documentation

int TAO_EC_Type_Filter::add_dependencies ( const RtecEventComm::EventHeader header,
const TAO_EC_QOS_Info qos_info 
)
virtual

This is used for computing the scheduling dependencies:

Leaf filters check if the header could be matched, similar to the can_match() method; if it does they return 1, and 0 otherwise. Intermediate nodes always return 0.

This is used to build precise dependencies between the suppliers and the leaf of the filters that accept that event. Notice that only the nodes doing scheduling recurse through the list, so in configurations that do no require scheduling the recursion stops fairly soon.

Implements TAO_EC_Filter.

int TAO_EC_Type_Filter::can_match ( const RtecEventComm::EventHeader header) const
virtual

Returns 0 if an event with that header could never be accepted. This can used by the suppliers to filter out consumers that couldn't possibly be interested in their events. The rt_info and

Implements TAO_EC_Filter.

void TAO_EC_Type_Filter::clear ( void  )
virtual

Clear any saved state, must reset and assume no events have been received.

Implements TAO_EC_Filter.

int TAO_EC_Type_Filter::filter ( const RtecEventComm::EventSet event,
TAO_EC_QOS_Info qos_info 
)
virtual

Filter this event, returns 1 if the event is accepted, 0 otherwise. Notice that there are two versions of the method, if the event is not const then filter can take ownership of the event.

Attention
There seems to be a disparity in interfaces: Supplier always push event sets of size 1 to the EC_ProxyPushSupplier, and EC_Filters do not implement handling of sets of more than 1 event. Then, why is this not enforced by the interface by having EC_ProxyPushSupplier take an event rather than a set?

Implements TAO_EC_Filter.

int TAO_EC_Type_Filter::filter_nocopy ( RtecEventComm::EventSet event,
TAO_EC_QOS_Info qos_info 
)
virtual

Implements TAO_EC_Filter.

int TAO_EC_Type_Filter::filter_set ( const RtecEventComm::EventSet event,
TAO_EC_QOS_Info qos_info 
)
private

Filter an EventSet that contains more than one event.

CORBA::ULong TAO_EC_Type_Filter::max_event_size ( void  ) const
virtual

Returns the maximum size of the events pushed by this filter.

Implements TAO_EC_Filter.

TAO_EC_Type_Filter& TAO_EC_Type_Filter::operator= ( const TAO_EC_Type_Filter )
private
void TAO_EC_Type_Filter::push ( const RtecEventComm::EventSet event,
TAO_EC_QOS_Info qos_info 
)
virtual

This is called by the children when they accept an event and which to pass it up. Notice that there are two versions of the method, if the event is not const then filter can take ownership of the event.

Implements TAO_EC_Filter.

void TAO_EC_Type_Filter::push_nocopy ( RtecEventComm::EventSet event,
TAO_EC_QOS_Info qos_info 
)
virtual

Implements TAO_EC_Filter.

Member Data Documentation

RtecEventComm::EventHeader TAO_EC_Type_Filter::header_
private

Encapsulate the type/source that we must match.


The documentation for this class was generated from the following files: