1cosTransactions(3)         Erlang Module Definition         cosTransactions(3)
2
3
4

NAME

6       cosTransactions - The main module of the cosTransactions application.
7

DESCRIPTION

9       To get access to the record definitions for the structures use:
10       -include_lib("cosTransactions/include/CosTransactions.hrl").
11
12       This module contains the functions for starting and stopping the appli‐
13       cation. If the application is started using application:start(cosTrans‐
14       actions)  the  default  configuration  is used (see listing below). The
15       Factory reference is stored using the CosNaming Service  under  the  id
16       "oe_cosTransactionsFac_IPNo".
17
18       The following application configuration parameters exist:
19
20         * maxRetries  -  default is 40 times, i.e., if a transaction partici‐
21           pant is unreachable the application will  retry  to  contact  it  N
22           times. Reaching the maximum is considered to be a disaster.
23
24         * comFailWait - default is 5000 milliseconds, i.e., before the appli‐
25           cation retries to contact unreachable transaction participants  the
26           application wait Time milliseconds.
27

EXPORTS

29       start() -> Return
30
31              Types:
32
33                 Return = ok | {error, Reason}
34
35              This operation starts the cosTransactions application.
36
37       stop() -> Return
38
39              Types:
40
41                 Return = ok | {error, Reason}
42
43              This operation stops the cosTransactions application.
44
45       start_factory() -> TransactionFactory
46
47              Types:
48
49                 TransactionFactory = #objref
50
51              This  operation  creates  a  Transaction Factory. The Factory is
52              used to create a new top-level transaction using default options
53              (see listing below).
54
55       start_factory(FacDef) -> TransactionFactory
56
57              Types:
58
59                 FacDef = [Options], see Option listing below.
60                 TransactionFactory = #objref
61
62              This  operation  creates  a  Transaction Factory. The Factory is
63              used to create a new top-level transaction.
64
65              The FacDef list must be a list of {Item,  Value}  tuples,  where
66              the following values are allowed:
67
68                * {hash_max,  HashValue}  - This value denotes the upper bound
69                  of the hash value the Coordinator  uses.  Default  is  1013.
70                  HashValue must be an integer.
71
72                * {allow_subtr,  Boolean}  -  If set to true it is possible to
73                  create subtransactions. Default is true.
74
75                * {typecheck, Boolean} - If set to to true all transaction op‐
76                  eration's arguments will be type-checked. Default is true.
77
78                * {tty,  Boolean} - Enables or disables error printouts to the
79                  tty. If Flag is false, all text that the error logger  would
80                  have sent to the terminal is discarded. If Flag is true, er‐
81                  ror messages are sent to the terminal screen.
82
83                * {logfile, FileName} - This function  makes  it  possible  to
84                  store  all system information in FileName (string()). It can
85                  be used in combination with the tty(false) item in to have a
86                  silent  system, where all system information are logged to a
87                  file. As default no logfile is used.
88
89                * {maxRetries, Integer} - default is  40  times,  i.e.,  if  a
90                  transaction  participant is unreachable the application will
91                  retry to contact it N times. Reaching the maximum is consid‐
92                  ered to be a disaster. This option overrides the application
93                  configuration parameter.
94
95                * {comFailWait, Integer} - default is 5000 milliseconds, i.e.,
96                  before the application retries to contact unreachable trans‐
97                  action participants the application wait Time  milliseconds.
98                  This  option overrides the application configuration parame‐
99                  ter.
100
101       stop_factory(TransactionFactory) -> Reply
102
103              Types:
104
105                 TransactionFactory = #objref
106                 Reply = ok | {'EXCEPTION', E}
107
108              This operation stop the target transaction factory.
109
110
111
112Ericsson AB                  cosTransactions 5.0.1          cosTransactions(3)