0001 TPTERM(3)
0002 =========
0003 :doctype: manpage
0004
0005
0006 NAME
0007 ----
0008 tpterm - terminate XATMI client session
0009
0010
0011 SYNOPSIS
0012 --------
0013 #include <atmi.h>
0014
0015 int tpterm (void);
0016
0017 Link with '-latmisrv|-latmisrvnomain|-latmisrvinteg -latmi -lubf -lnstd -lpthread -lrt -lm'
0018
0019 DESCRIPTION
0020 -----------
0021 Terminate XATMI client session. The function will try to close gracefully any open conversation session. It will close client's thread reply queue, it will make thread ID free. If XA was open, then it will be closed.
0022
0023 This function is available only for XATMI clients. It still valid to call the function from XATMI server's worker threads. The function needs to be called for any thread (except XATMI server main thread) which did the TP operations.
0024
0025 RETURN VALUE
0026 ------------
0027 On success, *tpterm()* return zero; on error, -1 is returned, with *tperrno* set to indicate the error.
0028
0029 ERRORS
0030 ------
0031 Note that *tpstrerror()* for returns generic error message plus custom message with debug info from last call.
0032
0033 *TPEPROTO* Called from XATMI server (main thread).
0034
0035 *TPESYSTEM* Failed to close conversations.
0036
0037 *TPEOS* System failure occurred during serving. See logs i.e. user log, or debugs for more info. That could insufficient memory or other error.
0038
0039
0040 EXAMPLE
0041 -------
0042 See *atmitest/test001_basiccall/atmiclt1.c* for sample code.
0043
0044 BUGS
0045 ----
0046 Report bugs to support@mavimax.com
0047
0048 SEE ALSO
0049 --------
0050 *tpinit(3)*
0051
0052 COPYING
0053 -------
0054 (C) Mavimax, Ltd
0055
