1CosNotifyChannelAdmin_ConsumEerrlAadnmginM(o3d)uleCDoesfNiontiitfiyoCnhannelAdmin_ConsumerAdmin(3)
2
3
4

NAME

6       CosNotifyChannelAdmin_ConsumerAdmin  -  This  module implements the OMG
7       CosNotifyChannelAdmin::ConsumerAdmin 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         * CosNotifyComm_NotifySubscribe
18
19         * CosNotifyFilter_FilterAdmin
20

EXPORTS

22       _get_MyID(ConsumerAdmin) -> AdminID
23
24              Types:
25
26                 ConsumerAdmin = #objref
27                 AdminID = long()
28
29              The ID returned by the creating channel is equal  to  the  value
30              encapsulated by this readonly attribute.
31
32       _get_MyChannel(ConsumerAdmin) -> Channel
33
34              Types:
35
36                 ConsumerAdmin = #objref
37                 Channel = #objref
38
39              The  creating channel's reference is maintained by this readonly
40              attribute.
41
42       _get_MyOperator(ConsumerAdmin) -> OpType
43
44              Types:
45
46                 ConsumerAdmin = #objref
47                 OpType = 'AND_OP' | 'OR_OP'
48
49              When  ConsumerAdmin's  are  created  an  operation  type,  i.e.,
50              'AND_OP' or 'OR_OP', is supplied, which determines the semantics
51              used by the target object concerning evaluation against any  as‐
52              sociated Filter objects.
53
54       _get_priority_filter(ConsumerAdmin) -> MappingFilter
55
56              Types:
57
58                 ConsumerAdmin = MappingFilter = #objref
59
60              If  set, this operation returns the associated priority Mapping‐
61              Filter, otherwise a NIL object reference is returned.
62
63       _set_priority_filter(ConsumerAdmin, MappingFilter) -> ok
64
65              Types:
66
67                 ConsumerAdmin = MappingFilter = #objref
68
69              To associate a priority MappingFilter  with  the  target  object
70              this operation must be used.
71
72       _get_lifetime_filter(ConsumerAdmin) -> MappingFilter
73
74              Types:
75
76                 ConsumerAdmin = MappingFilter = #objref
77
78              Unless  a  lifetime  MappingFilter have been associated with the
79              target object a NIL object reference is returned by this  opera‐
80              tion.
81
82       _set_lifetime_filter(ConsumerAdmin, MappingFilter) -> ok
83
84              Types:
85
86                 ConsumerAdmin = MappingFilter = #objref
87
88              This  operation associate a lifetime MappingFilter with the tar‐
89              get object.
90
91       _get_pull_suppliers(ConsumerAdmin) -> ProxyIDSeq
92
93              Types:
94
95                 ConsumerAdmin = #objref
96                 ProxyIDSeq = [ProxyID]
97                 ProxyID = long()
98
99              This readonly attribute maintains the Id's for  all  PullProxies
100              created by the target object and still alive.
101
102       _get_push_suppliers(ConsumerAdmin) -> ProxyIDSeq
103
104              Types:
105
106                 ConsumerAdmin = #objref
107                 ProxyIDSeq = [ProxyID]
108                 ProxyID = long()
109
110              This  attribute  is similar to the _get_pull_suppliers attribute
111              but maintains the Id's for all PushProxies created by the target
112              object and still alive.
113
114       get_proxy_supplier(ConsumerAdmin, ProxyID) -> Reply
115
116              Types:
117
118                 ConsumerAdmin = #objref
119                 ProxyID = long()
120                 Reply  =  Proxy | {'EXCEPTION', #'CosNotifyChannelAdmin_Prox‐
121                 yNotFound'{}}
122                 Proxy = #objref
123
124              If a proxy with the given Id exists the reference to the  object
125              is  returned, but if the object have terminated, or an incorrect
126              Id is supplied, an exception is raised.
127
128       obtain_notification_pull_supplier(ConsumerAdmin, ConsumerType) -> Reply
129
130              Types:
131
132                 ConsumerAdmin = #objref
133                 ConsumerType  =  'ANY_EVENT'  |  'STRUCTURED_EVENT'  |   'SE‐
134                 QUENCE_EVENT'
135                 Reply = {Proxy, ProxyID}
136                 Proxy = #objref
137                 ProxyID = long()
138
139              Determined by the parameter ConsumerType, a proxy which will ac‐
140              cept events of the defined type is created. Along with  the  ob‐
141              ject reference an Id is returned.
142
143       obtain_pull_supplier(ConsumerAdmin) -> Proxy
144
145              Types:
146
147                 ConsumerAdmin = #objref
148                 Proxy = #objref
149
150              This operation creates a new proxy which accepts #any{} events.
151
152       obtain_notification_push_supplier(ConsumerAdmin, ConsumerType) -> Reply
153
154              Types:
155
156                 ConsumerAdmin = #objref
157                 ConsumerType   =  'ANY_EVENT'  |  'STRUCTURED_EVENT'  |  'SE‐
158                 QUENCE_EVENT'
159                 Reply = {Proxy, ProxyID}
160                 Proxy = #objref
161                 ProxyID = long()
162
163              A proxy which accepts events of the type described by the param‐
164              eter  ConsumerType  is created by this operation. A unique Id is
165              returned as an out parameter.
166
167       obtain_push_supplier(ConsumerAdmin) -> Proxy
168
169              Types:
170
171                 ConsumerAdmin = #objref
172                 Proxy = #objref
173
174              The object created by this function is  a  proxy  which  accepts
175              #any{} events.
176
177       destroy(ConsumerAdmin) -> ok
178
179              Types:
180
181                 ConsumerAdmin = #objref
182
183              To  terminate  the  target object this operation should be used.
184              The associated Channel will be notified.
185
186
187
188Ericsson AB                   cosNotificaCtoisoNnot5i.f1yChannelAdmin_ConsumerAdmin(3)