0001 TPUNSUBSCRIBE(3)
0002 ================
0003 :doctype: manpage
0004
0005
0006 NAME
0007 ----
0008 tpunsubscribe - Unsubscribe from event
0009
0010
0011 SYNOPSIS
0012 --------
0013 #include <atmi.h>
0014
0015 int tpunsubscribe (long 'subscription', long 'flags');
0016
0017 Link with '-latmisrv|-latmisrvnomain|-latmisrvinteg -latmi -lubf -lnstd -lpthread -lrt -lm'
0018
0019 DESCRIPTION
0020 -----------
0021 Unsubscribe from event. The 'subscription' value is return value from
0022 original *tpsubscribe()* call. If 'subscription' is set to *-1*, then
0023 it will affect all events to which subscription was made by given process.
0024
0025 *Valid flags*
0026
0027 *TPSIGRSTRT* Restart the system call in progress if interrupted
0028 by signal handler. This affects only underlaying mq_* function calls.
0029
0030 *TPNOTIME* Ignore timeout setting (*NDRX_TOUT* env variable).
0031 Wait for reply for infinitely.
0032
0033 This function is available only for XATMI servers.
0034
0035 RETURN VALUE
0036 ------------
0037 On success, *tpunsubscribe()* return number of subscriptions removed;
0038 on error, -1 is returned, with *tperrno* set to indicate the error.
0039
0040 ERRORS
0041 ------
0042 Note that *tpstrerror()* returns generic error message plus
0043 custom message with debug info from last function call.
0044
0045 *TPEINVAL* Invalid parameter is given to function. 'subscription' < *-1*.
0046
0047 *TPENOENT* Event server is not available.
0048
0049 *TPETIME* Service did not reply in given time *NDRX_TOUT*).
0050
0051 *TPESVCFAIL* Service returned *TPFAIL*. This is application level failure.
0052
0053 *TPESVCERR* System level service failure. Server died during the
0054 message presence in service queue.
0055
0056 *TPESYSTEM* System failure occurred during serving. See logs i.e.
0057 user log, or debugs for more info.
0058
0059 *TPEOS* System failure occurred during serving. See logs i.e.
0060 user log, or debugs for more info.
0061
0062 EXAMPLE
0063 -------
0064 See *atmitest/test004_basicevent/atmisv4_1ST.c* for sample code.
0065
0066 BUGS
0067 ----
0068 Report bugs to support@mavimax.com
0069
0070 SEE ALSO
0071 --------
0072 *tpevsrv(8)* *tpsubscribe(3)* *tppost(3)*
0073
0074 COPYING
0075 -------
0076 (C) Mavimax, Ltd
0077
