<!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.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>LIRC libraries: lirc.client.AbstractConnection 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="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="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="projectlogo"><img alt="Logo" src="diode-2.gif"/></td> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">LIRC libraries </div> <div id="projectbrief">LinuxInfraredRemoteControl</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <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('',true,false,'search.php','Search'); $(document).ready(function() { init_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('classlirc_1_1client_1_1AbstractConnection.html','');}); /* @license-end */ </script> <div id="doc-content"> <!-- 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 class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classlirc_1_1client_1_1AbstractConnection-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">lirc.client.AbstractConnection Class Reference<div class="ingroups"><a class="el" href="group__python__bindings.html">Python client bindings</a> » <a class="el" href="group__receiving.html">Classes to receive keypresses</a></div></div> </div> </div><!--header--> <div class="contents"> <p>Abstract interface for all connections. <a href="classlirc_1_1client_1_1AbstractConnection.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for lirc.client.AbstractConnection:</div> <div class="dyncontent"> <div class="center"> <img src="classlirc_1_1client_1_1AbstractConnection.png" usemap="#lirc.client.AbstractConnection_map" alt=""/> <map id="lirc.client.AbstractConnection_map" name="lirc.client.AbstractConnection_map"> <area href="classlirc_1_1client_1_1LircdConnection.html" title="Interface to receive lircrc-translated keypresses." alt="lirc.client.LircdConnection" shape="rect" coords="0,112,187,136"/> <area href="classlirc_1_1client_1_1RawConnection.html" title="Interface to receive code strings as described in lircd(8)." alt="lirc.client.RawConnection" shape="rect" coords="197,112,384,136"/> <area href="classlirc_1_1client_1_1CommandConnection.html" title="Extends the parent with a send() method." alt="lirc.client.CommandConnection" shape="rect" coords="197,168,384,192"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a1fd7f22869b673c708b6d480a302b59d"><td class="memItemLeft" align="right" valign="top"><a id="a1fd7f22869b673c708b6d480a302b59d"></a> def </td><td class="memItemRight" valign="bottom"><b>__enter__</b> (self)</td></tr> <tr class="separator:a1fd7f22869b673c708b6d480a302b59d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4f27c8173812f53b642b14cc7a995b6d"><td class="memItemLeft" align="right" valign="top"><a id="a4f27c8173812f53b642b14cc7a995b6d"></a> def </td><td class="memItemRight" valign="bottom"><b>__exit__</b> (self, exc_type, exc, traceback)</td></tr> <tr class="separator:a4f27c8173812f53b642b14cc7a995b6d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afb11fea525fdc5cc948a90f51a09d99a"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1AbstractConnection.html#afb11fea525fdc5cc948a90f51a09d99a">readline</a> (self, float timeout=None)</td></tr> <tr class="memdesc:afb11fea525fdc5cc948a90f51a09d99a"><td class="mdescLeft"> </td><td class="mdescRight">Read a buffered line. <a href="#afb11fea525fdc5cc948a90f51a09d99a">More...</a><br /></td></tr> <tr class="separator:afb11fea525fdc5cc948a90f51a09d99a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a02256897cd8cfd43ec4d0577f92c63dd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1AbstractConnection.html#a02256897cd8cfd43ec4d0577f92c63dd">fileno</a> (self)</td></tr> <tr class="memdesc:a02256897cd8cfd43ec4d0577f92c63dd"><td class="mdescLeft"> </td><td class="mdescRight">Return the file nr used for IO, suitable for select() etc. <a href="#a02256897cd8cfd43ec4d0577f92c63dd">More...</a><br /></td></tr> <tr class="separator:a02256897cd8cfd43ec4d0577f92c63dd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae45f60472376cc6efe112a15d5a06ecc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1AbstractConnection.html#ae45f60472376cc6efe112a15d5a06ecc">has_data</a> (self)</td></tr> <tr class="memdesc:ae45f60472376cc6efe112a15d5a06ecc"><td class="mdescLeft"> </td><td class="mdescRight">Return true if next readline(None) won't block . <a href="#ae45f60472376cc6efe112a15d5a06ecc">More...</a><br /></td></tr> <tr class="separator:ae45f60472376cc6efe112a15d5a06ecc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4f8bd401740bb01d15a0e29b700ca2d3"><td class="memItemLeft" align="right" valign="top"><a id="a4f8bd401740bb01d15a0e29b700ca2d3"></a> def </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1AbstractConnection.html#a4f8bd401740bb01d15a0e29b700ca2d3">close</a> (self)</td></tr> <tr class="memdesc:a4f8bd401740bb01d15a0e29b700ca2d3"><td class="mdescLeft"> </td><td class="mdescRight">Close/release all resources. <br /></td></tr> <tr class="separator:a4f8bd401740bb01d15a0e29b700ca2d3"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Abstract interface for all connections. </p> <p class="definition">Definition at line <a class="el" href="client_8py_source.html#l00158">158</a> of file <a class="el" href="client_8py_source.html">client.py</a>.</p> </div><h2 class="groupheader">Member Function Documentation</h2> <a id="a02256897cd8cfd43ec4d0577f92c63dd"></a> <h2 class="memtitle"><span class="permalink"><a href="#a02256897cd8cfd43ec4d0577f92c63dd">◆ </a></span>fileno()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"> int lirc.client.AbstractConnection.fileno </td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Return the file nr used for IO, suitable for select() etc. </p> <p>Reimplemented in <a class="el" href="classlirc_1_1client_1_1LircdConnection.html#a35333b8290e6514de2471583f18edc91">lirc.client.LircdConnection</a>, and <a class="el" href="classlirc_1_1client_1_1RawConnection.html#a0f49513782497e672ce8afaf9f2ca428">lirc.client.RawConnection</a>.</p> <p class="definition">Definition at line <a class="el" href="client_8py_source.html#l00184">184</a> of file <a class="el" href="client_8py_source.html">client.py</a>.</p> </div> </div> <a id="ae45f60472376cc6efe112a15d5a06ecc"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae45f60472376cc6efe112a15d5a06ecc">◆ </a></span>has_data()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"> bool lirc.client.AbstractConnection.has_data </td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Return true if next readline(None) won't block . </p> <p>Reimplemented in <a class="el" href="classlirc_1_1client_1_1LircdConnection.html#a810e373844a258eafba4fe3608abb610">lirc.client.LircdConnection</a>, and <a class="el" href="classlirc_1_1client_1_1RawConnection.html#a7a453c2c67000628dd736a8a1308e384">lirc.client.RawConnection</a>.</p> <p class="definition">Definition at line <a class="el" href="client_8py_source.html#l00189">189</a> of file <a class="el" href="client_8py_source.html">client.py</a>.</p> </div> </div> <a id="afb11fea525fdc5cc948a90f51a09d99a"></a> <h2 class="memtitle"><span class="permalink"><a href="#afb11fea525fdc5cc948a90f51a09d99a">◆ </a></span>readline()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"> str lirc.client.AbstractConnection.readline </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">float  </td> <td class="paramname"><em>timeout</em> = <code>None</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Read a buffered line. </p> <dl class="section user"><dt>Parameters</dt><dd><ul> <li>timeout: seconds.<ul> <li>If set to 0 immediately return either a line or None.</li> <li>If set to None (default mode) use blocking read.</li> </ul> </li> </ul> </dd></dl> <p>Returns code string as described in lircd(8) without trailing newline or None.</p> <p>Raises <a class="el" href="classlirc_1_1client_1_1TimeoutException.html" title="Timeout receiving data from remote host.">TimeoutException</a> if timeout > 0 expires. </p> <p>Reimplemented in <a class="el" href="classlirc_1_1client_1_1LircdConnection.html#a59b3a0f2616b00361883895f002a37d9">lirc.client.LircdConnection</a>, and <a class="el" href="classlirc_1_1client_1_1RawConnection.html#a3b06ff68559d4558ec3e46a92c2562c2">lirc.client.RawConnection</a>.</p> <p class="definition">Definition at line <a class="el" href="client_8py_source.html#l00179">179</a> of file <a class="el" href="client_8py_source.html">client.py</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>/home/iurt/rpmbuild/BUILD/lirc-0.10.1/python-pkg/lirc/<a class="el" href="client_8py_source.html">client.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"><b>lirc</b></li><li class="navelem"><b>client</b></li><li class="navelem"><a class="el" href="classlirc_1_1client_1_1AbstractConnection.html">AbstractConnection</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.15 </li> </ul> </div> </body> </html>