Skip to content

Commit

Permalink
doc: fix links in tls, cluster docs
Browse files Browse the repository at this point in the history
Fix missing links described in #5322.

PR-URL: #5364
Reviewed-By: Roman Reiss <me@silverwind.io>
  • Loading branch information
estliberitas authored and rvagg committed Feb 28, 2016
1 parent f349a9a commit c8725f5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion doc/api/cluster.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ Causes `.suicide` to be set.
Note that after a server is closed, it will no longer accept new connections,
but connections may be accepted by any other listening worker. Existing
connections will be allowed to close as usual. When no more connections exist,
see [server.close()][], the IPC channel to the worker will close allowing it to
see [`server.close()`][], the IPC channel to the worker will close allowing it to
die gracefully.

The above applies *only* to server connections, client connections are not
Expand Down
16 changes: 8 additions & 8 deletions doc/api/tls.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ server-side resources, which makes it a potential vector for denial-of-service
attacks.

To mitigate this, renegotiations are limited to three times every 10 minutes. An
error is emitted on the [tls.TLSSocket][] instance when the threshold is
error is emitted on the [`tls.TLSSocket`][] instance when the threshold is
exceeded. The limits are configurable:

- `tls.CLIENT_RENEG_LIMIT`: renegotiation limit, default is 3.
Expand Down Expand Up @@ -155,7 +155,7 @@ is expensive.

## Class: CryptoStream

Stability: 0 - Deprecated: Use [`tls.TLSSocket()`][] instead.
Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead.

This is an encrypted stream.

Expand Down Expand Up @@ -190,7 +190,7 @@ connections using TLS or SSL.
When a client connection emits an `'error'` event before secure connection is
established - it will be forwarded here.

`tlsSocket` is the [tls.TLSSocket][] that the error originated from.
`tlsSocket` is the [`tls.TLSSocket`][] that the error originated from.

### Event: 'newSession'

Expand Down Expand Up @@ -272,7 +272,7 @@ server.on('resumeSession', (id, cb) => {
`function (tlsSocket) {}`

This event is emitted after a new connection has been successfully
handshaked. The argument is an instance of [tls.TLSSocket][]. It has all the
handshaked. The argument is an instance of [`tls.TLSSocket`][]. It has all the
common stream methods and events.

`socket.authorized` is a boolean value which indicates if the
Expand Down Expand Up @@ -649,7 +649,7 @@ Creates a new client connection to the given `port` and `host` (old API) or
The `callback` parameter will be added as a listener for the
[`'secureConnect'`][] event.

`tls.connect()` returns a [tls.TLSSocket][] object.
`tls.connect()` returns a [`tls.TLSSocket`][] object.

Here is an example of a client of echo server as described previously:

Expand Down Expand Up @@ -756,12 +756,12 @@ and the cleartext one is used as a replacement for the initial encrypted stream.
automatically reject clients with invalid certificates. Only applies to
servers with `requestCert` enabled.

- `options`: An object with common SSL options. See [tls.TLSSocket][].
- `options`: An object with common SSL options. See [`tls.TLSSocket`][].

`tls.createSecurePair()` returns a SecurePair object with `cleartext` and
`encrypted` stream properties.

NOTE: `cleartext` has the same APIs as [tls.TLSSocket][]
NOTE: `cleartext` has the same APIs as [`tls.TLSSocket`][]

## tls.createServer(options[, secureConnectionListener])

Expand Down Expand Up @@ -978,7 +978,7 @@ console.log(ciphers); // ['AES128-SHA', 'AES256-SHA', ...]
[`crypto.getCurves()`]: crypto.html#crypto_crypto_getcurves
[`tls.createServer()`]: #tls_tls_createserver_options_secureconnectionlistener
[`tls.createSecurePair()`]: #tls_tls_createsecurepair_context_isserver_requestcert_rejectunauthorized_options
[`tls.TLSSocket()`]: #tls_class_tls_tlssocket
[`tls.TLSSocket`]: #tls_class_tls_tlssocket
[`net.Server`]: net.html#net_class_net_server
[`net.Socket`]: net.html#net_class_net_socket
[`net.Server.address()`]: net.html#net_server_address
Expand Down

0 comments on commit c8725f5

Please sign in to comment.