cnet's Application Programming Interface

NAME

CNET_stop_timer - stop the asynchronous execution of an existing timer

SYNOPSIS

#include <cnet.h>

int CNET_stop_timer(CnetTimerID tid);

DESCRIPTION

CNET_stop_timer requests that the timer, indicated by tid, be stopped before it has completed its execution (and before its event handler has been called).

Timers are forgotten as soon as their event handler is invoked, and so attempting to stop a timer that has already expired results in an error.

RETURN VALUE

The value 0 is returned on success. On failure, the value -1 is returned, and the global variable cnet_errno is set to the following value to describe the error:

ER_BADTIMERID

The value of tid does not represent a currently executing timer (the timer may have already expired).

SEE ALSO

CNET_start_timer, and CNET_timer_data.