Interface CosNotifyChannelAdmin::EventChannel

interface EventChannel
inherits from CosNotification::QoSAdmin, CosNotification::AdminPropertiesAdmin, CosEventChannelAdmin::EventChannel

The EventChannel interface has operations which support the management of supplier and consumer admin objects.



Attribute Index

MyFactory
A reference to the event channel factory which created the target object.
default_consumer_admin
A reference to a default consumer admin which is created automatically when the channel is created.
default_filter_factory
A reference to the default filter factory.
default_supplier_admin
A reference to a default supplier admin which is created automatically when the channel is created.

Operation Index

get_all_consumeradmins
Obtains the IDs of all consumer admin objects associated with the target object.
get_all_supplieradmins
Obtains the IDs of all supplier admin objects associated with the target object.
get_consumeradmin
Obtains a reference to a consumer admin from an admin ID.
get_supplieradmin
Obtains a reference to a supplier admin from an admin ID.
new_for_consumers
Creates a new consumer admin.
new_for_suppliers
Creates a new supplier admin.

Attributes

MyFactory
readonly attribute EventChannelFactory MyFactory;

A reference to the event channel factory which created the target object.


default_consumer_admin
readonly attribute ConsumerAdmin default_consumer_admin;

A reference to a default consumer admin which is created automatically when the channel is created.


default_filter_factory
readonly attribute CosNotifyFilter::FilterFactory default_filter_factory;

A reference to the default filter factory.


default_supplier_admin
readonly attribute SupplierAdmin default_supplier_admin;

A reference to a default supplier admin which is created automatically when the channel is created.



Operations

get_all_consumeradmins
AdminIDSeq get_all_consumeradmins();

Obtains the IDs of all consumer admin objects associated with the target object.

Returns:
A sequence of admin IDs.

get_all_supplieradmins
AdminIDSeq get_all_supplieradmins();

Obtains the IDs of all supplier admin objects associated with the target object.

Returns:
A sequence of admin IDs.

get_consumeradmin
ConsumerAdmin get_consumeradmin(in AdminID id)
    raises(AdminNotFound);

Obtains a reference to a consumer admin from an admin ID.

Parameters:
id - The ID of the admin for which a reference is required. The ID is originally assigned by the channel on creation of the admin.
Returns:
A reference to the consumer admin with the given ID. If no matching admin object is found an AdminNotFound exception is raised.

get_supplieradmin
SupplierAdmin get_supplieradmin(in AdminID id)
    raises(AdminNotFound);

Obtains a reference to a supplier admin from an admin ID.

Parameters:
id - The ID of the admin for which a reference is required. The ID is originally assigned by the channel on creation of the admin.
Returns:
A reference to the supplier admin with the given ID. If no matching admin object is found an AdminNotFound exception is raised.

new_for_consumers
ConsumerAdmin new_for_consumers(in InterFilterGroupOperator op,
                                out AdminID id);

Creates a new consumer admin.

Parameters:
op - The InterFilterGroupOperator to apply between filter results from the target object and subsequently created proxy objects.
id - The id assigned to the new consumer admin by the event channel.
Returns:
A reference to the newly created consumer admin is returned.

new_for_suppliers
SupplierAdmin new_for_suppliers(in InterFilterGroupOperator op,
                                out AdminID id);

Creates a new supplier admin.

Parameters:
op - The InterFilterGroupOperator to apply between filter results from the target object and subsequently created proxy objects.
id - The id assigned to the new supplier admin by the event channel.
Returns:
A reference to the newly created supplier admin is returned.


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