CosNotifyChannelAdmin::ConsumerAdmin Interface Reference

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

import "CosNotifyChannelAdmin.idl";

Inheritance diagram for CosNotifyChannelAdmin::ConsumerAdmin:

Collaboration diagram for CosNotifyChannelAdmin::ConsumerAdmin:

List of all members.

Public Member Functions
ProxySupplier	get_proxy_supplier (in ProxyID proxy_id) raises (ProxyNotFound )
	Get an specific ProxySupplier.
ProxySupplier	obtain_notification_pull_supplier (in ClientType ctype, out ProxyID proxy_id) raises ( AdminLimitExceeded )
	Create a new pull-style proxy supplier.
ProxySupplier	obtain_notification_push_supplier (in ClientType ctype, out ProxyID proxy_id) raises ( AdminLimitExceeded )
	Create a new push-style proxy supplier.
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::NotifySubscribe
void	subscription_change (in CosNotification::EventTypeSeq added, in CosNotification::EventTypeSeq removed) raises ( InvalidEventType )
	Report a change in the list of subscriptions.
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::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.
readonly attribute EventChannel	MyChannel
	The event channel this admin belongs to.
readonly attribute InterFilterGroupOperator	MyOperator
	How are multiple filters interpreted.
attribute CosNotifyFilter::MappingFilter	priority_filter
attribute CosNotifyFilter::MappingFilter	lifetime_filter
readonly attribute ProxyIDSeq	pull_suppliers
	Get the complete list of pull proxy suppliers.
readonly attribute ProxyIDSeq	push_suppliers
	Get the complete list of push proxy suppliers.

---

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_id

The proxy ID that will be retrieved

Exceptions:

ProxyNotFound

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

ctype	The event format that the ProxySupplier should support
proxy_id	The ID assigned to the new proxy supplier

Returns:

The new ProxySupplier

Exceptions:

AdminLimitExceeded

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

ctype	The event format that the ProxySupplier should support
proxy_id	The ID assigned to the new proxy supplier

Returns:

The new ProxySupplier

Exceptions:

AdminLimitExceeded

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

• CosNotifyChannelAdmin.idl