1CosNotifyChannelAdmin_ProxySEurplpalnigerM(o3d)uleCDoesfNiontiitfiyoCnhannelAdmin_ProxySupplier(3)
2
3
4

NAME

6       CosNotifyChannelAdmin_ProxySupplier  -  This  module implements the OMG
7       CosNotifyChannelAdmin::ProxySupplier 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         * CosNotifyFilter_FilterAdmin
18

EXPORTS

20       _get_MyType(ProxySupplier) -> ProxyType
21
22              Types:
23
24                 ProxySupplier = #objref
25                 ProxyType = 'PUSH_ANY' |  'PULL_ANY'  |  'PUSH_STRUCTURED'  |
26                 'PULL_STRUCTURED' | 'PUSH_SEQUENCE' | 'PULL_SEQUENCE'
27
28              This  readonly  attribute maintains the enumerant describing the
29              which type the target object is.
30
31       _get_MyAdmin(ProxySupplier) -> AdminObject
32
33              Types:
34
35                 ProxySupplier = #objref
36                 AdminObject = #objref
37
38              This readonly attribute maintains the  admin's  reference  which
39              created the target object.
40
41       _get_priority_filter(ProxySupplier) -> MappingFilter
42
43              Types:
44
45                 ProxySupplier = #objref
46                 MappingFilter = #objref
47
48              This operation returns the associated priority MappingFilter. If
49              no such object exist a NIL reference is returned.
50
51       _set_priority_filter(ProxySupplier, MappingFilter) -> ok
52
53              Types:
54
55                 ProxySupplier = #objref
56                 MappingFilter = #objref
57
58              This operation associate a new priority MappingFilter  with  the
59              target object.
60
61       _get_lifetime_filter(ProxySupplier) -> MappingFilter
62
63              Types:
64
65                 ProxySupplier = #objref
66                 MappingFilter = #objref
67
68              This operation returns the associated lifetime MappingFilter. If
69              no such object exist a NIL reference is returned.
70
71       _set_lifetime_filter(ProxySupplier, MappingFilter) -> ok
72
73              Types:
74
75                 ProxySupplier = #objref
76                 MappingFilter = #objref
77
78              This operation associate a new lifetime MappingFilter  with  the
79              target object.
80
81       obtain_offered_types(ProxySupplier, ObtainInfoMode) -> EventTypeSeq
82
83              Types:
84
85                 ProxySupplier = #objref
86                 ObtainInfoMode = 'ALL_NOW_UPDATES_OFF' | 'ALL_NOW_UPDATES_ON'
87                 | 'NONE_NOW_UPDATES_OFF' | 'NONE_NOW_UPDATES_ON'
88                 EventTypeSeq = [EventType]
89                 EventType     =     #'CosNotification_EventType'{domain_name,
90                 type_name}
91                 domain_name = type_name = string()
92
93              Depending  on the input parameter ObtainInfoMode, this operation
94              may return a sequence of the EventTypes the target object is in‐
95              terested  in receiving. If 'ALL_NOW_UPDATES_OFF' or 'ALL_NOW_UP‐
96              DATES_ON' is given a sequence will be returned,  otherwise  not.
97              If  'ALL_NOW_UPDATES_OFF'  or  'NONE_NOW_UPDATES_OFF' are issued
98              the target object will not inform the associated NotifySubscribe
99              object   when   an   update   occurs.   'ALL_NOW_UPDATES_ON'  or
100              'NONE_NOW_UPDATES_ON' will result  in  that  update  information
101              will be sent.
102
103       validate_event_qos(ProxySupplier, QoSProperties) -> Reply
104
105              Types:
106
107                 ProxySupplier = #objref
108                 QoSProperties = [QoSProperty]
109                 QoSProperty = #'CosNotification_Property'{name, value}
110                 name = string()
111                 value = #any
112                 Reply  = {ok, NamedPropertyRangeSeq} | {'EXCEPTION', CosNoti‐
113                 fication_UnsupportedQoS{qos_err}}
114                 NamedPropertyRangeSeq = [NamedPropertyRange]
115                 NamedPropertyRange      =       #CosNotification_NamedProper‐
116                 tyRange{name, range}
117                 name = string()
118                 range = #CosNotification_PropertyRange{low_val, high_val}
119                 low_val = #any
120                 high_val = #any
121                 qos_err = PropertyErrorSeq
122                 PropertyErrorSeq = [PropertyError]
123                 PropertyError  = #'CosNotification_PropertyError'{code, name,
124                 available_range}
125                 code = 'UNSUPPORTED_PROPERTY' | 'UNAVAILABLE_PROPERTY' | 'UN‐
126                 SUPPORTED_VALUE'  |  'UNAVAILABLE_VALUE'  |  'BAD_PROPERTY' |
127                 'BAD_TYPE' | 'BAD_VALUE'
128                 name = string()
129                 available_range = PropertyRange
130                 PropertyRange    =    #CosNotification_PropertyRange{low_val,
131                 high_val}
132                 low_val = high_val = #any
133
134              To  check  if certain Quality of Service properties can be added
135              to events in the current context of the target object this oper‐
136              ation should be used. If we cannot support the required settings
137              an exception describing why will be raised.
138
139
140
141Ericsson AB                   cosNotificaCtoisoNnot5i.f1yChannelAdmin_ProxySupplier(3)