RepoMirrors
/
haproxy
mirror of http://git.haproxy.org/git/haproxy.git/
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DOC: sched: add missing scheduler API documentation for tasklet_wakeup_after() 

This was added to 2.6 but the doc was forgotten. Let's add it. It's not
needed to backport this since it's only used for new developments.
This commit is contained in:
Willy Tarreau 2024-11-19 16:04:09 +01:00
parent 501827ebe0
commit e5ca72cb6f
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/internals/api/scheduler.txt
View File

@ -103,6 +103,17 @@ void tasklet_wakeup(tl)
least once. The tasklet will run on its assigned thread, or on any least once. The tasklet will run on its assigned thread, or on any
thread if its TID is negative. thread if its TID is negative.
struct list *tasklet_wakeup_after(head, tl)
Schedule tasklet <tl> to run immediately the current one if <head> is
NULL, or after the last queued one if <head> is non-null. The new head
is returned, to be passed to the next call. The purpose here is to
permit instant wakeups of resumed tasklets that still preserve
ordering between them. A typical use case is for a mux' I/O handler to
instantly wake up a series of urgent streams before continuing with
already queued tasklets. This may induce extra latencies for pending
jobs and must only be used extremely carefully when it's certain that
the processing will benefit from using fresh data from the L1 cache.
void tasklet_wakeup_on(tl, thr) void tasklet_wakeup_on(tl, thr)
Make sure that tasklet <tl> will wake up on thread <thr>, that is, will Make sure that tasklet <tl> will wake up on thread <thr>, that is, will
execute at least once. The designated thread may only differ from the execute at least once. The designated thread may only differ from the