Message Manager

This group contains the Message Manager implementation. More...

Modules
	Message Manager Multiprocessing (MP) Support
	This group contains the implementation to support the Message Manager in multiprocessing (MP) configurations.

Files
file	message.h
	This header file defines the Message Manager API.
file	messagedata.h
	This header file provides data structures used by the implementation and the Application Configuration to define _Message_queue_Information.
file	messageimpl.h
	This header file provides the implementation interfaces of the Message Manager.
file	msg.c
	This source file contains a definition of the _Message_queue_Information with zero objects.
file	msgqbroadcast.c
	This source file contains the implementation of rtems_message_queue_broadcast().
file	msgqconstruct.c
	This source file contains the implementation of rtems_message_queue_construct().
file	msgqcreate.c
	This source file contains the implementation of rtems_message_queue_create().
file	msgqdelete.c
	This source file contains the implementation of rtems_message_queue_delete().
file	msgqflush.c
	This source file contains the implementation of rtems_message_queue_flush().
file	msgqgetnumberpending.c
	This source file contains the implementation of rtems_message_queue_get_number_pending().
file	msgqident.c
	This source file contains the implementation of rtems_message_queue_ident().
file	msgqreceive.c
	This source file contains the implementation of rtems_message_queue_receive().
file	msgqsend.c
	This source file contains the implementation of rtems_message_queue_send().
file	msgqurgent.c
	This source file contains the implementation of rtems_message_queue_urgent().

Data Structures
struct	Message_queue_Control

Macros
#define	MESSAGE_QUEUE_INFORMATION_DEFINE(max)
	Macro to define the objects information for the Classic Message Queue objects.

Enumerations
enum	Message_queue_Submit_types { MESSAGE_QUEUE_SEND_REQUEST = 0 , MESSAGE_QUEUE_URGENT_REQUEST = 1 }

Functions
rtems_status_code	_Message_queue_Submit (rtems_id id, const void *buffer, size_t size, Message_queue_Submit_types submit_type)
	Message_queue_Submit.
rtems_status_code	_Message_queue_Create (const rtems_message_queue_config *config, rtems_id *id, CORE_message_queue_Allocate_buffers allocate_buffers)
	Creates a message queue.

Variables
Objects_Information	_Message_queue_Information
	The Classic Message Queue objects information.

Detailed Description

This group contains the Message Manager implementation.

Macro Definition Documentation

MESSAGE_QUEUE_INFORMATION_DEFINE

#define MESSAGE_QUEUE_INFORMATION_DEFINE

(

max

)

Value:

  OBJECTS_INFORMATION_DEFINE( \
    _Message_queue, \
    OBJECTS_CLASSIC_API, \
    OBJECTS_RTEMS_MESSAGE_QUEUES, \
    Message_queue_Control, \
    max, \
    OBJECTS_NO_STRING_NAME, \
    _Message_queue_MP_Send_extract_proxy \
  )

Macro to define the objects information for the Classic Message Queue objects.

This macro should only be used by <rtems/confdefs.h>.

Parameters

max	The configured object maximum (the OBJECTS_UNLIMITED_OBJECTS flag may be set).

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_Create()

rtems_status_code _Message_queue_Create	(	const rtems_message_queue_config *	config,
		rtems_id *	id,
		CORE_message_queue_Allocate_buffers	allocate_buffers
	)

Creates a message queue.

Parameters

	config	is the message queue configuration.
[out]	id	contains the object identifier if the operation was successful.
	allocate_buffers	is the message buffer storage area allocation handler.

_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.