<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>José: /home/nmccallu/Projects/jose/jose/io.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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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">José
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_f2bd36b8a3f3d476e48bdb5015c9fdfb.html">jose</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">io.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* vim: set tabstop=8 shiftwidth=4 softtabstop=4 expandtab smarttab colorcolumn=80: */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2017 Red Hat, Inc.</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"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "cfg.h"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <stdbool.h></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <stdio.h></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifdef DOXYGEN</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="group__jose__io.html#ga5470c8ebb2993293197844f2782616b5"> 43</a></span> <span class="keyword">typedef</span> <a class="code" href="structjose__io__t.html">jose_io_t</a> <a class="code" href="group__jose__io.html#ga5470c8ebb2993293197844f2782616b5">jose_io_auto_t</a>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structjose__io__t.html"> 61</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="structjose__io__t.html#afa8ec8ac8802fd2600466b9477730cfe"> 70</a></span>  bool (*feed)(<a class="code" href="structjose__io__t.html">jose_io_t</a> *io, <span class="keyword">const</span> <span class="keywordtype">void</span> *in, <span class="keywordtype">size_t</span> len);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="structjose__io__t.html#a76d1eac0d05d3604c16686b08bd80aa0"> 80</a></span>  bool (*done)(<a class="code" href="structjose__io__t.html">jose_io_t</a> *io);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> } <a class="code" href="structjose__io__t.html">jose_io_t</a>;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#define jose_io_auto_t jose_io_t __attribute__((cleanup(jose_io_auto)))</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>jose_io <a class="code" href="structjose__io__t.html">jose_io_t</a>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keyword">struct </span>jose_io {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">size_t</span> refs;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  bool (*feed)(<a class="code" href="structjose__io__t.html">jose_io_t</a> *io, <span class="keyword">const</span> <span class="keywordtype">void</span> *in, <span class="keywordtype">size_t</span> len);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  bool (*done)(<a class="code" href="structjose__io__t.html">jose_io_t</a> *io);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  void (*free)(<a class="code" href="structjose__io__t.html">jose_io_t</a> *io); <span class="comment">/* Don't call this. Use jose_io_decref(). */</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> };</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="keywordtype">void</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> jose_io_auto(<a class="code" href="structjose__io__t.html">jose_io_t</a> **io);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <a class="code" href="structjose__io__t.html">jose_io_t</a> *</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <a class="code" href="group__jose__io.html#ga7fbb0f97c47943576a424a0351df2413">jose_io_incref</a>(<a class="code" href="structjose__io__t.html">jose_io_t</a> *io);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="keywordtype">void</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <a class="code" href="group__jose__io.html#ga399c2d4e43b0def36e831cc12a50877e">jose_io_decref</a>(<a class="code" href="structjose__io__t.html">jose_io_t</a> *io);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <a class="code" href="structjose__io__t.html">jose_io_t</a> *</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <a class="code" href="group__jose__io.html#gaa3f3eb70079093e1244ffe516fd1627f">jose_io_malloc</a>(jose_cfg_t *cfg, <span class="keywordtype">void</span> **buf, <span class="keywordtype">size_t</span> *len);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="keywordtype">void</span> *</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <a class="code" href="group__jose__io.html#ga4912707bb8e60870c661fb14e837bb69">jose_io_malloc_steal</a>(<span class="keywordtype">void</span> **buf);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <a class="code" href="structjose__io__t.html">jose_io_t</a> *</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <a class="code" href="group__jose__io.html#gaf9372e0f4d1c3d6ece6c38f31ea7c48c">jose_io_buffer</a>(jose_cfg_t *cfg, <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> *len);</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <a class="code" href="structjose__io__t.html">jose_io_t</a> *</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <a class="code" href="group__jose__io.html#gaa249153384969267f4d3f8d9691e2bef">jose_io_file</a>(jose_cfg_t *cfg, FILE *file);</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <a class="code" href="structjose__io__t.html">jose_io_t</a> *</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <a class="code" href="group__jose__io.html#ga6ea7adf304754afee8b6ec33597991f7">jose_io_multiplex</a>(jose_cfg_t *cfg, <a class="code" href="structjose__io__t.html">jose_io_t</a> **nexts, <span class="keywordtype">bool</span> all);</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="ttc" id="group__jose__io_html_ga7fbb0f97c47943576a424a0351df2413"><div class="ttname"><a href="group__jose__io.html#ga7fbb0f97c47943576a424a0351df2413">jose_io_incref</a></div><div class="ttdeci">jose_io_t * jose_io_incref(jose_io_t *io)</div><div class="ttdoc">Increases the reference count of an IO object. </div></div>
<div class="ttc" id="group__jose__io_html_gaa3f3eb70079093e1244ffe516fd1627f"><div class="ttname"><a href="group__jose__io.html#gaa3f3eb70079093e1244ffe516fd1627f">jose_io_malloc</a></div><div class="ttdeci">jose_io_t * jose_io_malloc(jose_cfg_t *cfg, void **buf, size_t *len)</div><div class="ttdoc">Creates a new IO object which collects data into a dynamic buffer. </div></div>
<div class="ttc" id="group__jose__io_html_ga399c2d4e43b0def36e831cc12a50877e"><div class="ttname"><a href="group__jose__io.html#ga399c2d4e43b0def36e831cc12a50877e">jose_io_decref</a></div><div class="ttdeci">void jose_io_decref(jose_io_t *io)</div><div class="ttdoc">Decreases the reference count of an IO object. </div></div>
<div class="ttc" id="group__jose__io_html_gaa249153384969267f4d3f8d9691e2bef"><div class="ttname"><a href="group__jose__io.html#gaa249153384969267f4d3f8d9691e2bef">jose_io_file</a></div><div class="ttdeci">jose_io_t * jose_io_file(jose_cfg_t *cfg, FILE *file)</div><div class="ttdoc">Creates a new IO object which writes data into a FILE. </div></div>
<div class="ttc" id="group__jose__io_html_ga6ea7adf304754afee8b6ec33597991f7"><div class="ttname"><a href="group__jose__io.html#ga6ea7adf304754afee8b6ec33597991f7">jose_io_multiplex</a></div><div class="ttdeci">jose_io_t * jose_io_multiplex(jose_cfg_t *cfg, jose_io_t **nexts, bool all)</div><div class="ttdoc">Creates a new IO object which multiplexes data into multiple IO objects. </div></div>
<div class="ttc" id="group__jose__io_html_gaf9372e0f4d1c3d6ece6c38f31ea7c48c"><div class="ttname"><a href="group__jose__io.html#gaf9372e0f4d1c3d6ece6c38f31ea7c48c">jose_io_buffer</a></div><div class="ttdeci">jose_io_t * jose_io_buffer(jose_cfg_t *cfg, void *buf, size_t *len)</div><div class="ttdoc">Creates a new IO object which collects data into a static buffer. </div></div>
<div class="ttc" id="group__jose__io_html_ga4912707bb8e60870c661fb14e837bb69"><div class="ttname"><a href="group__jose__io.html#ga4912707bb8e60870c661fb14e837bb69">jose_io_malloc_steal</a></div><div class="ttdeci">void * jose_io_malloc_steal(void **buf)</div><div class="ttdoc">Steals the buffer created by the jose_io_malloc() IO object. </div></div>
<div class="ttc" id="structjose__io__t_html"><div class="ttname"><a href="structjose__io__t.html">jose_io_t</a></div><div class="ttdoc">The interface for chained IO. </div><div class="ttdef"><b>Definition:</b> io.h:61</div></div>
<div class="ttc" id="group__jose__io_html_ga5470c8ebb2993293197844f2782616b5"><div class="ttname"><a href="group__jose__io.html#ga5470c8ebb2993293197844f2782616b5">jose_io_auto_t</a></div><div class="ttdeci">jose_io_t jose_io_auto_t</div><div class="ttdoc">Defines a jose_io_t which calls jose_io_decref() at end of scope. </div><div class="ttdef"><b>Definition:</b> io.h:43</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>