doc/generated/html/api/native_2pipe_8h.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <title>Xenomai API: include/native/pipe.h File Reference</title>
   6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   7 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
   8 </head>
   9 <body>
  10 <!-- Generated by Doxygen 1.7.1 -->
  11 <div class="navigation" id="top">
  12   <div class="tabs">
  13     <ul class="tablist">
  14       <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
  15       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  16       <li><a href="modules.html"><span>Modules</span></a></li>
  17       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  18       <li class="current"><a href="files.html"><span>Files</span></a></li>
  19       <li><a href="examples.html"><span>Examples</span></a></li>
  20     </ul>
  21   </div>
  22   <div class="tabs2">
  23     <ul class="tablist">
  24       <li><a href="files.html"><span>File&nbsp;List</span></a></li>
  25       <li><a href="globals.html"><span>Globals</span></a></li>
  26     </ul>
  27   </div>
  28 </div>
  29 <div class="header">
  30   <div class="summary">
  31 <a href="#func-members">Functions</a>  </div>
  32   <div class="headertitle">
  33 <h1>include/native/pipe.h File Reference</h1>  </div>
  34 </div>
  35 <div class="contents">
  36
  37 <p>This file is part of the Xenomai project.
  38 <a href="#_details">More...</a></p>
  39 <div class="dynheader">
  40 Include dependency graph for pipe.h:</div>
  41 <div class="dyncontent">
  42 <div class="center"><img src="native_2pipe_8h__incl.png" border="0" usemap="#include_2native_2pipe_8h" alt=""/></div>
  43 <map name="include_2native_2pipe_8h" id="include_2native_2pipe_8h">
  44 <area shape="rect" id="node3" href="nucleus_2pipe_8h_source.html" title="nucleus/pipe.h" alt="" coords="192,237,307,267"/><area shape="rect" id="node52" href="nucleus_2heap_8h_source.html" title="nucleus/heap.h" alt="" coords="183,160,300,189"/><area shape="rect" id="node55" href="native_2types_8h.html" title="This file is part of the Xenomai project." alt="" coords="1161,83,1273,112"/><area shape="rect" id="node58" href="native_2ppd_8h.html" title="This file is part of the Xenomai project." alt="" coords="376,83,477,112"/><area shape="rect" id="node5" href="nucleus_2queue_8h_source.html" title="nucleus/queue.h" alt="" coords="429,547,555,576"/><area shape="rect" id="node19" href="synch_8h_source.html" title="nucleus/synch.h" alt="" coords="381,469,504,499"/><area shape="rect" id="node22" href="include_2nucleus_2thread_8h_source.html" title="nucleus/thread.h" alt="" coords="864,315,992,344"/><area shape="rect" id="node7" href="nucleus_2types_8h_source.html" title="nucleus/types.h" alt="" coords="813,624,936,653"/><area shape="rect" id="node15" href="assert_8h_source.html" title="nucleus/assert.h" alt="" coords="595,701,720,731"/><area shape="rect" id="node13" href="compiler_8h_source.html" title="nucleus/compiler.h" alt="" coords="1064,701,1205,731"/><area shape="rect" id="node25" href="stat_8h_source.html" title="nucleus/stat.h" alt="" coords="1133,469,1245,499"/><area shape="rect" id="node28" href="include_2nucleus_2timer_8h.html" title="nucleus/timer.h" alt="" coords="1019,392,1139,421"/><area shape="rect" id="node41" href="include_2nucleus_2registry_8h.html" title="This file is part of the Xenomai project." alt="" coords="861,392,995,421"/><area shape="rect" id="node46" href="schedparam_8h_source.html" title="nucleus/schedparam.h" alt="" coords="621,392,787,421"/><area shape="rect" id="node30" href="timebase_8h.html" title="nucleus/timebase.h" alt="" coords="963,469,1109,499"/><area shape="rect" id="node33" href="vfile_8h.html" title="This file is part of the Xenomai project." alt="" coords="972,547,1084,576"/><area shape="rect" id="node60" href="pod_8h.html" title="Real&#45;time pod interface header." alt="" coords="821,160,931,189"/><area shape="rect" id="node77" href="nucleus_2ppd_8h_source.html" title="nucleus/ppd.h" alt="" coords="375,160,484,189"/><area shape="rect" id="node62" href="sched_8h.html" title="Scheduler interface header." alt="" coords="1117,237,1243,267"/><area shape="rect" id="node65" href="schedqueue_8h_source.html" title="nucleus/schedqueue.h" alt="" coords="432,392,597,421"/><area shape="rect" id="node68" href="sched-tp_8h.html" title="Definitions for the TP scheduling class." alt="" coords="1016,315,1157,344"/><area shape="rect" id="node70" href="sched-sporadic_8h.html" title="Definitions for the SSP scheduling class." alt="" coords="1181,315,1365,344"/><area shape="rect" id="node73" href="sched-idle_8h.html" title="Definitions for the IDLE scheduling class." alt="" coords="1389,315,1541,344"/><area shape="rect" id="node75" href="sched-rt_8h.html" title="Definitions for the RT scheduling class." alt="" coords="1565,315,1704,344"/><area shape="rect" id="node80" href="shadow_8h_source.html" title="nucleus/shadow.h" alt="" coords="448,237,581,267"/></map>
  45 </div>
  46 <div class="dynheader">
  47 This graph shows which files directly or indirectly include this file:</div>
  48 <div class="dyncontent">
  49 <div class="center"><img src="native_2pipe_8h__dep__incl.png" border="0" usemap="#include_2native_2pipe_8hdep" alt=""/></div>
  50 <map name="include_2native_2pipe_8hdep" id="include_2native_2pipe_8hdep">
  51 <area shape="rect" id="node3" href="skins_2native_2module_8c.html" title="This file is part of the Xenomai project." alt="" coords="5,83,195,112"/><area shape="rect" id="node5" href="ksrc_2skins_2native_2pipe_8c.html" title="This file is part of the Xenomai project." alt="" coords="219,83,387,112"/><area shape="rect" id="node7" href="native_2syscall_8c.html" title="This file is part of the Xenomai project." alt="" coords="411,83,595,112"/></map>
  52 </div>
  53
  54 <p><a href="native_2pipe_8h_source.html">Go to the source code of this file.</a></p>
  55 <table class="memberdecls">
  56 <tr><td colspan="2"><h2><a name="func-members"></a>
  57 Functions</h2></td></tr>
  58 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pipe.html#ga29521cc898afa0069963964955167aa5">rt_pipe_create</a> (RT_PIPE *pipe, const char *name, int minor, size_t poolsize)</td></tr>
  59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a message pipe.  <a href="group__pipe.html#ga29521cc898afa0069963964955167aa5"></a><br/></td></tr>
  60 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pipe.html#ga1d84976a1b9b668366261ca9b836b677">rt_pipe_delete</a> (RT_PIPE *pipe)</td></tr>
  61 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Delete a message pipe.  <a href="group__pipe.html#ga1d84976a1b9b668366261ca9b836b677"></a><br/></td></tr>
  62 <tr><td class="memItemLeft" align="right" valign="top">ssize_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pipe.html#ga62cb64807c2c843f8e8eebb2dc3a7d4e">rt_pipe_read</a> (RT_PIPE *pipe, void *buf, size_t size, RTIME timeout)</td></tr>
  63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a message from a pipe.  <a href="group__pipe.html#ga62cb64807c2c843f8e8eebb2dc3a7d4e"></a><br/></td></tr>
  64 <tr><td class="memItemLeft" align="right" valign="top">ssize_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pipe.html#ga12f801963d0db6aa60bc6cf92f65697a">rt_pipe_write</a> (RT_PIPE *pipe, const void *buf, size_t size, int mode)</td></tr>
  65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write a message to a pipe.  <a href="group__pipe.html#ga12f801963d0db6aa60bc6cf92f65697a"></a><br/></td></tr>
  66 <tr><td class="memItemLeft" align="right" valign="top">ssize_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pipe.html#gad8edc920499d2c5c5d821ee7b9fa2bcd">rt_pipe_stream</a> (RT_PIPE *pipe, const void *buf, size_t size)</td></tr>
  67 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stream bytes to a pipe.  <a href="group__pipe.html#gad8edc920499d2c5c5d821ee7b9fa2bcd"></a><br/></td></tr>
  68 <tr><td class="memItemLeft" align="right" valign="top">ssize_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pipe.html#ga731e5ef18007dcd58a9346bea66abbc6">rt_pipe_receive</a> (RT_PIPE *pipe, RT_PIPE_MSG **msg, RTIME timeout)</td></tr>
  69 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Receive a message from a pipe.  <a href="group__pipe.html#ga731e5ef18007dcd58a9346bea66abbc6"></a><br/></td></tr>
  70 <tr><td class="memItemLeft" align="right" valign="top">ssize_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pipe.html#gaf40b20cad1dcd7bedcda72beaa16c057">rt_pipe_send</a> (RT_PIPE *pipe, RT_PIPE_MSG *msg, size_t size, int mode)</td></tr>
  71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a message through a pipe.  <a href="group__pipe.html#gaf40b20cad1dcd7bedcda72beaa16c057"></a><br/></td></tr>
  72 <tr><td class="memItemLeft" align="right" valign="top">RT_PIPE_MSG *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pipe.html#ga40f294bf6254d2e1b66b8b6b400fc2e5">rt_pipe_alloc</a> (RT_PIPE *pipe, size_t size)</td></tr>
  73 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate a message pipe buffer.  <a href="group__pipe.html#ga40f294bf6254d2e1b66b8b6b400fc2e5"></a><br/></td></tr>
  74 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pipe.html#ga8face1c57df99cf43b029b3e3b6a05c6">rt_pipe_free</a> (RT_PIPE *pipe, RT_PIPE_MSG *msg)</td></tr>
  75 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Free a message pipe buffer.  <a href="group__pipe.html#ga8face1c57df99cf43b029b3e3b6a05c6"></a><br/></td></tr>
  76 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pipe.html#gab4d85ecda7675a75611500070c28b22e">rt_pipe_flush</a> (RT_PIPE *pipe, int mode)</td></tr>
  77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flush the i/o queues associated with the kernel endpoint of a message pipe.  <a href="group__pipe.html#gab4d85ecda7675a75611500070c28b22e"></a><br/></td></tr>
  78 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pipe.html#ga944600f54dc78a77badeda77f3af732d">rt_pipe_monitor</a> (RT_PIPE *pipe, int(*fn)(RT_PIPE *pipe, int event, long arg))</td></tr>
  79 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Monitor a message pipe asynchronously.  <a href="group__pipe.html#ga944600f54dc78a77badeda77f3af732d"></a><br/></td></tr>
  80 </table>
  81 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  82 <p>This file is part of the Xenomai project. </p>
  83 <dl class="note"><dt><b>Note:</b></dt><dd>Copyright (C) 2004 Philippe Gerum &lt;<a href="mailto:rpm@xenomai.org">rpm@xenomai.org</a>&gt;</dd></dl>
  84 <p>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.</p>
  85 <p>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.</p>
  86 <p>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. </p>
  87 </div>
  88 <hr class="footer"/><address class="footer"><small>Generated on Wed Nov 2 2011 18:01:08 for Xenomai API by&nbsp;
  89 <a href="http://www.doxygen.org/index.html">
  90 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
  91 </body>
  92 </html>