diff options
Diffstat (limited to 'docs/man/nng_tcp_dialer_alloc.3tcp.adoc')
| -rw-r--r-- | docs/man/nng_tcp_dialer_alloc.3tcp.adoc | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/man/nng_tcp_dialer_alloc.3tcp.adoc b/docs/man/nng_tcp_dialer_alloc.3tcp.adoc new file mode 100644 index 00000000..4d06900e --- /dev/null +++ b/docs/man/nng_tcp_dialer_alloc.3tcp.adoc @@ -0,0 +1,48 @@ += nng_tcp_dialer_alloc(3tcp) +// +// 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_tcp_dialer_alloc - allocate TCP dialer + +== SYNOPSIS + +[source, c] +---- +#include <nng/nng.h> +#include <nng/supplemental/tcp/tcp.h> + +int nng_tcp_dialer_alloc(nng_tcp_dialer *dp); +---- + +== DESCRIPTION + +The `nng_tcp_dialer_alloc()` allocates a TCP dialer, which can be used +to create outgoing connections over TCP, and stores a pointer to it +it in the location referenced by _dp_. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +[horizontal] +`NNG_ENOMEM`:: Insufficient free memory exists. + +== SEE ALSO + +[.text-left] +<<nng_tcp_dialer_close.3tcp#,nng_tcp_dialer_close(3tcp)>>, +<<nng_tcp_dialer_dial.3tcp#,nng_tcp_dialer_dial(3tcp)>>, +<<nng_tcp_dialer_free.3tcp#,nng_tcp_dialer_free(3tcp)>>, +<<nng_tcp_dialer.5#,nng_tcp_dialer(5)>>, +<<nng_strerror.3#,nng_strerror(3)>> |