CosNotifyChannelAdmin_EventChannelFactory

MODULE

CosNotifyChannelAdmin_EventChannelFactory

MODULE SUMMARY

DESCRIPTION

To get access to the record definitions for the structures use:
-include_lib("cosNotification/include/*.hrl").

EXPORTS

create_channel(ChannelFactory, InitialQoS, InitialAdmin) -> Return

Types:
ChannelFactory = #objref
InitialQoS = CosNotification::QoSProperties
InitialAdmin = CosNotification::AdminProperties
Return = {EventChannel, ChannelID}
EventChannel = #objref
ChannelID = long()

This operation creates a new event channel. Along with the channel reference an id is returned which can be used when invoking other operations exported by this module. The Quality of Service argument supplied will be inherited by objects created by the channel. For more information about QoS settings see the User's Guide.

get_all_channels(ChannelFactory) -> ChannelIDSeq

Types:
ChannelFactory = #objref
ChannelIDSeq = [long()]

This operation returns a id sequnce of all channel's created by this ChannelFactory.

get_event_channel(ChannelFactory, ChannelID) -> Return

Types:
ChannelFactory = #objref
ChannelID = long()
Retrurn = EventChannel | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}
EventChannel = #objref

This operation returns the EventChannel associated with the given id. If no channel is associated with the id, i.e., never existed or have been terminated, an exception is raised.

AUTHORS

support - support@erlang.ericsson.se