Browse Source

doc: fix http response event, Agent#getName

Removes the options block from the http 'response' event and attaches
it to Agent#getName where it belongs. Removes socketPath and documents
localAddress option.

PR-URL: https://github.com/nodejs/node/pull/5993
Reviewed-By: James M Snell <jasnell@gmail.com>
process-exit-stdio-flushing
Matthew Douglass 9 years ago
committed by James M Snell
parent
commit
a974e852c6
  1. 13
      doc/api/http.markdown

13
doc/api/http.markdown

@ -152,6 +152,13 @@ connection can be reused. In the http agent, this returns
CA, cert, ciphers, and other HTTPS/TLS-specific options that determine CA, cert, ciphers, and other HTTPS/TLS-specific options that determine
socket reusability. socket reusability.
Options:
- `host`: A domain name or IP address of the server to issue the request to.
- `port`: Port of remote server.
- `localAddress`: Local interface to bind for network connections when issuing
the request.
### agent.maxFreeSockets ### agent.maxFreeSockets
By default set to 256. For Agents supporting HTTP KeepAlive, this By default set to 256. For Agents supporting HTTP KeepAlive, this
@ -303,12 +310,6 @@ the client should send the request body.
Emitted when a response is received to this request. This event is emitted only Emitted when a response is received to this request. This event is emitted only
once. The `response` argument will be an instance of [`http.IncomingMessage`][]. once. The `response` argument will be an instance of [`http.IncomingMessage`][].
Options:
- `host`: A domain name or IP address of the server to issue the request to.
- `port`: Port of remote server.
- `socketPath`: Unix Domain Socket (use one of host:port or socketPath)
### Event: 'socket' ### Event: 'socket'
`function (socket) { }` `function (socket) { }`

Loading…
Cancel
Save