cosTransactions(3erl)					     Erlang Module Definition					     cosTransactions(3erl)

NAME

       cosTransactions - The main module of the cosTransactions application.

DESCRIPTION

       To get access to the record definitions for the structures use:
       -include_lib("cosTransactions/include/CosTransactions.hrl").

       This  module  contains  the functions for starting and stopping the application. If the application is started using application:start(cos-
       Transactions) the default configuration is used (see listing below). The Factory reference is stored using the CosNaming Service under  the
       id "oe_cosTransactionsFac_IPNo" .

       The following application configuration parameters exist:

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

	 * comFailWait - default is 5000 milliseconds, i.e., before the application retries to contact unreachable  transaction  participants  the
	   application wait Time milliseconds.

EXPORTS

       start() -> Return

	      Types  Return = ok | {error, Reason}

	      This operation starts the cosTransactions application.

       stop() -> Return

	      Types  Return = ok | {error, Reason}

	      This operation stops the cosTransactions application.

       start_factory() -> TransactionFactory

	      Types  TransactionFactory = #objref

	      This  operation creates a Transaction Factory . The Factory is used to create a new top-level transaction using default options (see
	      listing below).

       start_factory(FacDef) -> TransactionFactory

	      Types  FacDef = [Options], see Option listing below.
		     TransactionFactory = #objref

	      This operation creates a Transaction Factory . The Factory is used to create a new top-level transaction.

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

		* {hash_max, HashValue} - This value denotes the upper bound of the hash value the Coordinator uses. Default is 1013  .  HashValue
		  must be an integer.

		* {allow_subtr, Boolean} - If set to true it is possible to create subtransactions . Default is true .

		* {typecheck, Boolean} - If set to to true all transaction operation's arguments will be type-checked. Default is true .

		* {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.

		* {logfile, FileName} - This function makes it possible to store all system information in FileName (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.

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

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

       stop_factory(TransactionFactory) -> Reply

	      Types  TransactionFactory = #objref
		     Reply = ok | {'EXCEPTION', E}

	      This operation stop the target transaction factory.

Ericsson AB						      cosTransactions 1.2.10					     cosTransactions(3erl)