m4_comment([$Id: txn_set_timeout.so,v 10.22 2006/12/16 13:52:36 bostic Exp $])

define(M4PAGELOCAL, [txn_set_timeout, DB_SET_LOCK_TIMEOUT, DB_SET_TXN_TIMEOUT])
include(m4/m4.seealso)

m4_pf_header(m4_ref(txn_set_timeout),
ifelse(M4API, C_API, [dnl
u_int32_t
DB_TXN-__GT__set_timeout(DB_TXN *tid, db_timeout_t timeout, u_int32_t flags);
])
ifelse(M4API, CXX_API, [dnl
u_int32_t
DbTxn::set_timeout(db_timeout_t timeout, u_int32_t flags);
]))

m4_p([dnl
The m4_refT(txn_set_timeout) sets timeout values for locks or
transactions for the specified transaction.])

m4_p([dnl
Timeouts are checked whenever a thread of control blocks on a lock or
when deadlock detection is performed.  In the case of
m4_ref(DB_SET_LOCK_TIMEOUT), the timeout is for any single lock request.
In the case of m4_ref(DB_SET_TXN_TIMEOUT), the timeout is for the life
of the transaction.  As timeouts are only checked when the lock request
first blocks or when deadlock detection is performed, the accuracy of
the timeout depends on how often deadlock detection is performed.])

m4_p([dnl
Timeout values may be specified for the database environment as a whole.
See m4_ref(dbenv_set_timeout) and for more information.])

m4_scope_tx(txn_set_timeout)

m4_when_any(txn_set_timeout)

m4_return(txn_set_timeout, std)

m4_parambegin
m4_param(flags, [dnl
m4_sf_must

m4_tagbegin
m4_tag(m4_idef(DB_SET_LOCK_TIMEOUT), [dnl
Set the timeout value for locks in this transaction.])

m4_tag(m4_idef(DB_SET_TXN_TIMEOUT), [dnl
Set the timeout value for this transaction.])
m4_tagend])

m4_param(timeout, [dnl
The m4_arg(timeout) parameter is specified as an unsigned 32-bit number
of microseconds, limiting the maximum timeout to roughly 71 minutes.  A
value of 0 disables timeouts for the transaction.])
m4_paramend

m4_err(txn_set_timeout, einval)

m4_seealso(DbTxn)
m4_page_footer