File: cosEventApp.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 (259 lines) | stat: -rw-r--r-- 6,020 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>cosEventApp</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>cosEventApp</H1>
</CENTER>

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

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
The main module of the cosEvent application.
</DIV>

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

<P> To get access to the record definitions for the structures use:<BR>

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

<P> This module contains the functions for starting and stopping the application.

</DIV>

<H3>EXPORTS</H3>

<P><A NAME="install/0"><STRONG><CODE>install() -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Return = ok | {'EXCEPTION', E} | {'EXIT', R}</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation installs the cosEvent application.

</DIV>

<P><A NAME="uninstall/0"><STRONG><CODE>uninstall() -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Return = ok | {'EXCEPTION', E} | {'EXIT', R}</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation uninstalls the cosEvent application.

</DIV>

<P><A NAME="start/0"><STRONG><CODE>start() -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Return = ok | {error, Reason}</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation starts the cosEvent application.

</DIV>

<P><A NAME="stop/0"><STRONG><CODE>stop() -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Return = ok | {error, Reason}</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation stops the cosEvent application.

</DIV>

<P><A NAME="start_channel/0"><STRONG><CODE>start_channel() -&#62; Channel</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Channel = #objref</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation creates a new instance of a
<A HREF="CosEventChannelAdmin_EventChannel.html">Event Channel</A>
using the default settings.

</DIV>

<P><A NAME="start_channel/1"><STRONG><CODE>start_channel(Options) -&#62; Channel</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Options = [Option]</CODE></STRONG><BR>
<STRONG><CODE>Option = {pull_interval, Seconds} | {typecheck, Boolean} |
{maxEvents, Integer} | {blocking, Boolean}</CODE></STRONG><BR>
<STRONG><CODE>Channel = #objref</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation creates a new instance of a
<A HREF="CosEventChannelAdmin_EventChannel.html">Event Channel</A>


<P> 
<P>
<UL>

<LI>
<CODE>{pull_interval, Seconds}</CODE> - determine how often Proxy Pull 
Consumers will check for new events with the client application. The
default value is 20 seconds.
</LI>


<LI>
<CODE>{typecheck, Boolean}</CODE> - if this option is set to true the
proxies will check if the supplied client object is of correct type.
The default value is false.
</LI>


<LI>
<CODE>{maxEvents, Integer}</CODE> - this option determine how many events
the <CODE>ProxyPullSuppliers</CODE> will store before discarding events.
If the limit is reached events will be discarded in any order.
The default value is 300.
</LI>


<LI>
<CODE>{blocking, Boolean}</CODE> - this option determine the behavior of
the channel when handling events internally. If set to <CODE>true</CODE> the
risk of a single event supplier floods the system is reduced, but
the performance may also be reduced.
The default value is <CODE>true</CODE>.
</LI>


</UL>

</DIV>

<P><A NAME="start_channel_link/0"><STRONG><CODE>start_channel_link() -&#62; Channel</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Channel = #objref</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation creates a new instance of a
<A HREF="CosEventChannelAdmin_EventChannel.html">Event Channel</A>,
which is linked to the invoking process, using the default settings.

</DIV>

<P><A NAME="start_channel_link/1"><STRONG><CODE>start_channel_link(Options) -&#62; Channel</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Options = [Option]</CODE></STRONG><BR>
<STRONG><CODE>Option = {pull_interval, Seconds} | {typecheck, Boolean} |
{maxEvents, Integer} | {blocking, Boolean}</CODE></STRONG><BR>
<STRONG><CODE>Channel = #objref</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation creates a new instance of a
<A HREF="CosEventChannelAdmin_EventChannel.html">Event Channel</A>,
which is linked to the invoking process, with settings defined by the
given options. Allowed options are the same as for 
<CODE>cosEventApp:start_channel/1</CODE>.

</DIV>

<P><A NAME="stop_channel/1"><STRONG><CODE>stop_channel(Channel) -&#62; Reply</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Channel = #objref</CODE></STRONG><BR>
<STRONG><CODE>Reply = ok | {'EXCEPTION', E}</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation stop the target event channel.

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