diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-03-17 17:28:52 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-03-17 17:28:52 -0700 |
| commit | d759d4726ba8ac0fe8f8711a4015de717eb8a4a2 (patch) | |
| tree | 5580817646c60a992867c14b44409854721e35da /docs/man/nng_zt_register.3.adoc | |
| parent | 2e6f76636e2adbc5e2bc4659a0639d83eb3f2d59 (diff) | |
| download | nng-d759d4726ba8ac0fe8f8711a4015de717eb8a4a2.tar.gz nng-d759d4726ba8ac0fe8f8711a4015de717eb8a4a2.tar.bz2 nng-d759d4726ba8ac0fe8f8711a4015de717eb8a4a2.zip | |
fixes #294 rename nng_zerotier_xxx to nng_zt_xxx
Diffstat (limited to 'docs/man/nng_zt_register.3.adoc')
| -rw-r--r-- | docs/man/nng_zt_register.3.adoc | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/man/nng_zt_register.3.adoc b/docs/man/nng_zt_register.3.adoc new file mode 100644 index 00000000..181429a6 --- /dev/null +++ b/docs/man/nng_zt_register.3.adoc @@ -0,0 +1,42 @@ += nng_zt_register(3) +// +// Copyright 2018 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 +// 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 <nng/transport/zerotier/zerotier.h> + +int nng_zt_register(void); +---- + +== DESCRIPTION + +The `nng_zt_register()` function registers the +((_zt_ transport))(((transport, _zt_))) for use. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_ENOTSUP`:: The transport is not supported. + +== SEE ALSO + +<<nng_zerotier.7#,nng_zerotier(7)>>, +<<nng.7#,nng(7)>> |
