Mercurial > flash_v2
comparison packages/kernel/current/doc/kernel.sgml @ 1529:382e69fac9e0
* doc/kernel.sgml: Document cyg_thread_delete return value.
| author | jlarmour |
|---|---|
| date | Thu, 04 Mar 2004 02:17:54 +0000 |
| parents | 1b465c781382 |
| children | eead27d1aa2f |
comparison
equal
deleted
inserted
replaced
| 1528:970d06598f83 | 1529:382e69fac9e0 |
|---|---|
| 1663 <funcprototype> | 1663 <funcprototype> |
| 1664 <funcdef>void <function>cyg_thread_kill</function></funcdef> | 1664 <funcdef>void <function>cyg_thread_kill</function></funcdef> |
| 1665 <paramdef>cyg_handle_t <parameter>thread</parameter></paramdef> | 1665 <paramdef>cyg_handle_t <parameter>thread</parameter></paramdef> |
| 1666 </funcprototype> | 1666 </funcprototype> |
| 1667 <funcprototype> | 1667 <funcprototype> |
| 1668 <funcdef>void <function>cyg_thread_delete</function></funcdef> | 1668 <funcdef>cyg_bool_t <function>cyg_thread_delete</function></funcdef> |
| 1669 <paramdef>cyg_handle_t <parameter>thread</parameter></paramdef> | 1669 <paramdef>cyg_handle_t <parameter>thread</parameter></paramdef> |
| 1670 </funcprototype> | 1670 </funcprototype> |
| 1671 </funcsynopsis> | 1671 </funcsynopsis> |
| 1672 </refsynopsisdiv> | 1672 </refsynopsisdiv> |
| 1673 | 1673 |
| 1715 after it has exited and is no longer required. After this call the | 1715 after it has exited and is no longer required. After this call the |
| 1716 thread handle is no longer valid, and both the | 1716 thread handle is no longer valid, and both the |
| 1717 <structname>cyg_thread</structname> structure and the thread stack can | 1717 <structname>cyg_thread</structname> structure and the thread stack can |
| 1718 be re-used or freed. If <function>cyg_thread_delete</function> is | 1718 be re-used or freed. If <function>cyg_thread_delete</function> is |
| 1719 invoked on a thread that is still running then there is an implicit | 1719 invoked on a thread that is still running then there is an implicit |
| 1720 call to <function>cyg_thread_kill</function>. | 1720 call to <function>cyg_thread_kill</function>. This function returns |
| 1721 <literal>true</literal> if the delete was successful, and | |
| 1722 <literal>false</literal> if the delete did not happen. The delete | |
| 1723 may not happen for example if the thread being destroyed is a lower | |
| 1724 priority thread than the running thread, and will thus not wake up | |
| 1725 in order to exit until it is rescheduled. | |
| 1721 </para> | 1726 </para> |
| 1722 </refsect1> | 1727 </refsect1> |
| 1723 | 1728 |
| 1724 <refsect1 id="kernel-thread-termination-context"><title>Valid contexts</title> | 1729 <refsect1 id="kernel-thread-termination-context"><title>Valid contexts</title> |
| 1725 <para> | 1730 <para> |