The bitmask filter. More...

#include <EC_Bitmask_Filter.h>

Inheritance diagram for TAO_EC_Bitmask_Filter:

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.

Constructor & Destructor Documentation

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.

TAO_EC_Bitmask_Filter::~TAO_EC_Bitmask_Filter ( void ) [virtual]

Destructor.

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.

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.

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.

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.

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

Reimplemented from TAO_EC_Filter.

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.

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

Implements TAO_EC_Filter.

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.

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.