0001 TPCANCEL(3)
0002 ===========
0003 :doctype: manpage
0004
0005
0006 NAME
0007 ----
0008 tpcancel - Cancel the call which was issued by tpacall().
0009
0010
0011 SYNOPSIS
0012 --------
0013 #include <atmi.h>
0014
0015 int tpcancel(int cd);
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 Cancel the asynchronous call done by *tpacall()*. Basically this marks the call descriptor as unused in
0024 internal call descriptor registry. If answer is received for such descriptor, the answer is discarded.
0025 Note that this does not abort the transaction (if started) by previous tpacall.
0026 Thus if transaction needs to be aborted, use *tpabort()*.
0027
0028 Prior canceling the call descriptor, function attempts to perform non blocked read of the client reply
0029 queue until the given 'cd' is found or EOF of queue is reached. If other call replies are downloaded
0030 from the queue, they are buffered in processes memory.
0031
0032 RETURN VALUE
0033 ------------
0034 On success, *tpacall()* return call descriptor (>0); on error, -1 is returned,
0035 with *tperrno* set to indicate the error.
0036
0037
0038 ERRORS
0039 ------
0040 Note that *tpstrerror()* returns generic error message plus custom message with
0041 debug info from last function call.
0042
0043 *TPEBADDESC* Invalid call descriptor (out of range).
0044
0045 *TPEINVAL* Enduro/X is not configured.
0046
0047 *TPESYSTEM* System failure occurred during serving. See logs i.e. user log, or debugs for more info.
0048
0049 *TPEOS* System failure occurred during serving. See logs i.e. user log, or debugs for more info.
0050
0051 BUGS
0052 ----
0053 Report bugs to support@mavimax.com
0054
0055 SEE ALSO
0056 --------
0057 *tpacall(3)* *tpgetrply(3)*
0058
0059 COPYING
0060 -------
0061 (C) Mavimax, Ltd
0062
