Sat, 02 Jan 2010 18:19:35 +0000
Updated documentation.
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | <?xml version="1.0" encoding="utf-8"?> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | <html><head> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
5 | <title>eric5.DebugClients.Python3.AsyncIO</title> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | <style> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | </style> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | </head> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | <body><a NAME="top" ID="top"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | <h1>eric5.DebugClients.Python3.AsyncIO</h1> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
13 | Module implementing a base class of an asynchronous interface for the debugger. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | </p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | <h3>Global Attributes</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | <tr><td>None</td></tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
18 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | <h3>Classes</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | <tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | <td><a href="#AsyncIO">AsyncIO</a></td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | <td>Class implementing asynchronous reading and writing.</td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24 | </tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | <h3>Functions</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | <tr><td>None</td></tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | <a NAME="AsyncIO" ID="AsyncIO"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | <h2>AsyncIO</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
34 | Class implementing asynchronous reading and writing. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
35 | </p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | <h3>Derived from</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | object |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | <h3>Class Attributes</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | <tr><td>None</td></tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | <h3>Methods</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
44 | <tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
45 | <td><a href="#AsyncIO.__init__">AsyncIO</a></td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
46 | <td>Constructor</td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
47 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
48 | <td><a href="#AsyncIO.disconnect">disconnect</a></td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
49 | <td>Public method to disconnect any current connection.</td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
50 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
51 | <td><a href="#AsyncIO.readReady">readReady</a></td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
52 | <td>Public method called when there is data ready to be read.</td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
53 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
54 | <td><a href="#AsyncIO.setDescriptors">setDescriptors</a></td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
55 | <td>Public method called to set the descriptors for the connection.</td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
56 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
57 | <td><a href="#AsyncIO.write">write</a></td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58 | <td>Public method to write a string.</td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
59 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
60 | <td><a href="#AsyncIO.writeReady">writeReady</a></td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
61 | <td>Public method called when we are ready to write data.</td> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
62 | </tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
63 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
64 | <a NAME="AsyncIO.__init__" ID="AsyncIO.__init__"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | <h4>AsyncIO (Constructor)</h4> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | <b>AsyncIO</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
68 | Constructor |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
69 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
70 | <dt><i>parent</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
71 | <dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
72 | the optional parent of this object (QObject) (ignored) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
73 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
74 | </dl><a NAME="AsyncIO.disconnect" ID="AsyncIO.disconnect"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
75 | <h4>AsyncIO.disconnect</h4> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
76 | <b>disconnect</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
77 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
78 | Public method to disconnect any current connection. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
79 | </p><a NAME="AsyncIO.readReady" ID="AsyncIO.readReady"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
80 | <h4>AsyncIO.readReady</h4> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
81 | <b>readReady</b>(<i>fd</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
82 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
83 | Public method called when there is data ready to be read. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
84 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
85 | <dt><i>fd</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
86 | <dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
87 | file descriptor of the file that has data to be read (int) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
88 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
89 | </dl><a NAME="AsyncIO.setDescriptors" ID="AsyncIO.setDescriptors"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
90 | <h4>AsyncIO.setDescriptors</h4> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
91 | <b>setDescriptors</b>(<i>rfd, wfd</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
92 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
93 | Public method called to set the descriptors for the connection. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
94 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
95 | <dt><i>rfd</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
96 | <dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
97 | file descriptor of the input file (int) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
98 | </dd><dt><i>wfd</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
99 | <dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
100 | file descriptor of the output file (int) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
101 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
102 | </dl><a NAME="AsyncIO.write" ID="AsyncIO.write"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
103 | <h4>AsyncIO.write</h4> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
104 | <b>write</b>(<i>s</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
105 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
106 | Public method to write a string. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
107 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
108 | <dt><i>s</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
109 | <dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
110 | the data to be written (string) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
111 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
112 | </dl><a NAME="AsyncIO.writeReady" ID="AsyncIO.writeReady"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
113 | <h4>AsyncIO.writeReady</h4> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
114 | <b>writeReady</b>(<i>fd</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
115 | <p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
116 | Public method called when we are ready to write data. |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
117 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
118 | <dt><i>fd</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
119 | <dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
120 | file descriptor of the file that has data to be written (int) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
121 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
122 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
123 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
124 | <hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
125 | </body></html> |