Stream - История изменений

imported>Supportadmin: /* Class: stream.Readable */

2013-08-25T10:27:56Z

Class: stream.Readable

← Предыдущая версия		Версия от 13:27, 25 августа 2013
Строка 59:		Строка 59:
	Examples of readable streams include:		Examples of readable streams include:

	http responses, on the client		*http responses, on the client
	http requests, on the server		*http requests, on the server
	fs read streams		*fs read streams
	zlib streams		*zlib streams
	crypto streams		*crypto streams
	tcp sockets		*tcp sockets
	child process stdout and stderr		*child process stdout and stderr
	process.stdin		*process.stdin
	===Event: 'readable'===		===Event: 'readable'===

Строка 288:		Строка 288:
	myReader.read(); // etc.		myReader.read(); // etc.
	});</nowiki>		});</nowiki>

	==Class: stream.Writable==		==Class: stream.Writable==
	The Writable stream interface is an abstraction for a destination that you are writing data to.		The Writable stream interface is an abstraction for a destination that you are writing data to.

imported>Supportadmin: /* readable.pipe(destination, [options]) */

2013-08-25T10:25:33Z

readable.pipe(destination, [options])

← Предыдущая версия		Версия от 13:25, 25 августа 2013
Строка 178:		Строка 178:

	destination Writable Stream The destination for writing data		destination Writable Stream The destination for writing data

	options Object Pipe options		options Object Pipe options

	end Boolean End the writer when the reader ends. Default = true		end Boolean End the writer when the reader ends. Default = true

	This method pulls all the data out of a readable stream, and writes it to the supplied destination, automatically managing the flow so that the destination is not overwhelmed by a fast readable stream.		This method pulls all the data out of a readable stream, and writes it to the supplied destination, automatically managing the flow so that the destination is not overwhelmed by a fast readable stream.

imported>Supportadmin: /* readable.setEncoding(encoding) */

2013-08-25T10:25:09Z

readable.setEncoding(encoding)

← Предыдущая версия		Версия от 13:25, 25 августа 2013
Строка 136:		Строка 136:

	encoding String The encoding to use.		encoding String The encoding to use.

	Call this function to cause the stream to return strings of the specified encoding instead of Buffer objects. For example, if you do readable.setEncoding('utf8'), then the output data will be interpreted as UTF-8 data, and returned as strings. If you do readable.setEncoding('hex'), then the data will be encoded in hexadecimal string format.		Call this function to cause the stream to return strings of the specified encoding instead of Buffer objects. For example, if you do readable.setEncoding('utf8'), then the output data will be interpreted as UTF-8 data, and returned as strings. If you do readable.setEncoding('hex'), then the data will be encoded in hexadecimal string format.

Строка 146:		Строка 147:
	console.log('got %d characters of string data', chunk.length);		console.log('got %d characters of string data', chunk.length);
	})</nowiki>		})</nowiki>

	===readable.resume()===		===readable.resume()===

imported>Supportadmin: /* Event: 'end' */

2013-08-25T10:24:46Z

Event: 'end'

