Changeset 540de0e5 in rtems


Ignore:
Timestamp:
Apr 5, 2007, 3:24:32 PM (13 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
d51ecd6
Parents:
ed902c24
Message:

2007-04-05 Joel Sherrill <joel@…>

  • user/task.t: Add rtems_iterate_over_all_threads.
Location:
doc
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    red902c24 r540de0e5  
     12007-04-05      Joel Sherrill <joel@OARcorp.com>
     2
     3        * user/task.t: Add rtems_iterate_over_all_threads.
     4
    152007-04-02      Joel Sherrill <joel@OARcorp.com>
    26
  • doc/user/task.t

    red902c24 r540de0e5  
    3232@item @code{@value{DIRPREFIX}task_wake_after} - Wake up after interval
    3333@item @code{@value{DIRPREFIX}task_wake_when} - Wake up when specified 
     34@item @code{@value{DIRPREFIX}iterate_over_all_threads} - Iterate Over Tasks
    3435@item @code{@value{DIRPREFIX}task_variable_add} - Associate per task variable
    3536@item @code{@value{DIRPREFIX}task_variable_get} - Obtain value of a a per task variable
     
    16111612@page
    16121613
     1614@subsection ITERATE_OVER_ALL_THREADS - Iterate Over Tasks
     1615
     1616@cindex iterate over all threads
     1617@subheading CALLING SEQUENCE:
     1618
     1619@ifset is-C
     1620@findex rtems_iterate_over_all_threads
     1621@example
     1622typedef void (*rtems_per_thread_routine)(
     1623  Thread_Control *the_thread
     1624);
     1625
     1626void rtems_iterate_over_all_threads(
     1627  rtems_per_thread_routine routine
     1628);
     1629@end example
     1630@end ifset
     1631
     1632@ifset is-Ada
     1633@example
     1634NOT SUPPORTED FROM Ada
     1635@end example
     1636@end ifset
     1637
     1638@subheading DIRECTIVE STATUS CODES: NONE
     1639
     1640
     1641@subheading DESCRIPTION:
     1642
     1643This directive iterates over all of the existant threads in the
     1644system and invokes @code{routine} on each of them.  The user should
     1645be careful in accessing the contents of @code{the_thread}.
     1646
     1647This routine is intended for use in diagnostic utilities and is
     1648not intented for routine use in an operational system.
     1649
     1650@subheading NOTES:
     1651
     1652There is NO protection while this routine is called.  Thus it is
     1653possible that @code{the_thread} could be deleted while this is operating.
     1654By not having protection, the user is free to invoke support routines
     1655from the C Library which require semaphores for data structures.
     1656
     1657@page
     1658
    16131659@subsection TASK_VARIABLE_ADD - Associate per task variable
    16141660
Note: See TracChangeset for help on using the changeset viewer.