PURPOSE
tx_rollback - roll back a global transaction
SYNOPSIS
#include <tx.h>
int tx_rollback(void)
DESCRIPTION
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(3c))
is TX_UNCHAINED, then when tx_rollback() returns, the
caller is no longer in transaction mode. However, if the transaction_control
characteristic is TX_CHAINED, then when tx_rollback()
returns, the caller remains in transaction mode on behalf of a
new transaction (see the RETURN VALUE and S sections below).
OPTIONAL SET-UP
- --
- tx_set_transaction_control(3)
- --
- tx_set_transaction_timeout(3)
RETURN VALUE
Upon successful completion, tx_rollback() returns TX_OK,
a non-negative return value.
ERRORS
Under the following conditions, tx_rollback() fails and
returns one of these negative values:
- [TX_NO_BEGIN]
- The current transaction rolled back; however, a new
transaction could not be started and the caller is no
longer in transaction mode. This return value may occur
only when the transaction_control characteristic
is TX_CHAINED.
- [TX_MIXED]
- The work done on behalf of the transaction was partially
committed and partially rolled back. In addition, if the transaction_control
characteristic is TX_CHAINED, a new
transaction is started.
- [TX_MIXED_NO_BEGIN]
- The work done on behalf of the transaction was partially
committed and partially rolled back. In addition, a new
transaction could not be started and the caller is no
longer in transaction mode. This return value can occur
only when the transaction_control characteristic
is TX_CHAINED.
- [TX_HAZARD]
- Due to a failure, some of the work done on behalf of the
transaction may have been committed and some of it may
have been rolled back. In addition, if the transaction_control
characteristic is TX_CHAINED, a new
transaction is started.
- [TX_HAZARD_NO_BEGIN]
- Due to a failure, some of the work done on behalf of the
transaction may have been committed and some of it may
have been rolled back. In addition, a new transaction
could not be started and the caller is no longer in
transaction mode. This return value can occur only when
the transaction_control characteristic is TX_CHAINED.
- [TX_COMMITTED]
- The work done on behalf of the transaction was
heuristically committed. In addition, if the transaction_control
characteristic is TX_CHAINED, a new
transaction is started.
- [TX_COMMITTED_NO_BEGIN]
- The work done on behalf of the transaction was
heuristically committed. In addition, a new transaction
could not be started and the caller is no longer in
transaction mode. This return value can occur only when
the transaction_control characteristic is TX_CHAINED.
- [TX_PROTOCOL_ERROR]
- The function was called in an improper context (for
example, the caller is not in transaction mode).
- [TX_FAIL]
- Either the transaction manager or one or more of the
resource managers encountered a fatal error. The nature
of the error is such that the transaction manager and/or
one or more of the resource managers can no longer
perform work on behalf of the application. The exact
nature of the error is written to a log file. The
caller's state with respect to the transaction is
unknown.
SEE ALSO
tx_begin(3c),
tx_set_transaction_control(3c),
tx_set_transaction_timeout(3c)
WARNINGS
Both the X/Open TX interface and the X-Windows system defines
the type XID. It is not possible to use both X-Windows calls and
TX calls in the same file.