epics/epics-base
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

doc clarify callbackRequestDelayed() timer allocation

Browse Source
This commit is contained in:
Michael Davidsaver
2025-12-03 18:08:54 -08:00
parent 186106cd33
commit c2140ad0f3
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
modules/database/src/ioc/db/callback.h
View File

@@ -138,7 +138,14 @@ DBCORE_API int callbackRequestProcessCallback(
* epicsCallback object must not be modified while queued,
* and must remain valid while queued or executing.
*
* @param pCallback Callback object. Caller expected to initialize or zero all members.
* epicsCallback::timer must be zeroed before the first call,
* and left unmodified for subsequent calls.
* Each epicsCallback is allocated a timer on first call.
* There is no way to free this allocation.
* Reuse of epicsCallback is strongly recommended.
*
* @param pCallback Callback object.
* Caller expected to initialize or zero all members prior to first call.
* @param seconds Relative to call time. Expected to be >= 0.
* @return Zero on success.
* Errors if callback members not initialized correctly, or if queue is full.