1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">
<erlref>
<header>
<copyright>
<year>2000</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
The contents of this file are subject to the Erlang Public License,
Version 1.1, (the "License"); you may not use this file except in
compliance with the License. You should have received a copy of the
Erlang Public License along with this software. If not, it can be
retrieved online at http://www.erlang.org/.
Software distributed under the License is distributed on an "AS IS"
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
the License for the specific language governing rights and limitations
under the License.
</legalnotice>
<title>CosNotifyChannelAdmin_EventChannelFactory</title>
<prepared></prepared>
<docno></docno>
<checked></checked>
<date>2000-02-01</date>
<rev>1.0</rev>
</header>
<module>CosNotifyChannelAdmin_EventChannelFactory</module>
<modulesummary>This module implements the OMG CosNotifyChannelAdmin::EventChannelFactory interface.</modulesummary>
<description>
<p>To get access to the record definitions for the structures use: <br></br>
<c>-include_lib("cosNotification/include/*.hrl").</c></p>
</description>
<funcs>
<func>
<name>create_channel(ChannelFactory, InitialQoS, InitialAdmin) -> Return</name>
<fsummary>Create a new channel</fsummary>
<type>
<v>ChannelFactory = #objref</v>
<v>InitialQoS = CosNotification::QoSProperties</v>
<v>InitialAdmin = CosNotification::AdminProperties</v>
<v>Return = {EventChannel, ChannelID}</v>
<v>EventChannel = #objref</v>
<v>ChannelID = long()</v>
</type>
<desc>
<p>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 <c>User's Guide</c>.</p>
<p>If no QoS- and/or Admin-properties are supplied (i.e. empty list),
the <em>default</em> settings will be used. For more information, see the
User's Guide.</p>
</desc>
</func>
<func>
<name>get_all_channels(ChannelFactory) -> ChannelIDSeq</name>
<fsummary>Return all Id:s for channels, currently alive, created by the target object</fsummary>
<type>
<v>ChannelFactory = #objref</v>
<v>ChannelIDSeq = [long()]</v>
</type>
<desc>
<p>This operation returns a id sequence of all channel's created by this ChannelFactory.</p>
</desc>
</func>
<func>
<name>get_event_channel(ChannelFactory, ChannelID) -> Return</name>
<fsummary>Return the channel object associated with the given Id</fsummary>
<type>
<v>ChannelFactory = #objref</v>
<v>ChannelID = long()</v>
<v>Retrurn = EventChannel | {'EXCEPTION', #'CosNotifyChannelAdmin_ChannelNotFound'{}}</v>
<v>EventChannel = #objref</v>
</type>
<desc>
<p>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.</p>
</desc>
</func>
</funcs>
</erlref>
|
