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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
<TITLE>CosEventChannelAdmin_ProxyPushConsumer</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_ProxyPushConsumer</H1>
</CENTER>
<H3>MODULE</H3>
<DIV CLASS=REFBODY>
CosEventChannelAdmin_ProxyPushConsumer
</DIV>
<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
This module implements a ProxyPushConsumer interface which acts as a middleman
between push supplier and the event channel.
</DIV>
<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>
<P> The ProxyPushConsumer interface defines the second step for connecting push
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("cosEvent/include/*.hrl").</CODE>
<P> Any object that possesses an object reference that supports the ProxyPushConsumer
interface can perform the following operations:
</DIV>
<H3>EXPORTS</H3>
<P><A NAME="connect_push_supplier/2"><STRONG><CODE>connect_push_supplier(Object, PushSupplier) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Object = #objref</CODE></STRONG><BR>
<STRONG><CODE>PushSupplier = #objref of PushSupplier type</CODE></STRONG><BR>
<STRONG><CODE>Return = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation connects PushSupplier object to the ProxyPushConsumer object.
A nil object reference can be passed to this operation. If so a channel
cannot invoke the disconnect_push_supplier operation on the supplier;
the supplier may be disconnected from the channel without being
informed. If the ProxyPushConsumer is already connected to a
PushSupplier, then the <CODE>CosEventChannelAdmin_AlreadyConnected</CODE>
exception is raised.
</DIV>
<P><A NAME="disconnect_push_consumer/1"><STRONG><CODE>disconnect_push_consumer(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 push consumer from the event channel.
Sends a notification about the loss of the connection to the push supplier
attached to it, unless nil object reference was passed at the connection
time.
</DIV>
<P><A NAME="push/2"><STRONG><CODE>push(Object, Data) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Object = #objref</CODE></STRONG><BR>
<STRONG><CODE>Data = any</CODE></STRONG><BR>
<STRONG><CODE>Return = ok | {'EXCEPTION', #'CosEventComm_Disconnected'{}}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation sends event data to all connected consumers via the
event channel. If the event communication has already been disconnected,
the <CODE>CosEventComm_Disconnected</CODE> 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>
|
