From 1369d606f740545953dacd835dd7d36743f82d6f Mon Sep 17 00:00:00 2001 From: Ryan Dahl Date: Sat, 22 May 2010 13:02:30 -0700 Subject: [PATCH] Add bug notes about HTTP streams and throttling --- doc/api.markdown | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/api.markdown b/doc/api.markdown index c2467a15bc..da0ee84e3e 100644 --- a/doc/api.markdown +++ b/doc/api.markdown @@ -1801,6 +1801,10 @@ authentication details. This object is created internally by a HTTP server--not by the user. It is passed as the second parameter to the `'request'` event. It is a writable stream. +BUG: `http.ServerResponse` does not yet implement all the throttling +mechanisms of writable streams. In particiular the return value of `write()` +is not in line with the interface and it does not emit a `drain` event. + ### response.writeHead(statusCode[, reasonPhrase] , headers) Sends a response header to the request. The status code is a 3-digit HTTP @@ -1946,6 +1950,11 @@ event, the entire body will be caught. }); This is a writable stream. + +BUG: `http.ClientRequest` does not yet implement all the throttling +mechanisms of writable streams. In particiular the return value of `write()` +is not in line with the interface and it does not emit a `drain` event. + This is an `EventEmitter` with the following events: ### Event 'response'