1
0
mirror of https://github.com/postgres/postgres.git synced 2025-07-26 01:22:12 +03:00

Document units of "timeout" in ConditionVariableTimedSleep()

The timeout is passed down to WaitLatch() as milliseconds.

Author: Shveta Malik
Discussion: https://postgr.es/m/CAJpy0uC=xiBQD1WapgYYvOiytap6ULJaakLd867zZXqu9tYc8w@mail.gmail.com
This commit is contained in:
Michael Paquier
2024-03-09 15:44:41 +09:00
parent 33ee2550d3
commit f160bf06f7

View File

@ -102,6 +102,8 @@ ConditionVariableSleep(ConditionVariable *cv, uint32 wait_event_info)
/* /*
* Wait for a condition variable to be signaled or a timeout to be reached. * Wait for a condition variable to be signaled or a timeout to be reached.
* *
* The "timeout" is given in milliseconds.
*
* Returns true when timeout expires, otherwise returns false. * Returns true when timeout expires, otherwise returns false.
* *
* See ConditionVariableSleep() for general usage. * See ConditionVariableSleep() for general usage.