base/include/rtai_mbx.h File Reference


Detailed Description

Author:
Paolo Mantegazza
Note:
Copyright © 1999-2003 Paolo Mantegazza <mantegazza@aero.polimi.it>
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Definition in file rtai_mbx.h.#include <rtai_sem.h>
#include <rtai_lxrt.h>

Include dependency graph for rtai_mbx.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Data Structures

struct  rt_mailbox

Defines

#define RT_MBX_MAGIC   0x3f81aab
#define rt_mbx_init(name, size)   rt_typed_mbx_init(name, size, FIFO_Q)
#define rt_named_mbx_init(mbx_name, size)   rt_typed_named_mbx_init(mbx_name, size, FIFO_Q)

Typedefs

typedef rt_mailbox MBX

Functions

void * rt_typed_mbx_init (unsigned long name, int size, int qtype)
int rt_mbx_delete (struct rt_mailbox *mbx)
rt_mailboxrt_typed_named_mbx_init (const char *name, int size, int type)
int rt_named_mbx_delete (struct rt_mailbox *mbx)
int rt_mbx_send (struct rt_mailbox *mbx, void *msg, int msg_size)
int rt_mbx_send_wp (struct rt_mailbox *mbx, void *msg, int msg_size)
int rt_mbx_send_if (struct rt_mailbox *mbx, void *msg, int msg_size)
int rt_mbx_send_until (struct rt_mailbox *mbx, void *msg, int msg_size, RTIME time)
int rt_mbx_send_timed (struct rt_mailbox *mbx, void *msg, int msg_size, RTIME delay)
int rt_mbx_ovrwr_send (struct rt_mailbox *mbx, void *msg, int msg_size)
int rt_mbx_evdrp (struct rt_mailbox *mbx, void *msg, int msg_size)
int rt_mbx_receive (struct rt_mailbox *mbx, void *msg, int msg_size)
int rt_mbx_receive_wp (struct rt_mailbox *mbx, void *msg, int msg_size)
int rt_mbx_receive_if (struct rt_mailbox *mbx, void *msg, int msg_size)
int rt_mbx_receive_until (struct rt_mailbox *mbx, void *msg, int msg_size, RTIME time)
int rt_mbx_receive_timed (struct rt_mailbox *mbx, void *msg, int msg_size, RTIME delay)


Define Documentation

#define RT_MBX_MAGIC   0x3f81aab
 

Definition at line 29 of file rtai_mbx.h.

Referenced by mbx_send_if(), and rt_typed_mbx_init().

#define rt_named_mbx_init mbx_name,
size   )     rt_typed_named_mbx_init(mbx_name, size, FIFO_Q)
 

Definition at line 199 of file rtai_mbx.h.


Typedef Documentation

typedef struct rt_mailbox MBX
 

Referenced by _rt_mbx_evdrp(), _rt_mbx_ovrwr_send(), _rt_mbx_receive(), _rt_mbx_receive_if(), _rt_mbx_receive_timed(), _rt_mbx_receive_until(), _rt_mbx_receive_wp(), _rt_mbx_send(), _rt_mbx_send_if(), _rt_mbx_send_timed(), _rt_mbx_send_until(), _rt_mbx_send_wp(), _rt_typed_named_mbx_init(), clr_rtext(), handle_lxrt_request(), lxrt_typed_mbx_init(), mbx_delete_signal(), mbx_send_if(), mbx_signal(), mbx_wait(), mbx_wait_until(), mbxevdrp(), mbxget(), mbxovrwrput(), mbxput(), rt_get_net_rpc_ret(), rt_mbx_delete(), RT_mbx_evdrp(), rt_mbx_init(), RT_mbx_ovrwr_send(), RT_mbx_receive(), RT_mbx_receive_if(), RT_mbx_receive_timed(), RT_mbx_receive_until(), RT_mbx_receive_wp(), RT_mbx_send(), RT_mbx_send_if(), RT_mbx_send_timed(), RT_mbx_send_until(), RT_mbx_send_wp(), rt_named_mbx_delete(), RT_named_mbx_delete(), rt_send_req_rel_port(), rt_typed_mbx_init(), and RT_typed_named_mbx_init().


Function Documentation

int rt_mbx_delete struct rt_mailbox mbx  )  [inline]
 

Definition at line 181 of file rtai_mbx.h.

References BIDX, rtai_lxrt_t::i, LOW, LXRT_MBX_DELETE, rtai_lxrt(), and SIZARG.

Here is the call graph for this function:

int rt_mbx_evdrp struct rt_mailbox mbx,
void *  msg,
int  msg_size
[inline]
 

Definition at line 238 of file rtai_mbx.h.

References BIDX, rtai_lxrt_t::i, LOW, MBX_EVDRP, rtai_lxrt(), and SIZARG.

Referenced by RT_mbx_evdrp().

Here is the call graph for this function:

int rt_mbx_ovrwr_send struct rt_mailbox mbx,
void *  msg,
int  msg_size
[inline]
 

Definition at line 232 of file rtai_mbx.h.

References BIDX, rtai_lxrt_t::i, LOW, MBX_OVRWR_SEND, rtai_lxrt(), and SIZARG.

Referenced by RT_mbx_ovrwr_send().

Here is the call graph for this function:

int rt_mbx_receive struct rt_mailbox mbx,
void *  msg,
int  msg_size
[inline]
 

Definition at line 244 of file rtai_mbx.h.

References BIDX, rtai_lxrt_t::i, LOW, MBX_RECEIVE, rtai_lxrt(), and SIZARG.

Referenced by rt_get_net_rpc_ret(), and RT_mbx_receive().

Here is the call graph for this function:

int rt_mbx_receive_if struct rt_mailbox mbx,
void *  msg,
int  msg_size
[inline]
 

Definition at line 256 of file rtai_mbx.h.

References BIDX, rtai_lxrt_t::i, LOW, MBX_RECEIVE_IF, rtai_lxrt(), and SIZARG.

Referenced by rt_get_net_rpc_ret(), and RT_mbx_receive_if().

Here is the call graph for this function:

int rt_mbx_receive_timed struct rt_mailbox mbx,
void *  msg,
int  msg_size,
RTIME  delay
[inline]
 

Definition at line 268 of file rtai_mbx.h.

References BIDX, rtai_lxrt_t::i, LOW, MBX_RECEIVE_TIMED, rtai_lxrt(), RTIME, and SIZARG.

Referenced by rt_get_net_rpc_ret(), and RT_mbx_receive_timed().

Here is the call graph for this function:

int rt_mbx_receive_until struct rt_mailbox mbx,
void *  msg,
int  msg_size,
RTIME  time
[inline]
 

Definition at line 262 of file rtai_mbx.h.

References BIDX, rtai_lxrt_t::i, LOW, MBX_RECEIVE_UNTIL, rtai_lxrt(), RTIME, and SIZARG.

Referenced by rt_get_net_rpc_ret(), and RT_mbx_receive_until().

Here is the call graph for this function:

int rt_mbx_receive_wp struct rt_mailbox mbx,
void *  msg,
int  msg_size
[inline]
 

Definition at line 250 of file rtai_mbx.h.

References BIDX, rtai_lxrt_t::i, LOW, MBX_RECEIVE_WP, rtai_lxrt(), and SIZARG.

Referenced by rt_get_net_rpc_ret(), and RT_mbx_receive_wp().

Here is the call graph for this function:

int rt_mbx_send struct rt_mailbox mbx,
void *  msg,
int  msg_size
[inline]
 

Definition at line 202 of file rtai_mbx.h.

References BIDX, rtai_lxrt_t::i, LOW, MBX_SEND, rtai_lxrt(), and SIZARG.

Referenced by RT_mbx_send().

Here is the call graph for this function:

int rt_mbx_send_if struct rt_mailbox mbx,
void *  msg,
int  msg_size
[inline]
 

Definition at line 214 of file rtai_mbx.h.

References BIDX, rtai_lxrt_t::i, LOW, MBX_SEND_IF, rtai_lxrt(), and SIZARG.

Referenced by RT_mbx_send_if().

Here is the call graph for this function:

int rt_mbx_send_timed struct rt_mailbox mbx,
void *  msg,
int  msg_size,
RTIME  delay
[inline]
 

Definition at line 226 of file rtai_mbx.h.

References BIDX, rtai_lxrt_t::i, LOW, MBX_SEND_TIMED, rtai_lxrt(), RTIME, and SIZARG.

Here is the call graph for this function:

int rt_mbx_send_until struct rt_mailbox mbx,
void *  msg,
int  msg_size,
RTIME  time
[inline]
 

Definition at line 220 of file rtai_mbx.h.

References BIDX, rtai_lxrt_t::i, LOW, MBX_SEND_UNTIL, rtai_lxrt(), RTIME, and SIZARG.

Referenced by RT_mbx_send_timed(), and RT_mbx_send_until().

Here is the call graph for this function:

int rt_mbx_send_wp struct rt_mailbox mbx,
void *  msg,
int  msg_size
[inline]
 

Definition at line 208 of file rtai_mbx.h.

References BIDX, rtai_lxrt_t::i, LOW, MBX_SEND_WP, rtai_lxrt(), and SIZARG.

Referenced by RT_mbx_send_wp().

Here is the call graph for this function:

int rt_named_mbx_delete struct rt_mailbox mbx  )  [inline]
 

Definition at line 193 of file rtai_mbx.h.

References BIDX, rtai_lxrt_t::i, LOW, NAMED_MBX_DELETE, rtai_lxrt(), and SIZARG.

Here is the call graph for this function:

void* rt_typed_mbx_init unsigned long  name,
int  size,
int  qtype
[inline]
 

Definition at line 159 of file rtai_mbx.h.

References BIDX, LOW, LXRT_MBX_INIT, rtai_lxrt(), SIZARG, and rtai_lxrt_t::v.

Here is the call graph for this function:

struct rt_mailbox* rt_typed_named_mbx_init const char *  name,
int  size,
int  type
[inline]
 

Definition at line 187 of file rtai_mbx.h.

References BIDX, LOW, nam2num(), NAMED_MBX_INIT, rtai_lxrt(), SIZARG, and rtai_lxrt_t::v.

Referenced by RT_typed_named_mbx_init().

Here is the call graph for this function:


Generated on Thu Nov 20 11:52:41 2008 for RTAI API by doxygen 1.3.8