1CosNotifyChannelAdmin_StrucCtEoursrlNeaodntPgirfoMyxoCydhPuaulnlenleSDlueApfdpimlniiinet_riS(ot3nr)ucturedProxyPullSupplier(3)
2
3
4

NAME

6       CosNotifyChannelAdmin_StructuredProxyPullSupplier  - This module imple‐
7       ments the OMG   CosNotifyChannelAdmin::StructuredProxyPullSupplier  in‐
8       terface.
9

DESCRIPTION

11       To get access to the record definitions for the structures use:
12       -include_lib("cosNotification/include/*.hrl").
13
14       This module also exports the functions described in:
15
16         * CosNotifyComm_NotifySubscribe
17
18         * CosNotification_QoSAdmin
19
20         * CosNotifyFilter_FilterAdmin
21
22         * CosNotifyChannelAdmin_ProxySupplier
23

EXPORTS

25       connect_structured_pull_consumer(StructuredProxyPullSupplier,  PullCon‐
26       sumer) -> Reply
27
28              Types:
29
30                 StructuredProxyPullSupplier = #objref
31                 PullConsumer = #objref
32                 Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyCon‐
33                 nected'{}}
34
35              This  operation connects a PullConsumer to the target object. If
36              a connection already exists the  AlreadyConnected  exception  is
37              raised.
38
39       pull_structured_event(StructuredProxyPullSupplier) -> Reply
40
41              Types:
42
43                 StructuredProxyPullSupplier = #objref
44                 Reply  = StructuredEvent | {'EXCEPTION', #'CosEventChannelAd‐
45                 min_Disconnected'{}}
46                 StructuredEvent =  #'CosNotification_StructuredEvent'{header,
47                 filterable_data, remainder_of_body}
48                 header = EventHeader
49                 filterable_data = [#'CosNotification_Property'{name, value}]
50                 name = string()
51                 value = #any
52                 remainder_of_body = #any
53                 EventHeader   =  #'CosNotification_EventHeader'{fixed_header,
54                 variable_header}
55                 fixed_header = FixedEventHeader
56                 variable_header = OptionalHeaderFields
57                 FixedEventHeader       =        #'CosNotification_FixedEvent‐
58                 Header'{event_type, event_name}
59                 event_type = EventType
60                 event_name = string()
61                 EventType     =     #'CosNotification_EventType'{domain_name,
62                 type_name}
63                 domain_name = type_name = string()
64                 OptionalHeaderFields   =   [#'CosNotification_Property'{name,
65                 value}]
66
67              This  operation  pulls  next event from the target object; if an
68              event cannot be delivered this function blocks  until  an  event
69              arrives.
70
71       try_pull_structured_event(StructuredProxyPullSupplier) -> Reply
72
73              Types:
74
75                 StructuredProxyPullSupplier = #objref
76                 Reply  = {StructuredEvent, HasEvent} | {'EXCEPTION', #'CosEv‐
77                 entChannelAdmin_Disconnected'{}}
78                 HasEvent = boolean()
79                 StructuredEvent =  #'CosNotification_StructuredEvent'{header,
80                 filterable_data, remainder_of_body}
81                 header = EventHeader
82                 filterable_data = [#'CosNotification_Property'{name, value}]
83                 name = string()
84                 value = #any
85                 remainder_of_body = #any
86                 EventHeader   =  #'CosNotification_EventHeader'{fixed_header,
87                 variable_header}
88                 fixed_header = FixedEventHeader
89                 variable_header = OptionalHeaderFields
90                 FixedEventHeader       =        #'CosNotification_FixedEvent‐
91                 Header'{event_type, event_name}
92                 event_type = EventType
93                 event_name = string()
94                 EventType     =     #'CosNotification_EventType'{domain_name,
95                 type_name}
96                 domain_name = type_name = string()
97                 OptionalHeaderFields   =   [#'CosNotification_Property'{name,
98                 value}]
99
100              This operation try to pull next event from the target object. If
101              no event have arrived an empty event is returned and the out pa‐
102              rameter HasEvent is set to false. Otherwise, the boolean flag is
103              set to true and an valid event is returned.
104
105       disconnect_structured_pull_supplier(StructuredProxyPullSupplier) -> ok
106
107              Types:
108
109                 StructuredProxyPullSupplier = #objref
110
111              This operation cause the target object to close  the  connection
112              and terminate.
113
114
115
116Ericsson AB               CoscNoostNioftyiCfhiacnanteiloAndm5i.n0_.S1tructuredProxyPullSupplier(3)
Impressum