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

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

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
The main module of the cosTransactions 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;cosTransactions/include/CosTransactions.hrl&#34;).</CODE>

<P> This module contains the functions for starting and stopping the application.
If the application is started using <CODE>application:start(cosTransactions)</CODE> the 
default configuration is used (see listing below). The Factory reference is stored using the CosNaming Service
under the id <CODE>&#34;oe_cosTransactionsFac_IPNo&#34;</CODE>.

<P> The following application configuration parameters exist:

<P>
<UL>

<LI>
<STRONG>maxRetries</STRONG> - default is 40 times, i.e., if a transaction participant is unreachable
the application will retry to contact it <CODE>N</CODE> times. Reaching the maximum is considered to be a disaster.

</LI>


<LI>
<STRONG>comFailWait</STRONG> - default is 5000 milliseconds, i.e., before the application
retries to contact unreachable transaction participants the application wait <CODE>Time</CODE> milliseconds.

</LI>


</UL>

</DIV>

<H3>EXPORTS</H3>

<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 cosTransactions 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 cosTransactions application.

</DIV>

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

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation creates a <A HREF="CosTransactions_TransactionFactory.html">Transaction Factory</A>.
The Factory is used to create a new top-level <A HREF="CosTransactions_Control.html">transaction</A> using default options (see listing below).

</DIV>

<P><A NAME="start_factory/1"><STRONG><CODE>start_factory(FacDef) -&#62; TransactionFactory</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>FacDef = [Options], see Option listing below.</CODE></STRONG><BR>
<STRONG><CODE>TransactionFactory = #objref</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation creates a <A HREF="CosTransactions_TransactionFactory.html">Transaction Factory</A>.
The Factory is used to create a new top-level transaction. 

<P> The FacDef list must be a list of {Item, Value} tuples, 
where the following values are allowed: 

<P>
<UL>

<LI>
{hash_max, HashValue} - 
         This value denotes the upper bound of the hash value the 
         <A HREF="CosTransactions_Coordinator.html">     Coordinator</A> uses.
Default is <CODE>1013</CODE>. HashValue must be an integer.

</LI>


<LI>
{allow_subtr, Boolean} -
         If set to true it is possible to create <A HREF="CosTransactions_Coordinator.html">subtransactions</A>.
Default is <CODE>true</CODE>.

</LI>


<LI>
{typecheck, Boolean} -
If set to to true all transaction operation's arguments will be type-checked.
Default is <CODE>true</CODE>.
</LI>


<LI>
{tty, Boolean} - 
Enables or disables error printouts to the tty. 
If Flag is false, all text that the error logger would have sent to the terminal is discarded. 
If Flag is true, error messages are sent to the terminal screen. 

</LI>


<LI>
{logfile, FileName} -
This function makes it possible to store all system information in <CODE>FileName</CODE> (string()).
It can be used in combination with the tty(false) item in to have a silent system, 
where all system information are logged to a file. 
As default no logfile is used.
</LI>


<LI>
<CODE>{maxRetries, Integer}</CODE> -
default is 40 times, i.e., if a transaction participant is unreachable the application will 
retry to contact it <CODE>N</CODE> times. Reaching the maximum is considered to be a disaster.
This option overrides the application configuration parameter.
</LI>


<LI>
<CODE>{comFailWait, Integer}</CODE> -
default is 5000 milliseconds, i.e., before the application retries to contact unreachable 
transaction participants the application wait <CODE>Time</CODE> milliseconds.
This option overrides the application configuration parameter.
</LI>


</UL>

</DIV>

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

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation stop the target transaction factory.

</DIV>

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

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