OLD | NEW |
1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2012, 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 * Output streams are used to write data sequentially to a data | 6 * Output streams are used to write data sequentially to a data |
7 * destination e.g. a connected socket or an open file. | 7 * destination e.g. a connected socket or an open file. |
8 * | 8 * |
9 * An output stream provides internal buffering of the data written | 9 * An output stream provides internal buffering of the data written |
10 * through all calls to [write] and [writeFrom] if data cannot be | 10 * through all calls to [write] and [writeFrom] if data cannot be |
11 * written immediately to the communication channel. The callback set | 11 * written immediately to the communication channel. The callback set |
12 * through [onNoPendingWrites] can be used to to keep the rate of | 12 * through [onNoPendingWrites] can be used to to keep the rate of |
13 * writing in sync with the rate the system can actually write data to | 13 * writing in sync with the rate the system can actually write data to |
14 * the underlying communication channel. | 14 * the underlying communication channel. |
15 */ | 15 */ |
16 interface OutputStream { | 16 abstract class OutputStream { |
17 /** | 17 /** |
18 * Writes the content of [buffer] to the stream. If [copyBuffer] is | 18 * Writes the content of [buffer] to the stream. If [copyBuffer] is |
19 * false ownership of the specified buffer is passed to the system | 19 * false ownership of the specified buffer is passed to the system |
20 * and the caller should not change it afterwards. The default value | 20 * and the caller should not change it afterwards. The default value |
21 * for [copyBuffer] is true. | 21 * for [copyBuffer] is true. |
22 * | 22 * |
23 * Returns true if the data could be written to the underlying | 23 * Returns true if the data could be written to the underlying |
24 * communication channel immediately. Otherwise the data is buffered | 24 * communication channel immediately. Otherwise the data is buffered |
25 * by the output stream and will be sent as soon as possible. | 25 * by the output stream and will be sent as soon as possible. |
26 */ | 26 */ |
(...skipping 65 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
92 */ | 92 */ |
93 void set onClosed(void callback()); | 93 void set onClosed(void callback()); |
94 | 94 |
95 /** | 95 /** |
96 * Sets the handler that gets called when the underlying | 96 * Sets the handler that gets called when the underlying |
97 * communication channel gets into some kind of error situation. | 97 * communication channel gets into some kind of error situation. |
98 */ | 98 */ |
99 void set onError(void callback(e)); | 99 void set onError(void callback(e)); |
100 } | 100 } |
101 | 101 |
OLD | NEW |