From 34be2c20a62e94e3a2815dd869609554b3922477 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 7 Sep 2024 11:33:05 -0700 Subject: 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.) --- docs/man/CMakeLists.txt | 7 ------ docs/man/libnng.3.adoc | 15 ------------ docs/man/nng_inproc.7.adoc | 17 ++------------ docs/man/nng_inproc_register.3.adoc | 47 ------------------------------------- docs/man/nng_ipc.7.adoc | 16 +------------ docs/man/nng_ipc_register.3.adoc | 47 ------------------------------------- docs/man/nng_tcp.7.adoc | 16 +------------ docs/man/nng_tcp_register.3.adoc | 47 ------------------------------------- docs/man/nng_tls.7.adoc | 17 +------------- docs/man/nng_tls_register.3.adoc | 44 ---------------------------------- docs/man/nng_ws.7.adoc | 21 +---------------- docs/man/nng_ws_register.3.adoc | 47 ------------------------------------- docs/man/nng_wss_register.3.adoc | 47 ------------------------------------- docs/man/nng_zerotier.7.adoc | 18 -------------- docs/man/nng_zt_register.3.adoc | 47 ------------------------------------- 15 files changed, 6 insertions(+), 447 deletions(-) delete mode 100644 docs/man/nng_inproc_register.3.adoc delete mode 100644 docs/man/nng_ipc_register.3.adoc delete mode 100644 docs/man/nng_tcp_register.3.adoc delete mode 100644 docs/man/nng_tls_register.3.adoc delete mode 100644 docs/man/nng_ws_register.3.adoc delete mode 100644 docs/man/nng_wss_register.3.adoc delete mode 100644 docs/man/nng_zt_register.3.adoc (limited to 'docs') diff --git a/docs/man/CMakeLists.txt b/docs/man/CMakeLists.txt index 8d48c78f..2a7c4e96 100644 --- a/docs/man/CMakeLists.txt +++ b/docs/man/CMakeLists.txt @@ -104,8 +104,6 @@ if (NNG_ENABLE_DOC) nng_dialer_start nng_free nng_getopt - nng_inproc_register - nng_ipc_register nng_listen nng_listener_close nng_listener_create @@ -188,15 +186,10 @@ if (NNG_ENABLE_DOC) nng_strfree nng_sub_open nng_surveyor_open - nng_tcp_register - nng_tls_register nng_url_clone nng_url_free nng_url_parse nng_version - nng_ws_register - nng_wss_register - nng_zt_register ) set(NNG_MAN3HTTP diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc index 8d006ba8..dde2a118 100644 --- a/docs/man/libnng.3.adoc +++ b/docs/man/libnng.3.adoc @@ -204,20 +204,6 @@ The following functions are used to construct a socket with a specific protocol: |xref:nng_surveyor_open.3.adoc[nng_surveyor_open()]|open a surveyor socket |=== -=== Transports - -The following functions are used to register a transport for use. - -|=== -| xref:nng_inproc_register.3.adoc[nng_inproc_register()]|register inproc transport -| xref:nng_ipc_register.3.adoc[nng_ipc_register()]|register IPC transport -| xref:nng_tcp_register.3.adoc[nng_tcp_register()]|register TCP transport -| xref:nng_tls_register.3.adoc[nng_tls_register()]|register TLS transport -| xref:nng_ws_register.3.adoc[nng_ws_register()]|register WebSocket transport -| xref:nng_wss_register.3.adoc[nng_wss_register()]|register WebSocket Secure transport -| xref:nng_zt_register.3.adoc[nng_zt_register()]|register ZeroTier transport -|=== - === Protocol Contexts The following functions are useful to separate the protocol processing @@ -481,5 +467,4 @@ with TLS support. == SEE ALSO [.text-left] -xref:nng_compat.3compat.adoc[nng_compat(3compat)], xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_inproc.7.adoc b/docs/man/nng_inproc.7.adoc index 833ba353..6cdb07b1 100644 --- a/docs/man/nng_inproc.7.adoc +++ b/docs/man/nng_inproc.7.adoc @@ -1,6 +1,6 @@ = nng_inproc(7) // -// Copyright 2019 Staysail Systems, Inc. +// Copyright 2024 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // // This document is supplied under the terms of the MIT License, a @@ -13,15 +13,6 @@ nng_inproc - intra-process transport -== SYNOPSIS - -[source,c] ----- -#include - -int nng_inproc_register(void); ----- - == DESCRIPTION (((transport, _inproc_))) @@ -34,12 +25,8 @@ to slower transports when data must be moved within the same process. This transport tries hard to avoid copying data, and thus is very light-weight. -=== Registration - -This transport is generally built-in to the core, so -no extra steps to use it should be necessary. - === URI Format + (((URI, `inproc://`))) This transport uses URIs using the scheme `inproc://`, followed by an arbitrary string of text, terminated by a `NUL` byte. diff --git a/docs/man/nng_inproc_register.3.adoc b/docs/man/nng_inproc_register.3.adoc deleted file mode 100644 index 8379a4e8..00000000 --- a/docs/man/nng_inproc_register.3.adoc +++ /dev/null @@ -1,47 +0,0 @@ -= nng_inproc_register(3) -// -// Copyright 2021 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_inproc_register - register inproc transport - -== SYNOPSIS - -[source,c] ----- -#include - -int nng_inproc_register(void); ----- - -== DESCRIPTION - -The `nng_inproc_register()` function registers the -((_inproc_ transport))(((transport, _inproc_))) for use. - -NOTE: This function is deprecated, and may be removed from a future release. -It is no longer necessary to explicitly register transports. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_ENOMEM`:: Insufficient memory is available. -`NNG_ENOTSUP`:: The transport is not supported. - -== SEE ALSO - -[.text-left] -xref:nng_inproc.7.adoc[nng_inproc(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_ipc.7.adoc b/docs/man/nng_ipc.7.adoc index c085e4d2..456ea547 100644 --- a/docs/man/nng_ipc.7.adoc +++ b/docs/man/nng_ipc.7.adoc @@ -1,6 +1,6 @@ = nng_ipc(7) // -// Copyright 2023 Staysail Systems, Inc. +// Copyright 2024 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // // This document is supplied under the terms of the MIT License, a @@ -13,15 +13,6 @@ nng_ipc - IPC transport -== SYNOPSIS - -[source,c] ----- -#include - -int nng_ipc_register(void); ----- - == DESCRIPTION (((IPC)))(((transport, _ipc_))) @@ -33,11 +24,6 @@ Other platforms may have different implementation strategies. // We need to insert a reference to the nanomsg RFC. -=== Registration - -This transport is generally built-in to the core, so -no extra steps to use it should be necessary. - === URI Formats ==== Traditional Names diff --git a/docs/man/nng_ipc_register.3.adoc b/docs/man/nng_ipc_register.3.adoc deleted file mode 100644 index 64da4b00..00000000 --- a/docs/man/nng_ipc_register.3.adoc +++ /dev/null @@ -1,47 +0,0 @@ -= nng_ipc_register(3) -// -// Copyright 2021 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_ipc_register - register ipc transport - -== SYNOPSIS - -[source,c] ----- -#include - -int nng_ipc_register(void); ----- - -== DESCRIPTION - -The `nng_ipc_register()` function registers the -((_ipc_ transport))(((transport, _ipc_))) for use. - -NOTE: This function is deprecated, and may be removed from a future release. -It is no longer necessary to explicitly register transports. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_ENOMEM`:: Insufficient memory is available. -`NNG_ENOTSUP`:: The transport is not supported. - -== SEE ALSO - -[.text-left] -xref:nng_ipc.7.adoc[nng_ipc(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tcp.7.adoc b/docs/man/nng_tcp.7.adoc index c1b9a439..a5855f77 100644 --- a/docs/man/nng_tcp.7.adoc +++ b/docs/man/nng_tcp.7.adoc @@ -1,6 +1,6 @@ = nng_tcp(7) // -// Copyright 2019 Staysail Systems, Inc. +// Copyright 2024 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // // This document is supplied under the terms of the MIT License, a @@ -13,15 +13,6 @@ nng_tcp - TCP/IP transport -== SYNOPSIS - -[source,c] ----- -#include - -int nng_tcp_register(void); ----- - == DESCRIPTION (((transport, _tcp_))) @@ -31,11 +22,6 @@ Both IPv4 and IPv6 are supported when the underlying platform also supports it. // We need to insert a reference to the nanomsg RFC. -=== Registration - -This transport is generally built-in to the core of _NNG_, so -no extra steps to use it should be necessary. - === URI Format (((URI, `tcp://`))) diff --git a/docs/man/nng_tcp_register.3.adoc b/docs/man/nng_tcp_register.3.adoc deleted file mode 100644 index 3da671a9..00000000 --- a/docs/man/nng_tcp_register.3.adoc +++ /dev/null @@ -1,47 +0,0 @@ -= nng_tcp_register(3) -// -// Copyright 2021 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_tcp_register - register tcp transport - -== SYNOPSIS - -[source,c] ----- -#include - -int nng_tcp_register(void); ----- - -== DESCRIPTION - -The `nng_tcp_register()` function registers the -((_tcp_ transport))(((transport, _tcp_))) for use. - -NOTE: This function is deprecated, and may be removed from a future release. -It is no longer necessary to explicitly register transports. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_ENOMEM`:: Insufficient memory is available. -`NNG_ENOTSUP`:: The transport is not supported. - -== SEE ALSO - -[.text-left] -xref:nng_tcp.7.adoc[nng_tcp(7)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_tls.7.adoc b/docs/man/nng_tls.7.adoc index 017af4fc..0da590ac 100644 --- a/docs/man/nng_tls.7.adoc +++ b/docs/man/nng_tls.7.adoc @@ -1,6 +1,6 @@ = nng_tls(7) // -// Copyright 2019 Staysail Systems, Inc. +// Copyright 2024 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // // This document is supplied under the terms of the MIT License, a @@ -13,15 +13,6 @@ nng_tls - TLS transport -== SYNOPSIS - -[source,c] ----- -#include - -int nng_tls_register(void); ----- - == DESCRIPTION (((TLS)))(((Transport Layer Security)))(((transport, _tls_))) @@ -34,12 +25,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-tls-v1.html[TLS Mapping for Scalability Protocols]. -=== Registration - -Depending upon how the library was built, it may be necessary to -register the transport by calling -xref:nng_tls_register.3.adoc[`nng_tls_register()`]. - === Availability The _tls_ transport depends on the use of an external library. diff --git a/docs/man/nng_tls_register.3.adoc b/docs/man/nng_tls_register.3.adoc deleted file mode 100644 index bfe27e05..00000000 --- a/docs/man/nng_tls_register.3.adoc +++ /dev/null @@ -1,44 +0,0 @@ -= nng_tls_register(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_tls_register - register tls transport - -== SYNOPSIS - -[source,c] ----- -#include - -int nng_tls_register(void); ----- - -== DESCRIPTION - -The `nng_tls_register()` function registers the -((_tls_ transport))(((transport, _tls_))) for use. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_ENOMEM`:: Insufficient memory is available. -`NNG_ENOTSUP`:: The transport is not supported. - -== SEE ALSO - -[.text-left] -xref:nng_tls.7.adoc[nng_tls(7)], -xref:nng.7.adoc[nng(7)] 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. +// Copyright 2024 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // // This document is supplied under the terms of the MIT License, a @@ -13,16 +13,6 @@ nng_ws - WebSocket transport -== SYNOPSIS - -[source,c] ----- -#include - -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://`))) diff --git a/docs/man/nng_ws_register.3.adoc b/docs/man/nng_ws_register.3.adoc deleted file mode 100644 index 7a9cc1f3..00000000 --- a/docs/man/nng_ws_register.3.adoc +++ /dev/null @@ -1,47 +0,0 @@ -= nng_ws_register(3) -// -// Copyright 2021 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_ws_register - register WebSocket transport - -== SYNOPSIS - -[source,c] ----- -#include - -int nng_ws_register(void); ----- - -== DESCRIPTION - -The `nng_ws_register()` function registers the -((_ws_ transport))(((transport, _ws_))) for use. - -NOTE: This function is deprecated, and may be removed from a future release. -It is no longer necessary to explicitly register transports. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_ENOMEM`:: Insufficient memory is available. -`NNG_ENOTSUP`:: The transport is not supported. - -== SEE ALSO - -[.text-left] -xref:nng_ws.7.adoc[nng_ws(7)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_wss_register.3.adoc b/docs/man/nng_wss_register.3.adoc deleted file mode 100644 index 856fe1c0..00000000 --- a/docs/man/nng_wss_register.3.adoc +++ /dev/null @@ -1,47 +0,0 @@ -= nng_wss_register(3) -// -// Copyright 2021 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_wss_register - register WebSocket secure transport - -== SYNOPSIS - -[source,c] ----- -#include - -int nng_wss_register(void); ----- - -== DESCRIPTION - -The `nng_wss_register()` function registers the -((_wss_ transport))(((transport, _wss_))) for use. - -NOTE: This function is deprecated, and may be removed from a future release. -It is no longer necessary to explicitly register transports. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_ENOMEM`:: Insufficient memory is available. -`NNG_ENOTSUP`:: The transport is not supported. - -== SEE ALSO - -[.text-left] -xref:nng_ws.7.adoc[nng_ws(7)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_zerotier.7.adoc b/docs/man/nng_zerotier.7.adoc index fa8762bf..36cf7f0e 100644 --- a/docs/man/nng_zerotier.7.adoc +++ b/docs/man/nng_zerotier.7.adoc @@ -13,15 +13,6 @@ nng_zerotier - ZeroTier transport -== SYNOPSIS - -[source,c] ----- -#include - -int nng_zt_register(void); ----- - == DESCRIPTION (((ZeroTier)))(((transport, _zt_))) @@ -56,15 +47,6 @@ network. NOTE: This document assumes that the reader is familiar with ZeroTier concepts and administration. -=== Registration - -Depending upon how the library was built, it may be necessary to -register the transport by calling -xref:nng_zt_register.3.adoc[`nng_zt_register()`]. -This function -returns zero on success, or an nng error value if the transport -cannot be initialized for any reason. - === URI Format (((URI, `zt://`))) diff --git a/docs/man/nng_zt_register.3.adoc b/docs/man/nng_zt_register.3.adoc deleted file mode 100644 index 9c4a4ac4..00000000 --- a/docs/man/nng_zt_register.3.adoc +++ /dev/null @@ -1,47 +0,0 @@ -= nng_zt_register(3) -// -// Copyright 2021 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_zt_register - register ZeroTier transport - -== SYNOPSIS - -[source,c] ----- -#include - -int nng_zt_register(void); ----- - -== DESCRIPTION - -The `nng_zt_register()` function registers the -((_zt_ transport))(((transport, _zt_))) for use. - -NOTE: This function is deprecated, and may be removed from a future release. -It is no longer necessary to explicitly register transports. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_ENOMEM`:: Insufficient memory is available. -`NNG_ENOTSUP`:: The transport is not supported. - -== SEE ALSO - -[.text-left] -xref:nng_zerotier.7.adoc[nng_zerotier(7)], -xref:nng.7.adoc[nng(7)] -- cgit v1.2.3-70-g09d2