Module CosNotification

This module contains the definition of the structured event type and various definitions related to QoS and Administration properties.



Interface Index

AdminPropertiesAdmin
Supports the management of administrative properties.
QoSAdmin
Supports the management of QoS property settings.

Constant Index

AnyOrder
OrderPolicy property value indicating any ordering policy is permitted.
BestEffort
Reliability property value.
ConnectionReliability
Specifies connection reliability.
DeadlineOrder
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.
DefaultPriority
Priority property value.
DiscardPolicy
Discard policy determines the order in which events are discarded when the number of queued events exceeds MaxEventsPerConsumer.
EventReliability
Specifies event reliability.
FifoOrder
OrderPolicy property value indicating events should be delivered in the order of their arrival.
HighestPriority
Priority property value.
LifoOrder
DiscardPolicy property value.
LowestPriority
Priority property value.
MaxConsumers
The maximum number of consumers that can be connected to a channel at any one time.
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.
MaxQueueLength
The maximum number of events that a channel will buffer at any one time.
MaxSuppliers
The maximum number of suppliers that can be connected to a channel at any one time.
MaximumBatchSize
This QoS property has meaning in the case of consumers that register to receive sequences of structured events.
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).
PacingInterval
This QoS property has meaning in the case of consumers that register to receive sequences of structured events.
Persistent
Reliability property value.
Priority
Indicates the relative priority of the event compared to other events in the channel.
PriorityOrder
OrderPolicy property value indicating events should be buffered in priority order, such that higher priority events will be delivered before lower priority events.
RejectNewEvents
DiscardPolicy property value.
StartTime
Gives an absolute time (e.g., 12/12/99 at 23:59) after which the channel may deliver the event.
StartTimeSupported
Indicates whether or not the setting of StartTime on a per-message basis is supported.
StopTime
Gives an absolute time (e.g., 12/12/99 at 23:59) at which the channel should discard the event.
StopTimeSupported
Indicates whether or not the setting of StopTime on a per-message basis is supported.
Timeout
Gives a relative time (e.g., 10 minutes from time received) after which the channel should discard the event.

Exception Index

UnsupportedAdmin
This exception is raised when a channel or proxy does not support the requested aministrative property settings.
UnsupportedQoS
This exception is raised when a channel or channel component cannot satisfy a client's QoS request.

Struct Index

EventHeader
Structured event header
EventType
Structure defining an event type.
FixedEventHeader
Structured event fixed header
NamedPropertyRange
Structure used to indicate a range of acceptable values for a named property.
Property
A generic name-value property pair.
PropertyError
Structure to indicate a property error for the name property and, if applicable, a suitable range of values.
PropertyRange
Structure used to indicate a range of acceptable values for an unnamed property.
StructuredEvent
The StructuredEvent Type.

Enum Index

QoSError_code
Error codes used to indicate an invalid property assignment.

Alias Index

AdminProperties
Alias for channel administration properties.
EventBatch
Alias for a sequence of structured events.
EventTypeSeq
Alias for a sequence of event types.
FilterableEventBody
Alias for event body filterable fields.
Istring
NamedPropertyRangeSeq
Alias for a sequence of named property ranges.
OptionalHeaderFields
Alias for event header optional header fields.
PropertyErrorSeq
Alias for a sequence of property errors.
PropertyName
Alias for a property name.
PropertySeq
Alias for a sequence of property name-value pairs.
PropertyValue
Alias for a property value.
QoSProperties
Alias for Quality of Service properties.

Constants

AnyOrder
const short AnyOrder = 0;

OrderPolicy property value indicating any ordering policy is permitted.


BestEffort
const short BestEffort = 0;

Reliability property value.


ConnectionReliability
const string ConnectionReliability = "ConnectionReliability";

Specifies connection reliability. The valid values are BestEffort and Persistent.


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


DefaultPriority
const short DefaultPriority = 0;

Priority property value.


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


EventReliability
const string EventReliability = "EventReliability";

Specifies event reliability. The valid values are BestEffort and Persistent.


FifoOrder
const short FifoOrder = 1;

OrderPolicy property value indicating events should be delivered in the order of their arrival.


HighestPriority
const short HighestPriority = 32767;

Priority property value.


LifoOrder
const short LifoOrder = 4;

DiscardPolicy property value. The last event received will be the first discarded.


LowestPriority
const short LowestPriority = -32767;

Priority property value.


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


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


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


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


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


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


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


Persistent
const short Persistent = 1;

Reliability property value.


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


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


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


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


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


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


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


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



Structs

EventHeader
struct EventHeader
{
    FixedEventHeader fixed_header;
    OptionalHeaderFields variable_header;
};

Structured event header

Members:
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.

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

Members:
domain_name - Identifies the vertical industry domain in which the event is defined.
type_name - Further classifies the event within the domain.

FixedEventHeader
struct FixedEventHeader
{
    EventType event_type;
    string event_name;
};

Structured event fixed header

Members:
event_type - Categorizes the event.
event_name - A name given to this event instance to differentiate it from other events of the same type.

NamedPropertyRange
struct NamedPropertyRange
{
    PropertyName name;
    PropertyRange range;
};

Structure used to indicate a range of acceptable values for a named property.


Property
struct Property
{
    PropertyName name;
    PropertyValue value;
};

A generic name-value property pair.

Members:
name - The name of the property.
value - The value of the property.

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


PropertyRange
struct PropertyRange
{
    PropertyValue low_val;
    PropertyValue high_val;
};

Structure used to indicate a range of acceptable values for an unnamed property.


StructuredEvent
struct StructuredEvent
{
    EventHeader header;
    FilterableEventBody filterable_data;
    any remainder_of_body;
};

The StructuredEvent Type. Events transmitted in this form are subject to filtering.



Exceptions

UnsupportedAdmin
exception UnsupportedAdmin
{
    PropertyErrorSeq admin_err;
};

This exception is raised when a channel or proxy does not support the requested aministrative property settings.

Members:
admin_err - Contains a list of the rejected administrative settings, along with reason for rejection, and suitable property values, if applicable.

UnsupportedQoS
exception UnsupportedQoS
{
    PropertyErrorSeq qos_err;
};

This exception is raised when a channel or channel component cannot satisfy a client's QoS request.

Members:
qos_err - Contains a list of the rejected QoS settings, along with reason for rejection, and suitable property values, if applicable.


Enums

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

Members:
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.


Aliases

AdminProperties
typedef PropertySeq AdminProperties;

Alias for channel administration properties.


EventBatch
typedef sequence<StructuredEvent> EventBatch;

Alias for a sequence of structured events.


EventTypeSeq
typedef sequence<EventType> EventTypeSeq;

Alias for a sequence of event types.


FilterableEventBody
typedef PropertySeq FilterableEventBody;

Alias for event body filterable fields.


Istring
typedef string Istring;
NamedPropertyRangeSeq
typedef sequence<NamedPropertyRange> NamedPropertyRangeSeq;

Alias for a sequence of named property ranges.


OptionalHeaderFields
typedef PropertySeq OptionalHeaderFields;

Alias for event header optional header fields.


PropertyErrorSeq
typedef sequence<PropertyError> PropertyErrorSeq;

Alias for a sequence of property errors.


PropertyName
typedef Istring PropertyName;

Alias for a property name.


PropertySeq
typedef sequence<Property> PropertySeq;

Alias for a sequence of property name-value pairs.


PropertyValue
typedef any PropertyValue;

Alias for a property value.


QoSProperties
typedef PropertySeq QoSProperties;

Alias for Quality of Service properties.



Generated by the ORBacus IDL-to-HTML translator (non-commercial)