TAO_Notify_Event Class Reference

Base class abstraction for Events flowing through the EventChannel. More...

#include <Event.h>

Inheritance diagram for TAO_Notify_Event:

Collaboration diagram for TAO_Notify_Event:

List of all members.

Public Types

enum { MARSHAL_ANY = 1, MARSHAL_STRUCTURED = 2 }

typedef
TAO_Notify_Refcountable_Guard_T
< TAO_Notify_Event > Ptr

Public Member Functions

TAO_Notify_Event (void)

Constructor.

virtual ~TAO_Notify_Event ()

Destructor.

virtual const
TAO_Notify_EventType & type (void) const =0

Get the event type.

virtual CORBA::Boolean do_match (CosNotifyFilter::Filter_ptr filter) const =0

Returns true if the filter matches.

virtual void convert (CosNotification::StructuredEvent &notification) const =0

Convert to CosNotification::Structured type.

virtual void push (TAO_Notify_Consumer *consumer) const =0

Push event to consumer.

virtual void push (Event_Forwarder::StructuredProxyPushSupplier_ptr forwarder) const =0

Push event to the Event_Forwarder interface.

virtual void push_no_filtering (Event_Forwarder::StructuredProxyPushSupplier_ptr forwarder) const =0

Push event to the Event_Forwarder interface.

virtual void push (Event_Forwarder::ProxyPushSupplier_ptr forwarder) const =0

Push event to the Event_Forwarder interface.

virtual void push_no_filtering (Event_Forwarder::ProxyPushSupplier_ptr forwarder) const =0

Push event to the Event_Forwarder interface.

TAO_Notify_Event * queueable_copy (void) const

virtual void marshal (TAO_OutputCDR &cdr) const =0

marshal this event into a CDR buffer (for persistence)

const TAO_Notify_Property_Short & priority (void) const

const TAO_Notify_Property_Time & timeout (void) const

Timeout.

const TAO_Notify_Property_Boolean & reliable (void) const

Reliable.

const ACE_Time_Value & creation_time (void) const

Event creation time.

Static Public Member Functions

static void translate (const CORBA::Any &any, CosNotification::StructuredEvent &notification)

Translate Any to Structured.

static void translate (const CosNotification::StructuredEvent &notification, CORBA::Any &any)

Translate Structured to Any.

static TAO_Notify_Event * unmarshal (TAO_InputCDR &cdr)

Unmarshal an event from a CDR. (for persistence).

Protected Attributes

TAO_Notify_Property_Short priority_

= QoS properties

TAO_Notify_Property_Time timeout_

Timeout.

TAO_Notify_Property_Boolean reliable_

Reliability.

Private Member Functions

virtual TAO_Notify_Event * copy (void) const =0

Return a pointer to a copy of this event on the heap.

virtual void release (void)

The release method is called when the refcount reaches 0.

Private Attributes

Ptr clone_

bool is_on_heap_

ACE_Time_Value time_

Detailed Description

Base class abstraction for Events flowing through the EventChannel.

Member Typedef Documentation

typedef TAO_Notify_Refcountable_Guard_T<TAO_Notify_Event> TAO_Notify_Event::Ptr

Reimplemented from TAO_Notify_Refcountable.

Member Enumeration Documentation

anonymous enum

Enumerator:

MARSHAL_ANY
MARSHAL_STRUCTURED

Constructor & Destructor Documentation

TAO_Notify_Event::TAO_Notify_Event ( void )

Constructor.

TAO_Notify_Event::~TAO_Notify_Event ( ) [virtual]

Destructor.

Member Function Documentation

virtual void TAO_Notify_Event::convert ( CosNotification::StructuredEvent & notification ) const [pure virtual]

Convert to CosNotification::Structured type.

Implemented in TAO_Notify_AnyEvent_No_Copy, and TAO_Notify_StructuredEvent_No_Copy.

virtual TAO_Notify_Event* TAO_Notify_Event::copy ( void ) const [private, pure virtual]

Return a pointer to a copy of this event on the heap.

Implemented in TAO_Notify_AnyEvent_No_Copy, and TAO_Notify_StructuredEvent_No_Copy.

const ACE_Time_Value & TAO_Notify_Event::creation_time ( void ) const

Event creation time.

virtual CORBA::Boolean TAO_Notify_Event::do_match ( CosNotifyFilter::Filter_ptr filter ) const [pure virtual]

Returns true if the filter matches.

Implemented in TAO_Notify_AnyEvent_No_Copy, and TAO_Notify_StructuredEvent_No_Copy.

virtual void TAO_Notify_Event::marshal ( TAO_OutputCDR & cdr ) const [pure virtual]

marshal this event into a CDR buffer (for persistence)

Implemented in TAO_Notify_AnyEvent_No_Copy, and TAO_Notify_StructuredEvent_No_Copy.

const TAO_Notify_Property_Short & TAO_Notify_Event::priority ( void ) const

= Accessors Priority

virtual void TAO_Notify_Event::push ( Event_Forwarder::ProxyPushSupplier_ptr forwarder ) const [pure virtual]

Push event to the Event_Forwarder interface.

Implemented in TAO_Notify_AnyEvent_No_Copy, and TAO_Notify_StructuredEvent_No_Copy.

virtual void TAO_Notify_Event::push ( Event_Forwarder::StructuredProxyPushSupplier_ptr forwarder ) const [pure virtual]

Push event to the Event_Forwarder interface.

Implemented in TAO_Notify_AnyEvent_No_Copy, and TAO_Notify_StructuredEvent_No_Copy.

virtual void TAO_Notify_Event::push ( TAO_Notify_Consumer * consumer ) const [pure virtual]

