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 - `socketPath`: Unix Domain Socket (use one of host:port or socketPath)
 392 - `method`: A string specifying the HTTP request method. Possible values:
 393   `'GET'` (default), `'POST'`, `'PUT'`, and `'DELETE'`.
 394 - `path`: Request path. Should include query string and fragments if any.
 395    E.G. `'/index.html?page=12'`
 396 - `headers`: An object containing request headers.
 397 - `agent`: Controls `Agent` behavior. Possible values:
 398  - `undefined` (default): use default `Agent` for this host and port.
 399  - `Agent` object: explicitly use the passed in `Agent`.
 400  - `false`: explicitly generate a new `Agent` for this host and port. `Agent` will not be re-used.
 401
 402 `http.request()` returns an instance of the `http.ClientRequest`
 403 class. The `ClientRequest` instance is a writable stream. If one needs to
 404 upload a file with a POST request, then write to the `ClientRequest` object.
 405
 406 Example:
 407
 408     var options = {
 409       host: 'www.google.com',
 410       port: 80,
 411       path: '/upload',
 412       method: 'POST'
 413     };
 414
 415     var req = http.request(options, function(res) {
 416       console.log('STATUS: ' + res.statusCode);
 417       console.log('HEADERS: ' + JSON.stringify(res.headers));
 418       res.setEncoding('utf8');
 419       res.on('data', function (chunk) {
 420         console.log('BODY: ' + chunk);
 421       });
 422     });
 423
 424     req.on('error', function(e) {
 425       console.log('problem with request: ' + e.message);
 426     });
 427
 428     // write data to request body
 429     req.write('data\n');
 430     req.write('data\n');
 431     req.end();
 432
 433 Note that in the example `req.end()` was called. With `http.request()` one
 434 must always call `req.end()` to signify that you're done with the request -
 435 even if there is no data being written to the request body.
 436
 437 If any error is encountered during the request (be that with DNS resolution,
 438 TCP level errors, or actual HTTP parse errors) an `'error'` event is emitted
 439 on the returned request object.
 440
 441 There are a few special headers that should be noted.
 442
 443 * Sending a 'Connection: keep-alive' will notify Node that the connection to
 444   the server should be persisted until the next request.
 445
 446 * Sending a 'Content-length' header will disable the default chunked encoding.
 447
 448 * Sending an 'Expect' header will immediately send the request headers.
 449   Usually, when sending 'Expect: 100-continue', you should both set a timeout
 450   and listen for the `continue` event. See RFC2616 Section 8.2.3 for more
 451   information.
 452
 453 ## http.get(options, callback)
 454
 455 Since most requests are GET requests without bodies, Node provides this
 456 convenience method. The only difference between this method and `http.request()` is
 457 that it sets the method to GET and calls `req.end()` automatically.
 458
 459 Example:
 460
 461     var options = {
 462       host: 'www.google.com',
 463       port: 80,
 464       path: '/index.html'
 465     };
 466
 467     http.get(options, function(res) {
 468       console.log("Got response: " + res.statusCode);
 469     }).on('error', function(e) {
 470       console.log("Got error: " + e.message);
 471     });
 472
 473
 474 ## http.Agent
 475 ## http.getAgent(options)
 476
 477 `http.request()` uses a special `Agent` for managing multiple connections to
 478 an HTTP server. Normally `Agent` instances should not be exposed to user
 479 code, however in certain situations it's useful to check the status of the
 480 agent. The `http.getAgent()` function allows you to access the agents.
 481
 482 Options:
 483
 484 - `host`: A domain name or IP address of the server to issue the request to.
 485 - `port`: Port of remote server.
 486 - `socketPath`: Unix Domain Socket (use one of host:port or socketPath)
 487
 488 ### Event: 'upgrade'
 489
 490 `function (response, socket, head) { }`
 491
 492 Emitted each time a server responds to a request with an upgrade. If this
 493 event isn't being listened for, clients receiving an upgrade header will have
 494 their connections closed.
 495
 496 A client server pair that show you how to listen for the `upgrade` event using `http.getAgent`:
 497
 498     var http = require('http');
 499     var net = require('net');
 500
 501     // Create an HTTP server
 502     var srv = http.createServer(function (req, res) {
 503       res.writeHead(200, {'Content-Type': 'text/plain'});
 504       res.end('okay');
 505     });
 506     srv.on('upgrade', function(req, socket, upgradeHead) {
 507       socket.write('HTTP/1.1 101 Web Socket Protocol Handshake\r\n' +
 508                    'Upgrade: WebSocket\r\n' +
 509                    'Connection: Upgrade\r\n' +
 510                    '\r\n\r\n');
 511
 512       socket.ondata = function(data, start, end) {
 513         socket.write(data.toString('utf8', start, end), 'utf8'); // echo back
 514       };
 515     });
 516
 517     // now that server is running
 518     srv.listen(1337, '127.0.0.1', function() {
 519
 520       // make a request
 521       var agent = http.getAgent('127.0.0.1', 1337);
 522
 523       var options = {
 524         agent: agent,
 525         port: 1337,
 526         host: '127.0.0.1',
 527         headers: {
 528           'Connection': 'Upgrade',
 529           'Upgrade': 'websocket'
 530         }
 531       };
 532
 533       var req = http.request(options);
 534       req.end();
 535
 536       agent.on('upgrade', function(res, socket, upgradeHead) {
 537         console.log('got upgraded!');
 538         socket.end();
 539         process.exit(0);
 540       });
 541     });
 542
 543
 544 ### agent.maxSockets
 545
 546 By default set to 5. Determines how many concurrent sockets the agent can have open.
 547
 548 ### agent.sockets
 549
 550 An array of sockets currently in use by the Agent. Do not modify.
 551
 552 ### agent.queue
 553
 554 A queue of requests waiting to be sent to sockets.
 555
 556
 557
 558 ## http.ClientRequest
 559
 560 This object is created internally and returned from `http.request()`.  It
 561 represents an _in-progress_ request whose header has already been queued.  The
 562 header is still mutable using the `setHeader(name, value)`, `getHeader(name)`,
 563 `removeHeader(name)` API.  The actual header will be sent along with the first
 564 data chunk or when closing the connection.
 565
 566 To get the response, add a listener for `'response'` to the request object.
 567 `'response'` will be emitted from the request object when the response
 568 headers have been received.  The `'response'` event is executed with one
 569 argument which is an instance of `http.ClientResponse`.
 570
 571 During the `'response'` event, one can add listeners to the
 572 response object; particularly to listen for the `'data'` event. Note that
 573 the `'response'` event is called before any part of the response body is received,
 574 so there is no need to worry about racing to catch the first part of the
 575 body. As long as a listener for `'data'` is added during the `'response'`
 576 event, the entire body will be caught.
 577
 578
 579     // Good
 580     request.on('response', function (response) {
 581       response.on('data', function (chunk) {
 582         console.log('BODY: ' + chunk);
 583       });
 584     });
 585
 586     // Bad - misses all or part of the body
 587     request.on('response', function (response) {
 588       setTimeout(function () {
 589         response.on('data', function (chunk) {
 590           console.log('BODY: ' + chunk);
 591         });
 592       }, 10);
 593     });
 594
 595 This is a `Writable Stream`.
 596
 597 This is an `EventEmitter` with the following events:
 598
 599 ### Event: 'continue'
 600
 601 `function () { }`
 602
 603 Emitted when the server sends a '100 Continue' HTTP response, usually because
 604 the request contained 'Expect: 100-continue'. This is an instruction that
 605 the client should send the request body.
 606
 607 ### Event 'response'
 608
 609 `function (response) { }`
 610
 611 Emitted when a response is received to this request. This event is emitted only once. The
 612 `response` argument will be an instance of `http.ClientResponse`.
 613
 614
 615 ### request.write(chunk, encoding='utf8')
 616
 617 Sends a chunk of the body.  By calling this method
 618 many times, the user can stream a request body to a
 619 server--in that case it is suggested to use the
 620 `['Transfer-Encoding', 'chunked']` header line when
 621 creating the request.
 622
 623 The `chunk` argument should be an array of integers
 624 or a string.
 625
 626 The `encoding` argument is optional and only
 627 applies when `chunk` is a string.
 628
 629
 630 ### request.end([data], [encoding])
 631
 632 Finishes sending the request. If any parts of the body are
 633 unsent, it will flush them to the stream. If the request is
 634 chunked, this will send the terminating `'0\r\n\r\n'`.
 635
 636 If `data` is specified, it is equivalent to calling `request.write(data, encoding)`
 637 followed by `request.end()`.
 638
 639 ### request.abort()
 640
 641 Aborts a request.  (New since v0.3.8.)
 642
 643
 644 ## http.ClientResponse
 645
 646 This object is created when making a request with `http.request()`. It is
 647 passed to the `'response'` event of the request object.
 648
 649 The response implements the `Readable Stream` interface.
 650
 651 ### Event: 'data'
 652
 653 `function (chunk) { }`
 654
 655 Emitted when a piece of the message body is received.
 656
 657
 658 ### Event: 'end'
 659
 660 `function () { }`
 661
 662 Emitted exactly once for each message. No arguments. After
 663 emitted no other events will be emitted on the response.
 664
 665 ### Event: 'close'
 666
 667 `function (err) { }`
 668
 669 Indicates that the underlaying connection was terminated before
 670 `end` event was emitted.
 671 See [http.ServerRequest](#http.ServerRequest)'s `'close'` event for more
 672 information.
 673
 674 ### response.statusCode
 675
 676 The 3-digit HTTP response status code. E.G. `404`.
 677
 678 ### response.httpVersion
 679
 680 The HTTP version of the connected-to server. Probably either
 681 `'1.1'` or `'1.0'`.
 682 Also `response.httpVersionMajor` is the first integer and
 683 `response.httpVersionMinor` is the second.
 684
 685 ### response.headers
 686
 687 The response headers object.
 688
 689 ### response.trailers
 690
 691 The response trailers object. Only populated after the 'end' event.
 692
 693 ### response.setEncoding(encoding=null)
 694
 695 Set the encoding for the response body. Either `'utf8'`, `'ascii'`, or `'base64'`.
 696 Defaults to `null`, which means that the `'data'` event will emit a `Buffer` object..
 697
 698 ### response.pause()
 699
 700 Pauses response from emitting events.  Useful to throttle back a download.
 701
 702 ### response.resume()
 703
 704 Resumes a paused response.