CosNotifyChannelAdmin::SupplierAdmin Interface Reference

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

import"CosNotifyChannelAdmin.idl";

Inheritance diagram for CosNotifyChannelAdmin::SupplierAdmin:

Collaboration diagram for CosNotifyChannelAdmin::SupplierAdmin:

Public Member Functions
ProxyConsumer	get_proxy_consumer (in ProxyID proxy_id) raises ( ProxyNotFound )
	Get an specific ProxyConsumer. More...
ProxyConsumer	obtain_notification_pull_consumer (in ClientType ctype, out ProxyID proxy_id) raises ( AdminLimitExceeded )
	Create a new pull-style proxy consumer. More...
ProxyConsumer	obtain_notification_push_consumer (in ClientType ctype, out ProxyID proxy_id) raises ( AdminLimitExceeded )
	Create a new push-style proxy consumer. 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::NotifyPublish
void	offer_change (in CosNotification::EventTypeSeq added, in CosNotification::EventTypeSeq removed) raises ( InvalidEventType )
	Report a change in the list of publications. 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::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. More...
readonly attribute EventChannel	MyChannel
	The event channel this admin belongs to. More...
readonly attribute InterFilterGroupOperator	MyOperator
	How are multiple filters interpreted. More...
readonly attribute ProxyIDSeq	pull_consumers
	Get the complete list of pull proxy consumers. More...
readonly attribute ProxyIDSeq	push_consumers
	Get the complete list of push proxy consumers. More...

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_id

The proxy ID that will be retrieved

Exceptions

ProxyNotFound

if 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

ctype	The event format that the ProxyConsumer should support
proxy_id	The ID assigned to the new proxy consumer

Returns

The new ProxyConsumer

Exceptions

AdminLimitExceeded

if 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

ctype	The event format that the ProxyConsumer should support
proxy_id	The ID assigned to the new proxy consumer

Returns

The new ProxySupplier

Exceptions

AdminLimitExceeded

if 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:

• CosNotifyChannelAdmin.idl