ChibiOS/NIL  3.2.2
chmboxes.h File Reference

Mailboxes macros and structures. More...

Go to the source code of this file.

Data Structures

struct  mailbox_t
 Structure representing a mailbox object. More...
 

Macros

#define _MAILBOX_DATA(name, buffer, size)
 Data part of a static mailbox initializer. More...
 
#define MAILBOX_DECL(name, buffer, size)   mailbox_t name = _MAILBOX_DATA(name, buffer, size)
 Static mailbox initializer. More...
 

Functions

void chMBObjectInit (mailbox_t *mbp, msg_t *buf, size_t n)
 Initializes a mailbox_t object. More...
 
void chMBReset (mailbox_t *mbp)
 Resets a mailbox_t object. More...
 
void chMBResetI (mailbox_t *mbp)
 Resets a mailbox_t object. More...
 
msg_t chMBPostTimeout (mailbox_t *mbp, msg_t msg, sysinterval_t timeout)
 Posts a message into a mailbox. More...
 
msg_t chMBPostTimeoutS (mailbox_t *mbp, msg_t msg, sysinterval_t timeout)
 Posts a message into a mailbox. More...
 
msg_t chMBPostI (mailbox_t *mbp, msg_t msg)
 Posts a message into a mailbox. More...
 
msg_t chMBPostAheadTimeout (mailbox_t *mbp, msg_t msg, sysinterval_t timeout)
 Posts an high priority message into a mailbox. More...
 
msg_t chMBPostAheadTimeoutS (mailbox_t *mbp, msg_t msg, sysinterval_t timeout)
 Posts an high priority message into a mailbox. More...
 
msg_t chMBPostAheadI (mailbox_t *mbp, msg_t msg)
 Posts an high priority message into a mailbox. More...
 
msg_t chMBFetchTimeout (mailbox_t *mbp, msg_t *msgp, sysinterval_t timeout)
 Retrieves a message from a mailbox. More...
 
msg_t chMBFetchTimeoutS (mailbox_t *mbp, msg_t *msgp, sysinterval_t timeout)
 Retrieves a message from a mailbox. More...
 
msg_t chMBFetchI (mailbox_t *mbp, msg_t *msgp)
 Retrieves a message from a mailbox. More...
 
static size_t chMBGetSizeI (const mailbox_t *mbp)
 Returns the mailbox buffer size as number of messages. More...
 
static size_t chMBGetUsedCountI (const mailbox_t *mbp)
 Returns the number of used message slots into a mailbox. More...
 
static size_t chMBGetFreeCountI (const mailbox_t *mbp)
 Returns the number of free message slots into a mailbox. More...
 
static msg_t chMBPeekI (const mailbox_t *mbp)
 Returns the next message in the queue without removing it. More...
 
static void chMBResumeX (mailbox_t *mbp)
 Terminates the reset state. More...
 

Detailed Description

Mailboxes macros and structures.

Definition in file chmboxes.h.