From 5cf750697624d4fd63cfe26921209d7c30e1a2d2 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Mon, 21 Jan 2019 22:40:10 -0800 Subject: 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. --- src/core/stream.h | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 src/core/stream.h (limited to 'src/core/stream.h') diff --git a/src/core/stream.h b/src/core/stream.h new file mode 100644 index 00000000..18914979 --- /dev/null +++ b/src/core/stream.h @@ -0,0 +1,69 @@ +// +// Copyright 2019 Staysail Systems, Inc. +// +// This software 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. +// + +#ifndef CORE_STREAM_H +#define CORE_STREAM_H + +// This provides an abstraction for byte streams, allowing polymorphic +// use of them in rather flexible contexts. + +#include "core/nng_impl.h" + +// Private property operations (these include the types.) +extern int nni_stream_getx( + nng_stream *, const char *, void *, size_t *, nni_type); +extern int nni_stream_setx( + nng_stream *, const char *, const void *, size_t, nni_type); + +extern int nni_stream_dialer_getx( + nng_stream_dialer *, const char *, void *, size_t *, nni_type); +extern int nni_stream_dialer_setx( + nng_stream_dialer *, const char *, const void *, size_t, nni_type); + +extern int nni_stream_listener_getx( + nng_stream_listener *, const char *, void *, size_t *, nni_type); +extern int nni_stream_listener_setx( + nng_stream_listener *, const char *, const void *, size_t, nni_type); + +extern int nni_stream_checkopt( + const char *, const char *, const void *, size_t, nni_type); + +// This is the common implementation of a connected byte stream. It should be +// the first element of any implementation. Applications are not permitted to +// access it directly. +struct nng_stream { + void (*s_free)(void *); + void (*s_close)(void *); + void (*s_recv)(void *, nng_aio *); + void (*s_send)(void *, nng_aio *); + int (*s_getx)(void *, const char *, void *, size_t *, nni_type); + int (*s_setx)(void *, const char *, const void *, size_t, nni_type); +}; + +// Dialer implementation. Stream dialers create streams. +struct nng_stream_dialer { + void (*sd_free)(void *); + void (*sd_close)(void *); + void (*sd_dial)(void *, nng_aio *); + int (*sd_getx)(void *, const char *, void *, size_t *, nni_type); + int (*sd_setx)(void *, const char *, const void *, size_t, nni_type); +}; + +// Listener implementation. Stream listeners accept connections and create +// streams. +struct nng_stream_listener { + void (*sl_free)(void *); + void (*sl_close)(void *); + int (*sl_listen)(void *); + void (*sl_accept)(void *, nng_aio *); + int (*sl_getx)(void *, const char *, void *, size_t *, nni_type); + int (*sl_setx)(void *, const char *, const void *, size_t, nni_type); +}; + +#endif // CORE_STREAM_H -- cgit v1.2.3-70-g09d2