Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Search for 

CosNotification Namespace Reference

Define basic data structures used by the Notification Service. More...


Classes

struct  Property
 Define a name/value pair. More...

struct  _EventType
 Define event type names. More...

struct  PropertyRange
 A structure to define property ranges. More...

struct  NamedPropertyRange
 A named property range. More...

struct  PropertyError
 Describe the problems detected with an application requested QoS. More...

exception  UnsupportedQoS
 Exception used to describe problems with one or more QoS requests. More...

exception  UnsupportedAdmin
 Exception used to describe problems with one or more Admin properties. More...

struct  FixedEventHeader
 Define the 'fixed' part of the event header. More...

struct  EventHeader
 Complete event header. More...

struct  StructuredEvent
 Define structured events. More...

interface  QoSAdmin
 Interface used to control the QoS properties of an Event Service components (Channel, Proxy, etc.). More...

interface  AdminPropertiesAdmin
 Define the interface to manipulate the Admin properties of a Notification Service components. More...


Different kinds of property sequences

The following are all sequences of Property, but serve different purposes.

typedef PropertySeq OptionalHeaderFields
 Property sequence used for optional header fields.

typedef PropertySeq FilterableEventBody
typedef PropertySeq QoSProperties
 Specify quality of service properties.

typedef PropertySeq AdminProperties
 Specify administrative properties.


Constants for QoS Properties

The following constant declarations define the standard QoS property names and the associated values each property can take on. The name/value pairs for each standard property are grouped, beginning with a string constant defined for the property name, followed by the values the property can take on.

const string EventReliability = "EventReliability"
const short BestEffort = 0
const short Persistent = 1
const string ConnectionReliability = "ConnectionReliability"
 Can take on the same values as EventReliability.

const string Priority = "Priority"
const short LowestPriority = -32767
const short HighestPriority = 32767
const short DefaultPriority = 0
const string StartTime = "StartTime"
 StartTime takes a value of type TimeBase::UtcT.

const string StopTime = "StopTime"
 StopTime takes a value of type TimeBase::UtcT.

const string Timeout = "Timeout"
 Timeout takes on a value of type TimeBase::TimeT.

const string OrderPolicy = "OrderPolicy"
const short AnyOrder = 0
const short FifoOrder = 1
const short PriorityOrder = 2
const short DeadlineOrder = 3
const string DiscardPolicy = "DiscardPolicy"
 DiscardPolicy takes on the same values as OrderPolicy, plus.

const short LifoOrder = 4
const string MaximumBatchSize = "MaximumBatchSize"
 MaximumBatchSize takes on a value of type long.

const string PacingInterval = "PacingInterval"
 PacingInterval takes on a value of type TimeBase::TimeT.

const string StartTimeSupported = "StartTimeSupported"
 StartTimeSupported takes on a boolean value.

const string StopTimeSupported = "StopTimeSupported"
 StopTimeSupported takes on a boolean value.

const string MaxEventsPerConsumer = "MaxEventsPerConsumer"
 MaxEventsPerConsumer takes on a value of type long.


Constants for Admin Properties

Admin properties are defined in similar manner as QoS properties. The only difference is that these properties are related to channel administration policies, as opposed message quality of service

const string MaxQueueLength = "MaxQueueLength"
 MaxQueueLength takes on a value of type long.

const string MaxConsumers = "MaxConsumers"
 MaxConsumers takes on a value of type long.

const string MaxSuppliers = "MaxSuppliers"
 MaxSuppliers takes on a value of type long.

const string RejectNewEvents = "RejectNewEvents"
 RejectNewEvents takes on a value of type Boolean.


Typedefs

typedef string Istring
typedef Istring PropertyName
 Properties are named using a string.

typedef any PropertyValue
 Property values are stored using anys.

typedef sequence< Property > PropertySeq
 Define a sequence of properties.

typedef sequence< _EventType > EventTypeSeq
 A sequence of event types.

typedef sequence< NamedPropertyRange > NamedPropertyRangeSeq
 A sequence of named property ranges.

typedef sequence< PropertyError > PropertyErrorSeq
 List of property errors.

