Add bug notes about HTTP streams and throttling
authorRyan Dahl <ry@tinyclouds.org>
Sat, 22 May 2010 20:02:30 +0000 (13:02 -0700)
committerRyan Dahl <ry@tinyclouds.org>
Sat, 22 May 2010 20:02:30 +0000 (13:02 -0700)
doc/api.markdown

index c2467a1..da0ee84 100644 (file)
@@ -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'