diff options
Diffstat (limited to 'docs/man/nng_tls.5.adoc')
| -rw-r--r-- | docs/man/nng_tls.5.adoc | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/docs/man/nng_tls.5.adoc b/docs/man/nng_tls.5.adoc index 3e10f315..36395512 100644 --- a/docs/man/nng_tls.5.adoc +++ b/docs/man/nng_tls.5.adoc @@ -33,54 +33,54 @@ stream. NOTE: The `nng_tls` object is used for raw TLS connections, and should not be confused with a pipe object created using the -<<nng_tls.7#,nng_tls(7)>> transport. +xref:nng_tls.7.adoc[nng_tls(7)] transport. TIP: Most NNG applications should not use this, but instead use the -<<nng_tls.7#,nng_tls(7)>> transport instead. +xref:nng_tls.7.adoc[nng_tls(7)] transport instead. These objects are created either establishing an outgoing connection -with <<nng_tls_dialer_dial.3tls#,`nng_tls_dialer_dial()`>> or by +with xref:nng_tls_dialer_dial.3tls.adoc[`nng_tls_dialer_dial()`] or by accepting in incoming connection with -<<nng_tls_listener_accept.3tls#,`nng_tls_listener_accept()`>>. +xref:nng_tls_listener_accept.3tls.adoc[`nng_tls_listener_accept()`]. TLS connections are byte streams, and are "`reliable`" in that data will not be delivered out of order, or with portions missing. -Data can be sent using <<nng_tls_send.3tls#,`nng_tls_send()`>> or -received with <<nng_tls_recv.3tls#,`nng_tls_recv()`>>. +Data can be sent using xref:nng_tls_send.3tls.adoc[`nng_tls_send()`] or +received with xref:nng_tls_recv.3tls.adoc[`nng_tls_recv()`]. When the connection is no longer needed, it should be freed with -<<nng_tls_free.3tls#,`nng_tls_free()`>>. +xref:nng_tls_free.3tls.adoc[`nng_tls_free()`]. TIP: It is possible to close the connection, without freeing it, by -using <<nng_tls_close.3tls#,`nng_tls_close()`>>. +using xref:nng_tls_close.3tls.adoc[`nng_tls_close()`]. === Options The following options are applicable to TLS connections, and may be -accessed using the <<nng_tls_getopt.3tls#,`nng_tls_getopt()`>> and -<<nng_tls_setopt.3tls#,`nng_tls_setopt()`>> functions. +accessed using the xref:nng_tls_getopt.3tls.adoc[`nng_tls_getopt()`] and +xref:nng_tls_setopt.3tls.adoc[`nng_tls_setopt()`] functions. -* <<nng_options.5#NNG_OPT_LOCADDR,`NNG_OPT_LOCADDR`>> -* <<nng_options.5#NNG_OPT_REMADDR,`NNG_OPT_REMADDR`>> -* <<nng_tcp_options.5#NNG_OPT_TCP_KEEPALIVE,`NNG_OPT_TCP_KEEPALIVE`>> -* <<nng_tcp_options.5#NNG_OPT_TCP_NO_DELAY,`NNG_OPT_TCP_NODELAY`>> -* <<nng_tls_options.5#NNG_OPT_TLS_VERIFIED,`NNG_OPT_TLS_VERIFIED`>> +* xref:nng_options.5.adoc#NNG_OPT_LOCADDR[`NNG_OPT_LOCADDR`] +* xref:nng_options.5.adoc#NNG_OPT_REMADDR[`NNG_OPT_REMADDR`] +* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_KEEPALIVE[`NNG_OPT_TCP_KEEPALIVE`] +* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_NO_DELAY[`NNG_OPT_TCP_NODELAY`] +* xref:nng_tls_options.5.adoc#NNG_OPT_TLS_VERIFIED[`NNG_OPT_TLS_VERIFIED`] Other platform specific options may be available as well. == SEE ALSO [.text-left] -<<libnng.3#,libnng(3)>>, -<<nng_tls_close.3tls#,nng_tls_close(3tls)>>, -<<nng_tls_dialer_dial.3tls#,nng_tls_dialer_dial(3tls)>>, -<<nng_tls_free.3tls#,nng_tls_free(3tls)>>, -<<nng_tls_getopt.3tls#,nng_tls_getopt(3tls)>>, -<<nng_tls_listener_accept.3tls#,nng_tls_listener_accept(3tls)>>, -<<nng_tls_recv.3tls#,nng_tls_recv(3tls)>>, -<<nng_tls_send.3tls#,nng_tls_send(3tls)>>, -<<nng_tls_setopt.3tls#,nng_tls_setopt(3tls)>>, -<<nng_options.5#,nng_options(5)>>, -<<nng_tls_options.5#,nng_tls_options(5)>>, -<<nng.7#,nng(7)>> +xref:libnng.3.adoc[libnng(3)], +xref:nng_tls_close.3tls.adoc[nng_tls_close(3tls)], +xref:nng_tls_dialer_dial.3tls.adoc[nng_tls_dialer_dial(3tls)], +xref:nng_tls_free.3tls.adoc[nng_tls_free(3tls)], +xref:nng_tls_getopt.3tls.adoc[nng_tls_getopt(3tls)], +xref:nng_tls_listener_accept.3tls.adoc[nng_tls_listener_accept(3tls)], +xref:nng_tls_recv.3tls.adoc[nng_tls_recv(3tls)], +xref:nng_tls_send.3tls.adoc[nng_tls_send(3tls)], +xref:nng_tls_setopt.3tls.adoc[nng_tls_setopt(3tls)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_tls_options.5.adoc[nng_tls_options(5)], +xref:nng.7.adoc[nng(7)] |