|
TAO_CosNotification
2.1.0
|
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... | |
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. | |
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. | |
Enumerations | |
| enum | QoSError_code { UNSUPPORTED_PROPERTY, UNAVAILABLE_PROPERTY, UNSUPPORTED_VALUE, UNAVAILABLE_VALUE, BAD_PROPERTY, BAD_TYPE, BAD_VALUE } |
| Describe QoS errors. More... | |
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. | |
Define basic data structures used by the Notification Service.
Specify administrative properties.
| typedef sequence<StructuredEvent> CosNotification::EventBatch |
Sequence of events, for batch processing.
| typedef sequence<_EventType> CosNotification::EventTypeSeq |
A sequence of event types.
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.
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.
Specify quality of service properties.
Describe QoS errors.
| const short CosNotification::AnyOrder = 0 |
Can take on the same values as EventReliability.
| const short CosNotification::BestEffort = 0 |
Can take on the same values as EventReliability.
| const string CosNotification::ConnectionReliability = "ConnectionReliability" |
Can take on the same values as EventReliability.
| const short CosNotification::DeadlineOrder = 3 |
Can take on the same values as EventReliability.
| const short CosNotification::DefaultPriority = 0 |
Can take on the same values as EventReliability.
| const string CosNotification::DiscardPolicy = "DiscardPolicy" |
DiscardPolicy takes on the same values as OrderPolicy, plus.
| const string CosNotification::EventReliability = "EventReliability" |
Can take on the same values as EventReliability.
| const short CosNotification::FifoOrder = 1 |
Can take on the same values as EventReliability.
| const short CosNotification::HighestPriority = 32767 |
Can take on the same values as EventReliability.
| const short CosNotification::LifoOrder = 4 |
Can take on the same values as EventReliability.
| const short CosNotification::LowestPriority = -32767 |
Can take on the same values as EventReliability.
| 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::MaximumBatchSize = "MaximumBatchSize" |
MaximumBatchSize 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::OrderPolicy = "OrderPolicy" |
Can take on the same values as EventReliability.
| const string CosNotification::PacingInterval = "PacingInterval" |
PacingInterval takes on a value of type TimeBase::TimeT.
| const short CosNotification::Persistent = 1 |
Can take on the same values as EventReliability.
| const string CosNotification::Priority = "Priority" |
Can take on the same values as EventReliability.
| const short CosNotification::PriorityOrder = 2 |
Can take on the same values as EventReliability.
| 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.
1.8.0