TAO_RTEvent
2.3.3
|
Abstract base class for the filter hierarchy. More...
#include <EC_Filter.h>
Public Types | |
typedef TAO_EC_Filter * | value_type |
typedef TAO_EC_Filter *const | const_value_type |
typedef const_value_type * | ChildrenIterator |
Public Member Functions | |
TAO_EC_Filter (void) | |
constructor... More... | |
virtual | ~TAO_EC_Filter (void) |
destructor... More... | |
TAO_EC_Filter * | parent (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 int | filter (const RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info)=0 |
virtual int | filter_nocopy (RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info)=0 |
virtual void | push (const RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info)=0 |
virtual void | push_nocopy (RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info)=0 |
virtual void | clear (void)=0 |
virtual CORBA::ULong | max_event_size (void) const =0 |
Returns the maximum size of the events pushed by this filter. More... | |
virtual int | can_match (const RtecEventComm::EventHeader &header) const =0 |
virtual int | add_dependencies (const RtecEventComm::EventHeader &header, const TAO_EC_QOS_Info &qos_info)=0 |
virtual void | get_qos_info (TAO_EC_QOS_Info &qos_info) |
Static Public Member Functions | |
static int | matches (const RtecEventComm::EventHeader &rhs, const RtecEventComm::EventHeader &lhs) |
Private Attributes | |
TAO_EC_Filter * | parent_ |
The parent... More... | |
Abstract base class for the filter hierarchy.
The per-consumer filtering mechanisms. The EC needs to filter data passed to the consumers, so it can correctly satisfy its subscription requirements. This filtering can include correlations, sequences, timeouts, etc. each consumer can request different filtering criteria. Different filtering objects are associated with each consumer, the filters are organized in a hierarchical structure, corresponding to the subscription "expression" that the events must satisfy. The hierarchy is constructed using the "Builder" pattern.
It does not assume ownership of its parent.
typedef TAO_EC_Filter* const TAO_EC_Filter::const_value_type |
typedef TAO_EC_Filter* TAO_EC_Filter::value_type |
TAO_EC_Filter::TAO_EC_Filter | ( | void | ) |
constructor...
|
virtual |
destructor...
|
pure 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.
Implemented in TAO_EC_Null_Filter, TAO_EC_ProxyPushSupplier, TAO_EC_Bitmask_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Sched_Filter, TAO_EC_Timeout_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Disjunction_Filter, TAO_EC_And_Filter, TAO_EC_Negation_Filter, and TAO_EC_Type_Filter.
void TAO_EC_Filter::adopt_child | ( | TAO_EC_Filter * | child | ) |
Become the parent of child.
|
virtual |
STL-like iterators Filters follow the Composite pattern. All filters expose the same interface as if they all had children, but for simple filters the iterators return an empty range.
Reimplemented in TAO_EC_Bitmask_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Sched_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Disjunction_Filter, TAO_EC_And_Filter, and TAO_EC_Negation_Filter.
|
pure 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
Implemented in TAO_EC_Null_Filter, TAO_EC_ProxyPushSupplier, TAO_EC_Bitmask_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Sched_Filter, TAO_EC_Timeout_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Disjunction_Filter, TAO_EC_And_Filter, TAO_EC_Negation_Filter, and TAO_EC_Type_Filter.
|
pure virtual |
Clear any saved state, must reset and assume no events have been received.
Implemented in TAO_EC_Null_Filter, TAO_EC_ProxyPushSupplier, TAO_EC_Bitmask_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Sched_Filter, TAO_EC_Timeout_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Disjunction_Filter, TAO_EC_And_Filter, TAO_EC_Negation_Filter, and TAO_EC_Type_Filter.
|
virtual |
|
pure 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.
Implemented in TAO_EC_Null_Filter, TAO_EC_ProxyPushSupplier, TAO_EC_Bitmask_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Sched_Filter, TAO_EC_Timeout_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Disjunction_Filter, TAO_EC_And_Filter, TAO_EC_Negation_Filter, and TAO_EC_Type_Filter.
|
pure virtual |
|
virtual |
Obtain the QOS information for this filter, the default implementation returns an invalid QOS. Only the filters that support scheduling information implement this method.
Reimplemented in TAO_EC_Kokyu_Filter, and TAO_EC_Sched_Filter.
|
static |
Matches two event headers.
|
pure virtual |
Returns the maximum size of the events pushed by this filter.
Implemented in TAO_EC_Null_Filter, TAO_EC_ProxyPushSupplier, TAO_EC_Bitmask_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Sched_Filter, TAO_EC_Timeout_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Disjunction_Filter, TAO_EC_And_Filter, TAO_EC_Negation_Filter, and TAO_EC_Type_Filter.
TAO_EC_Filter * TAO_EC_Filter::parent | ( | void | ) | const |
Obtain the parent of this filter.
|
pure 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.
Implemented in TAO_EC_Null_Filter, TAO_EC_ProxyPushSupplier, TAO_EC_Bitmask_Filter, TAO_EC_Kokyu_Filter, TAO_EC_Sched_Filter, TAO_EC_Timeout_Filter, TAO_EC_Conjunction_Filter, TAO_EC_Masked_Type_Filter, TAO_EC_Disjunction_Filter, TAO_EC_And_Filter, TAO_EC_Negation_Filter, and TAO_EC_Type_Filter.
|
pure virtual |
|
virtual |
|
private |
The parent...