summaryrefslogtreecommitdiffstats
path: root/doc/user/concepts.t
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2007-05-15 20:17:21 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2007-05-15 20:17:21 +0000
commit35a81f8814f237efd9c6ee0e1e61201c806be669 (patch)
tree262449828cb67861eea21c25913f3af1a7077dc0 /doc/user/concepts.t
parent2007-05-15 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-35a81f8814f237efd9c6ee0e1e61201c806be669.tar.bz2
2007-05-15 Joel Sherrill <joel.sherrill@oarcorp.com>
* user/Makefile.am, user/concepts.t, user/rtmon.t: Integrate Rate Monotonic Statistics and Period Usage into Rate Monotonic Manager. Added the following directives: rtems_rate_monotonic_get_statistics, rtems_rate_monotonic_reset_statistics, rtems_rate_montonic_reset_all_statistics, rtems_rate_montonic_report_statistics, and rtems_object_get_name. Obsoleted the rtems/rtmonuse.h file as a public interface.
Diffstat (limited to 'doc/user/concepts.t')
-rw-r--r--doc/user/concepts.t26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/user/concepts.t b/doc/user/concepts.t
index adf8986e62..5f26703a37 100644
--- a/doc/user/concepts.t
+++ b/doc/user/concepts.t
@@ -76,6 +76,32 @@ assign meaningful ASCII names to each task. A more convenient
approach would be to name them the binary values one through
one-hundred, respectively.
+@findex rtems_get_object_name
+
+RTEMS provides a helper routine, @code{@value{DIRPREFIX}get_object_name},
+which can be used to obtain the name of any RTEMS object using just
+its ID. This routine attempts to convert the name into a printable string.
+
+@ifset is-C
+The following example illustrates the use of this method to print
+an object name:
+
+@example
+#include <rtems.h>
+#include <rtems/bspIo.h>
+
+void print_name(rtems_id the_object)
+@{
+ char buffer[10]; /* name assumed to be 10 characters or less */
+ char *result;
+
+ result = rtems_get_object_name( id, sizeof(buffer), buffer );
+ printk( "ID=0x%08x name=%s\n", id, ((result) ? result : "no name") );
+@}
+@end example
+@end ifset
+
+
@subsection Object IDs
@cindex object ID