msgq.h

Go to the documentation of this file.

/*
 Copyright (C) 2009 Sung Ho Park
 Contact: ubinos.org@gmail.com
 
 This file is part of the itf_ubinos component of the Ubinos.
 
 GNU General Public License Usage
 This file may be used under the terms of the GNU
 General Public License version 3.0 as published by the Free Software
 Foundation and appearing in the file license_gpl3.txt included in the
 packaging of this file. Please review the following information to
 ensure the GNU General Public License version 3.0 requirements will be
 met: http://www.gnu.org/copyleft/gpl.html.
 
 GNU Lesser General Public License Usage
 Alternatively, this file may be used under the terms of the GNU Lesser
 General Public License version 2.1 as published by the Free Software
 Foundation and appearing in the file license_lgpl.txt included in the
 packaging of this file. Please review the following information to
 ensure the GNU Lesser General Public License version 2.1 requirements
 will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
 
 Commercial Usage
 Alternatively, licensees holding valid commercial licenses may
 use this file in accordance with the commercial license agreement
 provided with the software or, alternatively, in accordance with the
 terms contained in a written agreement between you and rightful owner.
 */
 
#ifndef UBIK_MSGQ_H_
#define UBIK_MSGQ_H_
 
#ifdef  __cplusplus
extern "C"
{
#endif
 
#include <ubinos_config.h>
#include <ubinos/type.h>
 
#include "task.h"
 
#define MSGQ_OPT__IGNOREOVERFLOW        0x80
 
typedef struct __msgq_tip_t
{
    unsigned int type :8; 
    unsigned int valid :1; 
    unsigned int reserved :7; 
    unsigned int reserved2 :16; 
} _msgq_tip_t;
 
typedef _msgq_tip_t * msgq_pt;
 
int msgq_create(msgq_pt * msgq_p, unsigned int msgsize, unsigned int maxcount);
 
int msgq_create_ext(msgq_pt * msgq_p, unsigned int msgsize,
        unsigned int maxcount, unsigned int option);
 
int msgq_delete(msgq_pt * msgq_p);
 
int msgq_receive(msgq_pt msgq, unsigned char * msg);
 
int msgq_receive_timed(msgq_pt msgq, unsigned char * msg, unsigned int tick);
 
int msgq_receive_timedms(msgq_pt msgq, unsigned char * msg,
        unsigned int timems);
 
int msgq_send(msgq_pt msgq, unsigned char * msg);
 
int msgq_clear(msgq_pt msgq);
 
int msgq_setsender(msgq_pt msgq, task_pt task);
 
int msgq_getcount(msgq_pt msgq, unsigned int * count_p);
 
#ifdef  __cplusplus
}
#endif
 
#endif /* UBIK_MSGQ_H_ */