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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
.TH CosNotifyChannelAdmin_ConsumerAdmin 3 "cosNotification 1.1.7" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
CosNotifyChannelAdmin_ConsumerAdmin \- This module implements the OMG CosNotifyChannelAdmin::ConsumerAdmin interface\&.
.SH DESCRIPTION
.LP
To get access to the record definitions for the structures use:
.br
\fI-include_lib("cosNotification/include/*\&.hrl")\&.\fR
.LP
This module also exports the functions described in:
.RS 2
.TP 2
*
CosNotification_QoSAdmin
.TP 2
*
CosNotifyComm_NotifySubscribe
.TP 2
*
CosNotifyFilter_FilterAdmin
.RE
.SH EXPORTS
.LP
.B
_get_MyID(ConsumerAdmin) -> AdminID
.br
.RS
.TP
Types
ConsumerAdmin = #objref
.br
AdminID = long()
.br
.RE
.RS
.LP
The ID returned by the creating channel is equal to the value encapsulated by this readonly attribute\&.
.RE
.LP
.B
_get_MyChannel(ConsumerAdmin) -> Channel
.br
.RS
.TP
Types
ConsumerAdmin = #objref
.br
Channel = #objref
.br
.RE
.RS
.LP
The creating channel\&'s reference is maintained by this readonly attribute\&.
.RE
.LP
.B
_get_MyOperator(ConsumerAdmin) -> OpType
.br
.RS
.TP
Types
ConsumerAdmin = #objref
.br
OpType = \&'AND_OP\&' | \&'OR_OP\&'
.br
.RE
.RS
.LP
When \fIConsumerAdmin\&'s\fR are created an operation type, i\&.e\&., \fI\&'AND_OP\&'\fR or \fI\&'OR_OP\&'\fR, is supplied, which determines the semantics used by the target object concerning evaluation against any associated \fIFilter\fR objects\&.
.RE
.LP
.B
_get_priority_filter(ConsumerAdmin) -> MappingFilter
.br
.RS
.TP
Types
ConsumerAdmin = MappingFilter = #objref
.br
.RE
.RS
.LP
If set, this operation returns the associated priority \fIMappingFilter\fR, otherwise a \fINIL\fR object reference is returned\&.
.RE
.LP
.B
_set_priority_filter(ConsumerAdmin, MappingFilter) -> ok
.br
.RS
.TP
Types
ConsumerAdmin = MappingFilter = #objref
.br
.RE
.RS
.LP
To associate a priority \fIMappingFilter\fR with the target object this operation must be used\&.
.RE
.LP
.B
_get_lifetime_filter(ConsumerAdmin) -> MappingFilter
.br
.RS
.TP
Types
ConsumerAdmin = MappingFilter = #objref
.br
.RE
.RS
.LP
Unless a lifetime \fIMappingFilter\fR have been associated with the target object a \fINIL\fR object reference is returned by this operation\&.
.RE
.LP
.B
_set_lifetime_filter(ConsumerAdmin, MappingFilter) -> ok
.br
.RS
.TP
Types
ConsumerAdmin = MappingFilter = #objref
.br
.RE
.RS
.LP
This operation associate a lifetime \fIMappingFilter\fR with the target object\&.
.RE
.LP
.B
_get_pull_suppliers(ConsumerAdmin) -> ProxyIDSeq
.br
.RS
.TP
Types
ConsumerAdmin = #objref
.br
ProxyIDSeq = [ProxyID]
.br
ProxyID = long()
.br
.RE
.RS
.LP
This readonly attribute maintains the Id\&'s for all \fIPullProxies\fR created by the target object and still alive\&.
.RE
.LP
.B
_get_push_suppliers(ConsumerAdmin) -> ProxyIDSeq
.br
.RS
.TP
Types
ConsumerAdmin = #objref
.br
ProxyIDSeq = [ProxyID]
.br
ProxyID = long()
.br
.RE
.RS
.LP
This attribute is similar to the \fI_get_pull_suppliers\fR attribute but maintains the Id\&'s for all \fIPushProxies\fR created by the target object and still alive\&.
.RE
.LP
.B
get_proxy_supplier(ConsumerAdmin, ProxyID) -> Reply
.br
.RS
.TP
Types
ConsumerAdmin = #objref
.br
ProxyID = long()
.br
Reply = Proxy | {\&'EXCEPTION\&', #\&'CosNotifyChannelAdmin_ProxyNotFound\&'{}}
.br
Proxy = #objref
.br
.RE
.RS
.LP
If a proxy with the given Id exists the reference to the object is returned, but if the object have terminated, or an incorrect Id is supplied, an exception is raised\&.
.RE
.LP
.B
obtain_notification_pull_supplier(ConsumerAdmin, ConsumerType) -> Reply
.br
.RS
.TP
Types
ConsumerAdmin = #objref
.br
ConsumerType = \&'ANY_EVENT\&' | \&'STRUCTURED_EVENT\&' | \&'SEQUENCE_EVENT\&'
.br
Reply = {Proxy, ProxyID}
.br
Proxy = #objref
.br
ProxyID = long()
.br
.RE
.RS
.LP
Determined by the parameter \fIConsumerType\fR, a proxy which will accept events of the defined type is created\&. Along with the object reference an Id is returned\&.
.RE
.LP
.B
obtain_pull_supplier(ConsumerAdmin) -> Proxy
.br
.RS
.TP
Types
ConsumerAdmin = #objref
.br
Proxy = #objref
.br
.RE
.RS
.LP
This operation creates a new proxy which accepts \fI#any{}\fR events\&.
.RE
.LP
.B
obtain_notification_push_supplier(ConsumerAdmin, ConsumerType) -> Reply
.br
.RS
.TP
Types
ConsumerAdmin = #objref
.br
ConsumerType = \&'ANY_EVENT\&' | \&'STRUCTURED_EVENT\&' | \&'SEQUENCE_EVENT\&'
.br
Reply = {Proxy, ProxyID}
.br
Proxy = #objref
.br
ProxyID = long()
.br
.RE
.RS
.LP
A proxy which accepts events of the type described by the parameter \fIConsumerType\fR is created by this operation\&. A unique Id is returned as an out parameter\&.
.RE
.LP
.B
obtain_push_supplier(ConsumerAdmin) -> Proxy
.br
.RS
.TP
Types
ConsumerAdmin = #objref
.br
Proxy = #objref
.br
.RE
.RS
.LP
The object created by this function is a proxy which accepts \fI#any{}\fR events\&.
.RE
.LP
.B
destroy(ConsumerAdmin) -> ok
.br
.RS
.TP
Types
ConsumerAdmin = #objref
.br
.RE
.RS
.LP
To terminate the target object this operation should be used\&. The associated \fIChannel\fR will be notified\&.
.RE
|
