classach_1_1Channel.html
<!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>ach: ach.Channel Class 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</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">ach
</div>
<div id="projectbrief">Real-TimeIPCLibrary</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</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>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</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">
$(document).ready(function(){initNavTree('classach_1_1Channel.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">ach.Channel Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5c3ff0b898f8ee653e4d84b5c262d180"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classach_1_1Channel.html#a5c3ff0b898f8ee653e4d84b5c262d180">__init__</a></td></tr>
<tr class="memitem:ae90da57841d2c9d88cfea684bea11f6d"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classach_1_1Channel.html#ae90da57841d2c9d88cfea684bea11f6d">__del__</a></td></tr>
<tr class="memitem:a9dbc54817cb29412fa1270959db735b3"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classach_1_1Channel.html#a9dbc54817cb29412fa1270959db735b3">open</a></td></tr>
<tr class="memitem:a104c2de8fcc55641442239a4beeb97b0"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classach_1_1Channel.html#a104c2de8fcc55641442239a4beeb97b0">close</a></td></tr>
<tr class="memitem:af01074a7ff9fa110e8e41850b994c729"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classach_1_1Channel.html#af01074a7ff9fa110e8e41850b994c729">put</a></td></tr>
<tr class="memitem:acfb38166b33b07cc50f1181381f648fc"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classach_1_1Channel.html#acfb38166b33b07cc50f1181381f648fc">get</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a8f4a72603605cd9e471bce33ca785b95"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f4a72603605cd9e471bce33ca785b95"></a>
 </td><td class="memItemRight" valign="bottom"><b>pointer</b></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><pre class="fragment">An Ach channel.
Wraps the underlying pointer to channel structure and provides
methods for opening, closing, putting, and getting.
self.pointer: pointer to the underlying channel struct.
</pre> </div><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5c3ff0b898f8ee653e4d84b5c262d180"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def ach.Channel.__init__ </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>name</em> = <code>None</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">@brief Create an uninitialized channel.
foo bar.
</pre>
</div>
</div>
<a class="anchor" id="ae90da57841d2c9d88cfea684bea11f6d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def ach.Channel.__del__ </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Close the channel.</pre>
</div>
</div>
<h2>Member Function Documentation</h2>
<a class="anchor" id="a104c2de8fcc55641442239a4beeb97b0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def ach.Channel.close </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Close the channel.</pre>
</div>
</div>
<a class="anchor" id="acfb38166b33b07cc50f1181381f648fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def ach.Channel.get </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>wait</em> = <code>False</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>last</em> = <code>False</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Get a message from channel and write to buffer.
buf -- an object providing the buffer interface.
wait -- wait until new message posts
last -- get most recent message
returns a tuple of (ach_status, frame_size)</pre>
</div>
</div>
<a class="anchor" id="a9dbc54817cb29412fa1270959db735b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def ach.Channel.open </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Open channel with the given name.</pre>
</div>
</div>
<a class="anchor" id="af01074a7ff9fa110e8e41850b994c729"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def ach.Channel.put </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>buf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Put a buffer into the channel.
buf -- an object providing the buffer interface.</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>python/<a class="el" href="ach_8py.html">ach.py</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceach.html">ach</a></li><li class="navelem"><a class="el" href="classach_1_1Channel.html">Channel</a></li>
<li class="footer">Generated on Sun Feb 10 2013 21:20:39 for ach by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.2 </li>
</ul>
</div>
</body>
</html>
