Chromium Code Reviews| OLD | NEW |
|---|---|
| 1 // Copyright (c) 2011, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2011, the Dart project authors. Please see the AUTHORS file |
| 2 // for details. All rights reserved. Use of this source code is governed by a | 2 // for details. All rights reserved. Use of this source code is governed by a |
| 3 // BSD-style license that can be found in the LICENSE file. | 3 // BSD-style license that can be found in the LICENSE file. |
| 4 | 4 |
| 5 /** | 5 /** |
| 6 * Input is read from a given input stream. Such an input stream can | 6 * Input is read from a given input stream. Such an input stream can |
| 7 * be an endpoint, e.g., a socket or a file, or another input stream. | 7 * be an endpoint, e.g., a socket or a file, or another input stream. |
| 8 * Multiple input streams can be chained together to operate collaboratively | 8 * Multiple input streams can be chained together to operate collaboratively |
| 9 * on a given input. | 9 * on a given input. |
| 10 */ | 10 */ |
| 11 interface InputStream { | 11 interface InputStream { |
| 12 /** | 12 /** |
| 13 * Reads [len] bytes into [buffer] buffer starting at [offset] offset. | 13 * Reads data from the stream. Returns a system allocated buffer |
| 14 * [callback] callback is invoked on completion unless it is null. | 14 * with up to [len] bytes. If no value is passed for [len] all |
| 15 * available data will be returned. If no data is available null will | |
| 16 * be returned. | |
| 15 */ | 17 */ |
| 16 bool read(List<int> buffer, int offset, int len, void callback()); | 18 List<int> read([int len]); |
| 17 | 19 |
| 18 /** | 20 /** |
| 19 * Reads data from the stream into a buffer until a given [pattern] occurs and | 21 * Reads up to [len] bytes into buffer [buffer] starting at offset |
| 20 * hands that buffer over as an input to the registered [callback]. | 22 * [offset]. Returns the number of bytes actually read which might |
| 21 * The callback is not invoked if a read error occurs. | 23 * be zero. If [offset] is not specified 0 is used. If [len] is not |
| 24 * specified the length of [buffer] is used. | |
| 22 */ | 25 */ |
| 23 void readUntil(List<int> pattern, void callback(List<int> buffer)); | 26 int readInto(List<int> buffer, [int offset, int len]); |
| 27 | |
| 28 /** | |
| 29 * Returns the number of bytes available for immediate reading. | |
| 30 */ | |
| 31 int available(); | |
| 32 | |
| 33 /** | |
| 34 * Returns whether the stream has been closed. There might still be | |
| 35 * more data to read. | |
| 36 */ | |
| 37 bool closed(); | |
| 38 | |
| 39 /** | |
| 40 * Sets the data handler gets called when data is available. | |
|
Mads Ager (google)
2011/10/26 10:56:07
get called -> which gets called
As a separate cha
Søren Gjesse
2011/10/26 12:03:31
Done.
| |
| 41 */ | |
| 42 void set dataHandler(void callback()); | |
| 43 | |
| 44 /** | |
| 45 * The close handler gets called when the underlying communication | |
|
Mads Ager (google)
2011/10/26 10:56:07
As discussed offline we should rename to endHandle
Søren Gjesse
2011/10/26 12:03:31
Will do in a separate cl.
| |
| 46 * channel is closed and no more data will become available. Not all | |
| 47 * types of communication channels will emit close events. | |
| 48 */ | |
| 49 void set closeHandler(void callback()); | |
| 50 | |
| 51 /** | |
| 52 * The error handler gets called when the underlying communication | |
| 53 * channel gets into some kind of error situation. | |
| 54 */ | |
| 55 void set errorHandler(void callback()); | |
| 24 } | 56 } |
| 57 | |
| 58 | |
| 59 interface StringInputStream factory _StringInputStream { | |
| 60 /** | |
| 61 * Decodes a binary input stream into characters using the specified | |
| 62 * encoding. | |
| 63 */ | |
| 64 StringInputStream(InputStream input, [String encoding]); | |
| 65 | |
| 66 /** | |
| 67 * Reads as many characters as is available from the stream. If no data is | |
| 68 * available null will be returned. | |
| 69 */ | |
| 70 String read(); | |
| 71 | |
| 72 /** | |
| 73 * Reads the next line from the stream. The line ending characters | |
| 74 * will not be part og the returned string. If a full line is not | |
| 75 * available null will be returned.. | |
|
Mads Ager (google)
2011/10/26 10:56:07
.. -> .
Søren Gjesse
2011/10/26 12:03:31
Done.
| |
| 76 */ | |
| 77 String readLine(); | |
| 78 | |
| 79 /** | |
| 80 * Returns whether the stream has been closed. There might still be | |
| 81 * more data to read. | |
| 82 */ | |
| 83 bool get closed(); | |
|
Mads Ager (google)
2011/10/26 10:56:07
If we rename closeHandler to endHandler maybe this
Søren Gjesse
2011/10/26 12:03:31
Separate cl. Probably ended or maybe isEnded.
| |
| 84 | |
| 85 /** | |
| 86 * Returns the encoding used to decode the binary data into characters. | |
| 87 */ | |
| 88 String get encoding(); | |
| 89 | |
| 90 /** | |
| 91 * The data handler gets called when data is available. | |
| 92 */ | |
| 93 void set dataHandler(void callback()); | |
| 94 | |
| 95 /** | |
| 96 * The close handler gets called when the underlying communication | |
| 97 * channel is closed and no more data will become available. Not all | |
| 98 * types of communication channels will emit close events. | |
| 99 */ | |
| 100 void set closeHandler(void callback()); | |
| 101 | |
| 102 /** | |
| 103 * The error handler gets called when the underlying communication | |
| 104 * channel gets into some kind of error situation. | |
| 105 */ | |
| 106 void set errorHandler(void callback()); | |
| 107 } | |
| 108 | |
| 109 | |
| 110 class StreamException implements Exception { | |
| 111 const StreamException([String this.message = ""]); | |
| 112 String toString() => "StreamException: $message"; | |
| 113 | |
| 114 /* | |
| 115 * Contains the exception message. | |
|
Mads Ager (google)
2011/10/26 10:56:07
Remove comment. Doesn't add much.
Søren Gjesse
2011/10/26 12:03:31
Done.
| |
| 116 */ | |
| 117 final String message; | |
| 118 } | |
| OLD | NEW |