Skip to content

Commit

Permalink
doc: fix http response event, Agent#getName
Browse files Browse the repository at this point in the history
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: #5993
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
mdouglass authored and Myles Borins committed May 18, 2016
1 parent 292b1b7 commit 6a197ec
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions doc/api/http.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,13 @@ connection can be reused. In the http agent, this returns
CA, cert, ciphers, and other HTTPS/TLS-specific options that determine
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

By default set to 256. For Agents supporting HTTP KeepAlive, this
Expand Down Expand Up @@ -280,12 +287,6 @@ the client should send the request body.
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`][].

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'

`function (socket) { }`
Expand Down

0 comments on commit 6a197ec

Please sign in to comment.