--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.DebugClients.Python.AsyncFile.html Sat Jul 05 12:29:15 2014 +0200
@@ -0,0 +1,383 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.DebugClients.Python.AsyncFile</title>
+<meta charset="UTF-8">
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric6.DebugClients.Python.AsyncFile</h1>
+<p>
+Module implementing an asynchronous file like socket interface for the
+debugger.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#AsyncFile">AsyncFile</a></td>
+<td>Class wrapping a socket object with a file interface.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#AsyncPendingWrite">AsyncPendingWrite</a></td>
+<td>Module function to check for data to be written.</td>
+</tr>
+</table>
+<hr /><hr />
+<a NAME="AsyncFile" ID="AsyncFile"></a>
+<h2>AsyncFile</h2>
+<p>
+ Class wrapping a socket object with a file interface.
+</p>
+<h3>Derived from</h3>
+object
+<h3>Class Attributes</h3>
+<table>
+<tr><td>maxbuffersize</td></tr><tr><td>maxtries</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#AsyncFile.__init__">AsyncFile</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#AsyncFile.__checkMode">__checkMode</a></td>
+<td>Private method to check the mode.</td>
+</tr><tr>
+<td><a href="#AsyncFile.__nWrite">__nWrite</a></td>
+<td>Private method to write a specific number of pending bytes.</td>
+</tr><tr>
+<td><a href="#AsyncFile.close">close</a></td>
+<td>Public method to close the file.</td>
+</tr><tr>
+<td><a href="#AsyncFile.fileno">fileno</a></td>
+<td>Public method returning the file number.</td>
+</tr><tr>
+<td><a href="#AsyncFile.flush">flush</a></td>
+<td>Public method to write all pending bytes.</td>
+</tr><tr>
+<td><a href="#AsyncFile.isatty">isatty</a></td>
+<td>Public method to indicate whether a tty interface is supported.</td>
+</tr><tr>
+<td><a href="#AsyncFile.pendingWrite">pendingWrite</a></td>
+<td>Public method that returns the number of bytes waiting to be written.</td>
+</tr><tr>
+<td><a href="#AsyncFile.read">read</a></td>
+<td>Public method to read bytes from this file.</td>
+</tr><tr>
+<td><a href="#AsyncFile.read_p">read_p</a></td>
+<td>Public method to read bytes from this file.</td>
+</tr><tr>
+<td><a href="#AsyncFile.readline">readline</a></td>
+<td>Public method to read one line from this file.</td>
+</tr><tr>
+<td><a href="#AsyncFile.readline_p">readline_p</a></td>
+<td>Public method to read a line from this file.</td>
+</tr><tr>
+<td><a href="#AsyncFile.readlines">readlines</a></td>
+<td>Public method to read all lines from this file.</td>
+</tr><tr>
+<td><a href="#AsyncFile.seek">seek</a></td>
+<td>Public method to move the filepointer.</td>
+</tr><tr>
+<td><a href="#AsyncFile.tell">tell</a></td>
+<td>Public method to get the filepointer position.</td>
+</tr><tr>
+<td><a href="#AsyncFile.truncate">truncate</a></td>
+<td>Public method to truncate the file.</td>
+</tr><tr>
+<td><a href="#AsyncFile.write">write</a></td>
+<td>Public method to write a string to the file.</td>
+</tr><tr>
+<td><a href="#AsyncFile.writelines">writelines</a></td>
+<td>Public method to write a list of strings to the file.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="AsyncFile.__init__" ID="AsyncFile.__init__"></a>
+<h4>AsyncFile (Constructor)</h4>
+<b>AsyncFile</b>(<i>sock, mode, name</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>sock</i></dt>
+<dd>
+the socket object being wrapped
+</dd><dt><i>mode</i></dt>
+<dd>
+mode of this file (string)
+</dd><dt><i>name</i></dt>
+<dd>
+name of this file (string)
+</dd>
+</dl><a NAME="AsyncFile.__checkMode" ID="AsyncFile.__checkMode"></a>
+<h4>AsyncFile.__checkMode</h4>
+<b>__checkMode</b>(<i>mode</i>)
+<p>
+ Private method to check the mode.
+</p><p>
+ This method checks, if an operation is permitted according to
+ the mode of the file. If it is not, an IOError is raised.
+</p><dl>
+<dt><i>mode</i></dt>
+<dd>
+the mode to be checked (string)
+</dd>
+</dl><dl>
+<dt>Raises <b>IOError</b>:</dt>
+<dd>
+raised to indicate a bad file descriptor
+</dd>
+</dl><a NAME="AsyncFile.__nWrite" ID="AsyncFile.__nWrite"></a>
+<h4>AsyncFile.__nWrite</h4>
+<b>__nWrite</b>(<i>n</i>)
+<p>
+ Private method to write a specific number of pending bytes.
+</p><dl>
+<dt><i>n</i></dt>
+<dd>
+the number of bytes to be written (int)
+</dd>
+</dl><a NAME="AsyncFile.close" ID="AsyncFile.close"></a>
+<h4>AsyncFile.close</h4>
+<b>close</b>(<i>closeit=0</i>)
+<p>
+ Public method to close the file.
+</p><dl>
+<dt><i>closeit</i></dt>
+<dd>
+flag to indicate a close ordered by the debugger code
+ (boolean)
+</dd>
+</dl><a NAME="AsyncFile.fileno" ID="AsyncFile.fileno"></a>
+<h4>AsyncFile.fileno</h4>
+<b>fileno</b>(<i></i>)
+<p>
+ Public method returning the file number.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+file number (int)
+</dd>
+</dl><a NAME="AsyncFile.flush" ID="AsyncFile.flush"></a>
+<h4>AsyncFile.flush</h4>
+<b>flush</b>(<i></i>)
+<p>
+ Public method to write all pending bytes.
+</p><a NAME="AsyncFile.isatty" ID="AsyncFile.isatty"></a>
+<h4>AsyncFile.isatty</h4>
+<b>isatty</b>(<i></i>)
+<p>
+ Public method to indicate whether a tty interface is supported.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+always false
+</dd>
+</dl><a NAME="AsyncFile.pendingWrite" ID="AsyncFile.pendingWrite"></a>
+<h4>AsyncFile.pendingWrite</h4>
+<b>pendingWrite</b>(<i></i>)
+<p>
+ Public method that returns the number of bytes waiting to be written.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+the number of bytes to be written (int)
+</dd>
+</dl><a NAME="AsyncFile.read" ID="AsyncFile.read"></a>
+<h4>AsyncFile.read</h4>
+<b>read</b>(<i>size=-1</i>)
+<p>
+ Public method to read bytes from this file.
+</p><dl>
+<dt><i>size</i></dt>
+<dd>
+maximum number of bytes to be read (int)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+the bytes read (any)
+</dd>
+</dl><a NAME="AsyncFile.read_p" ID="AsyncFile.read_p"></a>
+<h4>AsyncFile.read_p</h4>
+<b>read_p</b>(<i>size=-1</i>)
+<p>
+ Public method to read bytes from this file.
+</p><dl>
+<dt><i>size</i></dt>
+<dd>
+maximum number of bytes to be read (int)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+the bytes read (any)
+</dd>
+</dl><a NAME="AsyncFile.readline" ID="AsyncFile.readline"></a>
+<h4>AsyncFile.readline</h4>
+<b>readline</b>(<i>sizehint=-1</i>)
+<p>
+ Public method to read one line from this file.
+</p><dl>
+<dt><i>sizehint</i></dt>
+<dd>
+hint of the numbers of bytes to be read (int)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+one line read (string)
+</dd>
+</dl><a NAME="AsyncFile.readline_p" ID="AsyncFile.readline_p"></a>
+<h4>AsyncFile.readline_p</h4>
+<b>readline_p</b>(<i>size=-1</i>)
+<p>
+ Public method to read a line from this file.
+</p><p>
+ <b>Note</b>: This method will not block and may return
+ only a part of a line if that is all that is available.
+</p><dl>
+<dt><i>size</i></dt>
+<dd>
+maximum number of bytes to be read (int)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+one line of text up to size bytes (string)
+</dd>
+</dl><a NAME="AsyncFile.readlines" ID="AsyncFile.readlines"></a>
+<h4>AsyncFile.readlines</h4>
+<b>readlines</b>(<i>sizehint=-1</i>)
+<p>
+ Public method to read all lines from this file.
+</p><dl>
+<dt><i>sizehint</i></dt>
+<dd>
+hint of the numbers of bytes to be read (int)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+list of lines read (list of strings)
+</dd>
+</dl><a NAME="AsyncFile.seek" ID="AsyncFile.seek"></a>
+<h4>AsyncFile.seek</h4>
+<b>seek</b>(<i>offset, whence=0</i>)
+<p>
+ Public method to move the filepointer.
+</p><dl>
+<dt><i>offset</i></dt>
+<dd>
+offset to seek for
+</dd><dt><i>whence</i></dt>
+<dd>
+where to seek from
+</dd>
+</dl><dl>
+<dt>Raises <b>IOError</b>:</dt>
+<dd>
+This method is not supported and always raises an
+ IOError.
+</dd>
+</dl><a NAME="AsyncFile.tell" ID="AsyncFile.tell"></a>
+<h4>AsyncFile.tell</h4>
+<b>tell</b>(<i></i>)
+<p>
+ Public method to get the filepointer position.
+</p><dl>
+<dt>Raises <b>IOError</b>:</dt>
+<dd>
+This method is not supported and always raises an
+ IOError.
+</dd>
+</dl><a NAME="AsyncFile.truncate" ID="AsyncFile.truncate"></a>
+<h4>AsyncFile.truncate</h4>
+<b>truncate</b>(<i>size=-1</i>)
+<p>
+ Public method to truncate the file.
+</p><dl>
+<dt><i>size</i></dt>
+<dd>
+size to truncate to (integer)
+</dd>
+</dl><dl>
+<dt>Raises <b>IOError</b>:</dt>
+<dd>
+This method is not supported and always raises an
+ IOError.
+</dd>
+</dl><a NAME="AsyncFile.write" ID="AsyncFile.write"></a>
+<h4>AsyncFile.write</h4>
+<b>write</b>(<i>s</i>)
+<p>
+ Public method to write a string to the file.
+</p><dl>
+<dt><i>s</i></dt>
+<dd>
+bytes to be written (string)
+</dd>
+</dl><dl>
+<dt>Raises <b>socket.error</b>:</dt>
+<dd>
+raised to indicate too many send attempts
+</dd>
+</dl><a NAME="AsyncFile.writelines" ID="AsyncFile.writelines"></a>
+<h4>AsyncFile.writelines</h4>
+<b>writelines</b>(<i>list</i>)
+<p>
+ Public method to write a list of strings to the file.
+</p><dl>
+<dt><i>list</i></dt>
+<dd>
+the list to be written (list of string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="AsyncPendingWrite" ID="AsyncPendingWrite"></a>
+<h2>AsyncPendingWrite</h2>
+<b>AsyncPendingWrite</b>(<i>file</i>)
+<p>
+ Module function to check for data to be written.
+</p><dl>
+<dt><i>file</i></dt>
+<dd>
+The file object to be checked (file)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+Flag indicating if there is data wating (int)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
