From 175a87473a80b3376e0100900ba4e8d02fba4bf7 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 6 Apr 2024 11:36:55 -0700 Subject: transport registration docs (deprecated) --- docs/man/nng_inproc_register.3.adoc | 47 ------------------------------------- docs/man/nng_ipc_register.3.adoc | 47 ------------------------------------- docs/man/nng_tcp_register.3.adoc | 47 ------------------------------------- docs/man/nng_tls_register.3.adoc | 44 ---------------------------------- docs/man/nng_ws_register.3.adoc | 47 ------------------------------------- docs/man/nng_wss_register.3.adoc | 47 ------------------------------------- docs/man/nng_zt_register.3.adoc | 47 ------------------------------------- docs/ref/old/nng_tran_register.adoc | 33 ++++++++++++++++++++++++++ 8 files changed, 33 insertions(+), 326 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 create mode 100644 docs/ref/old/nng_tran_register.adoc (limited to 'docs') 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_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_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_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_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_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)] diff --git a/docs/ref/old/nng_tran_register.adoc b/docs/ref/old/nng_tran_register.adoc new file mode 100644 index 00000000..a1af0864 --- /dev/null +++ b/docs/ref/old/nng_tran_register.adoc @@ -0,0 +1,33 @@ +## nng_tran_register (deprecated) + +Register transport. + +### Synopsis + +```c +int nng_inproc_register(void); +int nng_ipc_register(void); +int nng_tcp_register(void); +int nng_tls_register(void); +int nng_ws_register(void); +int nng_wss_register(void); +int nng_zt_register(void); +``` + +### Description + +These functions are deprecated. +They will initialize the library if not already initialized, but perform no other useful function. +They provided for compatibility, but may be removed in a future release.footnote:[If the library was built with ((`NNG_ELIDE_DEPRECATED`)) then these functions will not be present. +Functions referring to a transport will also not be present if the corresponding transport was not configured when the library was built.] + +Formerly they were used to register transports for use, but this is no longer necessary. + +### Return Values + +These function returns 0 on success, and non-zero otherwise. + +### Errors + +[horizontal] +`NNG_ENOMEM`:: Insufficient memory to initialize the library. -- cgit v1.2.3-70-g09d2