typedef sequence< StructuredEvent > EventBatch
 Sequence of events, for batch processing.


Enumerations

enum  QoSError_code {
  UNSUPPORTED_PROPERTY, UNAVAILABLE_PROPERTY, UNSUPPORTED_VALUE, UNAVAILABLE_VALUE,
  BAD_PROPERTY, BAD_TYPE, BAD_VALUE
}
 Describe QoS errors. More...

Detailed Description

Define basic data structures used by the Notification Service.

Typedef Documentation

typedef PropertySeq CosNotification::AdminProperties
 

Specify administrative properties.

Definition at line 70 of file CosNotification.idl.

Referenced by TAO_Notify_Builder::build_event_channel(), TAO_Notify_EventChannelFactory::create_channel(), TAO_Notify_EventChannel::get_admin(), TAO_Notify_EventChannel::init(), and TAO_Notify_EventChannel::set_admin().

typedef sequence<StructuredEvent> CosNotification::EventBatch
 

Sequence of events, for batch processing.

Definition at line 225 of file CosNotification.idl.

Referenced by TAO_Notify_Consumer::dispatch_batch(), TAO_Notify_SequencePushConsumer::dispatch_from_queue(), TAO_Notify_StructuredPushConsumer::push(), TAO_Notify_SequencePushConsumer::push(), TAO_Notify_PushConsumer::push(), and TAO_Notify_SequenceProxyPushConsumer::push_structured_events().

typedef sequence<_EventType> CosNotification::EventTypeSeq
 

A sequence of event types.

Definition at line 88 of file CosNotification.idl.

Referenced by TAO_Notify_ProxySupplier_T< SERVANT_TYPE >::admin_types_changed(), TAO_Notify_ProxyConsumer_T< SERVANT_TYPE >::admin_types_changed(), TAO_Notify_Peer::dispatch_updates(), TAO_Notify_Supplier::dispatch_updates_i(), TAO_Notify_Consumer::dispatch_updates_i(), TAO_Notify_EventTypeSeq::insert_seq(), TAO_Notify_Proxy::obtain_types(), TAO_Notify_SupplierAdmin::offer_change(), TAO_Notify_ProxyConsumer_T< SERVANT_TYPE >::offer_change(), TAO_Notify_EventTypeSeq::populate(), TAO_Notify_EventTypeSeq::populate_no_special(), TAO_Notify_EventTypeSeq::remove_seq(), TAO_Notify_ProxySupplier_T< SERVANT_TYPE >::subscription_change(), TAO_Notify_ConsumerAdmin::subscription_change(), TAO_Notify_EventTypeSeq::TAO_Notify_EventTypeSeq(), and TAO_Notify_Subscription_Change_Worker::TAO_Notify_Subscription_Change_Worker().

typedef PropertySeq CosNotification::FilterableEventBody
 

Property sequence used for the event body that can be used in filtering

Definition at line 64 of file CosNotification.idl.

typedef string CosNotification::Istring
 

Dummy typedef for strings, if the intent was to support I18N strings the spec should have used wstring

Definition at line 26 of file CosNotification.idl.

typedef sequence<NamedPropertyRange> CosNotification::NamedPropertyRangeSeq
 

A sequence of named property ranges.

Definition at line 115 of file CosNotification.idl.

typedef PropertySeq CosNotification::OptionalHeaderFields
 

Property sequence used for optional header fields.

Definition at line 60 of file CosNotification.idl.

typedef sequence<PropertyError> CosNotification::PropertyErrorSeq
 

List of property errors.

Definition at line 162 of file CosNotification.idl.

Referenced by TAO_Notify_QoSProperties::init(), and TAO_Notify_Object::set_qos().

typedef Istring CosNotification::PropertyName
 

Properties are named using a string.

Definition at line 29 of file CosNotification.idl.

typedef sequence<Property> CosNotification::PropertySeq
 

Define a sequence of properties.

Definition at line 50 of file CosNotification.idl.

Referenced by TAO_Notify_PropertyBase_T< TYPE >::get(), TAO_Notify_Property_Boolean::get(), TAO_Notify_QoSProperties::init(), TAO_Notify_PropertySeq::init(), TAO_Notify_AdminProperties::init(), and TAO_Notify_StructuredEvent_No_Copy::TAO_Notify_StructuredEvent_No_Copy().

