1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">
<erlref>
<header>
<copyright>
<year>2000</year>
<year>2007</year>
<holder>Ericsson AB, All Rights Reserved</holder>
</copyright>
<legalnotice>
The contents of this file are subject to the Erlang Public License,
Version 1.1, (the "License"); you may not use this file except in
compliance with the License. You should have received a copy of the
Erlang Public License along with this software. If not, it can be
retrieved online at http://www.erlang.org/.
Software distributed under the License is distributed on an "AS IS"
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
the License for the specific language governing rights and limitations
under the License.
The Initial Developer of the Original Code is Ericsson AB.
</legalnotice>
<title>CosNotifyChannelAdmin_­ProxyPullSupplier</title>
<shorttitle>..._ProxyPullSupplier</shorttitle>
<prepared>Niclas Eklund</prepared>
<responsible>Niclas Eklund</responsible>
<docno></docno>
<approved>Niclas Eklund</approved>
<checked></checked>
<date>2000-02-01</date>
<rev>1.0</rev>
</header>
<module>CosNotifyChannelAdmin_ProxyPullSupplier</module>
<modulesummary>This module implements the OMG CosNotifyChannelAdmin::ProxyPullSupplier interface.</modulesummary>
<description>
<p>To get access to the record definitions for the structures use: <br></br>
<c>-include_lib("cosNotification/include/*.hrl").</c></p>
<p>This module also exports the functions described in:</p>
<list type="bulleted">
<item>
<p><seealso marker="CosNotifyComm_NotifySubscribe">CosNotifyComm_NotifySubscribe</seealso></p>
</item>
<item>
<p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p>
</item>
<item>
<p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p>
</item>
<item>
<p><seealso marker="CosNotifyChannelAdmin_ProxySupplier">CosNotifyChannelAdmin_ProxySupplier</seealso></p>
</item>
</list>
</description>
<funcs>
<func>
<name>connect_any_pull_consumer(ProxyPullSupplier, PullConsumer) -> Reply</name>
<fsummary>Connect a consumer to the proxy</fsummary>
<type>
<v>ProxyPullSupplier = #objref</v>
<v>PullConsumer = #objref</v>
<v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}</v>
</type>
<desc>
<p>This operation connects the given <c>PullConsumer</c> to the target object.
If a connection already exists the <c>AlreadyConnected</c> exception is
raised.</p>
</desc>
</func>
<func>
<name>pull(ProxyPullSupplier) -> Reply</name>
<fsummary>Pull an Any event from the proxy</fsummary>
<type>
<v>ProxyPullSupplier = #objref</v>
<v>Reply = #any | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}</v>
</type>
<desc>
<p>This operation pulls next <c>#any{}</c> event, and blocks, if the target object
have no events to forward, until an event can be delivered. If no client have
been connected the <c>Disconnected</c> exception is raised.</p>
</desc>
</func>
<func>
<name>try_pull(ProxyPullSupplier) -> Reply</name>
<fsummary>Try and pull an Any event from the proxy</fsummary>
<type>
<v>ProxyPullSupplier = #objref</v>
<v>Reply = {#any, HasEvent} | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}</v>
<v>HasEvent = boolean()</v>
</type>
<desc>
<p>This operation pulls next event, but do not block if the target object
have no event to forward. If no client have
been connected the <c>Disconnected</c> exception is raised.</p>
</desc>
</func>
<func>
<name>disconnect_pull_supplier(ProxyPullSupplier) -> ok</name>
<fsummary>Close the connection and terminate the proxy</fsummary>
<type>
<v>ProxyPullSupplier = #objref</v>
</type>
<desc>
<p>Invoking this operation will cause the target object to close the connection and terminate.</p>
</desc>
</func>
</funcs>
</erlref>
|