← Предыдущая версия		Версия от 13:24, 25 августа 2013
Строка 98:		Строка 98:
	Note that the end event will not fire unless the data is completely consumed. This can be done by switching into flowing mode, or by calling read() repeatedly until you get to the end.		Note that the end event will not fire unless the data is completely consumed. This can be done by switching into flowing mode, or by calling read() repeatedly until you get to the end.

	var readable = getReadableStreamSomehow();		<nowiki>var readable = getReadableStreamSomehow();
	readable.on('data', function(chunk) {		readable.on('data', function(chunk) {
	console.log('got %d bytes of data', chunk.length);		console.log('got %d bytes of data', chunk.length);
Строка 104:		Строка 104:
	readable.on('end', function() {		readable.on('end', function() {
	console.log('there will be no more data.');		console.log('there will be no more data.');
	});		});</nowiki>

	===Event: 'close'===		===Event: 'close'===

imported>Supportadmin: /* Event: 'data' */

2013-08-25T10:24:26Z

Event: 'data'

← Предыдущая версия		Версия от 13:24, 25 августа 2013
Строка 82:		Строка 82:

	chunk Buffer \| String The chunk of data.		chunk Buffer \| String The chunk of data.

	If you attach a data event listener, then it will switch the stream into flowing mode, and data will be passed to your handler as soon as it is available.		If you attach a data event listener, then it will switch the stream into flowing mode, and data will be passed to your handler as soon as it is available.

	If you just want to get all the data out of the stream as fast as possible, this is the best way to do so.		If you just want to get all the data out of the stream as fast as possible, this is the best way to do so.

	var readable = getReadableStreamSomehow();		<nowiki>var readable = getReadableStreamSomehow();
	readable.on('data', function(chunk) {		readable.on('data', function(chunk) {
	console.log('got %d bytes of data', chunk.length);		console.log('got %d bytes of data', chunk.length);
	})		})</nowiki>

	===Event: 'end'===		===Event: 'end'===

imported>Supportadmin: /* Event: 'readable' */

2013-08-25T10:23:51Z

Event: 'readable'

← Предыдущая версия		Версия от 13:23, 25 августа 2013
Строка 73:		Строка 73:
	In some cases, listening for a 'readable' event will cause some data to be read into the internal buffer from the underlying system, if it hadn't already.		In some cases, listening for a 'readable' event will cause some data to be read into the internal buffer from the underlying system, if it hadn't already.

	var readable = getReadableStreamSomehow();		<nowiki>var readable = getReadableStreamSomehow();
	readable.on('readable', function() {		readable.on('readable', function() {
	// there is some data to read now		// there is some data to read now
	})		})</nowiki>
	Once the internal buffer is drained, a readable event will fire again when more data is available.		Once the internal buffer is drained, a readable event will fire again when more data is available.

imported>Supportadmin: /* stream.push(' ') */

2013-08-25T10:23:06Z

stream.push(' ')

← Предыдущая версия		Версия от 13:23, 25 августа 2013
Строка 813:		Строка 813:
	So far, the only use case for this functionality is in the tls.CryptoStream class, which is deprecated in Node v0.12. If you find that you have to use stream.push(''), please consider another approach, because it almost certainly indicates that something is horribly wrong.		So far, the only use case for this functionality is in the tls.CryptoStream class, which is deprecated in Node v0.12. If you find that you have to use stream.push(''), please consider another approach, because it almost certainly indicates that something is horribly wrong.

	Compatibility with Older Node Versions#		===Compatibility with Older Node Versions===
	In versions of Node prior to v0.10, the Readable stream interface was simpler, but also less powerful and less useful.		In versions of Node prior to v0.10, the Readable stream interface was simpler, but also less powerful and less useful.

imported>Supportadmin: /* stream.push() */

2013-08-25T10:22:37Z

stream.push()

← Предыдущая версия		Версия от 13:22, 25 августа 2013
Строка 806:		Строка 806:
	There is almost never a need to do this. However, you will see some cases in Node's internals where this is done, particularly in the Readable stream class internals.		There is almost never a need to do this. However, you will see some cases in Node's internals where this is done, particularly in the Readable stream class internals.

	===stream.push(<nowiki>''</nowiki>)===		===stream.push(<nowiki>' '</nowiki>)===
	Pushing a zero-byte string or Buffer (when not in Object mode) has an interesting side effect. Because it is a call to stream.push(), it will end the reading process. However, it does not add any data to the readable buffer, so there's nothing for a user to consume.		Pushing a zero-byte string or Buffer (when not in Object mode) has an interesting side effect. Because it is a call to stream.push(), it will end the reading process. However, it does not add any data to the readable buffer, so there's nothing for a user to consume.

imported>Supportadmin: /* stream.push() */

2013-08-25T10:22:22Z

stream.push()

← Предыдущая версия		Версия от 13:22, 25 августа 2013
Строка 806:		Строка 806:
	There is almost never a need to do this. However, you will see some cases in Node's internals where this is done, particularly in the Readable stream class internals.		There is almost never a need to do this. However, you will see some cases in Node's internals where this is done, particularly in the Readable stream class internals.

	===stream.push('')===		===stream.push(<nowiki>''</nowiki>)===
	Pushing a zero-byte string or Buffer (when not in Object mode) has an interesting side effect. Because it is a call to stream.push(), it will end the reading process. However, it does not add any data to the readable buffer, so there's nothing for a user to consume.		Pushing a zero-byte string or Buffer (when not in Object mode) has an interesting side effect. Because it is a call to stream.push(), it will end the reading process. However, it does not add any data to the readable buffer, so there's nothing for a user to consume.

imported>Supportadmin: /* transform._flush(callback) */

2013-08-25T10:21:53Z

transform._flush(callback)

← Предыдущая версия		Версия от 13:21, 25 августа 2013
Строка 712:		Строка 712:
	This method is prefixed with an underscore because it is internal to the class that defines it, and should not be called directly by user programs. However, you are expected to override this method in your own extension classes.		This method is prefixed with an underscore because it is internal to the class that defines it, and should not be called directly by user programs. However, you are expected to override this method in your own extension classes.

	Example: SimpleProtocol parser v2#		===Example: SimpleProtocol parser v2===

	The example above of a simple protocol parser can be implemented simply by using the higher level Transform stream class, similar to the parseHeader and SimpleProtocol v1 examples above.		The example above of a simple protocol parser can be implemented simply by using the higher level Transform stream class, similar to the parseHeader and SimpleProtocol v1 examples above.
Строка 783:		Строка 783:
	// Now parser is a readable stream that will emit 'header'		// Now parser is a readable stream that will emit 'header'
	// with the parsed header data.		// with the parsed header data.

	==Class: stream.PassThrough==		==Class: stream.PassThrough==
	This is a trivial implementation of a Transform stream that simply passes the input bytes across to the output. Its purpose is mainly for examples and testing, but there are occasionally use cases where it can come in handy as a building block for novel sorts of streams.		This is a trivial implementation of a Transform stream that simply passes the input bytes across to the output. Its purpose is mainly for examples and testing, but there are occasionally use cases where it can come in handy as a building block for novel sorts of streams.