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

Defines the interface used to build event channels. More...

import "CosNotifyChannelAdmin.idl";

Collaboration diagram for CosNotifyChannelAdmin::EventChannelFactory:
Collaboration graph

Public Member Functions

EventChannel create_channel (in CosNotification::QoSProperties initial_qos, in CosNotification::AdminProperties initial_admin, out ChannelID id) raises (CosNotification::UnsupportedQoS, CosNotification::UnsupportedAdmin )
 Create a new event channel.
 
ChannelIDSeq get_all_channels ()
 Get the complete list of event channels in this factory.
 
EventChannel get_event_channel (in ChannelID id) raises (ChannelNotFound)
 Get an event channel given its ID.
 

Detailed Description

Defines the interface used to build event channels.

Member Function Documentation

EventChannel CosNotifyChannelAdmin::EventChannelFactory::create_channel ( in CosNotification::QoSProperties  initial_qos,
in CosNotification::AdminProperties  initial_admin,
out ChannelID  id 
) raises (CosNotification::UnsupportedQoS, CosNotification::UnsupportedAdmin )

Create a new event channel.

Parameters
initial_qosConfigure the initial QoS properties of the new EventChannel
initial_adminConfigure the initial Admin properties of the new EventChannel
idReturns the ID assigned to the new EventChannel
Returns
The new event channel
Exceptions
CosNotification::UnsupportedQoSif the requested QoS properties cannot be satisfied or are invalid
CosNotification::UnsupportedAdminif the requested admin properties cannot be satisfied or are invalid
ChannelIDSeq CosNotifyChannelAdmin::EventChannelFactory::get_all_channels ( )

Get the complete list of event channels in this factory.

EventChannel CosNotifyChannelAdmin::EventChannelFactory::get_event_channel ( in ChannelID  id) raises (ChannelNotFound)

Get an event channel given its ID.

Parameters
idThe ID of the event channel the application wants
Returns
The event channel
Exceptions
ChannelNotFoundif the give ID is unknown on this factory

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