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
|
.TH CosNotifyChannelAdmin_ProxySupplier 3 "cosNotification 1.1.7" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
CosNotifyChannelAdmin_ProxySupplier \- This module implements the OMG CosNotifyChannelAdmin::ProxySupplier 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
*
CosNotifyFilter_FilterAdmin
.RE
.SH EXPORTS
.LP
.B
_get_MyType(ProxySupplier) -> ProxyType
.br
.RS
.TP
Types
ProxySupplier = #objref
.br
ProxyType = \&'PUSH_ANY\&' | \&'PULL_ANY\&' | \&'PUSH_STRUCTURED\&' | \&'PULL_STRUCTURED\&' | \&'PUSH_SEQUENCE\&' | \&'PULL_SEQUENCE\&'
.br
.RE
.RS
.LP
This readonly attribute maintains the enumerant describing the which type the target object is\&.
.RE
.LP
.B
_get_MyAdmin(ProxySupplier) -> AdminObject
.br
.RS
.TP
Types
ProxySupplier = #objref
.br
AdminObject = #objref
.br
.RE
.RS
.LP
This readonly attribute maintains the admin\&'s reference which created the target object\&.
.RE
.LP
.B
_get_priority_filter(ProxySupplier) -> MappingFilter
.br
.RS
.TP
Types
ProxySupplier = #objref
.br
MappingFilter = #objref
.br
.RE
.RS
.LP
This operation returns the associated priority MappingFilter\&. If no such object exist a \fINIL\fR reference is returned\&.
.RE
.LP
.B
_set_priority_filter(ProxySupplier, MappingFilter) -> ok
.br
.RS
.TP
Types
ProxySupplier = #objref
.br
MappingFilter = #objref
.br
.RE
.RS
.LP
This operation associate a new priority MappingFilter with the target object\&.
.RE
.LP
.B
_get_lifetime_filter(ProxySupplier) -> MappingFilter
.br
.RS
.TP
Types
ProxySupplier = #objref
.br
MappingFilter = #objref
.br
.RE
.RS
.LP
This operation returns the associated lifetime MappingFilter\&. If no such object exist a \fINIL\fR reference is returned\&.
.RE
.LP
.B
_set_lifetime_filter(ProxySupplier, MappingFilter) -> ok
.br
.RS
.TP
Types
ProxySupplier = #objref
.br
MappingFilter = #objref
.br
.RE
.RS
.LP
This operation associate a new lifetime MappingFilter with the target object\&.
.RE
.LP
.B
obtain_offered_types(ProxySupplier, ObtainInfoMode) -> EventTypeSeq
.br
.RS
.TP
Types
ProxySupplier = #objref
.br
ObtainInfoMode = \&'ALL_NOW_UPDATES_OFF\&' | \&'ALL_NOW_UPDATES_ON\&' | \&'NONE_NOW_UPDATES_OFF\&' | \&'NONE_NOW_UPDATES_ON\&'
.br
EventTypeSeq = [EventType]
.br
EventType = #\&'CosNotification_EventType\&'{domain_name, type_name}
.br
domain_name = type_name = string()
.br
.RE
.RS
.LP
Depending on the input parameter \fIObtainInfoMode\fR, this operation may return a sequence of the \fIEventTypes\fR the target object is interested in receiving\&. If \fI\&'ALL_NOW_UPDATES_OFF\&'\fR or \fI\&'ALL_NOW_UPDATES_ON\&'\fR is given a sequence will be returned, otherwise not\&. If \fI\&'ALL_NOW_UPDATES_OFF\&'\fR or \fI\&'NONE_NOW_UPDATES_OFF\&'\fR are issued the target object will not inform the associated \fINotifySubscribe\fR object when an update occurs\&. \fI\&'ALL_NOW_UPDATES_ON\&'\fR or \fI\&'NONE_NOW_UPDATES_ON\&'\fR will result in that update information will be sent\&.
.RE
.LP
.B
validate_event_qos(ProxySupplier, QoSProperties) -> Reply
.br
.RS
.TP
Types
ProxySupplier = #objref
.br
QoSProperties = [QoSProperty]
.br
QoSProperty = #\&'CosNotification_Property\&'{name, value}
.br
name = string()
.br
value = #any
.br
Reply = {ok, NamedPropertyRangeSeq} | {\&'EXCEPTION\&', CosNotification_UnsupportedQoS{qos_err}}
.br
NamedPropertyRangeSeq = [NamedPropertyRange]
.br
NamedPropertyRange = #CosNotification_NamedPropertyRange{name, range}
.br
name = string()
.br
range = #CosNotification_PropertyRange{low_val, high_val}
.br
low_val = #any
.br
high_val = #any
.br
qos_err = PropertyErrorSeq
.br
PropertyErrorSeq = [PropertyError]
.br
PropertyError = #\&'CosNotification_PropertyError\&'{code, name, available_range}
.br
code = \&'UNSUPPORTED_PROPERTY\&' | \&'UNAVAILABLE_PROPERTY\&' | \&'UNSUPPORTED_VALUE\&' | \&'UNAVAILABLE_VALUE\&' | \&'BAD_PROPERTY\&' | \&'BAD_TYPE\&' | \&'BAD_VALUE\&'
.br
name = string()
.br
available_range = PropertyRange
.br
PropertyRange = #CosNotification_PropertyRange{low_val, high_val}
.br
low_val = high_val = #any
.br
.RE
.RS
.LP
To check if certain Quality of Service properties can be added to events in the current context of the target object this operation should be used\&. If we cannot support the required settings an exception describing why will be raised\&.
.RE
|
