_mq_message_t Struct Reference [Message Queue]

Structure holding message which can be put into message queue. More...

#include <msg_queue.h>

Collaboration diagram for _mq_message_t:

Public Types

• enum { message_allocated_with_data, message_holding_data_ptr }

Data Fields

• enum _mq_message_t:: { ... } allocation_style

  member describing the manner of data storage
  

• void * data

  pointer to data hold by the message
  

• char data_buf [1]

  data buffer used when data are allocated together with message
  

• int data_len

  length of data hold by message
  

• destroy_function_f destroy_function

  pointer to destroy function
  

• struct _mq_message_t * next

  pointer to next message in the queue - is used only when message is in the queue
  

---

Detailed Description

There is a need to allow destroing the message without knowing its internals (destroying message queue with non-processed messages) and thus the destroy_function able to fully destroy whole data hold by message must be given. It is mostly needed to choose the function manually only for complex data with pointers which content need to be freed too. For simple structures it is set automaticaly during the message creation.

Definition at line 65 of file msg_queue.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

message_allocated_with_data	data are allocated together with message structure
message_holding_data_ptr	message holds only pointer to data

Definition at line 75 of file msg_queue.h.

---

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

• msg_queue.h