org.omg.CosNotifyChannelAdmin
Interface EventChannelFactoryOperations
public
interface
EventChannelFactoryOperations
The EventChannelFactory interface defines operations for creating and managing
new Notification Service style event channels. It supports a routine that creates new
instances of Notification Service event channels and assigns unique numeric identifiers
to them. In addition, the EventChannelFactory interface supports a routine which can
return the unique identifiers assigned to all event channels created by a given instance
of EventChannelFactory, and another routine which, given the unique identifier of an
event channel created by a target EventChannelFactory instance, returns the object
reference of that event channel.
Method Summary |
EventChannel | create_channel(Property[] initial_qos, Property[] initial_admin, IntHolder id)
The create_channel operation is invoked to create a new instance of the Notification
Service style event channel. |
int[] | get_all_channels()
The get_all_channels operation returns a sequence of all of the unique numeric
identifiers corresponding to Notification Service event channels which have been
created by the target object. |
EventChannel | get_event_channel(int id)
The get_event_channel operation accepts as input a numeric value which is supposed
to be the unique identifier of a Notification Service event channel that has been created
by the target object. |
The create_channel operation is invoked to create a new instance of the Notification
Service style event channel. This operation accepts two input parameters. The first
input parameter is a list of name-value pairs which specify the initial QoS property
settings for the new channel. The second input parameter is a list of name-value pairs
which specify the initial administrative property settings for the new channel.
If no implementation of the EventChannel interface exists that can support all of the
requested QoS property settings, the UnsupportedQoS exception is raised. This
exception contains as data a sequence of data structures, each of which identifies the
name of a QoS property in the input list whose requested setting could not be satisfied,
along with an error code and a range of settings for the property which could be
satisfied. The meanings of the error codes which might be returned are described in
Table 2-5.
Likewise, if no implementation of the EventChannel interface exists that can support
all of the requested administrative property settings, the UnsupportedAdmin
exception is raised. This exception contains as data a sequence of data structures, each
of which identifies the name of an administrative property in the input list whose
requested setting could not be satisfied, along with an error code and a range of
settings for the property which could be satisfied. The meanings of the error codes
which might be returned are described in Table 2-5.
If neither of these exceptions is raised, the create_channel operation will return a
reference to a new Notification Service style event channel. In addition, the operation
assigns to this new event channel a numeric identifier which is unique among all event
channels created by the target object. This numeric identifier is returned as an output
parameter.
public int[] get_all_channels()
The get_all_channels operation returns a sequence of all of the unique numeric
identifiers corresponding to Notification Service event channels which have been
created by the target object.
The get_event_channel operation accepts as input a numeric value which is supposed
to be the unique identifier of a Notification Service event channel that has been created
by the target object. If this input value does not correspond to such a unique identifier,
the ChannelNotFound exception is raised. Otherwise, the operation returns the object
reference of the Notification Service event channel corresponding to the input
identifier.