diff options
| author | monty@narttu.mysql.fi <> | 2003-06-05 17:25:09 +0300 |
|---|---|---|
| committer | monty@narttu.mysql.fi <> | 2003-06-05 17:25:09 +0300 |
| commit | e6cdc816137b679e4c8d7c333eacf48d6afa1622 (patch) | |
| tree | d028661a492bef41492ab112517a1395a5ea8741 /mysys | |
| parent | d793db2bb9f34706549b2cd0e7e199ffec92d278 (diff) | |
| download | mariadb-git-e6cdc816137b679e4c8d7c333eacf48d6afa1622.tar.gz | |
Added function comment
Diffstat (limited to 'mysys')
| -rw-r--r-- | mysys/thr_alarm.c | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/mysys/thr_alarm.c b/mysys/thr_alarm.c index 1f9c4c3b068..7a845e3eb00 100644 --- a/mysys/thr_alarm.c +++ b/mysys/thr_alarm.c @@ -122,9 +122,21 @@ void init_thr_alarm(uint max_alarms) /* Request alarm after sec seconds. - A pointer is returned with points to a non-zero int when the alarm has been - given. This can't be called from the alarm-handling thread. - Returns 0 if no more alarms are allowed (aborted by process) + + SYNOPSIS + thr_alarm() + alrm Pointer to alarm detection + alarm_data Structure to store in alarm queue + + NOTES + This function can't be called from the alarm-handling thread. + + RETURN VALUES + 0 ok + 1 If no more alarms are allowed (aborted by process) + + Stores in first argument a pointer to a non-zero int which is set to 0 + when the alarm has been given */ my_bool thr_alarm(thr_alarm_t *alrm, uint sec, ALARM *alarm_data) |