Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members

# CosNotification Namespace Reference

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

## Compounds
interface | CosNotification::AdminPropertiesAdmin
struct | CosNotification::EventHeader
struct | CosNotification::EventType
struct | CosNotification::FixedEventHeader
struct | CosNotification::NamedPropertyRange
struct | CosNotification::Property
struct | CosNotification::PropertyError
struct | CosNotification::PropertyRange
interface | CosNotification::QoSAdmin
struct | CosNotification::StructuredEvent
exception | CosNotification::UnsupportedAdmin
exception | CosNotification::UnsupportedQoS
## 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
| Property sequence used for the event body that can be used in filtering.
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
| Dummy typedef for strings, if the intent was to support I18N strings the spec should have used wstring.
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.

typedef sequence<StructuredEvent> CosNotification::EventBatch

| Sequence of events, for batch processing.

typedef sequence<EventType> CosNotification::EventTypeSeq

| A sequence of event types.

typedef PropertySeq CosNotification::FilterableEventBody

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

typedef string CosNotification::Istring

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

typedef sequence<NamedPropertyRange> CosNotification::NamedPropertyRangeSeq

| A sequence of named property ranges.

typedef PropertySeq CosNotification::OptionalHeaderFields

| Property sequence used for optional header fields.

typedef sequence<PropertyError> CosNotification::PropertyErrorSeq

| List of property errors.

typedef Istring CosNotification::PropertyName

| Properties are named using a string.

typedef sequence<Property> CosNotification::PropertySeq

| Define a sequence of properties.

typedef any CosNotification::PropertyValue

| Property values are stored using anys.

typedef PropertySeq CosNotification::QoSProperties

| Specify quality of service properties.

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

## Variable Documentation

const short CosNotification::AnyOrder = 0

const short CosNotification::BestEffort = 0

const string CosNotification::ConnectionReliability = "ConnectionReliability"

| Can take on the same values as EventReliability.

const short CosNotification::DeadlineOrder = 3

const short CosNotification::DefaultPriority = 0

const string CosNotification::DiscardPolicy = "DiscardPolicy"

| DiscardPolicy takes on the same values as OrderPolicy, plus.

const string CosNotification::EventReliability = "EventReliability"

const short CosNotification::FifoOrder = 1

const short CosNotification::HighestPriority = 32767

const short CosNotification::LifoOrder = 4

const short CosNotification::LowestPriority = -32767

const string CosNotification::MaxConsumers = "MaxConsumers"

| MaxConsumers takes on a value of type long.

const string CosNotification::MaxEventsPerConsumer = "MaxEventsPerConsumer"

| MaxEventsPerConsumer takes on a value of type long.

const string CosNotification::MaxQueueLength = "MaxQueueLength"

| MaxQueueLength takes on a value of type long.

const string CosNotification::MaxSuppliers = "MaxSuppliers"

| MaxSuppliers takes on a value of type long.

const string CosNotification::MaximumBatchSize = "MaximumBatchSize"

| MaximumBatchSize takes on a value of type long.

const string CosNotification::OrderPolicy = "OrderPolicy"

const string CosNotification::PacingInterval = "PacingInterval"

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

const short CosNotification::Persistent = 1

const string CosNotification::Priority = "Priority"

const short CosNotification::PriorityOrder = 2

const string CosNotification::RejectNewEvents = "RejectNewEvents"

| RejectNewEvents takes on a value of type Boolean.

const string CosNotification::StartTime = "StartTime"

| StartTime takes a value of type TimeBase::UtcT.

const string CosNotification::StartTimeSupported = "StartTimeSupported"

| StartTimeSupported takes on a boolean value.

const string CosNotification::StopTime = "StopTime"

| StopTime takes a value of type TimeBase::UtcT.

const string CosNotification::StopTimeSupported = "StopTimeSupported"

| StopTimeSupported takes on a boolean value.

const string CosNotification::Timeout = "Timeout"

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