summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRyan Dahl <ry@tinyclouds.org>2010-05-22 13:02:30 -0700
committerRyan Dahl <ry@tinyclouds.org>2010-05-22 13:02:30 -0700
commit1369d606f740545953dacd835dd7d36743f82d6f (patch)
tree521c44da7efecad006f6fa942468b8f84e5ed14c
parentfe3d8f2411209b202b7fe74cb48b582ffc5cfc5f (diff)
downloadnode-new-1369d606f740545953dacd835dd7d36743f82d6f.tar.gz
Add bug notes about HTTP streams and throttling
-rw-r--r--doc/api.markdown9
1 files changed, 9 insertions, 0 deletions
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'