Push event to consumer.

Implemented in TAO_Notify_AnyEvent_No_Copy, and TAO_Notify_StructuredEvent_No_Copy.

virtual void TAO_Notify_Event::push_no_filtering ( Event_Forwarder::ProxyPushSupplier_ptr forwarder ) const [pure virtual]

Push event to the Event_Forwarder interface.

Implemented in TAO_Notify_AnyEvent_No_Copy, and TAO_Notify_StructuredEvent_No_Copy.

virtual void TAO_Notify_Event::push_no_filtering ( Event_Forwarder::StructuredProxyPushSupplier_ptr forwarder ) const [pure virtual]

Push event to the Event_Forwarder interface.

Implemented in TAO_Notify_AnyEvent_No_Copy, and TAO_Notify_StructuredEvent_No_Copy.

TAO_Notify_Event * TAO_Notify_Event::queueable_copy ( void ) const

Return a pointer to a copy of this event on the heap. The event is not owned by the caller, so it should not be deleted or released.

void TAO_Notify_Event::release ( void ) [private, virtual]

The release method is called when the refcount reaches 0.

Implements TAO_Notify_Refcountable.

const TAO_Notify_Property_Boolean & TAO_Notify_Event::reliable ( void ) const

Reliable.

const TAO_Notify_Property_Time & TAO_Notify_Event::timeout ( void ) const

Timeout.

void TAO_Notify_Event::translate	(	const CosNotification::StructuredEvent &	notification,
		CORBA::Any &	any
	)			`[static]`

Translate Structured to Any.

void TAO_Notify_Event::translate	(	const CORBA::Any &	any,
		CosNotification::StructuredEvent &	notification
	)			`[static]`

Translate Any to Structured.

virtual const TAO_Notify_EventType& TAO_Notify_Event::type ( void ) const [pure virtual]

Get the event type.

Implemented in TAO_Notify_AnyEvent_No_Copy, and TAO_Notify_StructuredEvent_No_Copy.

TAO_Notify_Event * TAO_Notify_Event::unmarshal ( TAO_InputCDR & cdr ) [static]

Unmarshal an event from a CDR. (for persistence).

Reimplemented in TAO_Notify_AnyEvent_No_Copy, and TAO_Notify_StructuredEvent_No_Copy.

Member Data Documentation

Ptr TAO_Notify_Event::clone_ [mutable, private]

bool TAO_Notify_Event::is_on_heap_ [private]

TAO_Notify_Property_Short TAO_Notify_Event::priority_ [protected]

= QoS properties

Priority.

TAO_Notify_Property_Boolean TAO_Notify_Event::reliable_ [protected]

Reliability.

ACE_Time_Value TAO_Notify_Event::time_ [private]

TAO_Notify_Property_Time TAO_Notify_Event::timeout_ [protected]

Timeout.

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


Public Types
enum	{ MARSHAL_ANY = 1, MARSHAL_STRUCTURED = 2 }
typedef TAO_Notify_Refcountable_Guard_T < TAO_Notify_Event >	Ptr
Public Member Functions
	TAO_Notify_Event (void)
	Constructor.
virtual	~TAO_Notify_Event ()
	Destructor.
virtual const TAO_Notify_EventType &	type (void) const =0
	Get the event type.
virtual CORBA::Boolean	do_match (CosNotifyFilter::Filter_ptr filter) const =0
	Returns true if the filter matches.
virtual void	convert (CosNotification::StructuredEvent &notification) const =0
	Convert to CosNotification::Structured type.
virtual void	push (TAO_Notify_Consumer *consumer) const =0
	Push event to consumer.
virtual void	push (Event_Forwarder::StructuredProxyPushSupplier_ptr forwarder) const =0
	Push event to the Event_Forwarder interface.
virtual void	push_no_filtering (Event_Forwarder::StructuredProxyPushSupplier_ptr forwarder) const =0
	Push event to the Event_Forwarder interface.
virtual void	push (Event_Forwarder::ProxyPushSupplier_ptr forwarder) const =0
	Push event to the Event_Forwarder interface.
virtual void	push_no_filtering (Event_Forwarder::ProxyPushSupplier_ptr forwarder) const =0
	Push event to the Event_Forwarder interface.
TAO_Notify_Event *	queueable_copy (void) const
virtual void	marshal (TAO_OutputCDR &cdr) const =0
	marshal this event into a CDR buffer (for persistence)
const TAO_Notify_Property_Short &	priority (void) const
const TAO_Notify_Property_Time &	timeout (void) const
	Timeout.
const TAO_Notify_Property_Boolean &	reliable (void) const
	Reliable.
const ACE_Time_Value &	creation_time (void) const
	Event creation time.
Static Public Member Functions
static void	translate (const CORBA::Any &any, CosNotification::StructuredEvent &notification)
	Translate Any to Structured.
static void	translate (const CosNotification::StructuredEvent &notification, CORBA::Any &any)
	Translate Structured to Any.
static TAO_Notify_Event *	unmarshal (TAO_InputCDR &cdr)
	Unmarshal an event from a CDR. (for persistence).
Protected Attributes
TAO_Notify_Property_Short	priority_
	= QoS properties
TAO_Notify_Property_Time	timeout_
	Timeout.
TAO_Notify_Property_Boolean	reliable_
	Reliability.
Private Member Functions
virtual TAO_Notify_Event *	copy (void) const =0
	Return a pointer to a copy of this event on the heap.
virtual void	release (void)
	The release method is called when the refcount reaches 0.
Private Attributes
Ptr	clone_
bool	is_on_heap_
ACE_Time_Value	time_