gnuk/ChibiOS_2.0.8/docs/html/chioch_8h.html
2010-11-30 13:54:43 +09:00

100 lines
11 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ChibiOS/RT: chioch.h File Reference</title>
<link href="custom.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<table style="text-align: center; width: 100%;" border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
<td style="width: 80px;"></td>
</tr>
</tbody>
</table>
<hr size="1">
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Defines</a> </div>
<div class="headertitle">
<h1>chioch.h File Reference</h1> </div>
</div>
<div class="contents">
<p>I/O channels.
<a href="#_details">More...</a></p>
<p><a href="chioch_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_base_channel_v_m_t.html">BaseChannelVMT</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><code><a class="el" href="struct_base_channel.html" title="Base channel class.">BaseChannel</a></code> virtual methods table. <a href="struct_base_channel_v_m_t.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_base_channel.html">BaseChannel</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Base channel class. <a href="struct_base_channel.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_base_asynchronous_channel_v_m_t.html">BaseAsynchronousChannelVMT</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><code><a class="el" href="struct_base_asynchronous_channel.html" title="Base asynchronous channel class.">BaseAsynchronousChannel</a></code> virtual methods table. <a href="struct_base_asynchronous_channel_v_m_t.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_base_asynchronous_channel.html">BaseAsynchronousChannel</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Base asynchronous channel class. <a href="struct_base_asynchronous_channel.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io__channels.html#gaf5bd1e46b2d488dca8f3793b52a4c5f8">_base_channel_methods</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><code><a class="el" href="struct_base_channel.html" title="Base channel class.">BaseChannel</a></code> specific methods. <a href="group__io__channels.html#gaf5bd1e46b2d488dca8f3793b52a4c5f8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io__channels.html#gad2be0fba8350d51490b557900062a949">_base_channel_data</a>&nbsp;&nbsp;&nbsp;_base_sequential_stream_data</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><code><a class="el" href="struct_base_channel.html" title="Base channel class.">BaseChannel</a></code> specific data. <a href="group__io__channels.html#gad2be0fba8350d51490b557900062a949"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io__channels.html#ga248725580f06efca2b9222ac1780bdee">chIOPutWouldBlock</a>(ip)&nbsp;&nbsp;&nbsp;((ip)-&gt;vmt-&gt;putwouldblock(ip))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Channel output check. <a href="group__io__channels.html#ga248725580f06efca2b9222ac1780bdee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io__channels.html#ga389778a4742ae65edbfb7b1a7f8f832b">chIOGetWouldBlock</a>(ip)&nbsp;&nbsp;&nbsp;((ip)-&gt;vmt-&gt;getwouldblock(ip))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Channel input check. <a href="group__io__channels.html#ga389778a4742ae65edbfb7b1a7f8f832b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io__channels.html#ga5b8537016d3027eedd3e63b708b57bf7">chIOPut</a>(ip, b)&nbsp;&nbsp;&nbsp;((ip)-&gt;vmt-&gt;put(ip, b, TIME_INFINITE))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Channel blocking byte write. <a href="group__io__channels.html#ga5b8537016d3027eedd3e63b708b57bf7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io__channels.html#gac0117cf153fb3e08743aa8fe1b5487da">chIOPutTimeout</a>(ip, b, time)&nbsp;&nbsp;&nbsp;((ip)-&gt;vmt-&gt;put(ip, b, time))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Channel blocking byte write with timeout. <a href="group__io__channels.html#gac0117cf153fb3e08743aa8fe1b5487da"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io__channels.html#ga9ebccb48ead8398cf97ca7a564fe0a25">chIOGet</a>(ip)&nbsp;&nbsp;&nbsp;((ip)-&gt;vmt-&gt;get(ip, TIME_INFINITE))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Channel blocking byte read. <a href="group__io__channels.html#ga9ebccb48ead8398cf97ca7a564fe0a25"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io__channels.html#gace21d03c2ffbae1bf56b8a0b612421ba">chIOGetTimeout</a>(ip, time)&nbsp;&nbsp;&nbsp;((ip)-&gt;vmt-&gt;get(ip, time))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Channel blocking byte read with timeout. <a href="group__io__channels.html#gace21d03c2ffbae1bf56b8a0b612421ba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io__channels.html#ga432c7fbf8b1109bba566986143e9da21">chIOWriteTimeout</a>(ip, bp, n, time)&nbsp;&nbsp;&nbsp;((ip)-&gt;vmt-&gt;writet(ip, bp, n, time))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Channel blocking write with timeout. <a href="group__io__channels.html#ga432c7fbf8b1109bba566986143e9da21"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io__channels.html#ga98c9dc44ce78e6ac026235eea93b6911">chIOReadTimeout</a>(ip, bp, n, time)&nbsp;&nbsp;&nbsp;((ip)-&gt;vmt-&gt;readt(ip, bp, n, time))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Channel blocking read with timeout. <a href="group__io__channels.html#ga98c9dc44ce78e6ac026235eea93b6911"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io__channels.html#gaf23d5351675080d08be4cac30c5de151">_base_asynchronous_channel_methods</a>&nbsp;&nbsp;&nbsp;_base_channel_methods</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><code><a class="el" href="struct_base_asynchronous_channel.html" title="Base asynchronous channel class.">BaseAsynchronousChannel</a></code> specific methods. <a href="group__io__channels.html#gaf23d5351675080d08be4cac30c5de151"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io__channels.html#ga6c1762f0b3873dd09f9e655c951b9300">_base_asynchronous_channel_data</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><code><a class="el" href="struct_base_asynchronous_channel.html" title="Base asynchronous channel class.">BaseAsynchronousChannel</a></code> specific data. <a href="group__io__channels.html#ga6c1762f0b3873dd09f9e655c951b9300"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io__channels.html#ga1cdb36c296d20ee411fcf041a1ad80d1">chIOGetWriteEventSource</a>(ip)&nbsp;&nbsp;&nbsp;(&amp;((ip)-&gt;vmt-&gt;oevent))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the write event source. <a href="group__io__channels.html#ga1cdb36c296d20ee411fcf041a1ad80d1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__io__channels.html#ga763229d3f6ded408f4126dcf121f0baf">chIOGetReadEventSource</a>(ip)&nbsp;&nbsp;&nbsp;(&amp;((ip)-&gt;vmt-&gt;ievent))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the read event source. <a href="group__io__channels.html#ga763229d3f6ded408f4126dcf121f0baf"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>I/O channels. </p>
<p>This header defines abstract interfaces useful to access generic I/O resources in a standardized way. </p>
<p>Definition in file <a class="el" href="chioch_8h_source.html">chioch.h</a>.</p>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated on Sun Nov 28 2010 14:09:49 for ChibiOS/RT by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
</body>
</html>