help | logout
getPolltime

getPolltime

Name

getPolltime -- Get update interval for this module.

Synopsis

$err = $mod->getPolltime();

Description

The RSPD configuration file contains an integer with the number of seconds to wait between updating the RSPD with current data. This number is returned by this function, and should be used to specify the length of time to wait in the waitNextEvent().

Returns

This function returns -1 if an error occurred, and 0 otherwise. In case of error, the program will croak() with an appriopriate message.