typedef any CosNotification::PropertyValue
 

Property values are stored using anys.

Definition at line 32 of file CosNotification.idl.

Referenced by TAO_Notify_PropertySeq::find(), TAO_Notify_Object::find_qos_property_value(), TAO_Notify_StructProperty_T< TYPE >::set(), TAO_Notify_Property_T< TYPE >::set(), TAO_Notify_Property_Boolean::set(), and TAO_Notify_ProxyConsumer::supports_reliable_events().

typedef PropertySeq CosNotification::QoSProperties
 

Specify quality of service properties.

Definition at line 67 of file CosNotification.idl.

Referenced by TAO_Notify_Proxy_Builder_T< PROXY_IMPL, PROXY, PROXY_PTR, PROXY_VAR, PARENT >::build(), TAO_Notify_Builder::build_event_channel(), TAO_Notify_Builder::build_proxy(), TAO_Notify_EventChannelFactory::create_channel(), TAO_Notify_Properties::default_consumer_admin_qos_properties(), TAO_Notify_Properties::default_event_channel_qos_properties(), TAO_Notify_Properties::default_proxy_consumer_qos_properties(), TAO_Notify_Properties::default_proxy_supplier_qos_properties(), TAO_Notify_Properties::default_supplier_admin_qos_properties(), TAO_Notify_Object::get_qos(), TAO_Notify_SupplierAdmin::init(), TAO_Notify_ProxySupplier::init(), TAO_Notify_ProxyConsumer::init(), TAO_Notify_EventChannel::init(), TAO_CosNotify_Service::init(), TAO_Notify_ConsumerAdmin::init(), TAO_Notify_SupplierAdmin::obtain_notification_push_consumer(), TAO_Notify_SupplierAdmin::obtain_notification_push_consumer_with_qos(), TAO_Notify_ConsumerAdmin::obtain_notification_push_supplier(), TAO_Notify_ConsumerAdmin::obtain_notification_push_supplier_with_qos(), TAO_Notify_SupplierAdmin::set_qos(), TAO_Notify_Proxy_T< SERVANT_TYPE >::set_qos(), TAO_Notify_Object::set_qos(), TAO_Notify_EventChannel::set_qos(), TAO_Notify_ConsumerAdmin::set_qos(), TAO_CosNotify_Service::set_threads(), TAO_Notify_Proxy_T< SERVANT_TYPE >::validate_event_qos(), TAO_Notify_SupplierAdmin::validate_qos(), TAO_Notify_Proxy_T< SERVANT_TYPE >::validate_qos(), TAO_Notify_EventChannel::validate_qos(), and TAO_Notify_ConsumerAdmin::validate_qos().

Enumeration Type Documentation

enum CosNotification::QoSError_code
 

Describe QoS errors.

Enumeration values:
UNSUPPORTED_PROPERTY  The application has requested an unsupported QoS property.
UNAVAILABLE_PROPERTY  The application has requested a QoS property that, though supported, cannot be set in the requested scope.
UNSUPPORTED_VALUE  The application has requested a QoS property with an unsupported value.
UNAVAILABLE_VALUE  The application has requested a QoS property with a supported value, but unavailable at the requeste scope.
BAD_PROPERTY  The property name is unknown or not recognized.
BAD_TYPE  The value type for the requested property is invalid.
BAD_VALUE  The value for the requested property is illegal.

Definition at line 122 of file CosNotification.idl. 

00122                      {
00123     /// The application has requested an unsupported QoS property
00124     UNSUPPORTED_PROPERTY,
00125     /// The application has requested a QoS property that, though
00126     /// supported, cannot be set in the requested scope.
00127     UNAVAILABLE_PROPERTY,
00128     /// The application has requested a QoS property with an
00129     /// unsupported value.
00130     UNSUPPORTED_VALUE,
00131     /// The application has requested a QoS property with a supported
00132     /// value, but unavailable at the requeste scope.
00133     UNAVAILABLE_VALUE,
00134     /// The property name is unknown or not recognized.
00135     BAD_PROPERTY,
00136     /// The value type for the requested property is invalid
00137     BAD_TYPE,
00138     /// The value for the requested property is illegal
00139     BAD_VALUE
00140   };

