RTEMS 4.9.5 On-Line Library

RTEMS Specific Commands queue - display information about message queues

RTEMS Shell User's Guide

5.2.9: queue - display information about message queues

SYNOPSYS:

queue [id [id ... ] ]

DESCRIPTION:

When invoked with no arguments, this command prints information on the set of Classic API Message Queues currently active in the system.

If invoked with a set of ids as arguments, then just those objects are included in the information printed.

EXIT STATUS:

This command returns 0 on success and non-zero if an error is encountered.

NOTES:

NONE

EXAMPLES:

The following is an example of using the queue command on a system with no Classic API Message Queues.

SHLL [/] $ queue
  ID       NAME   ATTRIBUTES   PEND   MAXPEND  MAXSIZE
------------------------------------------------------------------------------

CONFIGURATION:

This command is included in the default shell command set. When building a custom command set, define CONFIGURE_SHELL_COMMAND_QUEUE to have this command included.

This command can be excluded from the shell command set by defining CONFIGURE_SHELL_NO_COMMAND_QUEUE when all shell commands have been configured.

PROGRAMMING INFORMATION:

The queue is implemented by a C language function which has the following prototype:

int rtems_shell_rtems_main_queue(
  int    argc,
  char **argv
);

The configuration structure for the queue has the following prototype:

extern rtems_shell_cmd_t rtems_shell_QUEUE_Command;

RTEMS Shell User's Guide