Classic Message Queue Implementation

Collaboration diagram for Classic Message Queue Implementation:

Data Structures
struct	Message_queue_Control
	The following records define the control block used to manage each message queue. More...

Macros
#define	RTEMS_MESSAGE_EXTERN   extern
	This constant is defined to extern most of the time when using this header file. More...

Enumerations
enum	Message_queue_Submit_types { MESSAGE_QUEUE_SEND_REQUEST = 0, MESSAGE_QUEUE_URGENT_REQUEST = 1 }
	The following enumerated type details the modes in which a message may be submitted to a message queue. More...

Functions
void	_Message_queue_Manager_initialization (void)
	Message Queue Manager Initialization. More...
rtems_status_code	_Message_queue_Submit (rtems_id id, const void *buffer, size_t size, Message_queue_Submit_types submit_type)
	Message_queue_Submit. More...
rtems_status_code	_Message_queue_Translate_core_message_queue_return_code (uint32_t the_message_queue_status)
	Message queue Translate Core Message Queue Return Code. More...
RTEMS_INLINE_ROUTINE void	_Message_queue_Free (Message_queue_Control *the_message_queue)
	Deallocates a message queue control block into the inactive chain of free message queue control blocks. More...
RTEMS_INLINE_ROUTINE Message_queue_Control *	_Message_queue_Get (Objects_Id id, Objects_Locations *location)
	Maps message queue IDs to message queue control blocks. More...
RTEMS_INLINE_ROUTINE Message_queue_Control *	_Message_queue_Get_interrupt_disable (Objects_Id id, Objects_Locations *location, ISR_lock_Context *lock_context)
RTEMS_INLINE_ROUTINE Message_queue_Control *	_Message_queue_Allocate (void)

Variables
RTEMS_MESSAGE_EXTERN Objects_Information	_Message_queue_Information
	The following defines the information control block used to manage this class of objects.

Detailed Description

Macro Definition Documentation

RTEMS_MESSAGE_EXTERN

#define RTEMS_MESSAGE_EXTERN   extern

This constant is defined to extern most of the time when using this header file.

However by defining it to nothing, the data declared in this header file can be instantiated. This is done in a single per manager file.

Enumeration Type Documentation

Message_queue_Submit_types

enum Message_queue_Submit_types

The following enumerated type details the modes in which a message may be submitted to a message queue.

The message may be posted in a send or urgent fashion.

Enumerator
MESSAGE_QUEUE_SEND_REQUEST	This value indicates the user wants to send the message using the normal message insertion protocol (FIFO or priority).
MESSAGE_QUEUE_URGENT_REQUEST	This value indicates the user considers the message to be urgent and wants it inserted at the head of the pending message queue.

Function Documentation

_Message_queue_Free()

RTEMS_INLINE_ROUTINE void _Message_queue_Free

(

Message_queue_Control *

the_message_queue

)

Deallocates a message queue control block into the inactive chain of free message queue control blocks.

This routine deallocates a message queue control block into the inactive chain of free message queue control blocks.

References _Objects_Free(), and Message_queue_Control::Object.

_Message_queue_Get()

RTEMS_INLINE_ROUTINE Message_queue_Control* _Message_queue_Get	(	Objects_Id	id,
		Objects_Locations *	location
	)

Maps message queue IDs to message queue control blocks.

This function maps message queue IDs to message queue control blocks. If ID corresponds to a local message queue, then it returns the_message_queue control pointer which maps to ID and location is set to OBJECTS_LOCAL. If the message queue ID is global and resides on a remote node, then location is set to OBJECTS_REMOTE, and the_message_queue is undefined. Otherwise, location is set to OBJECTS_ERROR and the_message_queue is undefined.

References _Objects_Get(), and RTEMS_INLINE_ROUTINE.

Referenced by rtems_message_queue_delete(), and rtems_message_queue_get_number_pending().

_Message_queue_Manager_initialization()

void _Message_queue_Manager_initialization

(

void

)

Message Queue Manager Initialization.

This routine performs the initialization necessary for this manager.

References _Message_queue_Information, and _Objects_Initialize_information().

_Message_queue_Submit()

rtems_status_code _Message_queue_Submit	(	rtems_id	id,
		const void *	buffer,
		size_t	size,
		Message_queue_Submit_types	submit_type
	)

Message_queue_Submit.

This routine implements the directives rtems_message_queue_send and rtems_message_queue_urgent. It processes a message that is to be submitted to the designated message queue. The message will either be processed as a send send message which it will be inserted at the rear of the queue or it will be processed as an urgent message which will be inserted at the front of the queue.

_Message_queue_Translate_core_message_queue_return_code()

rtems_status_code _Message_queue_Translate_core_message_queue_return_code

(

uint32_t

the_message_queue_status

)

Message queue Translate Core Message Queue Return Code.

This function returns a RTEMS status code based on the_message_queue_status.

Parameters

[in]

the_message_queue_status

is the status code to translate

Return values

translated

RTEMS status code