diff options
Diffstat (limited to 'docs/man/nng_ipc_dialer_alloc.3ipc.adoc')
| -rw-r--r-- | docs/man/nng_ipc_dialer_alloc.3ipc.adoc | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/man/nng_ipc_dialer_alloc.3ipc.adoc b/docs/man/nng_ipc_dialer_alloc.3ipc.adoc new file mode 100644 index 00000000..6b2c1fbb --- /dev/null +++ b/docs/man/nng_ipc_dialer_alloc.3ipc.adoc @@ -0,0 +1,49 @@ += nng_ipc_dialer_alloc(3ipc) +// +// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// Copyright 2019 Devolutions <info@devolutions.net> +// +// 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_dialer_alloc - allocate IPC dialer + +== SYNOPSIS + +[source, c] +---- +#include <nng/nng.h> +#include <nng/supplemental/ipc/ipc.h> + +int nng_ipc_dialer_alloc(nng_ipc_dialer *dp); +---- + +== DESCRIPTION + +The `nng_ipc_dialer_alloc()` allocates an IPC dialer, which can be used +to create outgoing connections over IPC, 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_ipc_dialer_close.3ipc#,nng_ipc_dialer_close(3ipc)>>, +<<nng_ipc_dialer_dial.3ipc#,nng_ipc_dialer_dial(3ipc)>>, +<<nng_ipc_dialer_free.3ipc#,nng_ipc_dialer_free(3ipc)>>, +<<nng_ipc_dialer.5#,nng_ipc_dialer(5)>>, +<<nng_strerror.3#,nng_strerror(3)>> |