0001 TX_SET_TRANSACTION_TIMEOUT(3)
0002 =============================
0003 :doctype: manpage
0004
0005
0006 NAME
0007 ----
0008 tx_set_transaction_timeout - Set timeout value for new transaction
0009
0010
0011 SYNOPSIS
0012 --------
0013 #include <tx.h>
0014
0015 int tx_set_transaction_timeout(TRANSACTION_TIMEOUT timeout);
0016
0017 For XATMI client link with '-latmiclt -latmi -lubf -lnstd -lpthread -lrt -lm'
0018
0019 For XATMI server link with '-latmisrv|-latmisrvnomain|-latmisrvinteg -latmi -lubf -lnstd -lpthread -lrt -lm'
0020
0021 DESCRIPTION
0022 -----------
0023 Function set timeout value for new transactions. The value is used when
0024 next *tx_begin(3)* is issued. The value does not affect any global transaction
0025 in progress. If value of 'timeout' is set to *0* then maximum timeout value
0026 is used for transaction. Units for 'timeout' is seconds.
0027
0028 RETURN VALUE
0029 ------------
0030 On success, *tx_set_transaction_timeout()* return *TX_OK*; on error, error code is returned
0031
0032 ERRORS
0033 ------
0034
0035 *TX_EINVAL* Invalid value of 'timeout' parameter, less than 0.
0036
0037 *TX_PROTOCOL_ERROR* Transaction manager is not open by *tx_open(3)*
0038
0039 EXAMPLE
0040 -------
0041 See *atmitest/test021_xafull/atmiclt21tx.c* for sample code.
0042
0043 BUGS
0044 ----
0045 Report bugs to support@mavimax.com
0046
0047 SEE ALSO
0048 --------
0049 *tx_open(3)* *tx_close(3)* *tx_begin(3)* *tx_commit(3)* *tx_rollback(3)* *tx_info(3)*
0050 *tx_set_transaction_control(3)* *tx_set_commit_return(3)*
0051
0052 COPYING
0053 -------
0054 (C) Mavimax, Ltd
0055
