summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrik Stutz <patrik.stutz@gmail.com>2013-10-17 02:11:19 +0200
committerTrevor Norris <trev.norris@gmail.com>2013-10-16 18:34:52 -0700
commit54910044b33a6405c72ad085915a55c575c027fc (patch)
treedc4f42042ba94f509fa018734fd20476dfafd46e
parent2bc30f239be3e56d642eda38df98c656d55b4d86 (diff)
downloadnode-new-54910044b33a6405c72ad085915a55c575c027fc.tar.gz
http: add statusMessage
Now the status message can be set via req.statusMessage = 'msg';
-rw-r--r--doc/api/http.markdown18
-rw-r--r--lib/_http_server.js10
-rw-r--r--test/simple/test-http-status-message.js50
3 files changed, 72 insertions, 6 deletions
diff --git a/doc/api/http.markdown b/doc/api/http.markdown
index 444500e0c6..7088ee3ddd 100644
--- a/doc/api/http.markdown
+++ b/doc/api/http.markdown
@@ -258,11 +258,11 @@ Indicates that the underlying connection was terminated before
Sends a HTTP/1.1 100 Continue message to the client, indicating that
the request body should be sent. See the ['checkContinue'][] event on `Server`.
-### response.writeHead(statusCode, [reasonPhrase], [headers])
+### response.writeHead(statusCode, [statusMessage], [headers])
Sends a response header to the request. The status code is a 3-digit HTTP
status code, like `404`. The last argument, `headers`, are the response headers.
-Optionally one can give a human-readable `reasonPhrase` as the second
+Optionally one can give a human-readable `statusMessage` as the second
argument.
Example:
@@ -313,6 +313,20 @@ Example:
After response header was sent to the client, this property indicates the
status code which was sent out.
+### response.statusMessage
+
+When using implicit headers (not calling `response.writeHead()` explicitly), this property
+controls the status message that will be sent to the client when the headers get
+flushed. If this is left as `undefined` then the standard message for the status
+code will be used.
+
+Example:
+
+ response.statusMessage = 'Not found';
+
+After response header was sent to the client, this property indicates the
+status message which was sent out.
+
### response.setHeader(name, value)
Sets a single header value for implicit headers. If this header already exists
diff --git a/lib/_http_server.js b/lib/_http_server.js
index 5a82c94dc8..4cb0c4b2f3 100644
--- a/lib/_http_server.js
+++ b/lib/_http_server.js
@@ -122,6 +122,7 @@ ServerResponse.prototype._finish = function() {
exports.ServerResponse = ServerResponse;
ServerResponse.prototype.statusCode = 200;
+ServerResponse.prototype.statusMessage = undefined;
function onServerResponseClose() {
// EventEmitter.emit makes a copy of the 'close' listeners array before
@@ -171,13 +172,14 @@ ServerResponse.prototype._implicitHeader = function() {
};
ServerResponse.prototype.writeHead = function(statusCode) {
- var reasonPhrase, headers, headerIndex;
+ var headers, headerIndex;
if (util.isString(arguments[1])) {
- reasonPhrase = arguments[1];
+ this.statusMessage = arguments[1];
headerIndex = 2;
} else {
- reasonPhrase = STATUS_CODES[statusCode] || 'unknown';
+ this.statusMessage =
+ this.statusMessage || STATUS_CODES[statusCode] || 'unknown';
headerIndex = 1;
}
this.statusCode = statusCode;
@@ -217,7 +219,7 @@ ServerResponse.prototype.writeHead = function(statusCode) {
}
var statusLine = 'HTTP/1.1 ' + statusCode.toString() + ' ' +
- reasonPhrase + CRLF;
+ this.statusMessage + CRLF;
if (statusCode === 204 || statusCode === 304 ||
(100 <= statusCode && statusCode <= 199)) {
diff --git a/test/simple/test-http-status-message.js b/test/simple/test-http-status-message.js
new file mode 100644
index 0000000000..a8d7a35104
--- /dev/null
+++ b/test/simple/test-http-status-message.js
@@ -0,0 +1,50 @@
+// Copyright Joyent, Inc. and other Node contributors.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to permit
+// persons to whom the Software is furnished to do so, subject to the
+// following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+// USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+var common = require('../common');
+var assert = require('assert');
+var http = require('http');
+var net = require('net');
+
+var s = http.createServer(function(req, res) {
+ res.statusCode = 200;
+ res.statusMessage = 'Custom Message';
+ res.end('');
+});
+
+s.listen(common.PORT, test);
+
+
+function test() {
+ var bufs = [];
+ var client = net.connect(common.PORT, function() {
+ client.write('GET / HTTP/1.1\r\nConnection: close\r\n\r\n');
+ });
+ client.on('data', function(chunk) {
+ bufs.push(chunk);
+ });
+ client.on('end', function() {
+ var head = Buffer.concat(bufs).toString('binary').split('\r\n')[0];
+ assert.equal('HTTP/1.1 200 Custom Message', head);
+ console.log('ok');
+ s.close();
+ });
+}