diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-09-07 11:33:05 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-06 13:59:35 -0700 |
| commit | 34be2c20a62e94e3a2815dd869609554b3922477 (patch) | |
| tree | 55eb5ae8aec9d9213f502bffda50abaa11b06bc2 /docs/man/nng_ws.7.adoc | |
| parent | 74adece2303ab7c2b05459c7ff24b362e9660068 (diff) | |
| download | nng-34be2c20a62e94e3a2815dd869609554b3922477.tar.gz nng-34be2c20a62e94e3a2815dd869609554b3922477.tar.bz2 nng-34be2c20a62e94e3a2815dd869609554b3922477.zip | |
Remove the legacy transport registration functions.
This also allows to remove most of the transport headers.
Only zerotier.h sticks around, and only for now. (We expect to
eject it into a separate module.)
Diffstat (limited to 'docs/man/nng_ws.7.adoc')
| -rw-r--r-- | docs/man/nng_ws.7.adoc | 21 |
1 files changed, 1 insertions, 20 deletions
diff --git a/docs/man/nng_ws.7.adoc b/docs/man/nng_ws.7.adoc index 171ec934..b63041ad 100644 --- a/docs/man/nng_ws.7.adoc +++ b/docs/man/nng_ws.7.adoc @@ -1,6 +1,6 @@ = nng_ws(7) // -// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2024 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> // // This document is supplied under the terms of the MIT License, a @@ -13,16 +13,6 @@ nng_ws - WebSocket transport -== SYNOPSIS - -[source,c] ----- -#include <nng/transport/websocket/ws.h> - -int nng_ws_register(void); -int nng_wss_register(void); ----- - == DESCRIPTION (((WebSocket)))(((transport, _ws_ and _wss_))) @@ -34,15 +24,6 @@ Both IPv4 and IPv6 are supported when the underlying platform also supports it. The protocol details are documented in http://nanomsg.org/rfcs/sp-websocket-v1.html[WebSocket Mapping for Scalability Protocols]. -=== Registration - -Depending upon how the library was built, it may be necessary to -register the transport by calling xref:nng_ws_register.3.adoc[`nng_ws_register()`]. - -If ((TLS)) support is enabled in the library, secure WebSockets (over TLS v1.2) -can be used as well, but the secure transport may have to be registered using -the xref:nng_wss_register.3.adoc[`nng_wss_register()`] function. - === URI Format (((URI, `ws://`))) |