0001 TPSETTOUT(3)
0002 ============
0003 :doctype: manpage
0004
0005
0006 NAME
0007 ----
0008 tptoutset - Set timeout configuration for ATMI library
0009
0010
0011 SYNOPSIS
0012 --------
0013 #include <atmi.h>
0014
0015 int tptoutset(int 'tout');
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 Configure ATMI library for using different timeout setting for performing
0024 timed service calls and waiting for answers. This function overrides the
0025 setting found in *NDRX_TOUT* environment variable. Note that this function
0026 does not pull-in *tpinit(3)* automatically (nor it loads the environment
0027 configuration). Thus if *tptoutset()* function is called before ATMI init,
0028 the current value will be overwritten.
0029
0030 For server processes at *tpsrvinit()* stage timeout value is already correct
0031 and can be overwritten.
0032
0033 *tout* is number of seconds that shall be configured as max wait/send time.
0034 It must be greater than *0*.
0035
0036 The function configures the value on process bases, and is not thread safe
0037 (shall be called only by one concurrent thread only).
0038
0039 For thread specific timeout setting use *tpsblktime(3)* *tpgblktime(3)*.
0040
0041 RETURN VALUE
0042 ------------
0043 On success, *tptoutset()* return zero; on error, -1 is returned, with
0044 *tperrno* set to indicate the error.
0045
0046 ERRORS
0047 ------
0048 Note that *tpstrerror()* returns generic error message plus custom message with
0049 debug info from last function call.
0050
0051 *TPEINVAL* 'tout' parameter is less or equal to *0*.
0052
0053 EXAMPLE
0054 -------
0055 See *atmitest/test051_settout/atmiclt51.c* for sample code.
0056
0057 BUGS
0058 ----
0059 Report bugs to support@mavimax.com
0060
0061 SEE ALSO
0062 --------
0063 *tptoutget(3)* *tpsblktime(3)* *tpgblktime(3)* *tpinit(3)* *ex_env(5)*
0064
0065 COPYING
0066 -------
0067 (C) Mavimax, Ltd
0068
