TAO_Notify_AdminProperties Class Reference

The AdminProperties per EventChannel. More...

#include <AdminProperties.h>

Inheritance diagram for TAO_Notify_AdminProperties:

[legend]Collaboration diagram for TAO_Notify_AdminProperties:

[legend]List of all members.

Public Types
typedef ACE_Strong_Bound_Ptr< TAO_Notify_AdminProperties, TAO_SYNCH_MUTEX >	Ptr
Public Member Functions
	TAO_Notify_AdminProperties (void)
	Constuctor.
virtual	~TAO_Notify_AdminProperties ()
	Destructor.
int	init (const CosNotification::PropertySeq &prop_seq)
	Return 0 on success, -1 on error.
void	init ()
const TAO_Notify_Property_Long &	max_global_queue_length (void) const
const TAO_Notify_Property_Long &	max_consumers (void) const
const TAO_Notify_Property_Long &	max_suppliers (void) const
const TAO_Notify_Property_Boolean &	reject_new_events (void) const
TAO_Notify_Property_Long &	max_global_queue_length (void)
TAO_Notify_Property_Long &	max_consumers (void)
TAO_Notify_Property_Long &	max_suppliers (void)
TAO_Notify_Property_Boolean &	reject_new_events (void)
CORBA::Long &	global_queue_length (void)
TAO_SYNCH_MUTEX &	global_queue_lock (void)
TAO_SYNCH_CONDITION &	global_queue_not_full (void)
TAO_Notify_Atomic_Property_Long &	consumers (void)
TAO_Notify_Atomic_Property_Long &	suppliers (void)
CORBA::Boolean	queue_full (void)
	Returns true if Queue is full.
Protected Attributes
TAO_Notify_Property_Long	max_global_queue_length_
TAO_Notify_Property_Long	max_consumers_
TAO_Notify_Property_Long	max_suppliers_
TAO_Notify_Property_Boolean	reject_new_events_
	Reject any new event.
CORBA::Long	global_queue_length_
TAO_SYNCH_MUTEX	global_queue_lock_
	Global queue lock used to serialize access to all queues.
TAO_SYNCH_CONDITION	global_queue_not_full_
	The condition that the queue_length_ is not at max.
TAO_Notify_Atomic_Property_Long	consumers_
TAO_Notify_Atomic_Property_Long	suppliers_

---

Detailed Description

The AdminProperties per EventChannel.

---

Member Typedef Documentation

typedef ACE_Strong_Bound_Ptr<TAO_Notify_AdminProperties, TAO_SYNCH_MUTEX> TAO_Notify_AdminProperties::Ptr

---

Constructor & Destructor Documentation

TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO_Notify_AdminProperties::TAO_Notify_AdminProperties

(

void

)

Constuctor.

TAO_Notify_AdminProperties::~TAO_Notify_AdminProperties

(

)

[virtual]

Destructor.

---

Member Function Documentation

ACE_INLINE TAO_Notify_Atomic_Property_Long & TAO_Notify_AdminProperties::consumers

(

void

)

ACE_INLINE CORBA::Long & TAO_Notify_AdminProperties::global_queue_length

(

void

)

ACE_INLINE TAO_SYNCH_MUTEX & TAO_Notify_AdminProperties::global_queue_lock

(

void

)

ACE_INLINE TAO_SYNCH_CONDITION & TAO_Notify_AdminProperties::global_queue_not_full

(

void

)

void TAO_Notify_AdminProperties::init

(

)

int TAO_Notify_AdminProperties::init

(

const CosNotification::PropertySeq &

prop_seq

)

Return 0 on success, -1 on error.

Reimplemented from TAO_Notify_PropertySeq.

ACE_INLINE TAO_Notify_Property_Long & TAO_Notify_AdminProperties::max_consumers

(

void

)

ACE_INLINE const TAO_Notify_Property_Long & TAO_Notify_AdminProperties::max_consumers

(

void

)

const

ACE_INLINE TAO_Notify_Property_Long & TAO_Notify_AdminProperties::max_global_queue_length

(

void

)

TAO_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE const TAO_Notify_Property_Long & TAO_Notify_AdminProperties::max_global_queue_length

(

void

)

const

ACE_INLINE TAO_Notify_Property_Long & TAO_Notify_AdminProperties::max_suppliers

(

void

)

ACE_INLINE const TAO_Notify_Property_Long & TAO_Notify_AdminProperties::max_suppliers

(

void

)

const

CORBA::Boolean TAO_Notify_AdminProperties::queue_full

(

void

)

Returns true if Queue is full.

ACE_INLINE TAO_Notify_Property_Boolean & TAO_Notify_AdminProperties::reject_new_events

(

void

)

ACE_INLINE const TAO_Notify_Property_Boolean & TAO_Notify_AdminProperties::reject_new_events

(

void

)

const

ACE_INLINE TAO_Notify_Atomic_Property_Long & TAO_Notify_AdminProperties::suppliers

(

void

)

---

Member Data Documentation

TAO_Notify_Atomic_Property_Long TAO_Notify_AdminProperties::consumers_ [protected]

These are used to count the number of consumers and suppliers connected to the system.

CORBA::Long TAO_Notify_AdminProperties::global_queue_length_ [protected]

This is used to count the queue length across all buffers in the Notify Service to enforce the "MaxQueueLength" property.

TAO_SYNCH_MUTEX TAO_Notify_AdminProperties::global_queue_lock_ [protected]

Global queue lock used to serialize access to all queues.

TAO_SYNCH_CONDITION TAO_Notify_AdminProperties::global_queue_not_full_ [protected]

The condition that the queue_length_ is not at max.

TAO_Notify_Property_Long TAO_Notify_AdminProperties::max_consumers_ [protected]

The maximum number of consumers that can be connected to the channel at any given time.

TAO_Notify_Property_Long TAO_Notify_AdminProperties::max_global_queue_length_ [protected]

The maximum number of events that will be queued by the channel before the channel begins discarding events or rejecting new events upon receipt of each new event.

TAO_Notify_Property_Long TAO_Notify_AdminProperties::max_suppliers_ [protected]

The maximum number of suppliers that can be connected to the channel at any given time.

TAO_Notify_Property_Boolean TAO_Notify_AdminProperties::reject_new_events_ [protected]

Reject any new event.

TAO_Notify_Atomic_Property_Long TAO_Notify_AdminProperties::suppliers_ [protected]

---

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

• AdminProperties.h
• AdminProperties.cpp
• AdminProperties.inl

---