<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>UbixOS: include/sys/pipe.h Source File</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">UbixOS
 <span id="projectnumber">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('da/d3e/pipe_8h_source.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">pipe.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="../../da/d3e/pipe_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*-</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2002-2018 The UbixOS Project.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This was developed by Christopher W. Olsen for the UbixOS Project.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without modification, are permitted</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * provided that the following conditions are met:</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * 1) Redistributions of source code must retain the above copyright notice, this list of</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * conditions, the following disclaimer and the list of authors.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * 2) Redistributions in binary form must reproduce the above copyright notice, this list of</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * conditions, the following disclaimer and the list of authors in the documentation and/or</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * other materials provided with the distribution.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * 3) Neither the name of the UbixOS Project nor the names of its contributors may be used to</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * endorse or promote products derived from this software without specific prior written</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * permission.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#ifndef _SYS_PIPE_H</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#define _SYS_PIPE_H</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <<a class="code" href="../../db/dd5/thread_8h.html">sys/thread.h</a>></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <<a class="code" href="../../d3/d7e/sysproto__posix_8h.html">sys/sysproto_posix.h</a>></span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">int</span> <a class="code" href="../../da/d3e/pipe_8h.html#a476208212b5dff10a39e8039c8eead6d">pipe</a>(<span class="keyword">struct</span> <a class="code" href="../../d3/dc5/structthread.html">thread</a> *, <span class="keyword">struct</span> <a class="code" href="../../da/db0/structpipe__args.html">pipe_args</a> *);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="../../d2/dd5/structpipeBuf.html"> 37</a></span> <span class="keyword">struct </span><a class="code" href="../../d2/dd5/structpipeBuf.html">pipeBuf</a> {</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="../../d2/dd5/structpipeBuf.html#ad9a3f124f1d677ea353fcc8cfc76a46d"> 38</a></span>  <span class="keyword">struct </span><a class="code" href="../../d2/dd5/structpipeBuf.html">pipeBuf</a> *<a class="code" href="../../d2/dd5/structpipeBuf.html#ad9a3f124f1d677ea353fcc8cfc76a46d">next</a>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="../../d2/dd5/structpipeBuf.html#aa910cff72b25f70395e2cc68ecc9a18d"> 39</a></span>  <span class="keywordtype">char</span> *<a class="code" href="../../d2/dd5/structpipeBuf.html#aa910cff72b25f70395e2cc68ecc9a18d">buffer</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="../../d2/dd5/structpipeBuf.html#aeec091b287e397899ae81495cd80f464"> 40</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="../../d2/dd5/structpipeBuf.html#aeec091b287e397899ae81495cd80f464">nbytes</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="../../d2/dd5/structpipeBuf.html#a117747ee40ba0c3fbb36e1b81d01bd61"> 41</a></span>  <a class="code" href="../../d0/d27/include_2sys_2types_8h.html#afa178be408981cc5edd64227b6332fc6">off_t</a> <a class="code" href="../../d2/dd5/structpipeBuf.html#a117747ee40ba0c3fbb36e1b81d01bd61">offset</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> };</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="../../da/da9/structpipeInfo.html"> 45</a></span> <span class="keyword">struct </span><a class="code" href="../../da/da9/structpipeInfo.html">pipeInfo</a> {</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="../../da/da9/structpipeInfo.html#a7b8ab29519bbfd2a4f319bb08b13d999"> 46</a></span>  <span class="keywordtype">int</span> <a class="code" href="../../da/da9/structpipeInfo.html#a7b8ab29519bbfd2a4f319bb08b13d999">rFD</a>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="../../da/da9/structpipeInfo.html#ad1f25bacb95bd28fd47a62b648dbd125"> 47</a></span>  <span class="keywordtype">int</span> <a class="code" href="../../da/da9/structpipeInfo.html#ad1f25bacb95bd28fd47a62b648dbd125">rfdCNT</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="../../da/da9/structpipeInfo.html#ab3c324342452efcb74529c9c830d708b"> 48</a></span>  <span class="keywordtype">int</span> <a class="code" href="../../da/da9/structpipeInfo.html#ab3c324342452efcb74529c9c830d708b">wFD</a>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="../../da/da9/structpipeInfo.html#a73534b061097015a340b287279fe52ed"> 49</a></span>  <span class="keywordtype">int</span> <a class="code" href="../../da/da9/structpipeInfo.html#a73534b061097015a340b287279fe52ed">wfdCNT</a>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="../../da/da9/structpipeInfo.html#a1af79350f10c92db334eb798c2e073e1"> 50</a></span>  <span class="keywordtype">int</span> <a class="code" href="../../da/da9/structpipeInfo.html#a1af79350f10c92db334eb798c2e073e1">bCNT</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="../../da/da9/structpipeInfo.html#a17d5f665e9b347438e7062904ece1cfa"> 51</a></span>  <span class="keyword">struct </span><a class="code" href="../../d2/dd5/structpipeBuf.html">pipeBuf</a> *<a class="code" href="../../da/da9/structpipeInfo.html#a17d5f665e9b347438e7062904ece1cfa">headPB</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="../../da/da9/structpipeInfo.html#a3bd26f08a5757a3e89049a8f1d7c0831"> 52</a></span>  <span class="keyword">struct </span><a class="code" href="../../d2/dd5/structpipeBuf.html">pipeBuf</a> *<a class="code" href="../../da/da9/structpipeInfo.html#a3bd26f08a5757a3e89049a8f1d7c0831">tailPB</a>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> };</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#endif </span><span class="comment">/* END _SYS_PIPE_H */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="astructpipeBuf_html_ad9a3f124f1d677ea353fcc8cfc76a46d"><div class="ttname"><a href="../../d2/dd5/structpipeBuf.html#ad9a3f124f1d677ea353fcc8cfc76a46d">pipeBuf::next</a></div><div class="ttdeci">struct pipeBuf * next</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d3e/pipe_8h_source.html#l00038">pipe.h:38</a></div></div>
<div class="ttc" id="asysproto__posix_8h_html"><div class="ttname"><a href="../../d3/d7e/sysproto__posix_8h.html">sysproto_posix.h</a></div></div>
<div class="ttc" id="astructthread_html"><div class="ttname"><a href="../../d3/dc5/structthread.html">thread</a></div><div class="ttdef"><b>Definition:</b> <a href="../../db/dd5/thread_8h_source.html#l00040">thread.h:40</a></div></div>
<div class="ttc" id="astructpipeInfo_html_ad1f25bacb95bd28fd47a62b648dbd125"><div class="ttname"><a href="../../da/da9/structpipeInfo.html#ad1f25bacb95bd28fd47a62b648dbd125">pipeInfo::rfdCNT</a></div><div class="ttdeci">int rfdCNT</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d3e/pipe_8h_source.html#l00047">pipe.h:47</a></div></div>
<div class="ttc" id="astructpipeInfo_html_a1af79350f10c92db334eb798c2e073e1"><div class="ttname"><a href="../../da/da9/structpipeInfo.html#a1af79350f10c92db334eb798c2e073e1">pipeInfo::bCNT</a></div><div class="ttdeci">int bCNT</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d3e/pipe_8h_source.html#l00050">pipe.h:50</a></div></div>
<div class="ttc" id="astructpipeInfo_html_a7b8ab29519bbfd2a4f319bb08b13d999"><div class="ttname"><a href="../../da/da9/structpipeInfo.html#a7b8ab29519bbfd2a4f319bb08b13d999">pipeInfo::rFD</a></div><div class="ttdeci">int rFD</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d3e/pipe_8h_source.html#l00046">pipe.h:46</a></div></div>
<div class="ttc" id="astructpipeBuf_html_aeec091b287e397899ae81495cd80f464"><div class="ttname"><a href="../../d2/dd5/structpipeBuf.html#aeec091b287e397899ae81495cd80f464">pipeBuf::nbytes</a></div><div class="ttdeci">size_t nbytes</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d3e/pipe_8h_source.html#l00040">pipe.h:40</a></div></div>
<div class="ttc" id="astructpipeBuf_html_aa910cff72b25f70395e2cc68ecc9a18d"><div class="ttname"><a href="../../d2/dd5/structpipeBuf.html#aa910cff72b25f70395e2cc68ecc9a18d">pipeBuf::buffer</a></div><div class="ttdeci">char * buffer</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d3e/pipe_8h_source.html#l00039">pipe.h:39</a></div></div>
<div class="ttc" id="astructpipeInfo_html_ab3c324342452efcb74529c9c830d708b"><div class="ttname"><a href="../../da/da9/structpipeInfo.html#ab3c324342452efcb74529c9c830d708b">pipeInfo::wFD</a></div><div class="ttdeci">int wFD</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d3e/pipe_8h_source.html#l00048">pipe.h:48</a></div></div>
<div class="ttc" id="astructpipeInfo_html_a3bd26f08a5757a3e89049a8f1d7c0831"><div class="ttname"><a href="../../da/da9/structpipeInfo.html#a3bd26f08a5757a3e89049a8f1d7c0831">pipeInfo::tailPB</a></div><div class="ttdeci">struct pipeBuf * tailPB</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d3e/pipe_8h_source.html#l00052">pipe.h:52</a></div></div>
<div class="ttc" id="astructpipeBuf_html_a117747ee40ba0c3fbb36e1b81d01bd61"><div class="ttname"><a href="../../d2/dd5/structpipeBuf.html#a117747ee40ba0c3fbb36e1b81d01bd61">pipeBuf::offset</a></div><div class="ttdeci">off_t offset</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d3e/pipe_8h_source.html#l00041">pipe.h:41</a></div></div>
<div class="ttc" id="apipe_8h_html_a476208212b5dff10a39e8039c8eead6d"><div class="ttname"><a href="../../da/d3e/pipe_8h.html#a476208212b5dff10a39e8039c8eead6d">pipe</a></div><div class="ttdeci">int pipe(struct thread *, struct pipe_args *)</div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d47/pipe_8c_source.html#l00039">pipe.c:39</a></div></div>
<div class="ttc" id="astructpipeBuf_html"><div class="ttname"><a href="../../d2/dd5/structpipeBuf.html">pipeBuf</a></div><div class="ttdef"><b>Definition:</b> <a href="../../da/d3e/pipe_8h_source.html#l00037">pipe.h:37</a></div></div>
<div class="ttc" id="astructpipeInfo_html_a17d5f665e9b347438e7062904ece1cfa"><div class="ttname"><a href="../../da/da9/structpipeInfo.html#a17d5f665e9b347438e7062904ece1cfa">pipeInfo::headPB</a></div><div class="ttdeci">struct pipeBuf * headPB</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d3e/pipe_8h_source.html#l00051">pipe.h:51</a></div></div>
<div class="ttc" id="ainclude_2sys_2types_8h_html_afa178be408981cc5edd64227b6332fc6"><div class="ttname"><a href="../../d0/d27/include_2sys_2types_8h.html#afa178be408981cc5edd64227b6332fc6">off_t</a></div><div class="ttdeci">__int64_t off_t</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d27/include_2sys_2types_8h_source.html#l00119">types.h:119</a></div></div>
<div class="ttc" id="astructpipeInfo_html"><div class="ttname"><a href="../../da/da9/structpipeInfo.html">pipeInfo</a></div><div class="ttdef"><b>Definition:</b> <a href="../../da/d3e/pipe_8h_source.html#l00045">pipe.h:45</a></div></div>
<div class="ttc" id="astructpipe__args_html"><div class="ttname"><a href="../../da/db0/structpipe__args.html">pipe_args</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d7e/sysproto__posix_8h_source.html#l00349">sysproto_posix.h:349</a></div></div>
<div class="ttc" id="athread_8h_html"><div class="ttname"><a href="../../db/dd5/thread_8h.html">thread.h</a></div></div>
<div class="ttc" id="astructpipeInfo_html_a73534b061097015a340b287279fe52ed"><div class="ttname"><a href="../../da/da9/structpipeInfo.html#a73534b061097015a340b287279fe52ed">pipeInfo::wfdCNT</a></div><div class="ttdeci">int wfdCNT</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d3e/pipe_8h_source.html#l00049">pipe.h:49</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_317ea3797c15f4a1d9c156bc812661ca.html">sys</a></li><li class="navelem"><a class="el" href="../../da/d3e/pipe_8h.html">pipe.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
</ul>
</div>
</body>
</html>
