-/*!
+/**
* \file
* <!--
* Copyright 2004 Develer S.r.l. (http://www.develer.com/)
* Copyright 1999,2001 Bernardo Innocenti <bernie@develer.com>
- * This file is part of DevLib - See devlib/README for information.
+ * This file is part of DevLib - See README.devlib for information.
* -->
*
* \brief Simple inter-process messaging system
/*#*
*#* $Log$
+ *#* Revision 1.9 2006/07/19 12:56:27 bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.8 2005/11/04 16:20:02 bernie
+ *#* Fix reference to README.devlib in header.
+ *#*
*#* Revision 1.7 2005/02/09 21:48:30 bernie
*#* Doxygen fixes.
*#*
#include <mware/list.h>
-/*!
+/**
* Handle queues of messages associated an action.
*
* A message port is an abstraction used to exchange information
*/
typedef struct MsgPort
{
- List queue; /*!< Messages queued at this port. */
- Event event; /*!< Event to trigger when a message arrives. */
+ List queue; /**< Messages queued at this port. */
+ Event event; /**< Event to trigger when a message arrives. */
} MsgPort;
typedef struct Msg
{
- Node link; /*!< Link into message port queue. */
- MsgPort *replyPort; /*!< Port to which the msg is to be replied. */
+ Node link; /**< Link into message port queue. */
+ MsgPort *replyPort; /**< Port to which the msg is to be replied. */
/* User data may follow */
} Msg;
-/*!
+/**
* Lock a message port.
*
* This is required before reading or manipulating
proc_forbid();
}
-/*!
+/**
* Unlock a message port.
*
* \see msg_lockPort()
}
-/*! Initialize a message port */
+/** Initialize a message port */
INLINE void msg_initPort(MsgPort *port, Event event)
{
LIST_INIT(&port->queue);
port->event = event;
}
-/*! Queue \a msg into \a port, triggering the associated event */
+/** Queue \a msg into \a port, triggering the associated event */
INLINE void msg_put(MsgPort *port, Msg *msg)
{
msg_portLock(port);
event_do(&port->event);
}
-/*!
+/**
* Get the first message from the queue of \a port.
*
* \return Pointer to the message or NULL if the port was empty.
return msg;
}
-/*! Peek the first message in the queue of \a port, or NULL if the port is empty. */
+/** Peek the first message in the queue of \a port, or NULL if the port is empty. */
INLINE Msg *msg_peek(MsgPort *port)
{
Msg *msg;
return msg;
}
-/*! Send back (reply) \a msg to its sender. */
+/** Send back (reply) \a msg to its sender. */
INLINE void msg_reply(Msg *msg)
{
msg_put(msg->replyPort, msg);