0001 TPTOUTGET(3)
0002 ============
0003 :doctype: manpage
0004
0005
0006 NAME
0007 ----
0008 tptoutget - Get current XATMI timeout setting
0009
0010 SYNOPSIS
0011 --------
0012 #include <atmi.h>
0013
0014 int tptoutget(void);
0015
0016 For XATMI client link with '-latmiclt -latmi -lubf -lnstd -lpthread -lrt -lm'
0017
0018 For XATMI server link with '-latmisrv|-latmisrvnomain|-latmisrvinteg -latmi -lubf -lnstd -lpthread -lrt -lm'
0019
0020 DESCRIPTION
0021 -----------
0022 Function returns currently configured number of seconds used by ATMI library
0023 for timeout control when performing timed service calls and waiting for reply.
0024 Note that correct value is only returned when there was *tpinit(3)* issued
0025 (which pulls in common environment settings). For server processes that is
0026 already done automatically - at stage tpsrvinit().
0027
0028 RETURN VALUE
0029 ------------
0030 Returns number of currently configure seconds for ATMI library to use for timed
0031 send and receive operations (like tpcall(), tpgetrply(), etc.). In case if
0032 tpinit() was not called, value *-1* is returned.
0033
0034 EXAMPLE
0035 -------
0036 See *atmitest/test051_settout/atmiclt51.c* for sample code.
0037
0038 BUGS
0039 ----
0040 Report bugs to support@mavimax.com
0041
0042 SEE ALSO
0043 --------
0044 *tptoutset(3)* *tpsblktime(3)* *tpgblktime(3)* *tpinit(3)* *ex_env(5)*
0045
0046 COPYING
0047 -------
0048 (C) Mavimax, Ltd
0049
