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:

Public Types
enum	{ MARSHAL_ANY =1 , MARSHAL_STRUCTURED =2 }
typedef TAO_Notify_Refcountable_Guard_T< TAO_Notify_Event >	Ptr
Public Types inherited from TAO_Notify_Refcountable
typedef TAO_Notify_Refcountable_Guard_T< TAO_Notify_Refcountable >	Ptr

Public Member Functions
	TAO_Notify_Event ()
	Constructor.
virtual	~TAO_Notify_Event ()
	Destructor.
virtual const TAO_Notify_EventType &	type () 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 () const
virtual void	marshal (TAO_OutputCDR &cdr) const =0
	marshal this event into a CDR buffer (for persistence)
const TAO_Notify_Property_Short &	priority () const
const TAO_Notify_Property_Time &	timeout () const
	Timeout.
const TAO_Notify_Property_Boolean &	reliable () const
	Reliable.
const ACE_Time_Value &	creation_time () const
	Event creation time.
Public Member Functions inherited from TAO_Notify_Refcountable
	TAO_Notify_Refcountable ()
	Constructor.
virtual	~TAO_Notify_Refcountable ()
CORBA::ULong	_incr_refcnt ()
CORBA::ULong	_decr_refcnt ()

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 () const =0
	Return a pointer to a copy of this event on the heap.
virtual void	release ()
	The release method is called when the refcount reaches 0.
Private Member Functions inherited from ACE_Copy_Disabled
	ACE_Copy_Disabled ()

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

Ptr

typedef TAO_Notify_Refcountable_Guard_T<TAO_Notify_Event> TAO_Notify_Event::Ptr

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
MARSHAL_ANY
MARSHAL_STRUCTURED

Constructor & Destructor Documentation

TAO_Notify_Event()

TAO_Notify_Event::TAO_Notify_Event

(

)

Constructor.

~TAO_Notify_Event()

TAO_Notify_Event::~TAO_Notify_Event ( )

virtual

Destructor.

Member Function Documentation

convert()

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.

copy()

virtual TAO_Notify_Event * TAO_Notify_Event::copy ( ) const

privatepure 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.

creation_time()

const ACE_Time_Value & TAO_Notify_Event::creation_time

(

)

const

Event creation time.

do_match()

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.

marshal()

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.

priority()

const TAO_Notify_Property_Short & TAO_Notify_Event::priority

(

)

const

= Accessors Priority

push() [1/3]

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.

push() [2/3]

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.

push() [3/3]

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.

push_no_filtering() [1/2]

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.

push_no_filtering() [2/2]

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.

queueable_copy()

TAO_Notify_Event * TAO_Notify_Event::queueable_copy

(

)

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.

release()

void TAO_Notify_Event::release ( )

privatevirtual

The release method is called when the refcount reaches 0.

Implements TAO_Notify_Refcountable.

reliable()

const TAO_Notify_Property_Boolean & TAO_Notify_Event::reliable

(

)

const

Reliable.

timeout()

const TAO_Notify_Property_Time & TAO_Notify_Event::timeout

(

)

const

Timeout.

translate() [1/2]

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

static

Translate Any to Structured.

translate() [2/2]

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

static

Translate Structured to Any.

type()

virtual const TAO_Notify_EventType & TAO_Notify_Event::type ( ) const

pure virtual

Get the event type.

Implemented in TAO_Notify_AnyEvent_No_Copy, and TAO_Notify_StructuredEvent_No_Copy.

unmarshal()

TAO_Notify_Event * TAO_Notify_Event::unmarshal ( TAO_InputCDR & cdr )

static

Unmarshal an event from a CDR. (for persistence)

Member Data Documentation

clone_

Ptr TAO_Notify_Event::clone_

mutableprivate

is_on_heap_

bool TAO_Notify_Event::is_on_heap_

private

priority_

TAO_Notify_Property_Short TAO_Notify_Event::priority_

protected

= QoS properties

Priority.

reliable_

TAO_Notify_Property_Boolean TAO_Notify_Event::reliable_

protected

Reliability.

time_

ACE_Time_Value TAO_Notify_Event::time_

private

timeout_

TAO_Notify_Property_Time TAO_Notify_Event::timeout_

protected

Timeout.

---

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

• Event.h
• Event.cpp
• Event.inl