scip/pcp
1
0
Fork 0
mirror of https://codeberg.org/scip/pcp.git synced 2025-12-17 12:00:56 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
2e4657bb084ec79608fd9b19962c1f447a51930b
pcp/man/html/struct__pcp__stream__t.html
TLINDEN 2e4657bb08 added api docs
2014-02-20 20:09:24 +01:00

173 lines
8.5 KiB
HTML
Raw Blame History

<!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"/>
<title>libpcp: _pcp_stream_t Struct Reference</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="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 style="padding-left: 0.5em;">
<div id="projectname">libpcp
&#160;<span id="projectnumber">0.2.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct__pcp__stream__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">_pcp_stream_t Struct Reference<div class="ingroups"><a class="el" href="group__Pcpstream.html">PCPSTREAMS</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>An I/O wrapper object backed by a file or a buffer.
<a href="struct__pcp__stream__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="pcpstream_8h_source.html">pcpstream.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab3be4b7b5c57f456ed996cb0b5d53f27"><td class="memItemLeft" align="right" valign="top">FILE *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__stream__t.html#ab3be4b7b5c57f456ed996cb0b5d53f27">fd</a></td></tr>
<tr class="memdesc:ab3be4b7b5c57f456ed996cb0b5d53f27"><td class="mdescLeft">&#160;</td><td class="mdescRight">The backend FILE stream. <a href="#ab3be4b7b5c57f456ed996cb0b5d53f27"></a><br/></td></tr>
<tr class="separator:ab3be4b7b5c57f456ed996cb0b5d53f27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a320a3c593ebcf0a651700f9263e5d9b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Buffer.html#ga2460ea15a51a37433b5f2e1503667e8f">Buffer</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__stream__t.html#a320a3c593ebcf0a651700f9263e5d9b4">b</a></td></tr>
<tr class="memdesc:a320a3c593ebcf0a651700f9263e5d9b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The backend Buffer object. <a href="#a320a3c593ebcf0a651700f9263e5d9b4"></a><br/></td></tr>
<tr class="separator:a320a3c593ebcf0a651700f9263e5d9b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fc108c71fb18d9835f7083e1b2ff5fa"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__stream__t.html#a5fc108c71fb18d9835f7083e1b2ff5fa">is_buffer</a></td></tr>
<tr class="memdesc:a5fc108c71fb18d9835f7083e1b2ff5fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set to 1 if the backend is a Buffer. <a href="#a5fc108c71fb18d9835f7083e1b2ff5fa"></a><br/></td></tr>
<tr class="separator:a5fc108c71fb18d9835f7083e1b2ff5fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b0242f83eec494ee19ad41e08e924af"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__stream__t.html#a4b0242f83eec494ee19ad41e08e924af">eof</a></td></tr>
<tr class="memdesc:a4b0242f83eec494ee19ad41e08e924af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set to 1 if EOF reached. <a href="#a4b0242f83eec494ee19ad41e08e924af"></a><br/></td></tr>
<tr class="separator:a4b0242f83eec494ee19ad41e08e924af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaed1bd389ba84b3cd87839088b4057ea"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__stream__t.html#aaed1bd389ba84b3cd87839088b4057ea">err</a></td></tr>
<tr class="memdesc:aaed1bd389ba84b3cd87839088b4057ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set to 1 if an error occured. <a href="#aaed1bd389ba84b3cd87839088b4057ea"></a><br/></td></tr>
<tr class="separator:aaed1bd389ba84b3cd87839088b4057ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An I/O wrapper object backed by a file or a buffer. </p>
<p>Definition at line <a class="el" href="pcpstream_8h_source.html#l00054">54</a> of file <a class="el" href="pcpstream_8h_source.html">pcpstream.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a320a3c593ebcf0a651700f9263e5d9b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Buffer.html#ga2460ea15a51a37433b5f2e1503667e8f">Buffer</a>* _pcp_stream_t::b</td>
</tr>
</table>
</div><div class="memdoc">
<p>The backend Buffer object. </p>
<p>Definition at line <a class="el" href="pcpstream_8h_source.html#l00056">56</a> of file <a class="el" href="pcpstream_8h_source.html">pcpstream.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4b0242f83eec494ee19ad41e08e924af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t _pcp_stream_t::eof</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set to 1 if EOF reached. </p>
<p>Definition at line <a class="el" href="pcpstream_8h_source.html#l00058">58</a> of file <a class="el" href="pcpstream_8h_source.html">pcpstream.h</a>.</p>
</div>
</div>
<a class="anchor" id="aaed1bd389ba84b3cd87839088b4057ea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t _pcp_stream_t::err</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set to 1 if an error occured. </p>
<p>Definition at line <a class="el" href="pcpstream_8h_source.html#l00059">59</a> of file <a class="el" href="pcpstream_8h_source.html">pcpstream.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab3be4b7b5c57f456ed996cb0b5d53f27"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FILE* _pcp_stream_t::fd</td>
</tr>
</table>
</div><div class="memdoc">
<p>The backend FILE stream. </p>
<p>Definition at line <a class="el" href="pcpstream_8h_source.html#l00055">55</a> of file <a class="el" href="pcpstream_8h_source.html">pcpstream.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5fc108c71fb18d9835f7083e1b2ff5fa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t _pcp_stream_t::is_buffer</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set to 1 if the backend is a Buffer. </p>
<p>Definition at line <a class="el" href="pcpstream_8h_source.html#l00057">57</a> of file <a class="el" href="pcpstream_8h_source.html">pcpstream.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="pcpstream_8h_source.html">pcpstream.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Feb 20 2014 19:59:14 for libpcp by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink