summaryrefslogtreecommitdiffstats
path: root/doc/user/task.t
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2008-01-11 22:26:29 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2008-01-11 22:26:29 +0000
commit4b10f2001e4e7c2aec009c158e3f56c84723248a (patch)
tree94ec69f40317d4f176917710deb47307d4426d4b /doc/user/task.t
parent2008-01-11 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-4b10f2001e4e7c2aec009c158e3f56c84723248a.tar.bz2
2008-01-11 Joel Sherrill <joel.sherrill@oarcorp.com>
* user/task.t: Add manual page for rtems_task_self().
Diffstat (limited to 'doc/user/task.t')
-rw-r--r--doc/user/task.t34
1 files changed, 33 insertions, 1 deletions
diff --git a/doc/user/task.t b/doc/user/task.t
index 7e502b411e..858879a94b 100644
--- a/doc/user/task.t
+++ b/doc/user/task.t
@@ -1,5 +1,5 @@
@c
-@c COPYRIGHT (c) 1988-2007.
+@c COPYRIGHT (c) 1988-2008.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@@ -19,6 +19,7 @@ by the task manager are:
@itemize @bullet
@item @code{@value{DIRPREFIX}task_create} - Create a task
@item @code{@value{DIRPREFIX}task_ident} - Get ID of a task
+@item @code{@value{DIRPREFIX}task_self} - Obtain ID of caller
@item @code{@value{DIRPREFIX}task_start} - Start a task
@item @code{@value{DIRPREFIX}task_restart} - Restart a task
@item @code{@value{DIRPREFIX}task_delete} - Delete a task
@@ -850,6 +851,37 @@ accesses only the local copy of the global object table.
@page
+@subsection TASK_SELF - Obtain ID of caller
+
+@cindex obtain ID of caller
+
+@subheading CALLING SEQUENCE:
+
+@ifset is-C
+@findex rtems_task_self
+@example
+rtems_id rtems_task_self(void);
+@end example
+@end ifset
+
+@ifset is-Ada
+@example
+function Task_Self return RTEMS.ID;
+@end example
+@end ifset
+
+@subheading DIRECTIVE STATUS CODES:
+Returns the object Id of the calling task.
+
+@subheading DESCRIPTION:
+This directive returns the Id of the calling task.
+
+@subheading NOTES:
+If called from an interrupt service routine, this directive
+will return the Id of the interrupted task.
+
+@page
+
@subsection TASK_START - Start a task
@cindex starting a task