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

#include <EC_Timeout_Filter.h>

Inheritance diagram for TAO_EC_Timeout_Filter:

Collaboration diagram for TAO_EC_Timeout_Filter:

Public Member Functions
	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)
	Constructor.

virtual	~TAO_EC_Timeout_Filter (void)
	Destructor.

const TAO_EC_QOS_Info &	qos_info (void) const
	Return the QOS_Info for this Timeout filter.

RtecEventComm::EventType	type (void) const
	The type of timeout event that we generate.

void	push_to_proxy (const RtecEventComm::EventSet &event, TAO_EC_QOS_Info &qos_info)
	Callback from the Timeout_Generator.

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)

Public Member Functions inherited from TAO_EC_Filter
	TAO_EC_Filter (void)
	constructor...

virtual	~TAO_EC_Filter (void)
	destructor...

TAO_EC_Filter *	parent (void) const
	Obtain the parent of this filter.

void	adopt_child (TAO_EC_Filter *child)
	Become the parent of child.

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_Timeout_Filter (const TAO_EC_Timeout_Filter &)

TAO_EC_Timeout_Filter &	operator= (const TAO_EC_Timeout_Filter &)

Private Attributes
TAO_EC_Event_Channel_Base *	event_channel_
	The event channel.

TAO_EC_ProxyPushSupplier *	supplier_
	The supplier that finally receives the timeout event.

TAO_EC_QOS_Info	qos_info_
	Events "generated" by this filter use this QOS_Info.

RtecEventComm::EventType	type_
	The type of timeout event...

RtecEventComm::Time	period_
	The period for deadline timeouts...

long	id_

Additional Inherited Members
Public Types inherited from TAO_EC_Filter
typedef TAO_EC_Filter *	value_type

typedef TAO_EC_Filter *const	const_value_type

typedef const_value_type *	ChildrenIterator

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_Timeout_Filter::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
	)

Constructor.

TAO_EC_Timeout_Filter::~TAO_EC_Timeout_Filter ( void )

virtual

Destructor.

TAO_EC_Timeout_Filter::TAO_EC_Timeout_Filter ( const TAO_EC_Timeout_Filter & )

private

Member Function Documentation

int TAO_EC_Timeout_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_Timeout_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_Timeout_Filter::clear ( void )

virtual

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

Implements TAO_EC_Filter.

int TAO_EC_Timeout_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_Timeout_Filter::filter_nocopy	(	RtecEventComm::EventSet &	event,
		TAO_EC_QOS_Info &	qos_info
	)

virtual

Implements TAO_EC_Filter.

CORBA::ULong TAO_EC_Timeout_Filter::max_event_size ( void ) const

virtual

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

Implements TAO_EC_Filter.

TAO_EC_Timeout_Filter& TAO_EC_Timeout_Filter::operator= ( const TAO_EC_Timeout_Filter & )

private

void TAO_EC_Timeout_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_Timeout_Filter::push_nocopy	(	RtecEventComm::EventSet &	event,
		TAO_EC_QOS_Info &	qos_info
	)

virtual

Implements TAO_EC_Filter.

void TAO_EC_Timeout_Filter::push_to_proxy	(	const RtecEventComm::EventSet &	event,
		TAO_EC_QOS_Info &	qos_info
	)

Callback from the Timeout_Generator.

const TAO_EC_QOS_Info & TAO_EC_Timeout_Filter::qos_info ( void ) const

Return the QOS_Info for this Timeout filter.

RtecEventComm::EventType TAO_EC_Timeout_Filter::type ( void ) const

The type of timeout event that we generate.

Member Data Documentation

TAO_EC_Event_Channel_Base* TAO_EC_Timeout_Filter::event_channel_

private

The event channel.

long TAO_EC_Timeout_Filter::id_

private

The ID of the timeout in the Timeout_Generator, for cancellation.

RtecEventComm::Time TAO_EC_Timeout_Filter::period_

private

The period for deadline timeouts...

TAO_EC_QOS_Info TAO_EC_Timeout_Filter::qos_info_

private

Events "generated" by this filter use this QOS_Info.

TAO_EC_ProxyPushSupplier* TAO_EC_Timeout_Filter::supplier_

private

The supplier that finally receives the timeout event.

RtecEventComm::EventType TAO_EC_Timeout_Filter::type_

private

The type of timeout event...

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation