msg.h

Go to the documentation of this file.
00001 #ifndef _SYS_MSG_H
00002 #define _SYS_MSG_H
00003 
00004 /*
00005  * Copyright (C) 2001-2003 by Telogis.com. All rights reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  * 2. Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in the
00015  *    documentation and/or other materials provided with the distribution.
00016  * 3. Neither the name of the copyright holders nor the names of
00017  *    contributors may be used to endorse or promote products derived
00018  *    from this software without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
00021  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
00024  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00027  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00028  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00029  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00030  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00031  * SUCH DAMAGE.
00032  *
00033  * For additional information see http://www.ethernut.de/
00034  *
00035  * This code was kindly provided by Ralph Mason.
00036  *
00037  */
00038 
00039 /*
00040  * $Log: msg.h,v $
00041  * Revision 1.2  2004/03/08 11:20:36  haraldkipp
00042  * Not all compilers like arrays of size zero.
00043  *
00044  * Revision 1.1  2004/02/04 18:05:04  drsung
00045  * First version of message queueing  implemented. Thanks to Ralph Mason, who provided this code.
00046  * Still contains some debug functions.
00047  *
00048  */
00049 
00050 #include <sys/timer.h>
00051 
00052 #ifdef _PC
00053 #pragma warning (disable:4200)
00054 #endif
00055 
00056 typedef struct _NUTMSG NUTMSG;
00057 struct _NUTMSG {
00058     u_char id;
00059     int param;
00060     void *data;
00061 };
00062 
00063 typedef struct _NUTMSGTMR NUTMSGTMR;
00064 struct _NUTMSGTMR;
00065 
00066 typedef struct _NUTMSGQ NUTMSGQ;
00067 struct _NUTMSGQ {
00068     HANDLE mq_wait;             /* Wait for a message */
00069     NUTMSGTMR *mq_timers;
00070     NUTMSGQ *mq_next;
00071     u_char mq_read;
00072     u_char mq_write;
00073     u_char mq_mask;
00074     NUTMSG mq_que[1];
00075 };
00076 
00077 
00078 extern NUTMSGQ *NutMsgQCreate(u_char len);
00079 extern int NutMsgQBroadcast(u_char id, int param, void *data);
00080 extern int NutMsgQPost(NUTMSGQ * que, u_char id, int param, void *data);
00081 extern int NutMsgQSend(NUTMSGQ * que, u_char id, int param, void *data);
00082 extern int NutMsgQGetMessage(NUTMSGQ * que, NUTMSG * msg, u_long timeout);
00083 extern int NutMsgQFull(NUTMSGQ * que);
00084 extern void NutMsgQFlush(NUTMSGQ * que);
00085 extern HANDLE NutMsgQStartTimer(NUTMSGQ * que, u_long ms, int param, void *data, u_char flags);
00086 extern void NutMsgQStopTimer(HANDLE timer);
00087 
00088 #define MSG_TIMER   0xfe
00089 #define MSG_NULL    0xff
00090 
00091 #endif

© 2000-2007 by egnite Software GmbH - visit http://www.ethernut.de/