ANSI C, C++

#include <tx.h>
int  tx_rollback (void)

K&R C

#include <tx.h>
int  tx_rollback()

The function tx_rollback() is used to roll back the work of the transaction active in the caller's thread of control.

If the transaction_control characteristic (see tx_set_transaction_control()) is TX_UNCHAINED, when tx_rollback() returns, the caller is no longer in transaction mode. However, if the transaction_control characteristic is TX_CHAINED, when tx_rollback() returns, the caller remains in transaction mode on behalf of a new transaction (see the Return value and Errors sections below).

<<The values set by the following functions affect the processing of tx_rollback().>>

Optional set-up

• tx_set_transaction_control()
• tx_set_transaction_timeout()

<<tx_rollback() cannot be called by MHP.>>

<<When return value is 0>>

Upon successful completion, tx_rollback() returns TX_OK, a non-negative return value.

<<If the transaction_control characteristic is TX_CHAINED, a new global transaction begins.>> <<If the SPP which issued tx_rollback() is not root transaction branch, actual rollback processing is not performed, and it is only recorded that the transaction branch is in rollback_only state. The transaction mode is kept until rollback is directed in the synchronization point processing of the root transaction branch.>>

Errors

Under the following conditions, tx_rollback() fails and returns one of these negative values.

tx_begin(), tx_set_transaction_control(), tx_set_transaction_timeout()

1. <<When the transaction characteristic is TX_CHAINED, tx_rollback() can be called only by the root transaction branch (UAP which called tx_begin()).>>
2. <<When the transaction characteristic is TX_UNCHAINED, tx_rollback() can be called by other than the root transaction branch. In this case, processing differs depending on the transaction branch which called tx_rollback(). When the caller of tx_rollback() is the root branch, rollback request is called to non-root branches via RPC function. When tx_rollback() is called by a non-root branch, the caller only records rollback_only and does not call rollback request to the root branch via RPC function. This non-root branch performs rollback processing after waiting for the direction by the root branch.>>
3. <<tx_rollback() cannot be used along with the functions dc_trn_~().>>