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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
<TITLE>CosEventChannelAdmin_ProxyPullSupplier</TITLE>
<SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
<STYLE TYPE="text/css">
<!--
.REFBODY { margin-left: 13mm }
.REFTYPES { margin-left: 8mm }
-->
</STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
<IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>CosEventChannelAdmin_ProxyPullSupplier</H1>
</CENTER>
<H3>MODULE</H3>
<DIV CLASS=REFBODY>
CosEventChannelAdmin_ProxyPullSupplier
</DIV>
<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
This module implements a ProxyPullSupplier interface which acts as a middleman
between pull consumer and the event channel.
</DIV>
<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>
<P> The ProxyPullSupplier interface defines the second step for connecting pull consumers to the event channel. A proxy supplier is similar to a normal supplier,
but includes an additional method for connecting a consumer to the proxy
supplier.
<P> To get access to all definitions, e.g., exceptions,
include necessary <CODE>hrl</CODE> files by using:<BR>
<CODE>-include_lib("cosEvent/include/*.hrl").</CODE>
<P> Any object that possesses an object reference that supports the ProxyPullSupplier
interface can perform the following operations:
</DIV>
<H3>EXPORTS</H3>
<P><A NAME="connect_pull_consumer/2"><STRONG><CODE>connect_pull_consumer(Object, PullConsumer) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Object = #objref</CODE></STRONG><BR>
<STRONG><CODE>PullConsumer = #objref of PullConsumer type</CODE></STRONG><BR>
<STRONG><CODE>Return = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation connects PullConsumer object to the ProxyPullSupplier object.
A nil object reference can be passed to this operation. If so a channel
cannot invoke the disconnect_pull_consumer operation on the consumer;
the consumer may be disconnected from the channel without being
informed. If the ProxyPullSupplier is already connected to a
PullConsumer, then the <CODE>CosEventChannelAdmin_AlreadyConnected</CODE>
exception is raised.
</DIV>
<P><A NAME="disconnect_pull_supplier/1"><STRONG><CODE>disconnect_pull_supplier(Object) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Object = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = ok</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation disconnects proxy pull supplier from the event channel.
It sends a notification about the loss of the connection to the pull consumer
attached to it, unless nil object reference was passed at the connection
time.
</DIV>
<P><A NAME="pull/1"><STRONG><CODE>pull(Object) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Object = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = any</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation blocks until the event data is available or the
<CODE>CosEventComm_Disconnected</CODE> exception is raised.
It returns the event data to the consumer.
</DIV>
<P><A NAME="try_pull/1"><STRONG><CODE>try_pull(Object) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Object = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = {any, bool()}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation does not block: if the event data is available, it returns
the event data and sets the data availability flag to true; otherwise
it returns a long with an undefined value and sets the data availability to
false. If the event communication has already been disconnected, the
<CODE>CosEventComm_Disconnected</CODE> exception is raised.
</DIV>
<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
support - support@erlang.ericsson.se<BR>
</DIV>
<CENTER>
<HR>
<SMALL>cosEvent 2.1<BR>
Copyright © 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>
|
