Atrinik Server 2.5
Functions | Variables
server/timers.c File Reference
#include <timers.h>

Go to the source code of this file.

Functions

static void cftimer_process_event (object *ob)
void cftimer_process_timers ()
int cftimer_create (int id, long delay, object *ob, int mode)
int cftimer_destroy (int id)
int cftimer_find_free_id ()
void cftimer_init ()

Variables

cftimer timers_table [MAX_TIMERS]

Detailed Description

Timer related functions.

Definition in file timers.c.


Function Documentation

int cftimer_create ( int  id,
long  delay,
object ob,
int  mode 
)

Creates a new timer.

Parameters:
idDesired timer identifier.
delayDesired timer delay.
obObject that will be linked to this timer.
modeUnit for delay, should be TIMER_MODE_SECONDS or TIMER_MODE_CYCLES. See timers.h.
Return values:
TIMER_ERR_NONETimer was successfully created.
TIMER_ERR_IDInvalid ID.
TIMER_ERR_MODEInvalid mode.
TIMER_ERR_OBJInvalid object.

Definition at line 89 of file timers.c.

int cftimer_destroy ( int  id)

Destroys an existing timer.

Parameters:
idIdentifier of the timer to destroy.
Return values:
TIMER_ERR_NONENo problem encountered.
TIMER_ERR_IDUnknown ID: timer not found.

Definition at line 136 of file timers.c.

int cftimer_find_free_id ( )

Finds a free ID for a new timer.

Returns:
TIMER_ERR_ID if no free ID is available, a nonzero free ID otherwise.

Definition at line 156 of file timers.c.

void cftimer_init ( )

Initialize timers.

Definition at line 173 of file timers.c.

static void cftimer_process_event ( object ob) [static]

Triggers the EVENT_TIMER of the given object.

Parameters:
obObject to trigger the event for.

Definition at line 70 of file timers.c.

void cftimer_process_timers ( )

Processes all timers.

Definition at line 38 of file timers.c.