File: CosEventChannelAdmin_EventChannel.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 (129 lines) | stat: -rw-r--r-- 3,531 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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>CosEventChannelAdmin_EventChannel</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_EventChannel</H1>
</CENTER>

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

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
This module implements an Event Channel interface, which plays the role of a 
mediator between consumers and suppliers.
</DIV>

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

<P> An event channel is an object that allows multiple suppliers to communicate
with multiple consumers in a highly decoupled, asynchronous manner. The event 
channel is built up incrementally. When an event channel is
created no suppliers or consumers are connected to it. Event Channel can
implement group communication by serving as a replicator, broadcaster, or
multicaster that forward events from one or more suppliers to multiple
consumers.

<P> It is up to the user to decide when an event channel is created and how 
references to the event channel are obtained. By representing the event
channel as an object, it has all of the properties that apply to objects.
One way to manage an event channel is to register it in a naming context,
or export it through an operation on an object.

<P> To get access to all definitions 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="for_consumers/1"><STRONG><CODE>for_consumers(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 = #objref</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>      This operation returns a ConsumerAdmin object reference. If ConsumerAdmin
         object does not exist already it creates one.
        
</DIV>

<P><A NAME="for_suppliers/1"><STRONG><CODE>for_suppliers(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 = #objref</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>      This operation returns a SupplierAdmin object reference. If SupplierAdmin
         object does not exist already it creates one.
        
</DIV>

<P><A NAME="destroy/1"><STRONG><CODE>destroy(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 = #objref</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>     
</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>