Skip to content

[doc] Add a note for TSLifecycleHookAdd. #8344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brbzull0 merged 1 commit into from
Sep 29, 2021
Merged

[doc] Add a note for TSLifecycleHookAdd. #8344

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/developer-guide/api/functions/TSContScheduleOnPool.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@ impact system performance by blocking other continuations on the threads.
Note that the TSContSchedule() family of API shall only be called from an ATS EThread.
Calling it from raw non-EThreads can result in unpredictable behavior.

Note that some times if the TASK threads are not ready when you schedule a "contp" on the ``TS_THREAD_POOL_TASK`` then
the "contp" could end up being executed in a ``ET_NET`` thread instead, more likely this is not what you want.
To avoid this you can use the ``TS_LIFECYCLE_TASK_THREADS_READY_HOOK`` to make sure that the task threads
have been started when you schedule a "contp". You can refer to :func:`TSLifecycleHookAdd` for more details.

Example Scenarios
=================

Expand Down Expand Up @@ -127,3 +132,4 @@ See Also
:doc:`TSContSchedule.en`
:doc:`TSContScheduleEvery.en`
:doc:`TSContScheduleOnThread.en`
:doc:`TSLifecycleHookAdd.en`