Interface CosNotifyChannelAdmin::ConsumerAdmin

interface ConsumerAdmin
inherits from CosNotification::QoSAdmin, CosNotifyComm::NotifySubscribe, CosNotifyFilter::FilterAdmin, CosEventChannelAdmin::ConsumerAdmin

The ConsumerAdmin interface supports the creation of proxy suppliers.



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 and its child proxies.
lifetime_filter
Reference to an optional lifetime mapping filter.
priority_filter
Reference to an optional priority mapping filter.
pull_suppliers
A list of pull suppliers managed by the target admin object.
push_suppliers
A list of push suppliers managed by the target admin object.

Operation Index

destroy
Destroys the target admin object and all proxies it is managing.
get_proxy_supplier
Obtains a reference to a proxy supplier with the given proxy ID.
obtain_notification_pull_supplier
Creates a new proxy pull supplier.
obtain_notification_push_supplier
Creates a new proxy push supplier.

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 and its child proxies.


lifetime_filter
attribute CosNotifyFilter::MappingFilter lifetime_filter;

Reference to an optional lifetime mapping filter.


priority_filter
attribute CosNotifyFilter::MappingFilter priority_filter;

Reference to an optional priority mapping filter.


pull_suppliers
readonly attribute ProxyIDSeq pull_suppliers;

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


push_suppliers
readonly attribute ProxyIDSeq push_suppliers;

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



Operations

destroy
void destroy();

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


get_proxy_supplier
ProxySupplier get_proxy_supplier(in ProxyID proxy_id)
    raises(ProxyNotFound);

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

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

obtain_notification_pull_supplier
ProxySupplier obtain_notification_pull_supplier(in ClientType ctype,
                                                out ProxyID proxy_id)
    raises(AdminLimitExceeded);

Creates a new proxy pull supplier.

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 supplier 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_supplier
ProxySupplier obtain_notification_push_supplier(in ClientType ctype,
                                                out ProxyID proxy_id)
    raises(AdminLimitExceeded);

Creates a new proxy push supplier.

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 supplier 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)