firmware/message_queue.c File Reference

A message queue used to exchange messages between two concurrent threads. More...

#include <stdint.h>
#include "message_queue.h"
#include "config_message_queue_impl.h"

Go to the source code of this file.

Data Structures

struct  S_messageQueue_GlobalData
 Structure of the global data of the queue. More...

Typedefs

typedef S_messageQueue_GlobalData messageQueue_GlobalData
 Structure of the global data of the queue.

Functions

void messageQueue_init (void)
 Initialize the queue.
void messageQueue_cleanup (void)
 Clean up the queue.
Boolean messageQueue_isEmpty (void)
 Test if the queue is empty.
Boolean messageQueue_isFull (void)
 Test if the queue is full.
Boolean messageQueue_read (messageQueue_QueuedMessage *pMessage)
 Read a message from the queue.
Boolean messageQueue_write (messageQueue_QueuedMessage message)
 Write a message to the queue.


Detailed Description

A message queue used to exchange messages between two concurrent threads.

Author:
Thomas Stegemann
Version:
Id
message_queue.c,v 1.2 2006/09/29 22:30:03 rschaten Exp
License: See documentation.

Definition in file message_queue.c.


Typedef Documentation

typedef struct S_messageQueue_GlobalData messageQueue_GlobalData

Structure of the global data of the queue.


Function Documentation

void messageQueue_cleanup ( void   ) 

Clean up the queue.

Currently this does nothing.

Definition at line 49 of file message_queue.c.

Referenced by pwm_Timer_cleanup().

void messageQueue_init ( void   ) 

Initialize the queue.

Definition at line 41 of file message_queue.c.

References S_messageQueue_GlobalData::begin, and S_messageQueue_GlobalData::end.

Referenced by pwm_Timer_init().

Boolean messageQueue_isEmpty ( void   ) 

Test if the queue is empty.

Returns:
True if it is empty, otherwise false.

Definition at line 56 of file message_queue.c.

References S_messageQueue_GlobalData::begin, and S_messageQueue_GlobalData::end.

Referenced by messageQueue_read().

Boolean messageQueue_isFull ( void   ) 

Test if the queue is full.

Returns:
True if it is full, otherwise false.

Definition at line 64 of file message_queue.c.

References S_messageQueue_GlobalData::begin, and S_messageQueue_GlobalData::end.

Referenced by messageQueue_write().

Boolean messageQueue_read ( messageQueue_QueuedMessage pMessage  ) 

Read a message from the queue.

Parameters:
pMessage Pointer to a message variable that should be set to the message.
Returns:
True if an entry could be read, otherwise false.

Definition at line 74 of file message_queue.c.

References S_messageQueue_GlobalData::begin, messageQueue_isEmpty(), and S_messageQueue_GlobalData::queue.

Referenced by SIGNAL().

Boolean messageQueue_write ( messageQueue_QueuedMessage  message  ) 

Write a message to the queue.

Parameters:
message The message to append.
Returns:
True if the message could be appended, otherwise false.

Definition at line 88 of file message_queue.c.

References S_messageQueue_GlobalData::end, messageQueue_isFull(), and S_messageQueue_GlobalData::queue.

Referenced by pwm_Channels_show().


Generated on Mon Oct 2 19:31:17 2006 for USB-LED-Fader by  doxygen 1.4.7