1CosNotifyChannelAdmin_SuppliEerrlAadnmginM(o3d)uleCDoesfNiontiitfiyoCnhannelAdmin_SupplierAdmin(3)
2
3
4

NAME

6       CosNotifyChannelAdmin_SupplierAdmin  -  This  module implements the OMG
7       CosNotifyChannelAdmin::SupplierAdmin 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         * CosNotifyComm_NotifyPublish
18
19         * CosNotifyFilter_FilterAdmin
20

EXPORTS

22       _get_MyID(SupplierAdmin) -> AdminID
23
24              Types:
25
26                 SupplierAdmin = #objref
27                 AdminID = long()
28
29              When a SupplierAdmin object is created it is given a  unique  Id
30              by  the creating channel. This readonly attribute maintains this
31              Id.
32
33       _get_MyChannel(SupplierAdmin) -> Channel
34
35              Types:
36
37                 SupplierAdmin = #objref
38                 Channel = #objref
39
40              The creating channel's reference is maintained by this  readonly
41              attribute.
42
43       _get_MyOperator(SupplierAdmin) -> OpType
44
45              Types:
46
47                 SupplierAdmin = #objref
48                 OpType = 'AND_OP' | 'OR_OP'
49
50              The  Operation  Type,  which determines the semantics the target
51              object will use for any associated  Filters,  is  maintained  by
52              this readonly attribute.
53
54       _get_pull_consumers(SupplierAdmin) -> ProxyIDSeq
55
56              Types:
57
58                 SupplierAdmin = #objref
59                 ProxyIDSeq = [ProxyID]
60                 ProxyID = long()
61
62              A  sequence  of  all  associated PullProxy Id's is maintained by
63              this readonly attribute.
64
65       _get_push_consumers(SupplierAdmin) -> ProxyIDSeq
66
67              Types:
68
69                 SupplierAdmin = #objref
70                 ProxyIDSeq = [ProxyID]
71                 ProxyID = long()
72
73              This operation returns all PushProxy Id's created by the  target
74              object.
75
76       get_proxy_consumer(SupplierAdmin, ProxyID) -> Reply
77
78              Types:
79
80                 SupplierAdmin = #objref
81                 ProxyID = long()
82                 Reply  =  Proxy | {'EXCEPTION', #'CosNotifyChannelAdmin_Prox‐
83                 yNotFound'{}}
84                 Proxy = #objref
85
86              The Proxy which corresponds to the given Id is returned by  this
87              operation.
88
89       obtain_notification_pull_consumer(SupplierAdmin, SupplierType) -> Reply
90
91              Types:
92
93                 SupplierAdmin = #objref
94                 SupplierType   =  'ANY_EVENT'  |  'STRUCTURED_EVENT'  |  'SE‐
95                 QUENCE_EVENT'
96                 Reply = {Proxy, ProxyID}
97                 Proxy = #objref
98                 ProxyID = long()
99
100              This operation creates a new proxy and returns its object refer‐
101              ence  along  with  its ID. The SupplierType parameter determines
102              the event type accepted by the proxy.
103
104       obtain_pull_consumer(SupplierAdmin) -> Proxy
105
106              Types:
107
108                 SupplierAdmin = #objref
109                 Proxy = #objref
110
111              A proxy which accepts #any{} events is created  by  this  opera‐
112              tion.
113
114       obtain_notification_push_consumer(SupplierAdmin, SupplierType) -> Reply
115
116              Types:
117
118                 SupplierAdmin = #objref
119                 SupplierType   =  'ANY_EVENT'  |  'STRUCTURED_EVENT'  |  'SE‐
120                 QUENCE_EVENT'
121                 Reply = {Proxy, ProxyID}
122                 Proxy = #objref
123                 ProxyID = long()
124
125              Determined by the SupplierType parameter a  compliant  proxy  is
126              created  and  its object reference along with its Id is returned
127              by this operation.
128
129       obtain_push_consumer(SupplierAdmin) -> Proxy
130
131              Types:
132
133                 SupplierAdmin = #objref
134                 Proxy = #objref
135
136              A proxy which accepts #any{} events is created  by  this  opera‐
137              tion.
138
139       destroy(SupplierAdmin) -> ok
140
141              Types:
142
143                 SupplierAdmin = #objref
144
145              This  operation terminates the SupplierAdmin object and notifies
146              the creating channel that the target object no longer is active.
147
148
149
150Ericsson AB                   cosNotificaCtoisoNnot5i.f1yChannelAdmin_SupplierAdmin(3)