CosNotification Module Reference

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

Classes
struct	_EventType
	Define event type names. More...
interface	AdminPropertiesAdmin
	Define the interface to manipulate the Admin properties of a Notification Service components. More...
struct	EventHeader
	Complete event header. More...
struct	FixedEventHeader
	Define the 'fixed' part of the event header. More...
struct	NamedPropertyRange
	A named property range. More...
struct	Property
	Define a name/value pair. More...
struct	PropertyError
	Describe the problems detected with an application requested QoS. More...
struct	PropertyRange
	A structure to define property ranges. More...
interface	QoSAdmin
	Interface used to control the QoS properties of an Event Service components (Channel, Proxy, etc.) More...
struct	StructuredEvent
	Define structured events. More...
exception	UnsupportedAdmin
	Exception used to describe problems with one or more Admin properties. More...
exception	UnsupportedQoS
	Exception used to describe problems with one or more QoS requests. More...

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.

Variables
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"
	Can take on the same values as EventReliability.
const short	BestEffort = 0
	Can take on the same values as EventReliability.
const short	Persistent = 1
	Can take on the same values as EventReliability.
const string	ConnectionReliability = "ConnectionReliability"
	Can take on the same values as EventReliability.
const string	Priority = "Priority"
	Can take on the same values as EventReliability.
const short	LowestPriority = -32767
	Can take on the same values as EventReliability.
const short	HighestPriority = 32767
	Can take on the same values as EventReliability.
const short	DefaultPriority = 0
	Can take on the same values as EventReliability.
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"
	Can take on the same values as EventReliability.
const short	AnyOrder = 0
	Can take on the same values as EventReliability.
const short	FifoOrder = 1
	Can take on the same values as EventReliability.
const short	PriorityOrder = 2
	Can take on the same values as EventReliability.
const short	DeadlineOrder = 3
	Can take on the same values as EventReliability.
const string	DiscardPolicy = "DiscardPolicy"
	DiscardPolicy takes on the same values as OrderPolicy, plus.
const short	LifoOrder = 4
	Can take on the same values as EventReliability.
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.

Different kinds of property sequences
The following are all sequences of Property, but serve different purposes.
enum	QoSError_code {   UNSUPPORTED_PROPERTY , UNAVAILABLE_PROPERTY , UNSUPPORTED_VALUE , UNAVAILABLE_VALUE ,   BAD_PROPERTY , BAD_TYPE , BAD_VALUE }
	Describe QoS errors. More...
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.
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.

Detailed Description

Define basic data structures used by the Notification Service.

Typedef Documentation

AdminProperties

typedef PropertySeq CosNotification::AdminProperties

Specify administrative properties.

EventBatch

typedef sequence<StructuredEvent> CosNotification::EventBatch

Sequence of events, for batch processing.

EventTypeSeq

typedef sequence<_EventType> CosNotification::EventTypeSeq

A sequence of event types.

FilterableEventBody

typedef PropertySeq CosNotification::FilterableEventBody

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

Istring

typedef string CosNotification::Istring

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

NamedPropertyRangeSeq

typedef sequence<NamedPropertyRange> CosNotification::NamedPropertyRangeSeq

A sequence of named property ranges.

OptionalHeaderFields

typedef PropertySeq CosNotification::OptionalHeaderFields

Property sequence used for optional header fields.

PropertyErrorSeq

typedef sequence<PropertyError> CosNotification::PropertyErrorSeq

List of property errors.

PropertyName

typedef Istring CosNotification::PropertyName

Properties are named using a string.

PropertySeq

typedef sequence<Property> CosNotification::PropertySeq

Define a sequence of properties.

PropertyValue

typedef any CosNotification::PropertyValue

Property values are stored using anys.

QoSProperties

typedef PropertySeq CosNotification::QoSProperties

Specify quality of service properties.

Enumeration Type Documentation

QoSError_code

enum CosNotification::QoSError_code

Describe QoS errors.

Enumerator
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 requested 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.

Variable Documentation

AnyOrder

const short CosNotification::AnyOrder = 0

Can take on the same values as EventReliability.

BestEffort

const short CosNotification::BestEffort = 0

Can take on the same values as EventReliability.

ConnectionReliability

const string CosNotification::ConnectionReliability = "ConnectionReliability"

Can take on the same values as EventReliability.

DeadlineOrder

const short CosNotification::DeadlineOrder = 3

Can take on the same values as EventReliability.

DefaultPriority

const short CosNotification::DefaultPriority = 0

Can take on the same values as EventReliability.

DiscardPolicy

const string CosNotification::DiscardPolicy = "DiscardPolicy"

DiscardPolicy takes on the same values as OrderPolicy, plus.

EventReliability

const string CosNotification::EventReliability = "EventReliability"

Can take on the same values as EventReliability.

FifoOrder

const short CosNotification::FifoOrder = 1

Can take on the same values as EventReliability.

HighestPriority

const short CosNotification::HighestPriority = 32767

Can take on the same values as EventReliability.

LifoOrder

const short CosNotification::LifoOrder = 4

Can take on the same values as EventReliability.

LowestPriority

const short CosNotification::LowestPriority = -32767

Can take on the same values as EventReliability.

MaxConsumers

const string CosNotification::MaxConsumers = "MaxConsumers"

MaxConsumers takes on a value of type long.

MaxEventsPerConsumer

const string CosNotification::MaxEventsPerConsumer = "MaxEventsPerConsumer"

MaxEventsPerConsumer takes on a value of type long.

MaximumBatchSize

const string CosNotification::MaximumBatchSize = "MaximumBatchSize"

MaximumBatchSize takes on a value of type long.

MaxQueueLength

const string CosNotification::MaxQueueLength = "MaxQueueLength"

MaxQueueLength takes on a value of type long.

MaxSuppliers

const string CosNotification::MaxSuppliers = "MaxSuppliers"

MaxSuppliers takes on a value of type long.

OrderPolicy

const string CosNotification::OrderPolicy = "OrderPolicy"

Can take on the same values as EventReliability.

PacingInterval

const string CosNotification::PacingInterval = "PacingInterval"

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

Persistent

const short CosNotification::Persistent = 1

Can take on the same values as EventReliability.

Priority

const string CosNotification::Priority = "Priority"

Can take on the same values as EventReliability.

PriorityOrder

const short CosNotification::PriorityOrder = 2

Can take on the same values as EventReliability.

RejectNewEvents

const string CosNotification::RejectNewEvents = "RejectNewEvents"

RejectNewEvents takes on a value of type Boolean.

StartTime

const string CosNotification::StartTime = "StartTime"

StartTime takes a value of type TimeBase::UtcT.

StartTimeSupported

const string CosNotification::StartTimeSupported = "StartTimeSupported"

StartTimeSupported takes on a boolean value.

StopTime

const string CosNotification::StopTime = "StopTime"

StopTime takes a value of type TimeBase::UtcT.

StopTimeSupported

const string CosNotification::StopTimeSupported = "StopTimeSupported"

StopTimeSupported takes on a boolean value.

Timeout

const string CosNotification::Timeout = "Timeout"

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