From 524a3f6ec6e1e921c16ff18997ae494cad09f860 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 1 Aug 2021 08:25:58 -0700 Subject: Fix premature transport registration. Mark it deprecated. Originally the idea was to better support having the transports be separate loadable modules. This isn't needed for the builtin transports, so we make the explicit initialization of them deprecated, and document it as such. --- docs/man/nng_inproc_register.3.adoc | 5 ++++- docs/man/nng_ipc_register.3.adoc | 5 ++++- docs/man/nng_tcp_register.3.adoc | 5 ++++- docs/man/nng_ws_register.3.adoc | 5 ++++- docs/man/nng_wss_register.3.adoc | 5 ++++- docs/man/nng_zt_register.3.adoc | 5 ++++- 6 files changed, 24 insertions(+), 6 deletions(-) (limited to 'docs') diff --git a/docs/man/nng_inproc_register.3.adoc b/docs/man/nng_inproc_register.3.adoc index cf9afce2..8379a4e8 100644 --- a/docs/man/nng_inproc_register.3.adoc +++ b/docs/man/nng_inproc_register.3.adoc @@ -1,6 +1,6 @@ = nng_inproc_register(3) // -// Copyright 2018 Staysail Systems, Inc. +// Copyright 2021 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // // This document is supplied under the terms of the MIT License, a @@ -27,6 +27,9 @@ int nng_inproc_register(void); 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. diff --git a/docs/man/nng_ipc_register.3.adoc b/docs/man/nng_ipc_register.3.adoc index cfdf823a..64da4b00 100644 --- a/docs/man/nng_ipc_register.3.adoc +++ b/docs/man/nng_ipc_register.3.adoc @@ -1,6 +1,6 @@ = nng_ipc_register(3) // -// Copyright 2018 Staysail Systems, Inc. +// Copyright 2021 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // // This document is supplied under the terms of the MIT License, a @@ -27,6 +27,9 @@ int nng_ipc_register(void); 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. diff --git a/docs/man/nng_tcp_register.3.adoc b/docs/man/nng_tcp_register.3.adoc index 1a3a8581..3da671a9 100644 --- a/docs/man/nng_tcp_register.3.adoc +++ b/docs/man/nng_tcp_register.3.adoc @@ -1,6 +1,6 @@ = nng_tcp_register(3) // -// Copyright 2018 Staysail Systems, Inc. +// Copyright 2021 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // // This document is supplied under the terms of the MIT License, a @@ -27,6 +27,9 @@ int nng_tcp_register(void); 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. diff --git a/docs/man/nng_ws_register.3.adoc b/docs/man/nng_ws_register.3.adoc index a5f09d97..7a9cc1f3 100644 --- a/docs/man/nng_ws_register.3.adoc +++ b/docs/man/nng_ws_register.3.adoc @@ -1,6 +1,6 @@ = nng_ws_register(3) // -// Copyright 2018 Staysail Systems, Inc. +// Copyright 2021 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // // This document is supplied under the terms of the MIT License, a @@ -27,6 +27,9 @@ int nng_ws_register(void); 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. diff --git a/docs/man/nng_wss_register.3.adoc b/docs/man/nng_wss_register.3.adoc index 14f434d6..856fe1c0 100644 --- a/docs/man/nng_wss_register.3.adoc +++ b/docs/man/nng_wss_register.3.adoc @@ -1,6 +1,6 @@ = nng_wss_register(3) // -// Copyright 2018 Staysail Systems, Inc. +// Copyright 2021 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // // This document is supplied under the terms of the MIT License, a @@ -27,6 +27,9 @@ int nng_wss_register(void); 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. diff --git a/docs/man/nng_zt_register.3.adoc b/docs/man/nng_zt_register.3.adoc index e3cc4060..9c4a4ac4 100644 --- a/docs/man/nng_zt_register.3.adoc +++ b/docs/man/nng_zt_register.3.adoc @@ -1,6 +1,6 @@ = nng_zt_register(3) // -// Copyright 2018 Staysail Systems, Inc. +// Copyright 2021 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // // This document is supplied under the terms of the MIT License, a @@ -27,6 +27,9 @@ int nng_zt_register(void); 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. -- cgit v1.2.3-70-g09d2