1CosNotifyChannelAdmin_ProxyCEornlsaunmgerM(o3d)uleCDoesfNiontiitfiyoCnhannelAdmin_ProxyConsumer(3)
2
3
4

NAME

6       CosNotifyChannelAdmin_ProxyConsumer  -  This  module implements the OMG
7       CosNotifyChannelAdmin::ProxyConsumer 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(ProxyConsumer) -> ProxyType
21
22              Types:
23
24                 ProxyConsumer = #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(ProxyConsumer) -> AdminObject
32
33              Types:
34
35                 ProxyConsumer = AdminObject = #objref
36
37              This readonly attribute maintains the  admin's  reference  which
38              created the target object.
39
40       obtain_subscription_types(ProxyConsumer,  ObtainInfoMode) -> EventType‐
41       Seq
42
43              Types:
44
45                 ProxyConsumer = #objref
46                 ObtainInfoMode = 'ALL_NOW_UPDATES_OFF' | 'ALL_NOW_UPDATES_ON'
47                 | 'NONE_NOW_UPDATES_OFF' | 'NONE_NOW_UPDATES_ON'
48                 EventTypeSeq = [EventType]
49                 EventType     =     #'CosNotification_EventType'{domain_name,
50                 type_name}
51                 domain_name = type_name = string()
52
53              Depending on the input parameter ObtainInfoMode, this  operation
54              may return a sequence of the EventTypes the target object is in‐
55              terested in receiving. If 'ALL_NOW_UPDATES_OFF' or  'ALL_NOW_UP‐
56              DATES_ON'  is  given a sequence will be returned, otherwise not.
57              If 'ALL_NOW_UPDATES_OFF' or  'NONE_NOW_UPDATES_OFF'  are  issued
58              the target object will not inform the associated NotifySubscribe
59              object  when   an   update   occurs.   'ALL_NOW_UPDATES_ON'   or
60              'NONE_NOW_UPDATES_ON'  will  result  in  that update information
61              will be sent.
62
63       validate_event_qos(ProxyConsumer, QoSProperties) -> Reply
64
65              Types:
66
67                 ProxyConsumer = #objref
68                 QoSProperties = [QoSProperty]
69                 QoSProperty = #'CosNotification_Property'{name, value}
70                 name = string()
71                 value = #any
72                 Reply = {ok, NamedPropertyRangeSeq} | {'EXCEPTION',  CosNoti‐
73                 fication_UnsupportedQoS{qos_err}}
74                 NamedPropertyRangeSeq = [NamedPropertyRange]
75                 NamedPropertyRange       =      #CosNotification_NamedProper‐
76                 tyRange{name, range}
77                 name = string()
78                 range = #CosNotification_PropertyRange{low_val, high_val}
79                 low_val = #any
80                 high_val = #any
81                 qos_err = PropertyErrorSeq
82                 PropertyErrorSeq = [PropertyError]
83                 PropertyError = #'CosNotification_PropertyError'{code,  name,
84                 available_range}
85                 code = 'UNSUPPORTED_PROPERTY' | 'UNAVAILABLE_PROPERTY' | 'UN‐
86                 SUPPORTED_VALUE' |  'UNAVAILABLE_VALUE'  |  'BAD_PROPERTY'  |
87                 'BAD_TYPE' | 'BAD_VALUE'
88                 name = string()
89                 available_range = PropertyRange
90                 PropertyRange    =    #CosNotification_PropertyRange{low_val,
91                 high_val}
92                 low_val = high_val = #any
93
94              To check if certain Quality of Service properties can  be  added
95              to events in the current context of the target object this oper‐
96              ation should be used. If we cannot support the required settings
97              an exception describing why will be raised.
98
99
100
101Ericsson AB                  cosNotificatCioosnNo5t.i0f.y2ChannelAdmin_ProxyConsumer(3)
Impressum