<!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.RawConnection 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_1RawConnection.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_1RawConnection-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">lirc.client.RawConnection 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>Interface to receive code strings as described in lircd(8).
<a href="classlirc_1_1client_1_1RawConnection.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for lirc.client.RawConnection:</div>
<div class="dyncontent">
<div class="center">
<img src="classlirc_1_1client_1_1RawConnection.png" usemap="#lirc.client.RawConnection_map" alt=""/>
<map id="lirc.client.RawConnection_map" name="lirc.client.RawConnection_map">
<area href="classlirc_1_1client_1_1AbstractConnection.html" title="Abstract interface for all connections." alt="lirc.client.AbstractConnection" shape="rect" coords="98,56,285,80"/>
<area href="classlirc_1_1client_1_1CommandConnection.html" title="Extends the parent with a send() method." alt="lirc.client.CommandConnection" shape="rect" coords="98,168,285,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:ac2d5360eb5e594ea53c2dd241ed2b5fe"><td class="memItemLeft" align="right" valign="top"><a id="ac2d5360eb5e594ea53c2dd241ed2b5fe"></a>
def </td><td class="memItemRight" valign="bottom"><b>__init__</b> (self, str socket_path=None, str prog=_DEFAULT_PROG)</td></tr>
<tr class="separator:ac2d5360eb5e594ea53c2dd241ed2b5fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b06ff68559d4558ec3e46a92c2562c2"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1RawConnection.html#a3b06ff68559d4558ec3e46a92c2562c2">readline</a> (self, float timeout=None)</td></tr>
<tr class="memdesc:a3b06ff68559d4558ec3e46a92c2562c2"><td class="mdescLeft"> </td><td class="mdescRight">Implements <a class="el" href="classlirc_1_1client_1_1AbstractConnection.html#afb11fea525fdc5cc948a90f51a09d99a" title="Read a buffered line.">AbstractConnection.readline()</a>. <a href="#a3b06ff68559d4558ec3e46a92c2562c2">More...</a><br /></td></tr>
<tr class="separator:a3b06ff68559d4558ec3e46a92c2562c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f49513782497e672ce8afaf9f2ca428"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1RawConnection.html#a0f49513782497e672ce8afaf9f2ca428">fileno</a> (self)</td></tr>
<tr class="memdesc:a0f49513782497e672ce8afaf9f2ca428"><td class="mdescLeft"> </td><td class="mdescRight">Implements <a class="el" href="classlirc_1_1client_1_1AbstractConnection.html#a02256897cd8cfd43ec4d0577f92c63dd" title="Return the file nr used for IO, suitable for select() etc.">AbstractConnection.fileno()</a>. <a href="#a0f49513782497e672ce8afaf9f2ca428">More...</a><br /></td></tr>
<tr class="separator:a0f49513782497e672ce8afaf9f2ca428"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a453c2c67000628dd736a8a1308e384"><td class="memItemLeft" align="right" valign="top"><a id="a7a453c2c67000628dd736a8a1308e384"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1RawConnection.html#a7a453c2c67000628dd736a8a1308e384">has_data</a> (self)</td></tr>
<tr class="memdesc:a7a453c2c67000628dd736a8a1308e384"><td class="mdescLeft"> </td><td class="mdescRight">Implements <a class="el" href="classlirc_1_1client_1_1AbstractConnection.html#ae45f60472376cc6efe112a15d5a06ecc" title="Return true if next readline(None) won't block .">AbstractConnection.has_data()</a> <br /></td></tr>
<tr class="separator:a7a453c2c67000628dd736a8a1308e384"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae013019105f8fd0c933f188aa465ac49"><td class="memItemLeft" align="right" valign="top"><a id="ae013019105f8fd0c933f188aa465ac49"></a>
def </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1RawConnection.html#ae013019105f8fd0c933f188aa465ac49">close</a> (self)</td></tr>
<tr class="memdesc:ae013019105f8fd0c933f188aa465ac49"><td class="mdescLeft"> </td><td class="mdescRight">Implements <a class="el" href="classlirc_1_1client_1_1AbstractConnection.html#a4f8bd401740bb01d15a0e29b700ca2d3" title="Close/release all resources.">AbstractConnection.close()</a> <br /></td></tr>
<tr class="separator:ae013019105f8fd0c933f188aa465ac49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classlirc_1_1client_1_1AbstractConnection"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlirc_1_1client_1_1AbstractConnection')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classlirc_1_1client_1_1AbstractConnection.html">lirc.client.AbstractConnection</a></td></tr>
<tr class="memitem:a1fd7f22869b673c708b6d480a302b59d inherit pub_methods_classlirc_1_1client_1_1AbstractConnection"><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 inherit pub_methods_classlirc_1_1client_1_1AbstractConnection"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f27c8173812f53b642b14cc7a995b6d inherit pub_methods_classlirc_1_1client_1_1AbstractConnection"><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 inherit pub_methods_classlirc_1_1client_1_1AbstractConnection"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface to receive code strings as described in lircd(8). </p>
<dl class="section user"><dt>Parameters</dt><dd><ul>
<li>socket_path: lircd output socket path, see <a class="el" href="group__python__bindings.html#ga4388cda807053ce0d28104333898065e" title="Get default value for the lircd socket path, using (falling priority):">get_default_socket_path()</a> for defaults.</li>
<li>prog: Program name used in lircrc decoding, see ircat(1). Could be omitted if only raw keypresses should be read. </li>
</ul>
</dd></dl>
<p class="definition">Definition at line <a class="el" href="client_8py_source.html#l00207">207</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="a0f49513782497e672ce8afaf9f2ca428"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f49513782497e672ce8afaf9f2ca428">◆ </a></span>fileno()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> int lirc.client.RawConnection.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>Implements <a class="el" href="classlirc_1_1client_1_1AbstractConnection.html#a02256897cd8cfd43ec4d0577f92c63dd" title="Return the file nr used for IO, suitable for select() etc.">AbstractConnection.fileno()</a>. </p>
<p>Reimplemented from <a class="el" href="classlirc_1_1client_1_1AbstractConnection.html#a02256897cd8cfd43ec4d0577f92c63dd">lirc.client.AbstractConnection</a>.</p>
<p class="definition">Definition at line <a class="el" href="client_8py_source.html#l00240">240</a> of file <a class="el" href="client_8py_source.html">client.py</a>.</p>
</div>
</div>
<a id="a3b06ff68559d4558ec3e46a92c2562c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b06ff68559d4558ec3e46a92c2562c2">◆ </a></span>readline()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> str lirc.client.RawConnection.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>Implements <a class="el" href="classlirc_1_1client_1_1AbstractConnection.html#afb11fea525fdc5cc948a90f51a09d99a" title="Read a buffered line.">AbstractConnection.readline()</a>. </p>
<p>Reimplemented from <a class="el" href="classlirc_1_1client_1_1AbstractConnection.html#afb11fea525fdc5cc948a90f51a09d99a">lirc.client.AbstractConnection</a>.</p>
<p class="definition">Definition at line <a class="el" href="client_8py_source.html#l00223">223</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_1RawConnection.html">RawConnection</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>
