0001 TPGETCALLINFO(3)
0002 ================
0003 :doctype: manpage
0004
0005
0006 NAME
0007 ----
0008 tpgetcallinfo - Read the associated call headers
0009
0010
0011 SYNOPSIS
0012 --------
0013 #include <atmi.h>
0014
0015 int tpgetcallinfo(const char \*'msg', UBFH **'cibuf', long 'flags');
0016
0017 Link with '-latmisrv|-latmisrvnomain|-latmisrvinteg -latmi -lubf -lnstd -lpthread -lrt -lm'
0018
0019 DESCRIPTION
0020 -----------
0021 Function is used to retrieve any call header information associated with 'msg'
0022 XATMI buffer. Both buffers 'msg' and 'cibuf' must be allocated by *tpalloc(3)*
0023 calls. The 'msg' cannot be NULL buffer (null). 'cibuf' most point to XATMI buffer
0024 or *NULL*. Once function called, any call infos are copied to 'cibuf' (with
0025 type reallocation, if there is not enough space in 'cibuf' or not a UBF buffer).
0026
0027 *Valid flags*
0028
0029 *TPCI_NOEOFERR* Do not generate *TPESYSTEM* error in case if no call info buffer
0030 is associated with the 'msg'. Instead return *0*. In case if buffer found, return
0031 value is *1*.
0032
0033 Call information to XATMI buffer is set by *tpsetcallinfo(3)* call, and is associated
0034 with 'msg' buffer through the call path, i.e. IPC between processes, such as
0035 *tpcall(3)*. For more details see *tpsetcallinfo(3)* description.
0036
0037 RETURN VALUE
0038 ------------
0039 If flag *TPCI_NOEOFERR* is not used: On success, *tpgetcallinfo()* returns zero;
0040 on error, *-1* is returned, with *tperrno* set to indicate the error.
0041
0042 If flag *TPCI_NOEOFERR* is used: On success *tpgetcallinfo()* returns *1*; If no
0043 call information is associated with the 'msg' buffer, returns *0*; on other error,
0044 *-1* is returned, with *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* 'msg' is NULL, 'msg' is not XATMI buffer, flags is not *0*. 'cibuf'
0052 is NULL or not pointing to valid XATMI buffer.
0053
0054 *TPESYSTEM* No call infos are associated with 'msg' buffer.
0055
0056 *TPEOS* System failure occurred during serving. See logs i.e. user log, or debugs for more info.
0057 Also used in cases in case of memory condition.
0058
0059 EXAMPLE
0060 -------
0061 See *atmitest/test000_system/atmiunit0.c* for sample code.
0062
0063 BUGS
0064 ----
0065 Report bugs to support@mavimax.com
0066
0067 SEE ALSO
0068 --------
0069 *tpsetcallinfo(3)* *tpcall(3)* *tpalloc(3)*
0070
0071 COPYING
0072 -------
0073 (C) Mavimax, Ltd
0074
