From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/cosTransactions/doc/src/cosTransactions.xml | 141 ++++++++++++++++++++++++ 1 file changed, 141 insertions(+) create mode 100644 lib/cosTransactions/doc/src/cosTransactions.xml (limited to 'lib/cosTransactions/doc/src/cosTransactions.xml') diff --git a/lib/cosTransactions/doc/src/cosTransactions.xml b/lib/cosTransactions/doc/src/cosTransactions.xml new file mode 100644 index 0000000000..836506974c --- /dev/null +++ b/lib/cosTransactions/doc/src/cosTransactions.xml @@ -0,0 +1,141 @@ + + + + +
+ + 1999 + 2007 + Ericsson AB, All Rights Reserved + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is Ericsson AB. + + + cosTransactions + Niclas Eklund + Niclas Eklund + + Niclas Eklund + + 1999-04-23 + PA1 +
+ cosTransactions + The main module of the cosTransactions application. + +

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(cosTransactions) 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. + + + + + start() -> Return + Start the cosTransactions application + + Return = ok | {error, Reason} + + +

This operation starts the cosTransactions application.

+ + + + stop() -> Return + Stop the cosTransactions application + + Return = ok | {error, Reason} + + +

This operation stops the cosTransactions application.

+ + + + start_factory() -> TransactionFactory + Start a Transaction Factory + + 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 + Start a Transaction Factorywith given options + + 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 + Terminate the target object + + TransactionFactory = #objref + Reply = ok | {'EXCEPTION', E} + + +

This operation stop the target transaction factory.

+ + + + + + -- cgit v1.2.3