TAO_EC_Bitmask_Filter Class Reference

The bitmask filter. More...

#include <EC_Bitmask_Filter.h>

Inheritance diagram for TAO_EC_Bitmask_Filter:

[legend]Collaboration diagram for TAO_EC_Bitmask_Filter:


Public Member Functions
	TAO_EC_Bitmask_Filter (CORBA::ULong source_mask, CORBA::ULong type_mask, TAO_EC_Filter *child)
virtual	~TAO_EC_Bitmask_Filter (void)
	Destructor.
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)
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.
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 Member Functions
	TAO_EC_Bitmask_Filter (const TAO_EC_Bitmask_Filter &)
TAO_EC_Bitmask_Filter &	operator= (const TAO_EC_Bitmask_Filter &)
Private Attributes
CORBA::ULong	source_mask_
	The bitmasks.
CORBA::ULong	type_mask_
TAO_EC_Filter *	child_
	The children.

Detailed Description

The bitmask filter.

This filter quickly rejects events that do not match a given bitmask. If the event is not rejected based on the mask then the child is consulted to finally accept or reject the event. When composed with the Null_Filter it accepts any events that satisfy: (event.header.type & type_mask) != 0 && (event.header.type & source_mask) != 0

Memory Management

It assumes ownership of the child.

Definition at line 46 of file EC_Bitmask_Filter.h.

Constructor & Destructor Documentation

TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO_EC_Bitmask_Filter::TAO_EC_Bitmask_Filter	(	CORBA::ULong	source_mask,
		CORBA::ULong	type_mask,
		TAO_EC_Filter *	child
	)

Constructor. Events that do not satisfy:

(e.header.source & source_mask) != 0 && (e.header.type & type_mask) != 0

are immediately rejected, other events are recursively tested using the child node. It assumes ownership of the child.

Definition at line 9 of file EC_Bitmask_Filter.cpp.

00012   :  source_mask_ (source_mask),
00013      type_mask_ (type_mask),
00014      child_ (child)
00015 {
00016   this->adopt_child (this->child_);
00017 }

TAO_EC_Bitmask_Filter::~TAO_EC_Bitmask_Filter ( void ) [virtual]

Destructor.

Definition at line 19 of file EC_Bitmask_Filter.cpp.

References child_.

00020 {
00021   delete this->child_;
00022 }

TAO_EC_Bitmask_Filter::TAO_EC_Bitmask_Filter ( const TAO_EC_Bitmask_Filter & ) [private]

Member Function Documentation

int TAO_EC_Bitmask_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.

Definition at line 110 of file EC_Bitmask_Filter.cpp.

00113 {
00114   return 0;
00115 }

TAO_EC_Filter::ChildrenIterator TAO_EC_Bitmask_Filter::begin ( void ) const [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 from TAO_EC_Filter.

Definition at line 25 of file EC_Bitmask_Filter.cpp.

References child_.

00026 {
00027   return const_cast<TAO_EC_Filter**> (&this->child_);
00028 }

int TAO_EC_Bitmask_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.

Definition at line 99 of file EC_Bitmask_Filter.cpp.

References TAO_EC_Filter::can_match(), child_, RtecEventComm::EventHeader::source, and RtecEventComm::EventHeader::type.

00101 {
00102   if ((header.type & this->type_mask_) == 0
00103       || (header.source & this->source_mask_) == 0)
00104     return 0;
00105 
00106   return this->child_->can_match (header);
00107 }

void TAO_EC_Bitmask_Filter::clear ( void ) [virtual]

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

Implements TAO_EC_Filter.

Definition at line 87 of file EC_Bitmask_Filter.cpp.

References child_, and TAO_EC_Filter::clear().

00088 {
00089   this->child_->clear ();
00090 }

TAO_EC_Filter::ChildrenIterator TAO_EC_Bitmask_Filter::end ( void ) const [virtual]

Reimplemented from TAO_EC_Filter.

Definition at line 31 of file EC_Bitmask_Filter.cpp.

References child_.

00032 {
00033   return const_cast<TAO_EC_Filter**> (&this->child_) + 1;
00034 }

int TAO_EC_Bitmask_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.

Definition at line 43 of file EC_Bitmask_Filter.cpp.

References child_, and TAO_EC_Filter::filter().

00045 {
00046   if (event.length () != 1)
00047     return 0;
00048 
00049   if ((event[0].header.type & this->type_mask_) == 0
00050       || (event[0].header.source & this->source_mask_) == 0)
00051     return 0;
00052 
00053   return this->child_->filter (event, qos_info);
00054 }

int TAO_EC_Bitmask_Filter::filter_nocopy	(	RtecEventComm::EventSet &	event,
		TAO_EC_QOS_Info &	qos_info
	)			`[virtual]`

Implements TAO_EC_Filter.

Definition at line 57 of file EC_Bitmask_Filter.cpp.

References child_, and TAO_EC_Filter::filter_nocopy().

00059 {
00060   if (event.length () != 1)
00061     return 0;
00062 
00063   if ((event[0].header.type & this->type_mask_) == 0
00064       || (event[0].header.source & this->source_mask_) == 0)
00065     return 0;
00066 
00067   return this->child_->filter_nocopy (event, qos_info);
00068 }

CORBA::ULong TAO_EC_Bitmask_Filter::max_event_size ( void ) const [virtual]

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

Implements TAO_EC_Filter.

Definition at line 93 of file EC_Bitmask_Filter.cpp.

References child_, and TAO_EC_Filter::max_event_size().

00094 {
00095   return this->child_->max_event_size ();
00096 }

TAO_EC_Bitmask_Filter& TAO_EC_Bitmask_Filter::operator= ( const TAO_EC_Bitmask_Filter & ) [private]

void TAO_EC_Bitmask_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.

Definition at line 71 of file EC_Bitmask_Filter.cpp.

00073 {
00074   if (this->parent () != 0)
00075     this->parent ()->push (event, qos_info);
00076 }

void TAO_EC_Bitmask_Filter::push_nocopy	(	RtecEventComm::EventSet &	event,
		TAO_EC_QOS_Info &	qos_info
	)			`[virtual]`

Implements TAO_EC_Filter.

Definition at line 79 of file EC_Bitmask_Filter.cpp.

00081 {
00082   if (this->parent () != 0)
00083     this->parent ()->push_nocopy (event, qos_info);
00084 }

int TAO_EC_Bitmask_Filter::size ( void ) const [virtual]

Reimplemented from TAO_EC_Filter.

Definition at line 37 of file EC_Bitmask_Filter.cpp.

00038 {
00039   return 1;
00040 }

Member Data Documentation

TAO_EC_Filter* TAO_EC_Bitmask_Filter::child_ [private]

The children.

Definition at line 96 of file EC_Bitmask_Filter.h.

Referenced by begin(), can_match(), clear(), end(), filter(), filter_nocopy(), max_event_size(), and ~TAO_EC_Bitmask_Filter().

CORBA::ULong TAO_EC_Bitmask_Filter::source_mask_ [private]

The bitmasks.

Definition at line 92 of file EC_Bitmask_Filter.h.

CORBA::ULong TAO_EC_Bitmask_Filter::type_mask_ [private]

Definition at line 93 of file EC_Bitmask_Filter.h.

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

Generated on Tue Feb 2 17:44:26 2010 for TAO_RTEvent by

1.4.7

TAO_EC_Bitmask_Filter Class Reference

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Memory Management

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation