Documentation/Source/eric5.DebugClients.Ruby.AsyncIO.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.DebugClients.Ruby.AsyncIO</title>
<style>
body {
    background: white;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: black; background: #C1BBA4; }
h4 { color: black; background: #C1BBA4; }
    
a { color: #C07037; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.DebugClients.Ruby.AsyncIO</h1>
<p>
File implementing an asynchronous interface for the debugger.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Modules</h3>
<table>
<tr>
<td><a href="#AsyncIO">AsyncIO</a></td>
<td>Module implementing asynchronous reading and writing.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="AsyncIO" ID="AsyncIO"></a>
<h2>AsyncIO</h2>
<p>
Module implementing asynchronous reading and writing.
</p>
<h3>Module Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Functions</h3>
<table>
<tr>
<td><a href="#AsyncIO.disconnect">disconnect</a></td>
<td>Function to disconnect any current connection.</td>
</tr><tr>
<td><a href="#AsyncIO.initializeAsyncIO">initializeAsyncIO</a></td>
<td>Function to initialize the module.</td>
</tr><tr>
<td><a href="#AsyncIO.readReady">readReady</a></td>
<td>Function called when there is data ready to be read.</td>
</tr><tr>
<td><a href="#AsyncIO.setDescriptors">setDescriptors</a></td>
<td>Function called to set the descriptors for the connection.</td>
</tr><tr>
<td><a href="#AsyncIO.write">write</a></td>
<td>Function to write a string.</td>
</tr><tr>
<td><a href="#AsyncIO.writeReady">writeReady</a></td>
<td>Function called when we are ready to write data.</td>
</tr>
</table>
<hr />

<a NAME="AsyncIO.disconnect" ID="AsyncIO.disconnect"></a>
<h4>AsyncIO.disconnect</h4>
<b>disconnect</b>(<i></i>)
<p>
Function to disconnect any current connection.
</p><a NAME="AsyncIO.initializeAsyncIO" ID="AsyncIO.initializeAsyncIO"></a>
<h4>AsyncIO.initializeAsyncIO</h4>
<b>initializeAsyncIO</b>(<i></i>)
<p>
Function to initialize the module.
</p><a NAME="AsyncIO.readReady" ID="AsyncIO.readReady"></a>
<h4>AsyncIO.readReady</h4>
<b>readReady</b>(<i></i>)
<p>
Function called when there is data ready to be read.
</p><dl>
<dt><i>fd</i></dt>
<dd>
file descriptor of the file that has data to be read (int)
</dd>
</dl><a NAME="AsyncIO.setDescriptors" ID="AsyncIO.setDescriptors"></a>
<h4>AsyncIO.setDescriptors</h4>
<b>setDescriptors</b>(<i>wfd</i>)
<p>
Function called to set the descriptors for the connection.
</p><dl>
<dt><i>fd</i></dt>
<dd>
file descriptor of the input file (int)
</dd><dt><i>wfd</i></dt>
<dd>
file descriptor of the output file (int)
</dd>
</dl><a NAME="AsyncIO.write" ID="AsyncIO.write"></a>
<h4>AsyncIO.write</h4>
<b>write</b>(<i></i>)
<p>
Function to write a string.
</p><dl>
<dt><i>s</i></dt>
<dd>
the data to be written (string)
</dd>
</dl><a NAME="AsyncIO.writeReady" ID="AsyncIO.writeReady"></a>
<h4>AsyncIO.writeReady</h4>
<b>writeReady</b>(<i></i>)
<p>
Function called when we are ready to write data.
</p><dl>
<dt><i>fd</i></dt>
<dd>
file descriptor of the file that has data to be written (int)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>