0001 TPGBLKTIME(3)
0002 =============
0003 :doctype: manpage
0004
0005
0006 NAME
0007 ----
0008 tpgblktime - Get timeout configuration for ATMI library
0009
0010
0011 SYNOPSIS
0012 --------
0013 #include <atmi.h>
0014
0015 int tpgblktime(long 'flags');
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
0024 Get current configured XATMI IPC call timeout setting in seconds. If particular setting is not configured,
0025 value *0* is returned.
0026
0027 *Valid flags*
0028
0029 *TPBLK_ALL* Get thread specific timeout setting.
0030
0031 *TPBLK_NEXT* Get thread specific next call timeout setting.
0032
0033 *0* Get effective timeout setting used that will be used for next XATMI IPC
0034 call (send/receive). This will return value including the *TPBLK_NEXT* value.
0035 Thought *TPBLK_NEXT* is only processed for certain XATMI calls. See the list
0036 in *tpsblktime(3)* manpage.
0037
0038
0039 RETURN VALUE
0040 ------------
0041 On success, *tpgblktime()* return timeout configured; on error, -1 is returned, with
0042 *tperrno* set to indicate the error.
0043
0044 ERRORS
0045 ------
0046 Note that *tpstrerror()* returns generic error message plus custom message with
0047 debug info from last function call.
0048
0049 *TPEINVAL* 'flags' is not *TPBLK_ALL*, *TPBLK_NEXT* or *0*.
0050
0051 *TPESYSTEM* *tpinit(3)* for client was not called and not other timeout was configured
0052 for given context.
0053
0054
0055 EXAMPLE
0056 -------
0057 See *atmitest/test051_settout/atmiclt51_blk.c* for sample code.
0058
0059 BUGS
0060 ----
0061 Report bugs to support@mavimax.com
0062
0063 SEE ALSO
0064 --------
0065 *tpsblktime(3)* *tptoutget(3)* *tptoutset(3)* *ex_env(5)*
0066
0067 COPYING
0068 -------
0069 (C) Mavimax, Ltd
0070
