Files
rtems/cpukit/itron/include/itronsys/msgbuffer.h
Joel Sherrill c4a3f1e914 2003-09-04 Joel Sherrill <joel@OARcorp.com>
* include/itron.h, include/itronsys/eventflags.h,
	include/itronsys/fmempool.h, include/itronsys/intr.h,
	include/itronsys/mbox.h, include/itronsys/msgbuffer.h,
	include/itronsys/network.h, include/itronsys/port.h,
	include/itronsys/semaphore.h, include/itronsys/status.h,
	include/itronsys/sysmgmt.h, include/itronsys/task.h,
	include/itronsys/time.h, include/itronsys/types.h,
	include/itronsys/vmempool.h, include/rtems/itron/config.h,
	include/rtems/itron/eventflags.h, include/rtems/itron/fmempool.h,
	include/rtems/itron/intr.h, include/rtems/itron/itronapi.h,
	include/rtems/itron/mbox.h, include/rtems/itron/msgbuffer.h,
	include/rtems/itron/network.h, include/rtems/itron/object.h,
	include/rtems/itron/port.h, include/rtems/itron/semaphore.h,
	include/rtems/itron/sysmgmt.h, include/rtems/itron/task.h,
	include/rtems/itron/time.h, include/rtems/itron/vmempool.h,
	inline/rtems/itron/eventflags.inl, inline/rtems/itron/fmempool.inl,
	inline/rtems/itron/intr.inl, inline/rtems/itron/mbox.inl,
	inline/rtems/itron/msgbuffer.inl, inline/rtems/itron/network.inl,
	inline/rtems/itron/port.inl, inline/rtems/itron/semaphore.inl,
	inline/rtems/itron/sysmgmt.inl, inline/rtems/itron/task.inl,
	inline/rtems/itron/time.inl, inline/rtems/itron/vmempool.inl,
	macros/rtems/itron/eventflags.inl, macros/rtems/itron/fmempool.inl,
	macros/rtems/itron/intr.inl, macros/rtems/itron/mbox.inl,
	macros/rtems/itron/msgbuffer.inl, macros/rtems/itron/network.inl,
	macros/rtems/itron/port.inl, macros/rtems/itron/semaphore.inl,
	macros/rtems/itron/sysmgmt.inl, macros/rtems/itron/task.inl,
	macros/rtems/itron/time.inl, macros/rtems/itron/vmempool.inl,
	src/can_wup.c, src/chg_pri.c, src/cre_mbf.c, src/cre_mbx.c,
	src/cre_sem.c, src/cre_tsk.c, src/del_mbf.c, src/del_mbx.c,
	src/del_sem.c, src/del_tsk.c, src/dis_dsp.c, src/ena_dsp.c,
	src/eventflags.c, src/exd_tsk.c, src/ext_tsk.c, src/fmempool.c,
	src/frsm_tsk.c, src/get_tid.c, src/itronintr.c, src/itronsem.c,
	src/itrontime.c, src/mbox.c, src/mboxtranslatereturncode.c,
	src/msgbuffer.c, src/msgbuffertranslatereturncode.c, src/network.c,
	src/port.c, src/prcv_mbf.c, src/prcv_mbx.c, src/preq_sem.c,
	src/psnd_mbf.c, src/rcv_mbf.c, src/rcv_mbx.c, src/ref_mbf.c,
	src/ref_mbx.c, src/ref_sem.c, src/ref_tsk.c, src/rel_wai.c,
	src/rot_rdq.c, src/rsm_tsk.c, src/sig_sem.c, src/slp_tsk.c,
	src/snd_mbf.c, src/snd_mbx.c, src/sta_tsk.c, src/sus_tsk.c,
	src/sysmgmt.c, src/task.c, src/ter_tsk.c, src/trcv_mbf.c,
	src/trcv_mbx.c, src/tslp_tsk.c, src/tsnd_mbf.c, src/twai_sem.c,
	src/vmempool.c, src/wai_sem.c, src/wup_tsk.c: URL for license
	changed.
2003-09-04 18:46:52 +00:00

161 lines
2.7 KiB
C

/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*
* $Id$
*/
#ifndef __ITRON_MESSAGEBUFFER_h_
#define __ITRON_MESSAGEBUFFER_h_
#ifdef __cplusplus
extern "C" {
#endif
/*
* Create Message Buffer (cre_mbf) Structure
*/
typedef struct t_cmbf {
VP exinf; /* extended information */
ATR mbfatr; /* messagebuffer attributes */
INT bufsz; /* messagebuffer size */
INT maxmsz; /* maximum size of messages */
/* additional information may be included depending on the implementation */
} T_CMBF;
/*
* mbfatr
*/
#define TA_TFIFO 0x00 /* tasks waiting to receive messages are handled
by FIFO */
#define TA_TPRI 0x01 /* tasks waiting to receive messages are handled
by priority */
/*
* mbfid
*/
#define TMBF_OS (-4) /* messagebuffer used for OS error log */
#define TMBF_DB (-3) /* messagebuffer used for debugging */
/*
* Reference Message Buffer (ref_mbf) Structure
*/
typedef struct t_rmbf {
VP exinf; /* extended information */
BOOL_ID wtsk; /* indicates whether or not there is a */
/* task waiting to receive a message */
BOOL_ID stsk; /* indicates whether or not there is a */
/* task waiting to send a message */
INT msgsz; /* size of message to be sent next */
INT frbufsz; /* size of free buffer */
/* additional information may be included depending on the implementation */
} T_RMBF;
/*
* Message Buffer Functions
*/
/*
* cre_mbf - Create MessageBuffer
*/
ER cre_mbf(
ID mbfid,
T_CMBF *pk_cmbf
);
/*
* del_mbf - Delete MessageBuffer
*/
ER del_mbf(
ID mbfid
);
/*
* snd_mbf - Send Message to MessageBuffer
*/
ER snd_mbf(
ID mbfid,
VP msg,
INT msgsz
);
/*
* psnd_mbf - Poll and Send Message to MessageBuffer
*/
ER psnd_mbf(
ID mbfid,
VP msg,
INT msgsz
);
/*
* tsnd_mbf - Send Message to MessageBuffer with Timeout
*/
ER tsnd_mbf(
ID mbfid,
VP msg,
INT msgsz,
TMO tmout
);
/*
* rcv_mbf - Receive Message from MessageBuffer
*/
ER rcv_mbf(
VP msg,
INT *p_msgsz,
ID mbfid
);
/*
* prcv_mbf - Poll and Receive Message from MessageBuffer
*/
ER prcv_mbf(
VP msg,
INT *p_msgsz,
ID mbfid
);
/*
* trcv_mbf - Receive Message from MessageBuffer with Timeout
*/
ER trcv_mbf(
VP msg,
INT *p_msgsz,
ID mbfid,
TMO tmout
);
/*
* ref_mbf - Reference MessageBuffer Status
*/
ER ref_mbf(
T_RMBF *pk_rmbf,
ID mbfid
);
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */