Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages | Search for 

base/include/rtai_tbx.h File Reference

#include <linux/version.h>
#include <rtai_sem.h>
#include <signal.h>
#include <rtai_lxrt.h>

Include dependency graph for rtai_tbx.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_msgq

Defines

#define MSGQ_INIT   TBX_INIT
#define MSGQ_DELETE   TBX_DELETE
#define NAMED_MSGQ_INIT   NAMED_TBX_INIT
#define NAMED_MSGQ_DELETE   NAMED_TBX_DELETE
#define MSG_SEND   TBX_SEND
#define MSG_SEND_IF   TBX_SEND_IF
#define MSG_SEND_UNTIL   TBX_SEND_UNTIL
#define MSG_SEND_TIMED   TBX_SEND_TIMED
#define MSG_RECEIVE   TBX_RECEIVE
#define MSG_RECEIVE_IF   TBX_RECEIVE_IF
#define MSG_RECEIVE_UNTIL   TBX_RECEIVE_UNTIL
#define MSG_RECEIVE_TIMED   TBX_RECEIVE_TIMED
#define MSG_BROADCAST   TBX_BROADCAST
#define MSG_BROADCAST_IF   TBX_BROADCAST_IF
#define MSG_BROADCAST_UNTIL   TBX_BROADCAST_UNTIL
#define MSG_BROADCAST_TIMED   TBX_BROADCAST_TIMED
#define MSG_EVDRP   TBX_URGENT
#define TBX   RT_MSGQ
#define rt_tbx_init(tbx, size, flags)   rt_msgq_init(tbx, size, 0)
#define rt_tbx_delete(tbx)   rt_msgq_delete(tbx)
#define rt_tbx_send(tbx, msg, msg_size)   rt_msg_send(tbx, msg, msg_size, 1)
#define rt_tbx_send_if(tbx, msg, msg_size)   rt_msg_send_if(tbx, msg, msg_size, 1)
#define rt_tbx_send_until(tbx, msg, msg_size, until)   rt_msg_send_until(tbx, msg, msg_size, 1, until)
#define rt_tbx_send_timed(tbx, msg, msg_size, delay)   rt_msg_send_timed(tbx, msg, msg_size, 1, delay)
#define rt_tbx_receive(tbx, msg, msg_size)   rt_msg_receive(tbx, msg, msg_size, 0)
#define rt_tbx_receive_if(tbx, msg, msg_size)   rt_msg_receive_if(tbx, msg, msg_size, 0)
#define rt_tbx_receive_until(tbx, msg, msg_size, until)   rt_msg_receive_until(tbx, msg, msg_size, 0, until)
#define rt_tbx_receive_timed(tbx, msg, msg_size, delay)   rt_msg_receive_timed(tbx, msg, msg_size, 0, delay)
#define rt_tbx_broadcast(tbx, msg, msg_size)   rt_msg_broadcast(tbx, msg, msg_size, 0)
#define rt_tbx_broadcast_if(tbx, msg, msg_size)   rt_msg_broadcast_if(tbx, msg, msg_size, 0)
#define rt_tbx_broadcast_until(tbx, msg, msg_size, until)   rt_msg_broadcast_until(tbx, msg, msg_size, 0, until)
#define rt_tbx_broadcast_timed(tbx, msg, msg_size, delay)   rt_msg_broadcast_timed(tbx, msg, msg_size, 0, delay)
#define rt_tbx_urgent(tbx, msg, msg_size)   rt_msg_send(tbx, msg, msg_size, 0)
#define rt_tbx_urgent_if(tbx, msg, msg_size)   rt_msg_send_if(tbx, msg, msg_size, 0)
#define rt_tbx_urgent_until(tbx, msg, msg_size, until)   rt_msg_send_until(tbx, msg, msg_size, 0, until)
#define rt_tbx_urgent_timed(tbx, msg, msg_size, delay)   rt_msg_send_timed(tbx, msg, msg_size, 0, delay)

Typedefs

typedef rt_msgq RT_MSGQ

Functions

RT_MSGQ * rt_msgq_init (unsigned long msgq, int nmsg, int msg_size)
int rt_msgq_delete (RT_MSGQ *msgq)
RT_MSGQ * rt_named_msgq_init (const char *name, int nmsg, int size)
int rt_named_msgq_delete (RT_MSGQ *msgq)
int rt_msg_send (RT_MSGQ *msgq, void *msg, int msg_size, int msgprio)
int rt_msg_send_if (RT_MSGQ *msgq, void *msg, int msg_size, int msgprio)
int rt_msg_send_until (RT_MSGQ *msgq, void *msg, int msg_size, int msgprio, RTIME until)
int rt_msg_send_timed (RT_MSGQ *msgq, void *msg, int msg_size, int msgprio, RTIME delay)
int rt_msg_receive (RT_MSGQ *msgq, void *msg, int msg_size, int *msgprio)
int rt_msg_receive_if (RT_MSGQ *msgq, void *msg, int msg_size, int *msgprio)
int rt_msg_receive_until (RT_MSGQ *msgq, void *msg, int msg_size, int *msgprio, RTIME until)
int rt_msg_receive_timed (RT_MSGQ *msgq, void *msg, int msg_size, int *msgprio, RTIME delay)
int rt_msg_evdrp (RT_MSGQ *msgq, void *msg, int msg_size, int *msgprio)
int rt_msg_broadcast (RT_MSGQ *msgq, void *msg, int msg_size, int msgprio)
int rt_msg_broadcast_if (RT_MSGQ *msgq, void *msg, int msg_size, int msgprio)
int rt_msg_broadcast_until (RT_MSGQ *msgq, void *msg, int msg_size, int msgprio, RTIME until)
int rt_msg_broadcast_timed (RT_MSGQ *msgq, void *msg, int msg_size, int msgprio, RTIME delay)

Define Documentation

#define MSG_BROADCAST   TBX_BROADCAST
 

Definition at line 39 of file rtai_tbx.h.

Referenced by rt_msg_broadcast().

#define MSG_BROADCAST_IF   TBX_BROADCAST_IF
 

Definition at line 40 of file rtai_tbx.h.

Referenced by rt_msg_broadcast_if().

#define MSG_BROADCAST_TIMED   TBX_BROADCAST_TIMED
 

Definition at line 42 of file rtai_tbx.h.

Referenced by rt_msg_broadcast_timed().

#define MSG_BROADCAST_UNTIL   TBX_BROADCAST_UNTIL
 

Definition at line 41 of file rtai_tbx.h.

Referenced by rt_msg_broadcast_until().

#define MSG_EVDRP   TBX_URGENT
 

Definition at line 43 of file rtai_tbx.h.

Referenced by rt_msg_evdrp().

#define MSG_RECEIVE   TBX_RECEIVE
 

Definition at line 35 of file rtai_tbx.h.

Referenced by rt_msg_receive().

#define MSG_RECEIVE_IF   TBX_RECEIVE_IF
 

Definition at line 36 of file rtai_tbx.h.

Referenced by rt_msg_receive_if().

#define MSG_RECEIVE_TIMED   TBX_RECEIVE_TIMED
 

Definition at line 38 of file rtai_tbx.h.

Referenced by rt_msg_receive_timed().

#define MSG_RECEIVE_UNTIL   TBX_RECEIVE_UNTIL
 

Definition at line 37 of file rtai_tbx.h.

Referenced by rt_msg_receive_until().

#define MSG_SEND   TBX_SEND
 

Definition at line 31 of file rtai_tbx.h.

Referenced by rt_msg_send().

#define MSG_SEND_IF   TBX_SEND_IF
 

Definition at line 32 of file rtai_tbx.h.

Referenced by rt_msg_send_if().

#define MSG_SEND_TIMED   TBX_SEND_TIMED
 

Definition at line 34 of file rtai_tbx.h.

Referenced by rt_msg_send_timed().

#define MSG_SEND_UNTIL   TBX_SEND_UNTIL
 

Definition at line 33 of file rtai_tbx.h.

Referenced by rt_msg_send_until().

#define MSGQ_DELETE   TBX_DELETE
 

Definition at line 28 of file rtai_tbx.h.

#define MSGQ_INIT   TBX_INIT
 

Definition at line 27 of file rtai_tbx.h.

#define NAMED_MSGQ_DELETE   NAMED_TBX_DELETE
 

Definition at line 30 of file rtai_tbx.h.

Referenced by rt_msgq_delete(), and rt_named_msgq_delete().

#define NAMED_MSGQ_INIT   NAMED_TBX_INIT
 

Definition at line 29 of file rtai_tbx.h.

Referenced by rt_msgq_init(), and rt_named_msgq_init().

#define rt_tbx_broadcast (  tbx,
msg,
msg_size   )     rt_msg_broadcast(tbx, msg, msg_size, 0)
 

Definition at line 316 of file rtai_tbx.h.

#define rt_tbx_broadcast_if (  tbx,
msg,
msg_size   )     rt_msg_broadcast_if(tbx, msg, msg_size, 0)
 

Definition at line 317 of file rtai_tbx.h.

#define rt_tbx_broadcast_timed (  tbx,
msg,
msg_size,
delay   )     rt_msg_broadcast_timed(tbx, msg, msg_size, 0, delay)
 

Definition at line 319 of file rtai_tbx.h.

#define rt_tbx_broadcast_until (  tbx,
msg,
msg_size,
until   )     rt_msg_broadcast_until(tbx, msg, msg_size, 0, until)
 

Definition at line 318 of file rtai_tbx.h.

#define rt_tbx_delete (  tbx   )     rt_msgq_delete(tbx)
 

Definition at line 304 of file rtai_tbx.h.

#define rt_tbx_init (  tbx,
size,
flags   )     rt_msgq_init(tbx, size, 0)
 

Definition at line 303 of file rtai_tbx.h.

#define rt_tbx_receive (  tbx,
msg,
msg_size   )     rt_msg_receive(tbx, msg, msg_size, 0)
 

Definition at line 311 of file rtai_tbx.h.

#define rt_tbx_receive_if (  tbx,
msg,
msg_size   )     rt_msg_receive_if(tbx, msg, msg_size, 0)
 

Definition at line 312 of file rtai_tbx.h.

#define rt_tbx_receive_timed (  tbx,
msg,
msg_size,
delay   )     rt_msg_receive_timed(tbx, msg, msg_size, 0, delay)
 

Definition at line 314 of file rtai_tbx.h.

#define rt_tbx_receive_until (  tbx,
msg,
msg_size,
until   )     rt_msg_receive_until(tbx, msg, msg_size, 0, until)
 

Definition at line 313 of file rtai_tbx.h.

#define rt_tbx_send (  tbx,
msg,
msg_size   )     rt_msg_send(tbx, msg, msg_size, 1)
 

Definition at line 306 of file rtai_tbx.h.

#define rt_tbx_send_if (  tbx,
msg,
msg_size   )     rt_msg_send_if(tbx, msg, msg_size, 1)
 

Definition at line 307 of file rtai_tbx.h.

#define rt_tbx_send_timed (  tbx,
msg,
msg_size,
delay   )     rt_msg_send_timed(tbx, msg, msg_size, 1, delay)
 

Definition at line 309 of file rtai_tbx.h.

#define rt_tbx_send_until (  tbx,
msg,
msg_size,
until   )     rt_msg_send_until(tbx, msg, msg_size, 1, until)
 

Definition at line 308 of file rtai_tbx.h.

#define rt_tbx_urgent (  tbx,
msg,
msg_size   )     rt_msg_send(tbx, msg, msg_size, 0)
 

Definition at line 321 of file rtai_tbx.h.

#define rt_tbx_urgent_if (  tbx,
msg,
msg_size   )     rt_msg_send_if(tbx, msg, msg_size, 0)
 

Definition at line 322 of file rtai_tbx.h.

#define rt_tbx_urgent_timed (  tbx,
msg,
msg_size,
delay   )     rt_msg_send_timed(tbx, msg, msg_size, 0, delay)
 

Definition at line 324 of file rtai_tbx.h.

#define rt_tbx_urgent_until (  tbx,
msg,
msg_size,
until   )     rt_msg_send_until(tbx, msg, msg_size, 0, until)
 

Definition at line 323 of file rtai_tbx.h.

#define TBX   RT_MSGQ
 

Definition at line 45 of file rtai_tbx.h.

Typedef Documentation

typedef struct rt_msgq RT_MSGQ
 

Referenced by _broadcast(), _receive(), _rt_msg_broadcast(), _rt_msg_broadcast_if(), _rt_msg_broadcast_timed(), _rt_msg_broadcast_until(), _rt_msg_evdrp(), _rt_msg_receive(), _rt_msg_receive_if(), _rt_msg_receive_timed(), _rt_msg_receive_until(), _rt_msg_send(), _rt_msg_send_if(), _rt_msg_send_timed(), _rt_msg_send_until(), _rt_named_msgq_init(), _send(), enq_msg(), rt_msg_broadcast(), rt_msg_broadcast_if(), rt_msg_broadcast_timed(), rt_msg_broadcast_until(), rt_msg_evdrp(), rt_msg_receive(), rt_msg_receive_if(), rt_msg_receive_timed(), rt_msg_receive_until(), rt_msg_send(), rt_msg_send_if(), rt_msg_send_timed(), rt_msg_send_until(), rt_msgq_delete(), rt_msgq_init(), rt_named_msgq_delete(), and rt_named_msgq_init().

Function Documentation

int rt_msg_broadcast (  RT_MSGQ *  msgq,
void *  msg,
int  msg_size,
int  msgprio
)  [inline]
 

Definition at line 273 of file rtai_tbx.h.

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

Here is the call graph for this function:

int rt_msg_broadcast_if (  RT_MSGQ *  msgq,
void *  msg,
int  msg_size,
int  msgprio
)  [inline]
 

Definition at line 279 of file rtai_tbx.h.

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

Here is the call graph for this function:

int rt_msg_broadcast_timed (  RT_MSGQ *  msgq,
void *  msg,
int  msg_size,
int  msgprio,
RTIME  delay
)  [inline]
 

Definition at line 291 of file rtai_tbx.h.

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

Here is the call graph for this function:

int rt_msg_broadcast_until (  RT_MSGQ *  msgq,
void *  msg,
int  msg_size,
int  msgprio,
RTIME  until
)  [inline]
 

Definition at line 285 of file rtai_tbx.h.

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

Here is the call graph for this function:

int rt_msg_evdrp (  RT_MSGQ *  msgq,
void *  msg,
int  msg_size,
int *  msgprio
)  [inline]
 

Definition at line 267 of file rtai_tbx.h.

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

Here is the call graph for this function:

int rt_msg_receive (  RT_MSGQ *  msgq,
void *  msg,
int  msg_size,
int *  msgprio
)  [inline]
 

Definition at line 243 of file rtai_tbx.h.

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

Here is the call graph for this function:

int rt_msg_receive_if (  RT_MSGQ *  msgq,
void *  msg,
int  msg_size,
int *  msgprio
)  [inline]
 

Definition at line 249 of file rtai_tbx.h.

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

Here is the call graph for this function:

int rt_msg_receive_timed (  RT_MSGQ *  msgq,
void *  msg,
int  msg_size,
int *  msgprio,
RTIME  delay
)  [inline]
 

Definition at line 261 of file rtai_tbx.h.

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

Here is the call graph for this function:

int rt_msg_receive_until (  RT_MSGQ *  msgq,
void *  msg,
int  msg_size,
int *  msgprio,
RTIME  until
)  [inline]
 

Definition at line 255 of file rtai_tbx.h.

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

Here is the call graph for this function:

int rt_msg_send (  RT_MSGQ *  msgq,
void *  msg,
int  msg_size,
int  msgprio
)  [inline]
 

Definition at line 219 of file rtai_tbx.h.

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

Here is the call graph for this function:

int rt_msg_send_if (  RT_MSGQ *  msgq,
void *  msg,
int  msg_size,
int  msgprio
)  [inline]
 

Definition at line 225 of file rtai_tbx.h.

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

Here is the call graph for this function:

int rt_msg_send_timed (  RT_MSGQ *  msgq,
void *  msg,
int  msg_size,
int  msgprio,
RTIME  delay
)  [inline]
 

Definition at line 237 of file rtai_tbx.h.

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

Here is the call graph for this function:

int rt_msg_send_until (  RT_MSGQ *  msgq,
void *  msg,
int  msg_size,
int  msgprio,
RTIME  until
)  [inline]
 

Definition at line 231 of file rtai_tbx.h.

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

Here is the call graph for this function:

int rt_msgq_delete (  RT_MSGQ *  msgq  )  [inline]
 

Definition at line 201 of file rtai_tbx.h.

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

Here is the call graph for this function:

RT_MSGQ* rt_msgq_init (  unsigned long  msgq,
int  nmsg,
int  msg_size
)  [inline]
 

Definition at line 195 of file rtai_tbx.h.

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

Here is the call graph for this function:

int rt_named_msgq_delete (  RT_MSGQ *  msgq  )  [inline]
 

Definition at line 213 of file rtai_tbx.h.

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

Here is the call graph for this function:

RT_MSGQ* rt_named_msgq_init (  const char *  name,
int  nmsg,
int  size
)  [inline]
 

Definition at line 207 of file rtai_tbx.h.

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

Here is the call graph for this function:

Generated on Thu Nov 20 11:54:07 2008 for RTAI API by doxygen 1.3.8