summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-04-06 11:36:55 -0700
committerGarrett D'Amore <garrett@damore.org>2024-04-06 11:36:55 -0700
commit175a87473a80b3376e0100900ba4e8d02fba4bf7 (patch)
tree5e3d8130f87b35a4aebc19a3bbd218680b6f1181 /docs/ref
parent410eba9514235058c42b922ecbf70e63e0a436e4 (diff)
downloadnng-175a87473a80b3376e0100900ba4e8d02fba4bf7.tar.gz
nng-175a87473a80b3376e0100900ba4e8d02fba4bf7.tar.bz2
nng-175a87473a80b3376e0100900ba4e8d02fba4bf7.zip
transport registration docs (deprecated)
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/old/nng_tran_register.adoc33
1 files changed, 33 insertions, 0 deletions
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.