doc/api/http.markdown

   1 ## HTTP
   2
   3 To use the HTTP server and client one must `require('http')`.
   4
   5 The HTTP interfaces in Node are designed to support many features
   6 of the protocol which have been traditionally difficult to use.
   7 In particular, large, possibly chunk-encoded, messages. The interface is
   8 careful to never buffer entire requests or responses--the
   9 user is able to stream data.
  10
  11 HTTP message headers are represented by an object like this:
  12
  13     { 'content-length': '123',
  14       'content-type': 'text/plain',
  15       'connection': 'keep-alive',
  16       'accept': '*/*' }
  17
  18 Keys are lowercased. Values are not modified.
  19
  20 In order to support the full spectrum of possible HTTP applications, Node's
  21 HTTP API is very low-level. It deals with stream handling and message
  22 parsing only. It parses a message into headers and body but it does not
  23 parse the actual headers or the body.
  24
  25
  26 ## http.Server
  27
  28 This is an `EventEmitter` with the following events:
  29
  30 ### Event: 'request'
  31
  32 `function (request, response) { }`
  33
  34 Emitted each time there is request. Note that there may be multiple requests
  35 per connection (in the case of keep-alive connections).
  36  `request` is an instance of `http.ServerRequest` and `response` is
  37  an instance of `http.ServerResponse`
  38
  39 ### Event: 'connection'
  40
  41 `function (stream) { }`
  42
  43  When a new TCP stream is established. `stream` is an object of type
  44  `net.Stream`. Usually users will not want to access this event. The
  45  `stream` can also be accessed at `request.connection`.
  46
  47 ### Event: 'close'
  48
  49 `function (errno) { }`
  50
  51  Emitted when the server closes.
  52
  53 ### Event: 'checkContinue'
  54
  55 `function (request, response) { }`
  56
  57 Emitted each time a request with an http Expect: 100-continue is received.
  58 If this event isn't listened for, the server will automatically respond
  59 with a 100 Continue as appropriate.
  60
  61 Handling this event involves calling `response.writeContinue` if the client
  62 should continue to send the request body, or generating an appropriate HTTP
  63 response (e.g., 400 Bad Request) if the client should not continue to send the
  64 request body.
  65
  66 Note that when this event is emitted and handled, the `request` event will
  67 not be emitted.
  68
  69 ### Event: 'upgrade'
  70
  71 `function (request, socket, head) { }`
  72
  73 Emitted each time a client requests a http upgrade. If this event isn't
  74 listened for, then clients requesting an upgrade will have their connections
  75 closed.
  76
  77 * `request` is the arguments for the http request, as it is in the request event.
  78 * `socket` is the network socket between the server and client.
  79 * `head` is an instance of Buffer, the first packet of the upgraded stream, this may be empty.
  80
  81 After this event is emitted, the request's socket will not have a `data`
  82 event listener, meaning you will need to bind to it in order to handle data
  83 sent to the server on that socket.
  84
  85 ### Event: 'clientError'
  86
  87 `function (exception) { }`
  88
  89 If a client connection emits an 'error' event - it will forwarded here.
  90
  91 ### http.createServer([requestListener])
  92
  93 Returns a new web server object.
  94
  95 The `requestListener` is a function which is automatically
  96 added to the `'request'` event.
  97
  98 ### server.listen(port, [hostname], [callback])
  99
 100 Begin accepting connections on the specified port and hostname.  If the
 101 hostname is omitted, the server will accept connections directed to any
 102 IPv4 address (`INADDR_ANY`).
 103
 104 To listen to a unix socket, supply a filename instead of port and hostname.
 105
 106 This function is asynchronous. The last parameter `callback` will be called
 107 when the server has been bound to the port.
 108
 109
 110 ### server.listen(path, [callback])
 111
 112 Start a UNIX socket server listening for connections on the given `path`.
 113
 114 This function is asynchronous. The last parameter `callback` will be called
 115 when the server has been bound.
 116
 117
 118 ### server.close()
 119
 120 Stops the server from accepting new connections.
 121
 122
 123 ## http.ServerRequest
 124
 125 This object is created internally by a HTTP server -- not by
 126 the user -- and passed as the first argument to a `'request'` listener.
 127
 128 This is an `EventEmitter` with the following events:
 129
 130 ### Event: 'data'
 131
 132 `function (chunk) { }`
 133
 134 Emitted when a piece of the message body is received.
 135
 136 Example: A chunk of the body is given as the single
 137 argument. The transfer-encoding has been decoded.  The
 138 body chunk is a string.  The body encoding is set with
 139 `request.setEncoding()`.
 140
 141 ### Event: 'end'
 142
 143 `function () { }`
 144
 145 Emitted exactly once for each request. After that, no more `'data'` events
 146 will be emitted on the request.
 147
 148 ### Event: 'close'
 149
 150 `function (err) { }`
 151
 152 Indicates that the underlaying connection was terminated before
 153 `response.end()` was called or able to flush.
 154
 155 The `err` parameter is always present and indicates the reason for the timeout:
 156
 157 `err.code === 'timeout'` indicates that the underlaying connection timed out.
 158 This may happen because all incoming connections have a default timeout of 2
 159 minutes.
 160
 161 `err.code === 'aborted'` means that the client has closed the underlaying
 162 connection prematurely.
 163
 164 Just like `'end'`, this event occurs only once per request, and no more `'data'`
 165 events will fire afterwards.
 166
 167 Note: `'close'` can fire after `'end'`, but not vice versa.
 168
 169 ### request.method
 170
 171 The request method as a string. Read only. Example:
 172 `'GET'`, `'DELETE'`.
 173
 174
 175 ### request.url
 176
 177 Request URL string. This contains only the URL that is
 178 present in the actual HTTP request. If the request is:
 179
 180     GET /status?name=ryan HTTP/1.1\r\n
 181     Accept: text/plain\r\n
 182     \r\n
 183
 184 Then `request.url` will be:
 185
 186     '/status?name=ryan'
 187
 188 If you would like to parse the URL into its parts, you can use
 189 `require('url').parse(request.url)`.  Example:
 190
 191     node> require('url').parse('/status?name=ryan')
 192     { href: '/status?name=ryan',
 193       search: '?name=ryan',
 194       query: 'name=ryan',
 195       pathname: '/status' }
 196
 197 If you would like to extract the params from the query string,
 198 you can use the `require('querystring').parse` function, or pass
 199 `true` as the second argument to `require('url').parse`.  Example:
 200
 201     node> require('url').parse('/status?name=ryan', true)
 202     { href: '/status?name=ryan',
 203       search: '?name=ryan',
 204       query: { name: 'ryan' },
 205       pathname: '/status' }
 206
 207
 208
 209 ### request.headers
 210
 211 Read only.
 212
 213 ### request.trailers
 214
 215 Read only; HTTP trailers (if present). Only populated after the 'end' event.
 216
 217 ### request.httpVersion
 218
 219 The HTTP protocol version as a string. Read only. Examples:
 220 `'1.1'`, `'1.0'`.
 221 Also `request.httpVersionMajor` is the first integer and
 222 `request.httpVersionMinor` is the second.
 223
 224
 225 ### request.setEncoding(encoding=null)
 226
 227 Set the encoding for the request body. Either `'utf8'` or `'binary'`. Defaults
 228 to `null`, which means that the `'data'` event will emit a `Buffer` object..
 229
 230
 231 ### request.pause()
 232
 233 Pauses request from emitting events.  Useful to throttle back an upload.
 234
 235
 236 ### request.resume()
 237
 238 Resumes a paused request.
 239
 240 ### request.connection
 241
 242 The `net.Stream` object associated with the connection.
 243
 244
 245 With HTTPS support, use request.connection.verifyPeer() and
 246 request.connection.getPeerCertificate() to obtain the client's
 247 authentication details.
 248
 249
 250
 251 ## http.ServerResponse
 252
 253 This object is created internally by a HTTP server--not by the user. It is
 254 passed as the second parameter to the `'request'` event. It is a `Writable Stream`.
 255
 256 ### response.writeContinue()
 257
 258 Sends a HTTP/1.1 100 Continue message to the client, indicating that
 259 the request body should be sent. See the [checkContinue](#event_checkContinue_) event on
 260 `Server`.
 261
 262 ### response.writeHead(statusCode, [reasonPhrase], [headers])
 263
 264 Sends a response header to the request. The status code is a 3-digit HTTP
 265 status code, like `404`. The last argument, `headers`, are the response headers.
 266 Optionally one can give a human-readable `reasonPhrase` as the second
 267 argument.
 268
 269 Example:
 270
 271     var body = 'hello world';
 272     response.writeHead(200, {
 273       'Content-Length': body.length,
 274       'Content-Type': 'text/plain' });
 275
 276 This method must only be called once on a message and it must
 277 be called before `response.end()` is called.
 278
 279 If you call `response.write()` or `response.end()` before calling this, the
 280 implicit/mutable headers will be calculated and call this function for you.
 281
 282 Note: that Content-Length is given in bytes not characters. The above example
 283 works because the string `'hello world'` contains only single byte characters.
 284 If the body contains higher coded characters then `Buffer.byteLength()`
 285 should be used to determine the number of bytes in a given encoding.
 286
 287 ### response.statusCode
 288
 289 When using implicit headers (not calling `response.writeHead()` explicitly), this property
 290 controls the status code that will be send to the client when the headers get
 291 flushed.
 292
 293 Example:
 294
 295     response.statusCode = 404;
 296
 297 ### response.setHeader(name, value)
 298
 299 Sets a single header value for implicit headers.  If this header already exists
 300 in the to-be-sent headers, it's value will be replaced.  Use an array of strings
 301 here if you need to send multiple headers with the same name.
 302
 303 Example:
 304
 305     response.setHeader("Content-Type", "text/html");
 306
 307 or
 308
 309     response.setHeader("Set-Cookie", ["type=ninja", "language=javascript"]);
 310
 311
 312 ### response.getHeader(name)
 313
 314 Reads out a header that's already been queued but not sent to the client.  Note
 315 that the name is case insensitive.  This can only be called before headers get
 316 implicitly flushed.
 317
 318 Example:
 319
 320     var contentType = response.getHeader('content-type');
 321
 322 ### response.removeHeader(name)
 323
 324 Removes a header that's queued for implicit sending.
 325
 326 Example:
 327
 328     response.removeHeader("Content-Encoding");
 329
 330
 331 ### response.write(chunk, encoding='utf8')
 332
 333 If this method is called and `response.writeHead()` has not been called, it will
 334 switch to implicit header mode and flush the implicit headers.
 335
 336 This sends a chunk of the response body. This method may
 337 be called multiple times to provide successive parts of the body.
 338
 339 `chunk` can be a string or a buffer. If `chunk` is a string,
 340 the second parameter specifies how to encode it into a byte stream.
 341 By default the `encoding` is `'utf8'`.
 342
 343 **Note**: This is the raw HTTP body and has nothing to do with
 344 higher-level multi-part body encodings that may be used.
 345
 346 The first time `response.write()` is called, it will send the buffered
 347 header information and the first body to the client. The second time
 348 `response.write()` is called, Node assumes you're going to be streaming
 349 data, and sends that separately. That is, the response is buffered up to the
 350 first chunk of body.
 351
 352 ### response.addTrailers(headers)
 353
 354 This method adds HTTP trailing headers (a header but at the end of the
 355 message) to the response.
 356
 357 Trailers will **only** be emitted if chunked encoding is used for the
 358 response; if it is not (e.g., if the request was HTTP/1.0), they will
 359 be silently discarded.
 360
 361 Note that HTTP requires the `Trailer` header to be sent if you intend to
 362 emit trailers, with a list of the header fields in its value. E.g.,
 363
 364     response.writeHead(200, { 'Content-Type': 'text/plain',
 365                               'Trailer': 'TraceInfo' });
 366     response.write(fileData);
 367     response.addTrailers({'Content-MD5': "7895bf4b8828b55ceaf47747b4bca667"});
 368     response.end();
 369
 370
 371 ### response.end([data], [encoding])
 372
 373 This method signals to the server that all of the response headers and body
 374 has been sent; that server should consider this message complete.
 375 The method, `response.end()`, MUST be called on each
 376 response.
 377
 378 If `data` is specified, it is equivalent to calling `response.write(data, encoding)`
 379 followed by `response.end()`.
 380
 381
 382 ## http.request(options, callback)
 383
 384 Node maintains several connections per server to make HTTP requests.
 385 This function allows one to transparently issue requests.
 386
 387 Options:
 388
 389 - `host`: A domain name or IP address of the server to issue the request to.
 390 - `port`: Port of remote server.
 391 - `method`: A string specifying the HTTP request method. Possible values:
 392   `'GET'` (default), `'POST'`, `'PUT'`, and `'DELETE'`.
 393 - `path`: Request path. Should include query string and fragments if any.
 394    E.G. `'/index.html?page=12'`
 395 - `headers`: An object containing request headers.
 396
 397 `http.request()` returns an instance of the `http.ClientRequest`
 398 class. The `ClientRequest` instance is a writable stream. If one needs to
 399 upload a file with a POST request, then write to the `ClientRequest` object.
 400
 401 Example:
 402
 403     var options = {
 404       host: 'www.google.com',
 405       port: 80,
 406       path: '/upload',
 407       method: 'POST'
 408     };
 409
 410     var req = http.request(options, function(res) {
 411       console.log('STATUS: ' + res.statusCode);
 412       console.log('HEADERS: ' + JSON.stringify(res.headers));
 413       res.setEncoding('utf8');
 414       res.on('data', function (chunk) {
 415         console.log('BODY: ' + chunk);
 416       });
 417     });
 418
 419     req.on('error', function(e) {
 420       console.log('problem with request: ' + e.message);
 421     });
 422
 423     // write data to request body
 424     req.write('data\n');
 425     req.write('data\n');
 426     req.end();
 427
 428 Note that in the example `req.end()` was called. With `http.request()` one
 429 must always call `req.end()` to signify that you're done with the request -
 430 even if there is no data being written to the request body.
 431
 432 If any error is encountered during the request (be that with DNS resolution,
 433 TCP level errors, or actual HTTP parse errors) an `'error'` event is emitted
 434 on the returned request object.
 435
 436 There are a few special headers that should be noted.
 437
 438 * Sending a 'Connection: keep-alive' will notify Node that the connection to
 439   the server should be persisted until the next request.
 440
 441 * Sending a 'Content-length' header will disable the default chunked encoding.
 442
 443 * Sending an 'Expect' header will immediately send the request headers.
 444   Usually, when sending 'Expect: 100-continue', you should both set a timeout
 445   and listen for the `continue` event. See RFC2616 Section 8.2.3 for more
 446   information.
 447
 448 ## http.get(options, callback)
 449
 450 Since most requests are GET requests without bodies, Node provides this
 451 convenience method. The only difference between this method and `http.request()` is
 452 that it sets the method to GET and calls `req.end()` automatically.
 453
 454 Example:
 455
 456     var options = {
 457       host: 'www.google.com',
 458       port: 80,
 459       path: '/index.html'
 460     };
 461
 462     http.get(options, function(res) {
 463       console.log("Got response: " + res.statusCode);
 464     }).on('error', function(e) {
 465       console.log("Got error: " + e.message);
 466     });
 467
 468
 469 ## http.Agent
 470 ## http.getAgent(host, port)
 471
 472 `http.request()` uses a special `Agent` for managing multiple connections to
 473 an HTTP server. Normally `Agent` instances should not be exposed to user
 474 code, however in certain situations it's useful to check the status of the
 475 agent. The `http.getAgent()` function allows you to access the agents.
 476
 477 ### Event: 'upgrade'
 478
 479 `function (response, socket, head) { }`
 480
 481 Emitted each time a server responds to a request with an upgrade. If this
 482 event isn't being listened for, clients receiving an upgrade header will have
 483 their connections closed.
 484
 485 A client server pair that show you how to listen for the `upgrade` event using `http.getAgent`:
 486
 487     var http = require('http');
 488     var net = require('net');
 489
 490     // Create an HTTP server
 491     var srv = http.createServer(function (req, res) {
 492       res.writeHead(200, {'Content-Type': 'text/plain'});
 493       res.end('okay');
 494     });
 495     srv.on('upgrade', function(req, socket, upgradeHead) {
 496       socket.write('HTTP/1.1 101 Web Socket Protocol Handshake\r\n' +
 497                    'Upgrade: WebSocket\r\n' +
 498                    'Connection: Upgrade\r\n' +
 499                    '\r\n\r\n');
 500
 501       socket.ondata = function(data, start, end) {
 502         socket.write(data.toString('utf8', start, end), 'utf8'); // echo back
 503       };
 504     });
 505
 506     // now that server is running
 507     srv.listen(1337, '127.0.0.1', function() {
 508
 509       // make a request
 510       var agent = http.getAgent('127.0.0.1', 1337);
 511
 512       var options = {
 513         agent: agent,
 514         port: 1337,
 515         host: '127.0.0.1',
 516         headers: {
 517           'Connection': 'Upgrade',
 518           'Upgrade': 'websocket'
 519         }
 520       };
 521
 522       var req = http.request(options);
 523       req.end();
 524
 525       agent.on('upgrade', function(res, socket, upgradeHead) {
 526         console.log('got upgraded!');
 527         socket.end();
 528         process.exit(0);
 529       });
 530     });
 531
 532
 533 ### agent.maxSockets
 534
 535 By default set to 5. Determines how many concurrent sockets the agent can have open.
 536
 537 ### agent.sockets
 538
 539 An array of sockets currently in use by the Agent. Do not modify.
 540
 541 ### agent.queue
 542
 543 A queue of requests waiting to be sent to sockets.
 544
 545
 546
 547 ## http.ClientRequest
 548
 549 This object is created internally and returned from `http.request()`.  It
 550 represents an _in-progress_ request whose header has already been queued.  The
 551 header is still mutable using the `setHeader(name, value)`, `getHeader(name)`,
 552 `removeHeader(name)` API.  The actual header will be sent along with the first
 553 data chunk or when closing the connection.
 554
 555 To get the response, add a listener for `'response'` to the request object.
 556 `'response'` will be emitted from the request object when the response
 557 headers have been received.  The `'response'` event is executed with one
 558 argument which is an instance of `http.ClientResponse`.
 559
 560 During the `'response'` event, one can add listeners to the
 561 response object; particularly to listen for the `'data'` event. Note that
 562 the `'response'` event is called before any part of the response body is received,
 563 so there is no need to worry about racing to catch the first part of the
 564 body. As long as a listener for `'data'` is added during the `'response'`
 565 event, the entire body will be caught.
 566
 567
 568     // Good
 569     request.on('response', function (response) {
 570       response.on('data', function (chunk) {
 571         console.log('BODY: ' + chunk);
 572       });
 573     });
 574
 575     // Bad - misses all or part of the body
 576     request.on('response', function (response) {
 577       setTimeout(function () {
 578         response.on('data', function (chunk) {
 579           console.log('BODY: ' + chunk);
 580         });
 581       }, 10);
 582     });
 583
 584 This is a `Writable Stream`.
 585
 586 This is an `EventEmitter` with the following events:
 587
 588 ### Event: 'continue'
 589
 590 `function () { }`
 591
 592 Emitted when the server sends a '100 Continue' HTTP response, usually because
 593 the request contained 'Expect: 100-continue'. This is an instruction that
 594 the client should send the request body.
 595
 596 ### Event 'response'
 597
 598 `function (response) { }`
 599
 600 Emitted when a response is received to this request. This event is emitted only once. The
 601 `response` argument will be an instance of `http.ClientResponse`.
 602
 603
 604 ### request.write(chunk, encoding='utf8')
 605
 606 Sends a chunk of the body.  By calling this method
 607 many times, the user can stream a request body to a
 608 server--in that case it is suggested to use the
 609 `['Transfer-Encoding', 'chunked']` header line when
 610 creating the request.
 611
 612 The `chunk` argument should be an array of integers
 613 or a string.
 614
 615 The `encoding` argument is optional and only
 616 applies when `chunk` is a string.
 617
 618
 619 ### request.end([data], [encoding])
 620
 621 Finishes sending the request. If any parts of the body are
 622 unsent, it will flush them to the stream. If the request is
 623 chunked, this will send the terminating `'0\r\n\r\n'`.
 624
 625 If `data` is specified, it is equivalent to calling `request.write(data, encoding)`
 626 followed by `request.end()`.
 627
 628 ### request.abort()
 629
 630 Aborts a request.  (New since v0.3.8.)
 631
 632
 633 ## http.ClientResponse
 634
 635 This object is created when making a request with `http.request()`. It is
 636 passed to the `'response'` event of the request object.
 637
 638 The response implements the `Readable Stream` interface.
 639
 640 ### Event: 'data'
 641
 642 `function (chunk) { }`
 643
 644 Emitted when a piece of the message body is received.
 645
 646
 647 ### Event: 'end'
 648
 649 `function () { }`
 650
 651 Emitted exactly once for each message. No arguments. After
 652 emitted no other events will be emitted on the response.
 653
 654 ### Event: 'close'
 655
 656 `function (err) { }`
 657
 658 Indicates that the underlaying connection was terminated before
 659 `end` event was emitted.
 660 See [http.ServerRequest](#http.ServerRequest)'s `'close'` event for more
 661 information.
 662
 663 ### response.statusCode
 664
 665 The 3-digit HTTP response status code. E.G. `404`.
 666
 667 ### response.httpVersion
 668
 669 The HTTP version of the connected-to server. Probably either
 670 `'1.1'` or `'1.0'`.
 671 Also `response.httpVersionMajor` is the first integer and
 672 `response.httpVersionMinor` is the second.
 673
 674 ### response.headers
 675
 676 The response headers object.
 677
 678 ### response.trailers
 679
 680 The response trailers object. Only populated after the 'end' event.
 681
 682 ### response.setEncoding(encoding=null)
 683
 684 Set the encoding for the response body. Either `'utf8'`, `'ascii'`, or `'base64'`.
 685 Defaults to `null`, which means that the `'data'` event will emit a `Buffer` object..
 686
 687 ### response.pause()
 688
 689 Pauses response from emitting events.  Useful to throttle back a download.
 690
 691 ### response.resume()
 692
 693 Resumes a paused response.