File: CosEventChannelAdmin_ProxyPullConsumer.html

package info (click to toggle)
erlang-doc-html 1%3A11.b.2-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 23,284 kB
  • ctags: 10,724
  • sloc: erlang: 505; ansic: 323; makefile: 62; perl: 61; sh: 45
file content (113 lines) | stat: -rw-r--r-- 3,438 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>CosEventChannelAdmin_ProxyPullConsumer</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_ProxyPullConsumer</H1>
</CENTER>

<H3>MODULE</H3>
<DIV CLASS=REFBODY>
CosEventChannelAdmin_ProxyPullConsumer
</DIV>

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
This module implements a ProxyPullConsumer interface which acts as a middleman
between pull supplier and the event channel.
</DIV>

<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>

<P> The ProxyPullConsumer interface defines the second step for connecting pull
suppliers to the event channel. A proxy consumer is similar to a normal consumer,
but includes an additional method for connecting a supplier to the proxy
consumer.

<P> To get access to all definitions, e.g., exceptions,
include necessary <CODE>hrl</CODE> files by using:<BR>

<CODE>-include_lib(&#34;cosEvent/include/*.hrl&#34;).</CODE>

<P> Any object that possesses an object reference that supports the ProxyPullConsumer
interface can perform the following operations:

</DIV>

<H3>EXPORTS</H3>

<P><A NAME="connect_pull_supplier/2"><STRONG><CODE>connect_pull_supplier(Object, PullSupplier) -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Object = #objref</CODE></STRONG><BR>
<STRONG><CODE>PullSupplier = #objref of PullSupplier type</CODE></STRONG><BR>
<STRONG><CODE>Return = ok | {'EXCEPTION', E}</CODE></STRONG><BR>
<STRONG><CODE>E = #'CosEventChannelAdmin_AlreadyConnected'{} | #'CosEventChannelAdmin_TypeError'{}</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>      This operation connects PullSupplier object to the ProxyPullConsumer object.
         If a nil object reference is passed CORBA standard <CODE>BAD_PARAM</CODE> exception 
         is raised. If the ProxyPullConsumer is already connected to a PullSupplier,
         then the <CODE>CosEventChannelAdmin_AlreadyConnected</CODE> exception is raised.
Implementations of ProxyPullConsumers may require additional interface
functionality; if these requirements are not met the 
<CODE>CosEventChannelAdmin_TypeError</CODE> exception will be raised.
        
</DIV>

<P><A NAME="disconnect_pull_consumer/1"><STRONG><CODE>disconnect_pull_consumer(Object) -&#62; 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 consumer from the event channel and
         sends a notification about the loss of the connection to the pull supplier
         attached to it.
        
</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
support - support@erlang.ericsson.se<BR>

</DIV>
<CENTER>
<HR>
<SMALL>cosEvent 2.1<BR>
Copyright &copy; 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>