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_stream_dialer.5.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_stream_dialer.5.adoc')
| -rw-r--r-- | docs/man/nng_stream_dialer.5.adoc | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/man/nng_stream_dialer.5.adoc b/docs/man/nng_stream_dialer.5.adoc new file mode 100644 index 00000000..5c1d2e0b --- /dev/null +++ b/docs/man/nng_stream_dialer.5.adoc @@ -0,0 +1,46 @@ += nng_stream_dialer(5) +// +// 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_stream_dialer - byte stream dialer + +== SYNOPSIS + +[source, c] +---- +#include <nng/nng.h> + +typedef struct nng_stream_dialer nng_stream_dialer; +---- + +== DESCRIPTION + +(((byte stream, dialer))) +An `nng_stream_dialer` is a handle to a "`dialer`" for byte streams, +and is responsible for creating +xref:nng_stream.5.adoc[`nng_stream`] objects (corresponding to connected byte +streams) by connecting to remote peers. + +NOTE: The `nng_stream_dialer` object is used for low-level byte stream +connections, and should not be confused with a high-level +xref:nng_dialer.5.adoc[`nng_dialer`] object. + +== SEE ALSO + +[.text-left] +xref:nng_stream_dialer_alloc.3str.adoc[nng_stream_dialer_alloc(3str)], +xref:nng_stream_dialer_close.3str.adoc[nng_stream_dialer_close(3str)], +xref:nng_stream_dialer_dial.3str.adoc[nng_stream_dialer_dial(3str)], +xref:nng_stream_dialer_free.3str.adoc[nng_stream_dialer_free(3str)], +xref:nng_stream.5.adoc[nng_stream(5)], +xref:nng_stream_listener.5.adoc[nng_stream_listener(5)] |