TAO_CosNotification  2.2.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
CosNotifyChannelAdmin::ConsumerAdmin Interface Reference

Interface used to control and obtain the proxies used by consumers. More...

import "CosNotifyChannelAdmin.idl";

Inheritance diagram for CosNotifyChannelAdmin::ConsumerAdmin:
Inheritance graph
Collaboration diagram for CosNotifyChannelAdmin::ConsumerAdmin:
Collaboration graph

Public Member Functions

ProxySupplier get_proxy_supplier (in ProxyID proxy_id) raises (ProxyNotFound )
 Get an specific ProxySupplier. More...
 
ProxySupplier obtain_notification_pull_supplier (in ClientType ctype, out ProxyID proxy_id) raises ( AdminLimitExceeded )
 Create a new pull-style proxy supplier. More...
 
ProxySupplier obtain_notification_push_supplier (in ClientType ctype, out ProxyID proxy_id) raises ( AdminLimitExceeded )
 Create a new push-style proxy supplier. More...
 
void destroy ()
 Destroy the Admin. More...
 
- Public Member Functions inherited from CosNotification::QoSAdmin
QoSProperties get_qos ()
 Get the current QoS properties. More...
 
void set_qos (in QoSProperties qos) raises ( UnsupportedQoS )
 Set the QoS properties. More...
 
void validate_qos (in QoSProperties required_qos, out NamedPropertyRangeSeq available_qos) raises ( UnsupportedQoS )
 Validate a set of QoS properties. More...
 
- Public Member Functions inherited from CosNotifyComm::NotifySubscribe
void subscription_change (in CosNotification::EventTypeSeq added, in CosNotification::EventTypeSeq removed) raises ( InvalidEventType )
 Report a change in the list of subscriptions. More...
 
- Public Member Functions inherited from CosNotifyFilter::FilterAdmin
FilterID add_filter (in Filter new_filter)
 Add a filter. More...
 
void remove_filter (in FilterID filter) raises ( FilterNotFound )
 Remove a filter. More...
 
Filter get_filter (in FilterID filter) raises ( FilterNotFound )
 Get a filter. More...
 
FilterIDSeq get_all_filters ()
 Get the IDs of all the filters. More...
 
void remove_all_filters ()
 Remove all the filters from this component. More...
 
- Public Member Functions inherited from CosEventChannelAdmin::ConsumerAdmin
ProxyPushSupplier obtain_push_supplier ()
 
ProxyPullSupplier obtain_pull_supplier ()
 

Public Attributes

readonly attribute AdminID MyID
 The ID assigned to this admin by its event channel. More...
 
readonly attribute EventChannel MyChannel
 The event channel this admin belongs to. More...
 
readonly attribute
InterFilterGroupOperator 
MyOperator
 How are multiple filters interpreted. More...
 
attribute
CosNotifyFilter::MappingFilter 
priority_filter
 
attribute
CosNotifyFilter::MappingFilter 
lifetime_filter
 
readonly attribute ProxyIDSeq pull_suppliers
 Get the complete list of pull proxy suppliers. More...
 
readonly attribute ProxyIDSeq push_suppliers
 Get the complete list of push proxy suppliers. More...
 

Detailed Description

Interface used to control and obtain the proxies used by consumers.

Member Function Documentation

void CosNotifyChannelAdmin::ConsumerAdmin::destroy ( )

Destroy the Admin.

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

Get an specific ProxySupplier.

Parameters
proxy_idThe proxy ID that will be retrieved
Exceptions
ProxyNotFoundif the proxy_id is not found in this ConsumerAdmin
ProxySupplier CosNotifyChannelAdmin::ConsumerAdmin::obtain_notification_pull_supplier ( in ClientType  ctype,
out ProxyID  proxy_id 
) raises ( AdminLimitExceeded )

Create a new pull-style proxy supplier.

Parameters
ctypeThe event format that the ProxySupplier should support
proxy_idThe ID assigned to the new proxy supplier
Returns
The new ProxySupplier
Exceptions
AdminLimitExceededif a limit in this admin is reached, such as the maximum number of proxies.
ProxySupplier CosNotifyChannelAdmin::ConsumerAdmin::obtain_notification_push_supplier ( in ClientType  ctype,
out ProxyID  proxy_id 
) raises ( AdminLimitExceeded )

Create a new push-style proxy supplier.

Parameters
ctypeThe event format that the ProxySupplier should support
proxy_idThe ID assigned to the new proxy supplier
Returns
The new ProxySupplier
Exceptions
AdminLimitExceededif a limit in this admin is reached, such as the maximum number of proxies.

Member Data Documentation

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

A special mapping filter to change the lifetime property of events

readonly attribute EventChannel CosNotifyChannelAdmin::ConsumerAdmin::MyChannel

The event channel this admin belongs to.

readonly attribute AdminID CosNotifyChannelAdmin::ConsumerAdmin::MyID

The ID assigned to this admin by its event channel.

readonly attribute InterFilterGroupOperator CosNotifyChannelAdmin::ConsumerAdmin::MyOperator

How are multiple filters interpreted.

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

A special mapping filter to change the priority property of events

readonly attribute ProxyIDSeq CosNotifyChannelAdmin::ConsumerAdmin::pull_suppliers

Get the complete list of pull proxy suppliers.

readonly attribute ProxyIDSeq CosNotifyChannelAdmin::ConsumerAdmin::push_suppliers

Get the complete list of push proxy suppliers.


The documentation for this interface was generated from the following file: