Interface CosNotifyChannelAdmin::SupplierAdmin

interface SupplierAdmin
inherits from CosNotification::QoSAdmin, CosNotifyComm::NotifyPublish, CosNotifyFilter::FilterAdmin, CosEventChannelAdmin::SupplierAdmin

The SupplierAdmin interface supports the creation of proxy consumers.



Attribute Index

MyChannel
A reference to the parent channel.
MyID
The ID assigned to the target admin object by the channel.
MyOperator
The InterFilterGroupOperator to be used when combining filter results from the target admin object a its child proxies.
pull_consumers
A list of pull consumers managed by the target admin object.
push_consumers
A list of push consumers managed by the target admin object.

Operation Index

destroy
Destroys the target admin object and all proxies it is managing.
get_proxy_consumer
Obtains a reference to a proxy consumer with the given proxy ID.
obtain_notification_pull_consumer
Creates a new proxy pull consumer.
obtain_notification_push_consumer
Creates a new proxy push consumer.

Attributes

MyChannel
readonly attribute EventChannel MyChannel;

A reference to the parent channel.


MyID
readonly attribute AdminID MyID;

The ID assigned to the target admin object by the channel.


MyOperator
readonly attribute InterFilterGroupOperator MyOperator;

The InterFilterGroupOperator to be used when combining filter results from the target admin object a its child proxies.


pull_consumers
readonly attribute ProxyIDSeq pull_consumers;

A list of pull consumers managed by the target admin object.


push_consumers
readonly attribute ProxyIDSeq push_consumers;

A list of push consumers managed by the target admin object.



Operations

destroy
void destroy();

Destroys the target admin object and all proxies it is managing.


get_proxy_consumer
ProxyConsumer get_proxy_consumer(in ProxyID proxy_id)
    raises(ProxyNotFound);

Obtains a reference to a proxy consumer with the given proxy ID.

Parameters:
proxy_id - The ID of the proxy to locate. A supplier admin object assigns an ID to each proxy it creates.
Returns:
If found, a reference to the proxy consumer is returned. Otherwise a ProxyNotFound exception is raised.

obtain_notification_pull_consumer
ProxyConsumer obtain_notification_pull_consumer(in ClientType ctype,
                                                out ProxyID proxy_id)
    raises(AdminLimitExceeded);

Creates a new proxy pull consumer.

Parameters:
ctype - Specifies the client type. The returned proxy can be narrowed to a type suitable for the given client type.
proxy_id - Returns the ID assigned to the newly created proxy.
Returns:
A reference to a newly created proxy consumer is returned. This reference should be narrowed to the appropriate type before use. The AdminLimitExceeded exception is raised if creating a new proxy would exceed the limit for the target admin.

obtain_notification_push_consumer
ProxyConsumer obtain_notification_push_consumer(in ClientType ctype,
                                                out ProxyID proxy_id)
    raises(AdminLimitExceeded);

Creates a new proxy push consumer.

Parameters:
ctype - Specifies the client type. The returned proxy can be narrowed to a type suitable for the given client type.
proxy_id - Returns the ID assigned to the newly created proxy.
Returns:
A reference to a newly created proxy consumer is returned. This reference should be narrowed to the appropriate type before use. The AdminLimitExceeded exception is raised if creating a new proxy would exceed the limit for the target admin.


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