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

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

import "CosNotifyChannelAdmin.idl";

Inheritance diagram for CosNotifyChannelAdmin::SupplierAdmin:
Inheritance graph
Collaboration diagram for CosNotifyChannelAdmin::SupplierAdmin:
Collaboration graph

Public Member Functions

ProxyConsumer get_proxy_consumer (in ProxyID proxy_id) raises ( ProxyNotFound )
 Get an specific ProxyConsumer.
 
ProxyConsumer obtain_notification_pull_consumer (in ClientType ctype, out ProxyID proxy_id) raises ( AdminLimitExceeded )
 Create a new pull-style proxy consumer.
 
ProxyConsumer obtain_notification_push_consumer (in ClientType ctype, out ProxyID proxy_id) raises ( AdminLimitExceeded )
 Create a new push-style proxy consumer.
 
void destroy ()
 Destroy the Admin.
 
- Public Member Functions inherited from CosNotification::QoSAdmin
QoSProperties get_qos ()
 Get the current QoS properties.
 
void set_qos (in QoSProperties qos) raises ( UnsupportedQoS )
 Set the QoS properties.
 
void validate_qos (in QoSProperties required_qos, out NamedPropertyRangeSeq available_qos) raises ( UnsupportedQoS )
 Validate a set of QoS properties.
 
- Public Member Functions inherited from CosNotifyComm::NotifyPublish
void offer_change (in CosNotification::EventTypeSeq added, in CosNotification::EventTypeSeq removed) raises ( InvalidEventType )
 Report a change in the list of publications.
 
- Public Member Functions inherited from CosNotifyFilter::FilterAdmin
FilterID add_filter (in Filter new_filter)
 Add a filter.
 
void remove_filter (in FilterID filter) raises ( FilterNotFound )
 Remove a filter.
 
Filter get_filter (in FilterID filter) raises ( FilterNotFound )
 Get a filter.
 
FilterIDSeq get_all_filters ()
 Get the IDs of all the filters.
 
void remove_all_filters ()
 Remove all the filters from this component.
 
- Public Member Functions inherited from CosEventChannelAdmin::SupplierAdmin
ProxyPushConsumer obtain_push_consumer ()
 
ProxyPullConsumer obtain_pull_consumer ()
 

Public Attributes

readonly attribute AdminID MyID
 The ID assigned to this admin by its event channel.
 
readonly attribute EventChannel MyChannel
 The event channel this admin belongs to.
 
readonly attribute
InterFilterGroupOperator 
MyOperator
 How are multiple filters interpreted.
 
readonly attribute ProxyIDSeq pull_consumers
 Get the complete list of pull proxy consumers.
 
readonly attribute ProxyIDSeq push_consumers
 Get the complete list of push proxy consumers.
 

Detailed Description

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

Member Function Documentation

void CosNotifyChannelAdmin::SupplierAdmin::destroy ( )

Destroy the Admin.

ProxyConsumer CosNotifyChannelAdmin::SupplierAdmin::get_proxy_consumer ( in ProxyID  proxy_id) raises ( ProxyNotFound )

Get an specific ProxyConsumer.

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

Create a new pull-style proxy consumer.

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

Create a new push-style proxy consumer.

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

Member Data Documentation

readonly attribute EventChannel CosNotifyChannelAdmin::SupplierAdmin::MyChannel

The event channel this admin belongs to.

readonly attribute AdminID CosNotifyChannelAdmin::SupplierAdmin::MyID

The ID assigned to this admin by its event channel.

readonly attribute InterFilterGroupOperator CosNotifyChannelAdmin::SupplierAdmin::MyOperator

How are multiple filters interpreted.

readonly attribute ProxyIDSeq CosNotifyChannelAdmin::SupplierAdmin::pull_consumers

Get the complete list of pull proxy consumers.

readonly attribute ProxyIDSeq CosNotifyChannelAdmin::SupplierAdmin::push_consumers

Get the complete list of push proxy consumers.


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