diff options
| author | Garrett D'Amore <garrett@damore.org> | 2019-01-21 22:40:10 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2019-02-16 19:22:27 -0800 |
| commit | 5cf750697624d4fd63cfe26921209d7c30e1a2d2 (patch) | |
| tree | bf11695e5f1ec5e400c87da0cc6ff23935a2eeff /docs/man/nng_ipc_dialer_getopt.3ipc.adoc | |
| parent | ca655b9db689ee0e655248b1a9f166b8db6cc984 (diff) | |
| download | nng-5cf750697624d4fd63cfe26921209d7c30e1a2d2.tar.gz nng-5cf750697624d4fd63cfe26921209d7c30e1a2d2.tar.bz2 nng-5cf750697624d4fd63cfe26921209d7c30e1a2d2.zip | |
fixes #872 create unified nng_stream API
This is a major change, and includes changes to use a polymorphic
stream API for all transports. There have been related bugs fixed
along the way. Additionally the man pages have changed.
The old non-polymorphic APIs are removed now. This is a breaking
change, but the old APIs were never part of any released public API.
Diffstat (limited to 'docs/man/nng_ipc_dialer_getopt.3ipc.adoc')
| -rw-r--r-- | docs/man/nng_ipc_dialer_getopt.3ipc.adoc | 64 |
1 files changed, 0 insertions, 64 deletions
diff --git a/docs/man/nng_ipc_dialer_getopt.3ipc.adoc b/docs/man/nng_ipc_dialer_getopt.3ipc.adoc deleted file mode 100644 index 4a480bb5..00000000 --- a/docs/man/nng_ipc_dialer_getopt.3ipc.adoc +++ /dev/null @@ -1,64 +0,0 @@ -= nng_ipc_dialer_getopt(3ipc) -// -// Copyright 2019 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_getopt - get option from IPC dialer - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> -#include <nng/supplemental/ipc/ipc.h> - -int nng_ipc_getopt(nng_ipc_dialer *d, const char *name, void *data, size_t *sizep); ----- - -== DESCRIPTION - -The `nng_ipc_dialer_getopt()` is used to retrieve the value of the option _name_ for the <<nng_ipc_dialer.5#,IPC dialer>> _d_. -The size of the buffer located at _data_ to receive the copy is passed by the -caller at the location referenced by _sizep_. -If this size is sufficient to hold the entire object, the object is copied into -the buffer specified by _data_. -In either event, the size of the source object (the amount of data copied, -or that would have been copied if sufficient space were available) is stored -at the location of _sizep_. - -=== Options - -There are no predefined options for IPC dialers at this time. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_ECLOSED`:: The dialer is closed. -`NNG_EINVAL`:: There was insufficient space to receive the object. - The amount of data actually needed is returned in _sizep_. -`NNG_ENOTSUP`:: The option _name_ is not supported. -`NNG_EWRITEONLY`:: The option _name_ may not read. - -== SEE ALSO - -[.text-left] -<<nng_ipc_dialer_setopt.3ipc#,nng_ipc_dialer_setopt(3ipc)>>, -<<nng_ipc_getopt.3ipc#,nng_ipc_getopt(3ipc)>>, -<<nng_ipc_options.5#,nng_ipc_options(5)>>, -<<nng_options.5#,nng_options(5)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_ipc.5#,nng_ipc(5)>>, -<<nng_ipc_dialer.5#,nng_ipc_dialer(5)>> |