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::ProxySupplier Interface Reference

Defines the interface shared by all supplier proxies. More...

import "CosNotifyChannelAdmin.idl";

Inheritance diagram for CosNotifyChannelAdmin::ProxySupplier:
Inheritance graph
Collaboration diagram for CosNotifyChannelAdmin::ProxySupplier:
Collaboration graph

Public Member Functions

CosNotification::EventTypeSeq obtain_offered_types (in ObtainInfoMode mode)
 
void validate_event_qos (in CosNotification::QoSProperties required_qos, out CosNotification::NamedPropertyRangeSeq available_qos) raises (CosNotification::UnsupportedQoS)
 Validate a list of QoS properties for an event. 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 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 Attributes

readonly attribute ProxyType MyType
 The style and event format for this proxy. More...
 
readonly attribute ConsumerAdmin MyAdmin
 The ConsumerAdmin this proxy belongs to. More...
 
attribute
CosNotifyFilter::MappingFilter 
priority_filter
 
attribute
CosNotifyFilter::MappingFilter 
lifetime_filter
 

Detailed Description

Defines the interface shared by all supplier proxies.

Supplier proxies are used by consumers to communicate with the Notification Service, this interface captures the shared operations in all those proxies.

Member Function Documentation

CosNotification::EventTypeSeq CosNotifyChannelAdmin::ProxySupplier::obtain_offered_types ( in ObtainInfoMode  mode)

Get the list of event types that this proxy could potentially forward to its connected supplier

Parameters
modeDescribe how the publications should be fetched
Returns
The list of current subscriptions, if requested in the mode argument
void CosNotifyChannelAdmin::ProxySupplier::validate_event_qos ( in CosNotification::QoSProperties  required_qos,
out CosNotification::NamedPropertyRangeSeq  available_qos 
) raises (CosNotification::UnsupportedQoS)

Validate a list of QoS properties for an event.

Applications send events with specific QoS properties, the following operation allows consumers to verify if a given set of QoS properties would be honored by the proxy.

Parameters
required_qosThe QoS properties required by the supplier
available_qosIf the QoS properties required are supported this argument returns any other QoS properties that the application may set without breaking the proxy capabilities.
Exceptions
CosNotification::UnsupportedQoSif the QoS properties required cannot be supported. The exception describes the problems and any legal values in detail.

Member Data Documentation

attribute CosNotifyFilter::MappingFilter CosNotifyChannelAdmin::ProxySupplier::lifetime_filter

Get and set the mapping filter used to change the lifetime property for this proxy. The filter is initialized to the nil reference

readonly attribute ConsumerAdmin CosNotifyChannelAdmin::ProxySupplier::MyAdmin

The ConsumerAdmin this proxy belongs to.

readonly attribute ProxyType CosNotifyChannelAdmin::ProxySupplier::MyType

The style and event format for this proxy.

attribute CosNotifyFilter::MappingFilter CosNotifyChannelAdmin::ProxySupplier::priority_filter

Get and set the mapping filter used to change the priority property for this proxy. The filter is initialized to the nil reference


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