diff options
| author | Benoit Germain <benoit.germain@ubisoft.com> | 2025-04-23 09:01:14 +0200 |
|---|---|---|
| committer | Benoit Germain <benoit.germain@ubisoft.com> | 2025-04-23 09:01:14 +0200 |
| commit | 7eb03175d19fca48ac915fc03c352e0d429bc37e (patch) | |
| tree | 02a6044557f571fa461f6b976633b82595313bc2 /docs/index.html | |
| parent | fa89fef9db0435b4e2c017a1aa67f1b2467a07da (diff) | |
| download | lanes-7eb03175d19fca48ac915fc03c352e0d429bc37e.tar.gz lanes-7eb03175d19fca48ac915fc03c352e0d429bc37e.tar.bz2 lanes-7eb03175d19fca48ac915fc03c352e0d429bc37e.zip | |
Fix doc typos
Diffstat (limited to 'docs/index.html')
| -rw-r--r-- | docs/index.html | 76 |
1 files changed, 38 insertions, 38 deletions
diff --git a/docs/index.html b/docs/index.html index 3dfac70..e3e8c7a 100644 --- a/docs/index.html +++ b/docs/index.html | |||
| @@ -181,66 +181,66 @@ | |||
| 181 | The <tt>lanes</tt> module | 181 | The <tt>lanes</tt> module |
| 182 | <ul> | 182 | <ul> |
| 183 | <li><tt>lanes.cancel_error</tt>: a special error value returned from cancelled lanes</li> | 183 | <li><tt>lanes.cancel_error</tt>: a special error value returned from cancelled lanes</li> |
| 184 | <li><tt>lanes.collectgarbage()</tt>: o trigger a GC cycle in all Keeper states</li> | 184 | <li><tt>lanes.collectgarbage()</tt>: trigger a GC cycle in all Keeper states</li> |
| 185 | <li><tt>lanes.configure()</tt>: to configure Lanes</li> | 185 | <li><tt>lanes.configure()</tt>: configure Lanes</li> |
| 186 | <li><tt>lanes.coro()</tt>: to start a coroutine-like lane</li> | 186 | <li><tt>lanes.coro()</tt>: start a coroutine-like lane</li> |
| 187 | <li><tt>lanes.finally()</tt>: to install a function called on Lanes shutdown</li> | 187 | <li><tt>lanes.finally()</tt>: install a function called on Lanes shutdown</li> |
| 188 | <li><tt>lanes.gen()</tt>: to start a lane as a regular function</li> | 188 | <li><tt>lanes.gen()</tt>: start a lane as a regular function</li> |
| 189 | <li><tt>lanes.genactomic()</tt>: to obtain an atomic counter</li> | 189 | <li><tt>lanes.genactomic()</tt>: obtain an atomic counter</li> |
| 190 | <li><tt>lanes.genlock()</tt>: to obtain an atomic-like data stack</li> | 190 | <li><tt>lanes.genlock()</tt>: obtain an atomic-like data stack</li> |
| 191 | <li><tt>lanes.linda()</tt>: to create a Linda</li> | 191 | <li><tt>lanes.linda()</tt>: create a Linda</li> |
| 192 | <li><tt>lanes.nameof()</tt>: to find where a value exists</li> | 192 | <li><tt>lanes.nameof()</tt>: find where a value exists</li> |
| 193 | <li><tt>lanes.now_secs()</tt>: to obtain the current clock value</li> | 193 | <li><tt>lanes.now_secs()</tt>: obtain the current clock value</li> |
| 194 | <li><tt>lanes.register()</tt>: to scan modules so that functions using them can be transferred</li> | 194 | <li><tt>lanes.register()</tt>: scan modules so that functions using them can be transferred</li> |
| 195 | <li><tt>lanes.set_thread_priority()</tt>: to change thread priority</li> | 195 | <li><tt>lanes.set_thread_priority()</tt>: change thread priority</li> |
| 196 | <li><tt>lanes.set_thread_affinity()</tt>: to change thread affinity</li> | 196 | <li><tt>lanes.set_thread_affinity()</tt>: change thread affinity</li> |
| 197 | <li><tt>lanes.threads()</tt>: to obtain a list of all lanes</li> | 197 | <li><tt>lanes.threads()</tt>: obtain a list of all lanes</li> |
| 198 | <li><tt>lanes.sleep()</tt>: to sleep for a given duration</li> | 198 | <li><tt>lanes.sleep()</tt>: sleep for a given duration</li> |
| 199 | <li><tt>lanes.timer()</tt>: to start a timer</li> | 199 | <li><tt>lanes.timer()</tt>: start a timer</li> |
| 200 | <li><tt>lanes.timers()</tt>: to list active timers</li> | 200 | <li><tt>lanes.timers()</tt>: list active timers</li> |
| 201 | </ul> | 201 | </ul> |
| 202 | </li> | 202 | </li> |
| 203 | <li> | 203 | <li> |
| 204 | Given some lane handle <tt>lane_h</tt> | 204 | Given some lane handle <tt>lane_h</tt> |
| 205 | <ul> | 205 | <ul> |
| 206 | <li><tt>lane_h[]</tt>: to wait for, and read the values returned by the lane</li> | 206 | <li><tt>lane_h[]</tt>: wait for, and read the values returned by the lane</li> |
| 207 | <li><tt>lane_h:cancel()</tt>: to request the lane to stop running</li> | 207 | <li><tt>lane_h:cancel()</tt>: request the lane to stop running</li> |
| 208 | <li><tt>lane_h.error_trace_level</tt>: current setting of error logging level</li> | 208 | <li><tt>lane_h.error_trace_level</tt>: current setting of error logging level</li> |
| 209 | <li><tt>lane_h:get_threadname()</tt>: to read the thread name</li> | 209 | <li><tt>lane_h:get_threadname()</tt>: read the thread name</li> |
| 210 | <li><tt>lane_h:join()</tt>: to wait for the lane to terminate (or yield)</li> | 210 | <li><tt>lane_h:join()</tt>: wait for the lane to terminate (or yield)</li> |
| 211 | <li><tt>lane_h:resume()</tt>: to resume a coroutine Lane</li> | 211 | <li><tt>lane_h:resume()</tt>: resume a coroutine Lane</li> |
| 212 | <li><tt>lane_h.status</tt>: current status of the lane</li> | 212 | <li><tt>lane_h.status</tt>: current status of the lane</li> |
| 213 | </ul> | 213 | </ul> |
| 214 | </li> | 214 | </li> |
| 215 | <li> | 215 | <li> |
| 216 | Inside the lane | 216 | Inside the lane |
| 217 | <ul> | 217 | <ul> |
| 218 | <li><tt>lane_threadname()</tt>: to read or change the name of the thread</li> | 218 | <li><tt>lane_threadname()</tt>: read or change the name of the thread</li> |
| 219 | <li><tt>set_finalizer()</tt>: to install a function called when the lane exits</li> | 219 | <li><tt>set_finalizer()</tt>: install a function called when the lane exits</li> |
| 220 | </ul> | 220 | </ul> |
| 221 | </li> | 221 | </li> |
| 222 | <li> | 222 | <li> |
| 223 | Given some Linda <tt>l</tt> | 223 | Given some Linda <tt>l</tt> |
| 224 | <ul> | 224 | <ul> |
| 225 | <li><tt>l:cancel()</tt>: to mark a Linda for cancellation</li> | 225 | <li><tt>l:cancel()</tt>: mark a Linda for cancellation</li> |
| 226 | <li><tt>l:collectgarbage()</tt>: to trigger a GC cycle in the Linda's Keeper state</li> | 226 | <li><tt>l:collectgarbage()</tt>: trigger a GC cycle in the Linda's Keeper state</li> |
| 227 | <li><tt>l:deep()</tt>: returns a light userdata uniquely representing the Linda</li> | 227 | <li><tt>l:deep()</tt>: obtain a light userdata uniquely representing the Linda</li> |
| 228 | <li><tt>l:dump()</tt>: to have information about slot contents</li> | 228 | <li><tt>l:dump()</tt>: have information about slot contents</li> |
| 229 | <li><tt>l:count()</tt>: to count data items</li> | 229 | <li><tt>l:count()</tt>: obtain a count of data items in slots</li> |
| 230 | <li><tt>l:get()</tt>: to read data without consuming it</li> | 230 | <li><tt>l:get()</tt>: read data without consuming it</li> |
| 231 | <li><tt>l:limit()</tt>: to cap the amount of transiting data</li> | 231 | <li><tt>l:limit()</tt>: cap the amount of transiting data</li> |
| 232 | <li><tt>l:receive()</tt>: to read one item of data from multiple slots</li> | 232 | <li><tt>l:receive()</tt>: read one item of data from multiple slots</li> |
| 233 | <li><tt>l:receive_batched()</tt>: to to read several item of data from a single slot</li> | 233 | <li><tt>l:receive_batched()</tt>: read several item of data from a single slot</li> |
| 234 | <li><tt>l:restrict()</tt>: to place a restraint on the operations that can be done</li> | 234 | <li><tt>l:restrict()</tt>: place a restraint on the operations that can be done on a slot</li> |
| 235 | <li><tt>l:send()</tt>: to append data</li> | 235 | <li><tt>l:send()</tt>: append data</li> |
| 236 | <li><tt>l:set()</tt>: to replace the data</li> | 236 | <li><tt>l:set()</tt>: replace the data</li> |
| 237 | <li><tt>l:wake()</tt>: to manually wake blocking calls</li> | 237 | <li><tt>l:wake()</tt>: manually wake blocking calls</li> |
| 238 | </ul> | 238 | </ul> |
| 239 | </li> | 239 | </li> |
| 240 | <li> | 240 | <li> |
| 241 | embedding | 241 | embedding |
| 242 | <ul> | 242 | <ul> |
| 243 | <li><tt>luaopen_lanes_embedded</tt>: to manually initialize Lanes</li> | 243 | <li><tt>luaopen_lanes_embedded</tt>: manually initialize Lanes</li> |
| 244 | </ul> | 244 | </ul> |
| 245 | </li> | 245 | </li> |
| 246 | </ul> | 246 | </ul> |