Variable Documentation

const short CosNotification::AnyOrder = 0
 

Definition at line 260 of file CosNotification.idl.

const short CosNotification::BestEffort = 0
 

Definition at line 239 of file CosNotification.idl.

const string CosNotification::ConnectionReliability = "ConnectionReliability"
 

Can take on the same values as EventReliability.

Definition at line 243 of file CosNotification.idl.

const short CosNotification::DeadlineOrder = 3
 

Definition at line 263 of file CosNotification.idl.

const short CosNotification::DefaultPriority = 0
 

Definition at line 248 of file CosNotification.idl.

const string CosNotification::DiscardPolicy = "DiscardPolicy"
 

DiscardPolicy takes on the same values as OrderPolicy, plus.

Definition at line 266 of file CosNotification.idl.

const string CosNotification::EventReliability = "EventReliability"
 

Definition at line 238 of file CosNotification.idl.

const short CosNotification::FifoOrder = 1
 

Definition at line 261 of file CosNotification.idl.

const short CosNotification::HighestPriority = 32767
 

Definition at line 247 of file CosNotification.idl.

const short CosNotification::LifoOrder = 4
 

Definition at line 267 of file CosNotification.idl.

const short CosNotification::LowestPriority = -32767
 

Definition at line 246 of file CosNotification.idl.

const string CosNotification::MaxConsumers = "MaxConsumers"
 

MaxConsumers takes on a value of type long.

Definition at line 346 of file CosNotification.idl.

const string CosNotification::MaxEventsPerConsumer = "MaxEventsPerConsumer"
 

MaxEventsPerConsumer takes on a value of type long.

Definition at line 282 of file CosNotification.idl.

const string CosNotification::MaximumBatchSize = "MaximumBatchSize"
 

MaximumBatchSize takes on a value of type long.

Definition at line 270 of file CosNotification.idl.

const string CosNotification::MaxQueueLength = "MaxQueueLength"
 

MaxQueueLength takes on a value of type long.

Definition at line 343 of file CosNotification.idl.

const string CosNotification::MaxSuppliers = "MaxSuppliers"
 

MaxSuppliers takes on a value of type long.

Definition at line 349 of file CosNotification.idl.

const string CosNotification::OrderPolicy = "OrderPolicy"
 

Definition at line 259 of file CosNotification.idl.

const string CosNotification::PacingInterval = "PacingInterval"
 

PacingInterval takes on a value of type TimeBase::TimeT.

Definition at line 273 of file CosNotification.idl.

const short CosNotification::Persistent = 1
 

Definition at line 240 of file CosNotification.idl.

const string CosNotification::Priority = "Priority"
 

Definition at line 245 of file CosNotification.idl.

const short CosNotification::PriorityOrder = 2
 

Definition at line 262 of file CosNotification.idl.

const string CosNotification::RejectNewEvents = "RejectNewEvents"
 

RejectNewEvents takes on a value of type Boolean.

Definition at line 352 of file CosNotification.idl.

const string CosNotification::StartTime = "StartTime"
 

StartTime takes a value of type TimeBase::UtcT.

Definition at line 251 of file CosNotification.idl.

const string CosNotification::StartTimeSupported = "StartTimeSupported"
 

StartTimeSupported takes on a boolean value.

Definition at line 276 of file CosNotification.idl.

const string CosNotification::StopTime = "StopTime"
 

StopTime takes a value of type TimeBase::UtcT.

Definition at line 254 of file CosNotification.idl.

const string CosNotification::StopTimeSupported = "StopTimeSupported"
 

StopTimeSupported takes on a boolean value.

Definition at line 279 of file CosNotification.idl.

const string CosNotification::Timeout = "Timeout"
 

Timeout takes on a value of type TimeBase::TimeT.

Definition at line 257 of file CosNotification.idl.

Generated on Thu Nov 9 13:33:40 2006 for TAO_CosNotification by doxygen 1.3.6