1CosNotifyChannelAdmin_SequenEcrCeloPasrnNogoxtyMiPofudyluCllhSeaunpDnpeelfliiAendrim(ti3in)o_nSequenceProxyPullSupplier(3)
2
3
4

NAME

6       CosNotifyChannelAdmin_SequenceProxyPullSupplier  -  This  module imple‐
7       ments the OMG  CosNotifyChannelAdmin::SequenceProxyPullSupplier  inter‐
8       face.
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_sequence_pull_consumer(SequenceProxyPullSupplier, PullConsumer)
26       -> Reply
27
28              Types:
29
30                 SequenceProxyPullSupplier = #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 an exception is raised.
37
38       pull_structured_events(SequenceProxyPullSupplier, MaxEvents) -> Reply
39
40              Types:
41
42                 SequenceProxyPullSupplier = #objref
43                 MaxEvents = long()
44                 Reply  =  EventBatch  |  {'EXCEPTION',   #'CosEventChannelAd‐
45                 min_Disconnected'{}}
46                 EventBatch = [StructuredEvent]
47                 StructuredEvent  = #'CosNotification_StructuredEvent'{header,
48                 filterable_data, remainder_of_body}
49                 header = EventHeader
50                 filterable_data = [#'CosNotification_Property'{name, value}]
51                 name = string()
52                 value = #any
53                 remainder_of_body = #any
54                 EventHeader  =   #'CosNotification_EventHeader'{fixed_header,
55                 variable_header}
56                 fixed_header = FixedEventHeader
57                 variable_header = OptionalHeaderFields
58                 FixedEventHeader        =       #'CosNotification_FixedEvent‐
59                 Header'{event_type, event_name}
60                 event_type = EventType
61                 event_name = string()
62                 EventType     =     #'CosNotification_EventType'{domain_name,
63                 type_name}
64                 domain_name = type_name = string()
65                 OptionalHeaderFields   =   [#'CosNotification_Property'{name,
66                 value}]
67
68              A client use this operation to pull next event sequence of maxi‐
69              mum  length  MaxEvents.  This operation is blocking and will not
70              reply until the requested amount of events can be  delivered  or
71              the QoS property PacingInterval is reached. For more information
72              see the User's Guide.
73
74       try_pull_structured_events(SequenceProxyPullSupplier, MaxEvents) -> Re‐
75       ply
76
77              Types:
78
79                 SequenceProxyPullSupplier = #objref
80                 MaxEvents = long()
81                 Reply  =  {EventBatch,  HasEvent}  |  {'EXCEPTION',  #'CosEv‐
82                 entChannelAdmin_Disconnected'{}}
83                 HasEvent = boolean()
84                 EventBatch = [StructuredEvent]
85                 StructuredEvent =  #'CosNotification_StructuredEvent'{header,
86                 filterable_data, remainder_of_body}
87                 header = EventHeader
88                 filterable_data = [#'CosNotification_Property'{name, value}]
89                 name = string()
90                 value = #any
91                 remainder_of_body = #any
92                 EventHeader   =  #'CosNotification_EventHeader'{fixed_header,
93                 variable_header}
94                 fixed_header = FixedEventHeader
95                 variable_header = OptionalHeaderFields
96                 FixedEventHeader       =        #'CosNotification_FixedEvent‐
97                 Header'{event_type, event_name}
98                 event_type = EventType
99                 event_name = string()
100                 EventType     =     #'CosNotification_EventType'{domain_name,
101                 type_name}
102                 domain_name = type_name = string()
103                 OptionalHeaderFields   =   [#'CosNotification_Property'{name,
104                 value}]
105
106              This  operation  pulls  an  event sequence of the maximum length
107              MaxEvents, but do not block if the target object have no  events
108              to  forward.  The outparameter, HasEvent is true if the sequence
109              contain any events.
110
111       disconnect_sequence_pull_supplier(SequenceProxyPullSupplier) -> ok
112
113              Types:
114
115                 SequenceProxyPullSupplier = #objref
116
117              This operation cause the target object to close  the  connection
118              and terminate.
119
120
121
122Ericsson AB                 CcoossNNoottiiffyiCchaatninoenlA5d.m0i.n1_SequenceProxyPullSupplier(3)