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
|
.TH CosNotifyChannelAdmin_SupplierAdmin 3 "cosNotification 1.1.7" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
CosNotifyChannelAdmin_SupplierAdmin \- This module implements the OMG CosNotifyChannelAdmin::SupplierAdmin 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_NotifyPublish
.TP 2
*
CosNotifyFilter_FilterAdmin
.RE
.SH EXPORTS
.LP
.B
_get_MyID(SupplierAdmin) -> AdminID
.br
.RS
.TP
Types
SupplierAdmin = #objref
.br
AdminID = long()
.br
.RE
.RS
.LP
When a \fISupplierAdmin\fR object is created it is given a unique Id by the creating channel\&. This readonly attribute maintains this Id\&.
.RE
.LP
.B
_get_MyChannel(SupplierAdmin) -> Channel
.br
.RS
.TP
Types
SupplierAdmin = #objref
.br
Channel = #objref
.br
.RE
.RS
.LP
The creating channel\&'s reference is maintained by this readonly attribute\&.
.RE
.LP
.B
_get_MyOperator(SupplierAdmin) -> OpType
.br
.RS
.TP
Types
SupplierAdmin = #objref
.br
OpType = \&'AND_OP\&' | \&'OR_OP\&'
.br
.RE
.RS
.LP
The Operation Type, which determines the semantics the target object will use for any associated \fIFilters\fR, is maintained by this readonly attribute\&.
.RE
.LP
.B
_get_pull_consumers(SupplierAdmin) -> ProxyIDSeq
.br
.RS
.TP
Types
SupplierAdmin = #objref
.br
ProxyIDSeq = [ProxyID]
.br
ProxyID = long()
.br
.RE
.RS
.LP
A sequence of all associated \fIPullProxy\fR Id\&'s is maintained by this readonly attribute\&.
.RE
.LP
.B
_get_push_consumers(SupplierAdmin) -> ProxyIDSeq
.br
.RS
.TP
Types
SupplierAdmin = #objref
.br
ProxyIDSeq = [ProxyID]
.br
ProxyID = long()
.br
.RE
.RS
.LP
This operation returns all \fIPushProxy\fR Id\&'s created by the target object\&.
.RE
.LP
.B
get_proxy_consumer(SupplierAdmin, ProxyID) -> Reply
.br
.RS
.TP
Types
SupplierAdmin = #objref
.br
ProxyID = long()
.br
Reply = Proxy | {\&'EXCEPTION\&', #\&'CosNotifyChannelAdmin_ProxyNotFound\&'{}}
.br
Proxy = #objref
.br
.RE
.RS
.LP
The Proxy which corresponds to the given Id is returned by this operation\&.
.RE
.LP
.B
obtain_notification_pull_consumer(SupplierAdmin, SupplierType) -> Reply
.br
.RS
.TP
Types
SupplierAdmin = #objref
.br
SupplierType = \&'ANY_EVENT\&' | \&'STRUCTURED_EVENT\&' | \&'SEQUENCE_EVENT\&'
.br
Reply = {Proxy, ProxyID}
.br
Proxy = #objref
.br
ProxyID = long()
.br
.RE
.RS
.LP
This operation creates a new proxy and returns its object reference along with its ID\&. The \fISupplierType\fR parameter determines the event type accepted by the proxy\&.
.RE
.LP
.B
obtain_pull_consumer(SupplierAdmin) -> Proxy
.br
.RS
.TP
Types
SupplierAdmin = #objref
.br
Proxy = #objref
.br
.RE
.RS
.LP
A proxy which accepts \fI#any{}\fR events is created by this operation\&.
.RE
.LP
.B
obtain_notification_push_consumer(SupplierAdmin, SupplierType) -> Reply
.br
.RS
.TP
Types
SupplierAdmin = #objref
.br
SupplierType = \&'ANY_EVENT\&' | \&'STRUCTURED_EVENT\&' | \&'SEQUENCE_EVENT\&'
.br
Reply = {Proxy, ProxyID}
.br
Proxy = #objref
.br
ProxyID = long()
.br
.RE
.RS
.LP
Determined by the \fISupplierType\fR parameter a compliant proxy is created and its object reference along with its Id is returned by this operation\&.
.RE
.LP
.B
obtain_push_consumer(SupplierAdmin) -> Proxy
.br
.RS
.TP
Types
SupplierAdmin = #objref
.br
Proxy = #objref
.br
.RE
.RS
.LP
A proxy which accepts \fI#any{}\fR events is created by this operation\&.
.RE
.LP
.B
destroy(SupplierAdmin) -> ok
.br
.RS
.TP
Types
SupplierAdmin = #objref
.br
.RE
.RS
.LP
This operation terminates the SupplierAdmin object and notifies the creating channel that the target object no longer is active\&.
.RE
|
