rtems_message_queue_config Struct Reference

This structure defines the configuration of a message queue constructed by rtems_message_queue_construct(). More...

#include <message.h>

Data Fields
rtems_name	name
	This member defines the name of the message queue.
uint32_t	maximum_pending_messages
	This member defines the maximum number of pending messages supported by the message queue.
size_t	maximum_message_size
	This member defines the maximum message size supported by the message queue.
void *	storage_area
	This member shall point to the message buffer storage area begin.
size_t	storage_size
	This member defines size of the message buffer storage area in bytes.
void(*	storage_free )(void *)
	This member defines the optional handler to free the message buffer storage area.
rtems_attribute	attributes
	This member defines the attributes of the message queue.

Detailed Description

This structure defines the configuration of a message queue constructed by rtems_message_queue_construct().

Field Documentation

storage_area

void* rtems_message_queue_config::storage_area

This member shall point to the message buffer storage area begin.

The message buffer storage area for the message queue shall be an array of the type defined by RTEMS_MESSAGE_QUEUE_BUFFER() with a maximum message size equal to the maximum message size of this configuration.

storage_free

void(* rtems_message_queue_config::storage_free) (void *)

This member defines the optional handler to free the message buffer storage area.

It is called when the message queue is deleted. It is called from task context under protection of the object allocator lock. It is allowed to call free() in this handler. If handler is NULL, then no action will be performed.

---

The documentation for this struct was generated from the following file:

• cpukit/include/rtems/rtems/message.h