Thu, 18 Nov 2010 20:53:30 +0100
Finished implementing the display of annotations .
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.Ruby.AsyncFile</title> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | <style> |
21
b88a0e6268bd
Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
7 | body { |
440
69ace3e2dcf6
Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
409
diff
changeset
|
8 | background: #EDECE6; |
21
b88a0e6268bd
Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
9 | margin: 0em 1em 10em 1em; |
b88a0e6268bd
Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
10 | color: black; |
b88a0e6268bd
Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
11 | } |
b88a0e6268bd
Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
12 | |
409
0ea528e80202
Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
58
diff
changeset
|
13 | h1 { color: white; background: #85774A; } |
0ea528e80202
Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
58
diff
changeset
|
14 | h2 { color: white; background: #85774A; } |
440
69ace3e2dcf6
Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
409
diff
changeset
|
15 | h3 { color: white; background: #9D936E; } |
69ace3e2dcf6
Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
409
diff
changeset
|
16 | h4 { color: white; background: #9D936E; } |
21
b88a0e6268bd
Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
17 | |
440
69ace3e2dcf6
Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
409
diff
changeset
|
18 | a { color: #BA6D36; } |
21
b88a0e6268bd
Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
19 | |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | </style> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | </head> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | <body><a NAME="top" ID="top"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | <h1>eric5.DebugClients.Ruby.AsyncFile</h1> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
25 | File implementing an asynchronous file like socket interface for the debugger. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | </p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | <h3>Global Attributes</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | <tr><td>None</td></tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | <h3>Classes</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | <tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
34 | <td><a href="#AsyncFile">AsyncFile</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
35 | <td>Class wrapping a socket object with a file interface.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | </tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | <h3>Modules</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>Functions</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="#<<"><<</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
46 | <td>Synonym for write(s).</td> |
17
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="#AsyncPendingWrite">AsyncPendingWrite</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
49 | <td>Module function to check for data to be written.</td> |
17
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="#close">close</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
52 | <td>Public method to close the file.</td> |
17
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="#fileno">fileno</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
55 | <td>Public method returning the file number.</td> |
17
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="#flush">flush</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
58 | <td>Public method to write all pending bytes.</td> |
17
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="#getSock">getSock</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
61 | <td>Public method to get the socket object.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
62 | </tr><tr> |
728
3ee110082fb7
Finished implementing the display of annotations .
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
440
diff
changeset
|
63 | <td><a href="#gets">gets</a></td> |
3ee110082fb7
Finished implementing the display of annotations .
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
440
diff
changeset
|
64 | <td>Public method to read a line from this file.</td> |
3ee110082fb7
Finished implementing the display of annotations .
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
440
diff
changeset
|
65 | </tr><tr> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | <td><a href="#isatty">isatty</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
67 | <td>Public method to indicate whether a tty interface is supported.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
68 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
69 | <td><a href="#pendingWrite">pendingWrite</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
70 | <td>Public method that returns the number of bytes waiting to be written.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
71 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
72 | <td><a href="#read">read</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
73 | <td>Public method to read bytes from this file.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
74 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
75 | <td><a href="#readline">readline</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
76 | <td>Public method to read a line from this file.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
77 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
78 | <td><a href="#readlines">readlines</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
79 | <td>Public method to read all lines from this file.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
80 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
81 | <td><a href="#seek">seek</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
82 | <td>Public method to move the filepointer.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
83 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
84 | <td><a href="#tell">tell</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
85 | <td>Public method to get the filepointer position.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
86 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
87 | <td><a href="#write">write</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
88 | <td>Public method to write a string to the file.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
89 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
90 | <td><a href="#writelines">writelines</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
91 | <td>Public method to write a list of strings to the file.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
92 | </tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
93 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
94 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
95 | <a NAME="AsyncFile" ID="AsyncFile"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
96 | <h2>AsyncFile</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
97 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
98 | Class wrapping a socket object with a file interface. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
99 | </p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
100 | <h3>Derived from</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
101 | None |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
102 | <h3>Class Attributes</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
103 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
104 | <tr><td>@@maxbuffersize</td></tr><tr><td>@@maxtries</td></tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
105 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
106 | <h3>Methods</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
107 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
108 | <tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
109 | <td><a href="#AsyncFile.checkMode">checkMode</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
110 | <td>Private method to check the mode.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
111 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
112 | <td><a href="#AsyncFile.initialize">initialize</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
113 | <td>Constructor</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
114 | </tr><tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
115 | <td><a href="#AsyncFile.nWrite">nWrite</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
116 | <td>Private method to write a specific number of pending bytes.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
117 | </tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
118 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
119 | <a NAME="AsyncFile.checkMode" ID="AsyncFile.checkMode"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
120 | <h4>AsyncFile.checkMode</h4> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
121 | <b>checkMode</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
122 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
123 | Private method to check the mode. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
124 | </p><p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
125 | This method checks, if an operation is permitted according to |
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
126 | the mode of the file. If it is not, an IOError is raised. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
127 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
128 | <dt><i>mode</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
129 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
130 | the mode to be checked (string) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
131 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
132 | </dl><a NAME="AsyncFile.initialize" ID="AsyncFile.initialize"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
133 | <h4>AsyncFile.initialize</h4> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
134 | <b>initialize</b>(<i>mode, name</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
135 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
136 | Constructor |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
137 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
138 | <dt><i>sock</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
139 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
140 | the socket object being wrapped |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
141 | </dd><dt><i>mode</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
142 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
143 | mode of this file (string) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
144 | </dd><dt><i>name</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
145 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
146 | name of this file (string) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
147 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
148 | </dl><a NAME="AsyncFile.nWrite" ID="AsyncFile.nWrite"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
149 | <h4>AsyncFile.nWrite</h4> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
150 | <b>nWrite</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
151 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
152 | Private method to write a specific number of pending bytes. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
153 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
154 | <dt><i>n</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
155 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
156 | the number of bytes to be written (int) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
157 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
158 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
159 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
160 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
161 | <a NAME="<<" ID="<<"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
162 | <h2><<</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
163 | <b><<</b>(<i>s</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
164 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
165 | Synonym for write(s). |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
166 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
167 | <dt><i>s</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
168 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
169 | bytes to be written (string) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
170 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
171 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
172 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
173 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
174 | <a NAME="AsyncPendingWrite" ID="AsyncPendingWrite"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
175 | <h2>AsyncPendingWrite</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
176 | <b>AsyncPendingWrite</b>(<i>file</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
177 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
178 | Module function to check for data to be written. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
179 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
180 | <dt><i>file</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
181 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
182 | The file object to be checked (file) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
183 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
184 | </dl><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
185 | <dt>Returns:</dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
186 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
187 | Flag indicating if there is data wating (int) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
188 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
189 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
190 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
191 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
192 | <a NAME="close" ID="close"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
193 | <h2>close</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
194 | <b>close</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
195 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
196 | Public method to close the file. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
197 | </p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
198 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
199 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
200 | <a NAME="fileno" ID="fileno"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
201 | <h2>fileno</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
202 | <b>fileno</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
203 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
204 | Public method returning the file number. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
205 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
206 | <dt>Returns:</dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
207 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
208 | file number (int) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
209 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
210 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
211 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
212 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
213 | <a NAME="flush" ID="flush"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
214 | <h2>flush</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
215 | <b>flush</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
216 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
217 | Public method to write all pending bytes. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
218 | </p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
219 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
220 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
221 | <a NAME="getSock" ID="getSock"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
222 | <h2>getSock</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
223 | <b>getSock</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
224 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
225 | Public method to get the socket object. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
226 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
227 | <dt>Returns:</dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
228 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
229 | the socket object |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
230 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
231 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
232 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
233 | <hr /><hr /> |
728
3ee110082fb7
Finished implementing the display of annotations .
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
440
diff
changeset
|
234 | <a NAME="gets" ID="gets"></a> |
3ee110082fb7
Finished implementing the display of annotations .
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
440
diff
changeset
|
235 | <h2>gets</h2> |
3ee110082fb7
Finished implementing the display of annotations .
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
440
diff
changeset
|
236 | <b>gets</b>(<i></i>) |
3ee110082fb7
Finished implementing the display of annotations .
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
440
diff
changeset
|
237 | <p> |
3ee110082fb7
Finished implementing the display of annotations .
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
440
diff
changeset
|
238 | Public method to read a line from this file. |
3ee110082fb7
Finished implementing the display of annotations .
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
440
diff
changeset
|
239 | </p> |
3ee110082fb7
Finished implementing the display of annotations .
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
440
diff
changeset
|
240 | <div align="right"><a href="#top">Up</a></div> |
3ee110082fb7
Finished implementing the display of annotations .
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
440
diff
changeset
|
241 | <hr /><hr /> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
242 | <a NAME="isatty" ID="isatty"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
243 | <h2>isatty</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
244 | <b>isatty</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
245 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
246 | Public method to indicate whether a tty interface is supported. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
247 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
248 | <dt>Returns:</dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
249 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
250 | always false |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
251 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
252 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
253 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
254 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
255 | <a NAME="pendingWrite" ID="pendingWrite"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
256 | <h2>pendingWrite</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
257 | <b>pendingWrite</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
258 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
259 | Public method that returns the number of bytes waiting to be written. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
260 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
261 | <dt>Returns:</dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
262 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
263 | the number of bytes to be written (int) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
264 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
265 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
266 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
267 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
268 | <a NAME="read" ID="read"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
269 | <h2>read</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
270 | <b>read</b>(<i>size = -1</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
271 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
272 | Public method to read bytes from this file. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
273 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
274 | <dt><i>size</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
275 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
276 | maximum number of bytes to be read (int) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
277 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
278 | </dl><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
279 | <dt>Returns:</dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
280 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
281 | the bytes read (any) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
282 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
283 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
284 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
285 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
286 | <a NAME="readline" ID="readline"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
287 | <h2>readline</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
288 | <b>readline</b>(<i>size = -1</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
289 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
290 | Public method to read a line from this file. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
291 | </p><p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
292 | <b>Note</b>: This method will not block and may return |
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
293 | only a part of a line if that is all that is available. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
294 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
295 | <dt><i>size</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
296 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
297 | maximum number of bytes to be read (int) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
298 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
299 | </dl><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
300 | <dt>Returns:</dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
301 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
302 | one line of text up to size bytes (string) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
303 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
304 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
305 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
306 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
307 | <a NAME="readlines" ID="readlines"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
308 | <h2>readlines</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
309 | <b>readlines</b>(<i>sizehint = -1</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
310 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
311 | Public method to read all lines from this file. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
312 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
313 | <dt><i>sizehint</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
314 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
315 | hint of the numbers of bytes to be read (int) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
316 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
317 | </dl><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
318 | <dt>Returns:</dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
319 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
320 | list of lines read (list of strings) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
321 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
322 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
323 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
324 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
325 | <a NAME="seek" ID="seek"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
326 | <h2>seek</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
327 | <b>seek</b>(<i>offset, whence=IO::SEEK_SET</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
328 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
329 | Public method to move the filepointer. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
330 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
331 | <dt>Raises <b>IOError</b>:</dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
332 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
333 | This method is not supported and always raises an |
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
334 | IOError. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
335 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
336 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
337 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
338 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
339 | <a NAME="tell" ID="tell"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
340 | <h2>tell</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
341 | <b>tell</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
342 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
343 | Public method to get the filepointer position. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
344 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
345 | <dt>Raises <b>IOError</b>:</dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
346 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
347 | This method is not supported and always raises an |
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
348 | IOError. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
349 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
350 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
351 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
352 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
353 | <a NAME="write" ID="write"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
354 | <h2>write</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
355 | <b>write</b>(<i>s</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
356 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
357 | Public method to write a string to the file. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
358 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
359 | <dt><i>s</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
360 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
361 | bytes to be written (string) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
362 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
363 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
364 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
365 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
366 | <a NAME="writelines" ID="writelines"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
367 | <h2>writelines</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
368 | <b>writelines</b>(<i>list</i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
369 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
370 | Public method to write a list of strings to the file. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
371 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
372 | <dt><i>list</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
373 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
374 | the list to be written (list of string) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
375 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
376 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
377 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
378 | <hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
379 | </body></html> |