This module contains the definition of the structured event type and various definitions related to QoS and Administration properties.
OrderPolicy
property value indicating any ordering
policy is permitted.
OrderPolicy
property value indicating events should
be buffered in the order of shortest expiry deadline first, such
that events that are destined to timeout soonest should be
delivered first.
MaxEventsPerConsumer
.
OrderPolicy
property value indicating events should be
delivered in the order of their arrival.
DiscardPolicy
property value.
OrderPolicy
property value indicating events should
be buffered in priority order, such that higher priority events
will be delivered before lower priority events.
DiscardPolicy
property value.
StartTime
on
a per-message basis is supported.
StopTime
on
a per-message basis is supported.
const short AnyOrder = 0;
OrderPolicy
property value indicating any ordering
policy is permitted.
const short BestEffort = 0;
Reliability property value.
const string ConnectionReliability = "ConnectionReliability";
Specifies connection reliability. The valid values are
BestEffort
and Persistent
.
const short DeadlineOrder = 3;
OrderPolicy
property value indicating events should
be buffered in the order of shortest expiry deadline first, such
that events that are destined to timeout soonest should be
delivered first.
const short DefaultPriority = 0;
Priority property value.
const string DiscardPolicy = "DiscardPolicy";
Discard policy determines the order in which events are
discarded when the number of queued events exceeds
MaxEventsPerConsumer
. The OrderPolicy
property values are also DiscardPolicy
property values.
const string EventReliability = "EventReliability";
Specifies event reliability. The valid values are
BestEffort
and Persistent
.
const short FifoOrder = 1;
OrderPolicy
property value indicating events should be
delivered in the order of their arrival.
const short HighestPriority = 32767;
Priority property value.
const short LifoOrder = 4;
DiscardPolicy
property value. The last event received
will be the first discarded.
const short LowestPriority = -32767;
Priority property value.
const string MaxConsumers = "MaxConsumers";
The maximum number of consumers that can be connected to a
channel at any one time. The corresponding value is of type
long
.
const string MaxEventsPerConsumer = "MaxEventsPerConsumer";
An administrative property can be set on a channel to
bound the maximum number of events a given channel is
allowed to queue at any given point in time. However,
a single badly behaved consumer could result in the
channel holding the maximum number of events it is allowed
to queue for an extended period of time, preventing further
event communication through the channel.
This QoS property helps to avoid this situation by
bounding the maximum number of events the channel
will queue on behalf of a given consumer. The corresponding
value is of type long
.
const string MaxQueueLength = "MaxQueueLength";
The maximum number of events that a channel will buffer at
any one time. The corresponding value is of type
long
.
const string MaxSuppliers = "MaxSuppliers";
The maximum number of suppliers that can be connected to a
channel at any one time. The corresponding value is of type
long
.
const string MaximumBatchSize = "MaximumBatchSize";
This QoS property has meaning in the case of consumers that
register to receive sequences of structured events. For any
such consumer, this property indicates the maximum number of
events that will be delivered within each sequence. The
corresponding value is of type long
.
const string OrderPolicy = "OrderPolicy";
This QoS property sets the policy used by a given proxy to order the events it has buffered for delivery (either to another proxy or a consumer). Constant values to represent the permitted settings are defined.
const string PacingInterval = "PacingInterval";
This QoS property has meaning in the case of consumers
that register to receive sequences of structured events. For
any such consumer, this property defines the maximum period
of time the channel will collect individual events into a
sequence before delivering the sequence to the consumer.
The corresponding value is of type TimeBase::TimeT
.
const short Persistent = 1;
Reliability property value.
const string Priority = "Priority";
Indicates the relative priority of the event compared to other events in the channel. Can take on any value between -32,767 and 32,767, with -32,767 being the lowest priority, 32,767 being the highest, and 0 being the default.
const short PriorityOrder = 2;
OrderPolicy
property value indicating events should
be buffered in priority order, such that higher priority events
will be delivered before lower priority events.
const short RejectNewEvents = 5;
DiscardPolicy
property value. The proxy consumers of
the associated channel should reject attempts to send new events
to the channel when such an attempt would result in a buffer
overflow, raising the system exception IMPL_LIMIT
.
Note that this is the default setting for discard policy.
const string StartTime = "StartTime";
Gives an absolute time (e.g., 12/12/99 at
23:59) after which the channel may deliver the
event. The value for this property is of type
TimeBase:UtcT
.
const string StartTimeSupported = "StartTimeSupported";
Indicates whether or not the setting of StartTime
on
a per-message basis is supported. The corresponding value
is of type boolean
.
const string StopTime = "StopTime";
Gives an absolute time (e.g., 12/12/99 at
23:59) at which the channel should discard the
event. The value for this property is of type
TimeBase:UtcT
.
const string StopTimeSupported = "StopTimeSupported";
Indicates whether or not the setting of StopTime
on
a per-message basis is supported. The corresponding value
is of type boolean
.
const string Timeout = "Timeout";
Gives a relative time (e.g., 10 minutes from
time received) after which the channel should
discard the event. The value 0 indicates there
is no timeout. The value for this property is of type
TimeBase:TimeT
.
struct EventHeader { FixedEventHeader fixed_header; OptionalHeaderFields variable_header; };
Structured event header
fixed_header
- Categorizes and names the event.
variable_header
- Optional header information. This
may contain any name-value pair that the user chooses.
Standard values are related to per event QoS settings.
struct EventType { string domain_name; string type_name; };
Structure defining an event type. The type of an event is
governed by the domain_name
and
type_name
.
domain_name
- Identifies the vertical industry domain in
which the event is defined.
type_name
- Further classifies the event within the domain.
struct FixedEventHeader { EventType event_type; string event_name; };
Structured event fixed header
event_type
- Categorizes the event.
event_name
- A name given to this event instance to
differentiate it from other events of the same type.
struct NamedPropertyRange { PropertyName name; PropertyRange range; };
Structure used to indicate a range of acceptable values for a named property.
struct Property { PropertyName name; PropertyValue value; };
A generic name-value property pair.
name
- The name of the property.
value
- The value of the property.
struct PropertyError { QoSError_code code; PropertyName name; PropertyRange available_range; };
Structure to indicate a property error for the name property and, if applicable, a suitable range of values.
struct PropertyRange { PropertyValue low_val; PropertyValue high_val; };
Structure used to indicate a range of acceptable values for an unnamed property.
struct StructuredEvent { EventHeader header; FilterableEventBody filterable_data; any remainder_of_body; };
The StructuredEvent Type. Events transmitted in this form are subject to filtering.
exception UnsupportedAdmin { PropertyErrorSeq admin_err; };
This exception is raised when a channel or proxy does not support the requested aministrative property settings.
admin_err
- Contains a list of the rejected administrative
settings, along with reason for rejection, and suitable property
values, if applicable.
exception UnsupportedQoS { PropertyErrorSeq qos_err; };
This exception is raised when a channel or channel component cannot satisfy a client's QoS request.
qos_err
- Contains a list of the rejected QoS settings,
along with reason for rejection, and suitable property values,
if applicable.
enum QoSError_code { UNSUPPORTED_PROPERTY, UNAVAILABLE_PROPERTY, UNSUPPORTED_VALUE, UNAVAILABLE_VALUE, BAD_PROPERTY, BAD_TYPE, BAD_VALUE };
Error codes used to indicate an invalid property assignment.
UNSUPPORTED_PROPERTY
- Property not supported by
this implementation of the target object.
UNAVAILABLE_PROPERTY
- Property cannot be set within
the current context of other property settings.
UNSUPPORTED_VALUE
- The property value is not supported
by this implementation of the target object.
UNAVAILABLE_VALUE
- The property value is not supported
within the current context of other property settings.
BAD_PROPERTY
- Unrecognized property name.
BAD_TYPE
- Incorrect value type for this property.
BAD_VALUE
- Illegal value for this property.
typedef PropertySeq AdminProperties;
Alias for channel administration properties.
typedef sequence<StructuredEvent> EventBatch;
Alias for a sequence of structured events.
typedef sequence<EventType> EventTypeSeq;
Alias for a sequence of event types.
typedef PropertySeq FilterableEventBody;
Alias for event body filterable fields.
typedef string Istring;
typedef sequence<NamedPropertyRange> NamedPropertyRangeSeq;
Alias for a sequence of named property ranges.
typedef PropertySeq OptionalHeaderFields;
Alias for event header optional header fields.
typedef sequence<PropertyError> PropertyErrorSeq;
Alias for a sequence of property errors.
typedef Istring PropertyName;
Alias for a property name.
typedef sequence<Property> PropertySeq;
Alias for a sequence of property name-value pairs.
typedef any PropertyValue;
Alias for a property value.
typedef PropertySeq QoSProperties;
Alias for Quality of Service properties.
Generated by the ORBacus IDL-to-HTML translator (non-commercial)