<!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.async_client.AsyncConnection 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_1async__client_1_1AsyncConnection.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_1async__client_1_1AsyncConnection-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">lirc.async_client.AsyncConnection 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>Asynchronous read interface on top of an AbstractConnection.
<a href="classlirc_1_1async__client_1_1AsyncConnection.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for lirc.async_client.AsyncConnection:</div>
<div class="dyncontent">
<div class="center">
<img src="classlirc_1_1async__client_1_1AsyncConnection.png" alt=""/>
</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:a9416ea80847bca8d44b5dca306e1101b"><td class="memItemLeft" align="right" valign="top"><a id="a9416ea80847bca8d44b5dca306e1101b"></a>
def </td><td class="memItemRight" valign="bottom"><b>__init__</b> (self, <a class="el" href="classlirc_1_1client_1_1AbstractConnection.html">AbstractConnection</a> connection, asyncio.AbstractEventLoop loop)</td></tr>
<tr class="separator:a9416ea80847bca8d44b5dca306e1101b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24d9bf2fefa53bbf083c9e93b83b830b"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1async__client_1_1AsyncConnection.html#a24d9bf2fefa53bbf083c9e93b83b830b">close</a> (self)</td></tr>
<tr class="memdesc:a24d9bf2fefa53bbf083c9e93b83b830b"><td class="mdescLeft"> </td><td class="mdescRight">Clean up loop and the base connection. <a href="#a24d9bf2fefa53bbf083c9e93b83b830b">More...</a><br /></td></tr>
<tr class="separator:a24d9bf2fefa53bbf083c9e93b83b830b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6e5495c66491f19bfbe399a98c9c9ae"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1async__client_1_1AsyncConnection.html#aa6e5495c66491f19bfbe399a98c9c9ae">readline</a> (self)</td></tr>
<tr class="separator:aa6e5495c66491f19bfbe399a98c9c9ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3be87ad02a246a2980966ee41ca5a30e"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1async__client_1_1AsyncConnection.html#a3be87ad02a246a2980966ee41ca5a30e">__aiter__</a> (self)</td></tr>
<tr class="memdesc:a3be87ad02a246a2980966ee41ca5a30e"><td class="mdescLeft"> </td><td class="mdescRight">Return async iterator. <a href="#a3be87ad02a246a2980966ee41ca5a30e">More...</a><br /></td></tr>
<tr class="separator:a3be87ad02a246a2980966ee41ca5a30e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27fa0328a4aa207dd550e65d47a4bc8b"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1async__client_1_1AsyncConnection.html#a27fa0328a4aa207dd550e65d47a4bc8b">__anext__</a> (self)</td></tr>
<tr class="separator:a27fa0328a4aa207dd550e65d47a4bc8b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ceb045308be18187c72f43ffa7858f9"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1async__client_1_1AsyncConnection.html#a7ceb045308be18187c72f43ffa7858f9">__aenter__</a> (self)</td></tr>
<tr class="separator:a7ceb045308be18187c72f43ffa7858f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8755967447e3290277ed39cb89f36346"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1async__client_1_1AsyncConnection.html#a8755967447e3290277ed39cb89f36346">__aexit__</a> (self, exc_type, exc, traceback)</td></tr>
<tr class="separator:a8755967447e3290277ed39cb89f36346"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Asynchronous read interface on top of an AbstractConnection. </p>
<dl class="section user"><dt>Parameters</dt><dd><ul>
<li>connection: Typically a lirc.RawConnection or lirc.LircdConnection.</li>
<li>loop: AbstractEventLoop, typically obtained using asyncio.get_event_loop(). </li>
</ul>
</dd></dl>
<p class="definition">Definition at line <a class="el" href="async__client_8py_source.html#l00053">53</a> of file <a class="el" href="async__client_8py_source.html">async_client.py</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a7ceb045308be18187c72f43ffa7858f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ceb045308be18187c72f43ffa7858f9">◆ </a></span>__aenter__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lirc.async_client.AsyncConnection.__aenter__ </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">Implement "async with". </pre>
<p class="definition">Definition at line <a class="el" href="async__client_8py_source.html#l00085">85</a> of file <a class="el" href="async__client_8py_source.html">async_client.py</a>.</p>
</div>
</div>
<a id="a8755967447e3290277ed39cb89f36346"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8755967447e3290277ed39cb89f36346">◆ </a></span>__aexit__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lirc.async_client.AsyncConnection.__aexit__ </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>exc_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>exc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>traceback</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Implement exit from "async with". </pre>
<p class="definition">Definition at line <a class="el" href="async__client_8py_source.html#l00089">89</a> of file <a class="el" href="async__client_8py_source.html">async_client.py</a>.</p>
</div>
</div>
<a id="a3be87ad02a246a2980966ee41ca5a30e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3be87ad02a246a2980966ee41ca5a30e">◆ </a></span>__aiter__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lirc.async_client.AsyncConnection.__aiter__ </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 async iterator. </p>
<p class="definition">Definition at line <a class="el" href="async__client_8py_source.html#l00078">78</a> of file <a class="el" href="async__client_8py_source.html">async_client.py</a>.</p>
</div>
</div>
<a id="a27fa0328a4aa207dd550e65d47a4bc8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27fa0328a4aa207dd550e65d47a4bc8b">◆ </a></span>__anext__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lirc.async_client.AsyncConnection.__anext__ </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">Implement async iterator.next(). </pre>
<p class="definition">Definition at line <a class="el" href="async__client_8py_source.html#l00081">81</a> of file <a class="el" href="async__client_8py_source.html">async_client.py</a>.</p>
</div>
</div>
<a id="a24d9bf2fefa53bbf083c9e93b83b830b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24d9bf2fefa53bbf083c9e93b83b830b">◆ </a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def lirc.async_client.AsyncConnection.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">
<p>Clean up loop and the base connection. </p>
<p class="definition">Definition at line <a class="el" href="async__client_8py_source.html#l00070">70</a> of file <a class="el" href="async__client_8py_source.html">async_client.py</a>.</p>
</div>
</div>
<a id="aa6e5495c66491f19bfbe399a98c9c9ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6e5495c66491f19bfbe399a98c9c9ae">◆ </a></span>readline()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> str lirc.async_client.AsyncConnection.readline </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">Asynchronous get next line from the connection. </pre>
<p class="definition">Definition at line <a class="el" href="async__client_8py_source.html#l00073">73</a> of file <a class="el" href="async__client_8py_source.html">async_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="async__client_8py_source.html">async_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>async_client</b></li><li class="navelem"><a class="el" href="classlirc_1_1async__client_1_1AsyncConnection.html">AsyncConnection</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>
