Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members  

CosNotifyChannelAdmin::ConsumerAdmin Interface Reference

An interface for consumer administration objects. More...

import "CosNotifyChannelAdmin.idl";

Inherits CosNotification::QoSAdmin, CosNotifyComm::NotifySubscribe, CosNotifyFilter::FilterAdmin, and CosEventChannelAdmin::ConsumerAdmin.

Inherited by CosTypedNotifyChannelAdmin::TypedConsumerAdmin, DsNotifyLogAdmin::NotifyLogFactory, DsTypedNotifyLogAdmin::TypedNotifyLogFactory, and NotificationExtensions::TrConsumerAdmin.

List of all members.

Public Methods

ProxySupplier get_proxy_supplier (in ProxyID proxy_id) raises ( ProxyNotFound )
 Get the proxy with the specified ID. More...

ProxySupplier obtain_notification_pull_supplier (in ClientType ctype, out ProxyID proxy_id) raises ( AdminLimitExceeded )
 Obtain a pull supplier proxy for this administration object. More...

ProxySupplier obtain_notification_push_supplier (in ClientType ctype, out ProxyID proxy_id) raises ( AdminLimitExceeded )
 Obtain a push supplier proxy for this administration object. More...

void destroy ()
 Destroy this administration object and all proxies created by it. More...


Public Attributes

readonly attribute AdminID MyID
 A unique identifier for this administration object. More...

readonly attribute EventChannel MyChannel
 The event channel object that created this administration object. More...

readonly attribute InterFilterGroupOperator MyOperator
 Indicates whether AND or OR semantics is used when combining administration object filters and proxy filters. More...

attribute CosNotifyFilter::MappingFilter priority_filter
 A mapping filter which if a non-nil reference will be consulted for resolving the priority of the event. More...

attribute CosNotifyFilter::MappingFilter lifetime_filter
 A mapping filter which if a non-nil reference will be consulted for resolving the lifetime of the event. More...

readonly attribute ProxyIDSeq pull_suppliers
 A list of pull supplier proxies created by the administration object. More...

readonly attribute ProxyIDSeq push_suppliers
 A list of push supplier proxies created by the administration object. More...


Detailed Description

An interface for consumer administration objects.


Member Function Documentation

void CosNotifyChannelAdmin::ConsumerAdmin::destroy  
 

Destroy this administration object and all proxies created by it.

ProxySupplier CosNotifyChannelAdmin::ConsumerAdmin::get_proxy_supplier in ProxyID    proxy_id raises ( ProxyNotFound )
 

Get the proxy with the specified ID.

m <code>proxy_id</code> - The ID of the proxy to retrieve.
@raises ProxyNotFound If no proxy with the specified ID could be found.

ProxySupplier CosNotifyChannelAdmin::ConsumerAdmin::obtain_notification_pull_supplier in ClientType    ctype,
out ProxyID    proxy_id
raises ( AdminLimitExceeded )
 

Obtain a pull supplier proxy for this administration object.

m <code>ctype</code> - The client type.
m <code>proxy_id</code> - The ID of the newly created proxy,
i.e. the return value.
Returns:
A ProxySupplier object reference. @raises AdminLimitExceeded If the number of proxies associated with this administration object exceeds the MaxConsumers property.

ProxySupplier CosNotifyChannelAdmin::ConsumerAdmin::obtain_notification_push_supplier in ClientType    ctype,
out ProxyID    proxy_id
raises ( AdminLimitExceeded )
 

Obtain a push supplier proxy for this administration object.

m <code>ctype</code> - The client type.
m <code>proxy_id</code> - The ID of the newly created proxy,
i.e. the return value.
Returns:
A ProxySupplier object reference. @raises AdminLimitExceeded If the number of proxies associated with this administration object exceeds the MaxConsumers property.


Member Data Documentation

attribute CosNotifyFilter::MappingFilter CosNotifyChannelAdmin::ConsumerAdmin::lifetime_filter
 

A mapping filter which if a non-nil reference will be consulted for resolving the lifetime of the event.

readonly attribute EventChannel CosNotifyChannelAdmin::ConsumerAdmin::MyChannel
 

The event channel object that created this administration object.

readonly attribute AdminID CosNotifyChannelAdmin::ConsumerAdmin::MyID
 

A unique identifier for this administration object.

readonly attribute InterFilterGroupOperator CosNotifyChannelAdmin::ConsumerAdmin::MyOperator
 

Indicates whether AND or OR semantics is used when combining administration object filters and proxy filters.

attribute CosNotifyFilter::MappingFilter CosNotifyChannelAdmin::ConsumerAdmin::priority_filter
 

A mapping filter which if a non-nil reference will be consulted for resolving the priority of the event.

readonly attribute ProxyIDSeq CosNotifyChannelAdmin::ConsumerAdmin::pull_suppliers
 

A list of pull supplier proxies created by the administration object.

readonly attribute ProxyIDSeq CosNotifyChannelAdmin::ConsumerAdmin::push_suppliers
 

A list of push supplier proxies created by the administration object.