mirror of
https://github.com/MariaDB/server.git
synced 2025-05-28 13:01:41 +03:00
Added function comment
This commit is contained in:
parent
a86c80e46a
commit
a3afb2bcbe
@ -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)
|
||||
|
Loading…
x
Reference in New Issue
Block a user