1CosNotifyChannelAdmin_EventCEhralnannegl(M3o)dule DCeofsiNnoittiifoynChannelAdmin_EventChannel(3)
2
3
4

NAME

6       CosNotifyChannelAdmin_EventChannel  -  This  module  implements the OMG
7       CosNotifyChannelAdmin::EventChannel interface.
8

DESCRIPTION

10       To get access to the record definitions for the structures use:
11       -include_lib("cosNotification/include/*.hrl").
12
13       This module also exports the functions described in:
14
15         * CosNotification_QoSAdmin
16
17         * CosNotification_AdminPropertiesAdmin
18

EXPORTS

20       _get_MyFactory(Channel) -> ChannelFactory
21
22              Types:
23
24                 Channel = #objref
25                 ChannelFactory = #objref
26
27              This readonly attribute maintains the  reference  of  the  event
28              channel factory that created the target channel.
29
30       _get_default_consumer_admin(Channel) -> ConsumerAdmin
31
32              Types:
33
34                 Channel = #objref
35                 ConsumerAdmin = #objref
36
37              This  is  a  readonly attribute which maintains a reference to a
38              default ConsumerAdmin object associated with the target object.
39
40       _get_default_supplier_admin(Channel) -> SupplierAdmin
41
42              Types:
43
44                 Channel = #objref
45                 SupplierAdmin = #objref
46
47              This is a readonly attribute which maintains a  reference  to  a
48              default SupplierAdmin object associated with the target object.
49
50       _get_default_filter_factory(Channel) -> FilterFactory
51
52              Types:
53
54                 Channel = #objref
55                 FilterFactory = #objref
56
57              The  default FilterFactory associated with the target channel is
58              maintained by this readonly attribute.
59
60       new_for_consumers(Channel, OpType) -> Return
61
62              Types:
63
64                 Channel = #objref
65                 OpType = 'AND_OP' | 'OR_OP'
66                 Return = {ConsumerAdmin, AdminID}
67                 ConsumerAdmin = #objref
68                 AdminID = long()
69
70              This operation creates a new instance  of  a  ConsumerAdmin  and
71              supplies  an Id which may be used when invoking other operations
72              exported by this module. The returned object  will  inherit  the
73              Quality of Service properties of the target channel.
74
75       for_consumers(Channel) -> ConsumerAdmin
76
77              Types:
78
79                 Channel = #objref
80                 ConsumerAdmin = #objref
81
82              A  new  new instance of a ConsumerAdmin object is created but no
83              Id is returned. The  returned  object's  operation  type,  i.e.,
84              'AND_OP'  or 'OR_OP', will be set to the value of the configura‐
85              tion parameter filterOp. The target object's Quality of  Service
86              properties will be inherited by the returned ConsumerAdmin.
87
88       new_for_suppliers(Channel, OpType) -> Return
89
90              Types:
91
92                 Channel = #objref
93                 OpType = 'AND_OP' | 'OR_OP'
94                 Return = {SupplierAdmin, AdminID}
95                 SupplierAdmin = #objref
96                 AdminID = long()
97
98              Enables  us  to create a new instance of a SupplierAdmin. An Id,
99              which may be used when invoking  other  operations  exported  by
100              this  module,  is  also returned. The current Quality of Service
101              settings associated with the target object will be inherited  by
102              the SupplierAdmin.
103
104       for_suppliers(Channel) -> SupplierAdmin
105
106              Types:
107
108                 Channel = #objref
109                 SupplierAdmin = #objref
110
111              To  create  a new SupplierAdmin with the target object's current
112              Quality of Service settings we can use this  function.  The  re‐
113              turned object's operation type ('AND_OP' or 'OR_OP') will be de‐
114              termined by the configuration variable filterOp.
115
116       get_consumeradmin(Channel, AdminID) -> ConsumerAdmin
117
118              Types:
119
120                 Channel = #objref
121                 AdminID = long()
122                 ConsumerAdmin = #objref | {'EXCEPTION', #'CosNotifyChannelAd‐
123                 min_AdminNotFound'{}}
124
125              If  the  given  Id is associated with a ConsumerAdmin the object
126              reference is returned. If such association never existed or  the
127              ConsumerAdmin have terminated an exception is raised.
128
129       get_supplieradmin(Channel, AdminID) -> SupplierAdmin
130
131              Types:
132
133                 Channel = #objref
134                 AdminID = long()
135                 SupplierAdmin = #objref | {'EXCEPTION', #'CosNotifyChannelAd‐
136                 min_AdminNotFound'{}}
137
138              Equal to the operation get_consumeradmin/2 but a reference to  a
139              SupplierAdmin is returned.
140
141       get_all_consumeradmins(Channel) -> Reply
142
143              Types:
144
145                 Channel = #objref
146                 Reply = [AdminID]
147                 AdminID = long()
148
149              To  get  access  to all ConsumerAdmin Id's created by the target
150              object, and still alive, this operation could be invoked.
151
152       get_all_supplieradmins(Channel) -> Reply
153
154              Types:
155
156                 Channel = #objref
157                 Reply = [AdminID]
158                 AdminID = long()
159
160              Equal to the operation get_all_consumeradmins/1  but  returns  a
161              list of all SupplierAdmin object ID's.
162
163       destroy(Channel) -> ok
164
165              Types:
166
167                 Channel = #objref
168
169              The  destroy operation will terminate the target channel and all
170              associated Admin objects.
171
172
173
174Ericsson AB                  cosNotificatiCoonsN5o.t0i.f1yChannelAdmin_EventChannel(3)
Impressum