ACC Programmer's Reference Guide

276 Chapter4
ZCOM C I/F Library Routines
ZRNTIMER (3X)
See the NOTES section below for more information on using this routine
in a multi-threaded application.
PARAMETERS
RETURN VAULE Ro utine zrntimer returns 0 if successful. Otherwise, a non-zero error
code is returned. See /o pt/acc/include/zcom/zcomsys.h for the list of
ZCOM error codes and their meanings.
NOTES Setting the timeout value for the local node will complete without error.
However, the timeout value will have no effect because ZCOM does not
timeout local requests (i.e. a program may be suspended forever in order
to complete its local request).
An internal table is maintained to keep track of the timeout values for
each remote node. The table is initialized with the default values defined
in the TTGEN configuration file. If an unknown node number is
specified, it is rejected with error -6 (ZENODE).
In a multi-threaded application, all the threads share the single timeout
value table. Hence, when a thread sets a node timeout value, the new
value will be effective in all the other threads.
Although a timeout value of one (1) is a legal value, a minimum value of
two (2) is used in order to avoid false alarms because the internal
timeout processing is activated on 1-second intervals.
EXAMPLE
#include <zcom/zcomsys.h>
#include <zcom/zcomcall.h>
int32 ierr;
int32 node;
int32 time;
if (ierr = zrntimer (node, time)) {
/* error return code */
}
else {
/* good return code */
}
node Remote node number where timeout is set. A value of zero means setting
the timeout values for ALL remote nodes.
time Timeout value in seconds (1-65535). Zero or negative values are not
allowed.