RTEMS 4.9.5 On-Line Library

Message Manager MESSAGE_QUEUE_IDENT - Get ID of a queue

RTEMS C User's Guide

10.4.2: MESSAGE_QUEUE_IDENT - Get ID of a queue

CALLING SEQUENCE:

rtems_status_code rtems_message_queue_ident(
  rtems_name  name,
  uint32_t    node,
  rtems_id   *id
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - queue identified successfully
RTEMS_INVALID_ADDRESS - id is NULL
RTEMS_INVALID_NAME - queue name not found
RTEMS_INVALID_NODE - invalid node id

DESCRIPTION:

This directive obtains the queue id associated with the queue name specified in name. If the queue name is not unique, then the queue id will match one of the queues with that name. However, this queue id is not guaranteed to correspond to the desired queue. The queue id is used with other message related directives to access the message queue.

NOTES:

This directive will not cause the running task to be preempted.

If node is RTEMS_SEARCH_ALL_NODES, all nodes are searched with the local node being searched first. All other nodes are searched with the lowest numbered node searched first.

If node is a valid node number which does not represent the local node, then only the message queues exported by the designated node are searched.

This directive does not generate activity on remote nodes. It accesses only the local copy of the global object table.

RTEMS C User's Guide