fixes #143 Protocols and transports should be "configurable"

This makes all the protocols and transports optional.  All
of them except ZeroTier are enabled by default, but you can
now disable them (remove from the build) with cmake options.

The test suite is modified so that tests still run as much
as they can, but skip over things caused by missing functionality
from the library (due to configuration).

Further, the constant definitions and prototypes for functions
that are specific to transports or protocols are moved into
appropriate headers, which should be included directly by
applications wishing to use these.

We have also added and improved documentation -- all of the
transports are documented, and several more man pages for
protocols have been added.  (Req/Rep and Surveyor are still
missing.)

2 files changed, 0 insertions, 501 deletions

diff --git a/src/protocol/pipeline/pull.c b/src/protocol/pipeline/pull.c
deleted file mode 100644
index 9685f0a1..00000000
--- a/src/protocol/pipeline/pull.c
+++ /dev/null
@@ -1,242 +0,0 @@
-//
-// Copyright 2017 Garrett D'Amore <garrett@damore.org>
-// Copyright 2017 Capitar IT Group BV <info@capitar.com>
-//
-// 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.
-//
-
-#include <stdlib.h>
-#include <string.h>
-
-#include "core/nng_impl.h"
-
-// Pull protocol.  The PULL protocol is the "read" side of a pipeline.
-
-typedef struct pull_pipe pull_pipe;
-typedef struct pull_sock pull_sock;
-
-static void pull_putq_cb(void *);
-static void pull_recv_cb(void *);
-static void pull_putq(pull_pipe *, nni_msg *);
-
-// A pull_sock is our per-socket protocol private structure.
-struct pull_sock {
-	nni_msgq *urq;
-	int       raw;
-};
-
-// A pull_pipe is our per-pipe protocol private structure.
-struct pull_pipe {
-	nni_pipe * pipe;
-	pull_sock *pull;
-	nni_aio *  putq_aio;
-	nni_aio *  recv_aio;
-};
-
-static int
-pull_sock_init(void **sp, nni_sock *sock)
-{
-	pull_sock *s;
-
-	if ((s = NNI_ALLOC_STRUCT(s)) == NULL) {
-		return (NNG_ENOMEM);
-	}
-	s->raw = 0;
-	s->urq = nni_sock_recvq(sock);
-
-	*sp = s;
-	return (0);
-}
-
-static void
-pull_sock_fini(void *arg)
-{
-	pull_sock *s = arg;
-
-	NNI_FREE_STRUCT(s);
-}
-
-static void
-pull_pipe_fini(void *arg)
-{
-	pull_pipe *p = arg;
-
-	nni_aio_fini(p->putq_aio);
-	nni_aio_fini(p->recv_aio);
-	NNI_FREE_STRUCT(p);
-}
-
-static int
-pull_pipe_init(void **pp, nni_pipe *pipe, void *s)
-{
-	pull_pipe *p;
-	int        rv;
-
-	if ((p = NNI_ALLOC_STRUCT(p)) == NULL) {
-		return (NNG_ENOMEM);
-	}
-	if (((rv = nni_aio_init(&p->putq_aio, pull_putq_cb, p)) != 0) ||
-	    ((rv = nni_aio_init(&p->recv_aio, pull_recv_cb, p)) != 0)) {
-		pull_pipe_fini(p);
-		return (rv);
-	}
-
-	p->pipe = pipe;
-	p->pull = s;
-	*pp     = p;
-	return (0);
-}
-
-static int
-pull_pipe_start(void *arg)
-{
-	pull_pipe *p = arg;
-
-	// Start the pending pull...
-	nni_pipe_recv(p->pipe, p->recv_aio);
-
-	return (0);
-}
-
-static void
-pull_pipe_stop(void *arg)
-{
-	pull_pipe *p = arg;
-
-	nni_aio_stop(p->putq_aio);
-	nni_aio_stop(p->recv_aio);
-}
-
-static void
-pull_recv_cb(void *arg)
-{
-	pull_pipe *p   = arg;
-	nni_aio *  aio = p->recv_aio;
-	nni_msg *  msg;
-
-	if (nni_aio_result(aio) != 0) {
-		// Failed to get a message, probably the pipe is closed.
-		nni_pipe_stop(p->pipe);
-		return;
-	}
-
-	// Got a message... start the put to send it up to the application.
-	msg = nni_aio_get_msg(aio);
-	nni_msg_set_pipe(msg, nni_pipe_id(p->pipe));
-	nni_aio_set_msg(aio, NULL);
-	pull_putq(p, msg);
-}
-
-static void
-pull_putq_cb(void *arg)
-{
-	pull_pipe *p   = arg;
-	nni_aio *  aio = p->putq_aio;
-
-	if (nni_aio_result(aio) != 0) {
-		// If we failed to put, probably NNG_ECLOSED, nothing else
-		// we can do.  Just close the pipe.
-		nni_msg_free(nni_aio_get_msg(aio));
-		nni_aio_set_msg(aio, NULL);
-		nni_pipe_stop(p->pipe);
-		return;
-	}
-
-	nni_pipe_recv(p->pipe, p->recv_aio);
-}
-
-// nni_pull_putq schedules a put operation to the user socket (sendup).
-static void
-pull_putq(pull_pipe *p, nni_msg *msg)
-{
-	pull_sock *s = p->pull;
-
-	nni_aio_set_msg(p->putq_aio, msg);
-
-	nni_msgq_aio_put(s->urq, p->putq_aio);
-}
-
-static void
-pull_sock_open(void *arg)
-{
-	NNI_ARG_UNUSED(arg);
-}
-
-static void
-pull_sock_close(void *arg)
-{
-	NNI_ARG_UNUSED(arg);
-}
-
-static int
-pull_sock_setopt_raw(void *arg, const void *buf, size_t sz)
-{
-	pull_sock *s = arg;
-	return (nni_setopt_int(&s->raw, buf, sz, 0, 1));
-}
-
-static int
-pull_sock_getopt_raw(void *arg, void *buf, size_t *szp)
-{
-	pull_sock *s = arg;
-	return (nni_getopt_int(s->raw, buf, szp));
-}
-
-static void
-pull_sock_send(void *arg, nni_aio *aio)
-{
-	nni_aio_finish_error(aio, NNG_ENOTSUP);
-}
-
-static void
-pull_sock_recv(void *arg, nni_aio *aio)
-{
-	pull_sock *s = arg;
-
-	nni_msgq_aio_get(s->urq, aio);
-}
-
-static nni_proto_pipe_ops pull_pipe_ops = {
-	.pipe_init  = pull_pipe_init,
-	.pipe_fini  = pull_pipe_fini,
-	.pipe_start = pull_pipe_start,
-	.pipe_stop  = pull_pipe_stop,
-};
-
-static nni_proto_sock_option pull_sock_options[] = {
-	{
-	    .pso_name   = NNG_OPT_RAW,
-	    .pso_getopt = pull_sock_getopt_raw,
-	    .pso_setopt = pull_sock_setopt_raw,
-	},
-	// terminate list
-	{ NULL, NULL, NULL },
-};
-
-static nni_proto_sock_ops pull_sock_ops = {
-	.sock_init    = pull_sock_init,
-	.sock_fini    = pull_sock_fini,
-	.sock_open    = pull_sock_open,
-	.sock_close   = pull_sock_close,
-	.sock_send    = pull_sock_send,
-	.sock_recv    = pull_sock_recv,
-	.sock_options = pull_sock_options,
-};
-
-static nni_proto pull_proto = {
-	.proto_version  = NNI_PROTOCOL_VERSION,
-	.proto_self     = { NNI_PROTO_PULL_V0, "pull" },
-	.proto_peer     = { NNI_PROTO_PUSH_V0, "push" },
-	.proto_flags    = NNI_PROTO_FLAG_RCV,
-	.proto_pipe_ops = &pull_pipe_ops,
-	.proto_sock_ops = &pull_sock_ops,
-};
-
-int
-nng_pull0_open(nng_socket *sidp)
-{
-	return (nni_proto_open(sidp, &pull_proto));
-}
diff --git a/src/protocol/pipeline/push.c b/src/protocol/pipeline/push.c
deleted file mode 100644
index 9ff74558..00000000
--- a/src/protocol/pipeline/push.c
+++ /dev/null
@@ -1,259 +0,0 @@
-//
-// Copyright 2017 Garrett D'Amore <garrett@damore.org>
-// Copyright 2017 Capitar IT Group BV <info@capitar.com>
-//
-// 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.
-//
-
-#include <stdlib.h>
-#include <string.h>
-
-#include "core/nng_impl.h"
-
-// Push protocol.  The PUSH protocol is the "write" side of a pipeline.
-// Push distributes fairly, or tries to, by giving messages in round-robin
-// order.
-
-typedef struct push_pipe push_pipe;
-typedef struct push_sock push_sock;
-
-static void push_send_cb(void *);
-static void push_recv_cb(void *);
-static void push_getq_cb(void *);
-
-// An nni_push_sock is our per-socket protocol private structure.
-struct push_sock {
-	nni_msgq *uwq;
-	int       raw;
-};
-
-// An nni_push_pipe is our per-pipe protocol private structure.
-struct push_pipe {
-	nni_pipe *    pipe;
-	push_sock *   push;
-	nni_list_node node;
-
-	nni_aio *aio_recv;
-	nni_aio *aio_send;
-	nni_aio *aio_getq;
-};
-
-static int
-push_sock_init(void **sp, nni_sock *sock)
-{
-	push_sock *s;
-
-	if ((s = NNI_ALLOC_STRUCT(s)) == NULL) {
-		return (NNG_ENOMEM);
-	}
-	s->raw = 0;
-	s->uwq = nni_sock_sendq(sock);
-	*sp    = s;
-	return (0);
-}
-
-static void
-push_sock_fini(void *arg)
-{
-	push_sock *s = arg;
-
-	NNI_FREE_STRUCT(s);
-}
-
-static void
-push_sock_open(void *arg)
-{
-	NNI_ARG_UNUSED(arg);
-}
-
-static void
-push_sock_close(void *arg)
-{
-	NNI_ARG_UNUSED(arg);
-}
-
-static void
-push_pipe_fini(void *arg)
-{
-	push_pipe *p = arg;
-
-	nni_aio_fini(p->aio_recv);
-	nni_aio_fini(p->aio_send);
-	nni_aio_fini(p->aio_getq);
-	NNI_FREE_STRUCT(p);
-}
-
-static int
-push_pipe_init(void **pp, nni_pipe *pipe, void *s)
-{
-	push_pipe *p;
-	int        rv;
-
-	if ((p = NNI_ALLOC_STRUCT(p)) == NULL) {
-		return (NNG_ENOMEM);
-	}
-	if (((rv = nni_aio_init(&p->aio_recv, push_recv_cb, p)) != 0) ||
-	    ((rv = nni_aio_init(&p->aio_send, push_send_cb, p)) != 0) ||
-	    ((rv = nni_aio_init(&p->aio_getq, push_getq_cb, p)) != 0)) {
-		push_pipe_fini(p);
-		return (rv);
-	}
-	NNI_LIST_NODE_INIT(&p->node);
-	p->pipe = pipe;
-	p->push = s;
-	*pp     = p;
-	return (0);
-}
-
-static int
-push_pipe_start(void *arg)
-{
-	push_pipe *p = arg;
-	push_sock *s = p->push;
-
-	if (nni_pipe_peer(p->pipe) != NNI_PROTO_PULL_V0) {
-		return (NNG_EPROTO);
-	}
-
-	// Schedule a receiver.  This is mostly so that we can detect
-	// a closed transport pipe.
-	nni_pipe_recv(p->pipe, p->aio_recv);
-
-	// Schedule a sender.
-	nni_msgq_aio_get(s->uwq, p->aio_getq);
-
-	return (0);
-}
-
-static void
-push_pipe_stop(void *arg)
-{
-	push_pipe *p = arg;
-
-	nni_aio_stop(p->aio_recv);
-	nni_aio_stop(p->aio_send);
-	nni_aio_stop(p->aio_getq);
-}
-
-static void
-push_recv_cb(void *arg)
-{
-	push_pipe *p = arg;
-
-	// We normally expect to receive an error.  If a pipe actually
-	// sends us data, we just discard it.
-	if (nni_aio_result(p->aio_recv) != 0) {
-		nni_pipe_stop(p->pipe);
-		return;
-	}
-	nni_msg_free(nni_aio_get_msg(p->aio_recv));
-	nni_aio_set_msg(p->aio_recv, NULL);
-	nni_pipe_recv(p->pipe, p->aio_recv);
-}
-
-static void
-push_send_cb(void *arg)
-{
-	push_pipe *p = arg;
-	push_sock *s = p->push;
-
-	if (nni_aio_result(p->aio_send) != 0) {
-		nni_msg_free(nni_aio_get_msg(p->aio_send));
-		nni_aio_set_msg(p->aio_send, NULL);
-		nni_pipe_stop(p->pipe);
-		return;
-	}
-
-	nni_msgq_aio_get(s->uwq, p->aio_getq);
-}
-
-static void
-push_getq_cb(void *arg)
-{
-	push_pipe *p   = arg;
-	nni_aio *  aio = p->aio_getq;
-
-	if (nni_aio_result(aio) != 0) {
-		// If the socket is closing, nothing else we can do.
-		nni_pipe_stop(p->pipe);
-		return;
-	}
-
-	nni_aio_set_msg(p->aio_send, nni_aio_get_msg(aio));
-	nni_aio_set_msg(aio, NULL);
-
-	nni_pipe_send(p->pipe, p->aio_send);
-}
-
-static int
-push_sock_setopt_raw(void *arg, const void *buf, size_t sz)
-{
-	push_sock *s = arg;
-	return (nni_setopt_int(&s->raw, buf, sz, 0, 1));
-}
-
-static int
-push_sock_getopt_raw(void *arg, void *buf, size_t *szp)
-{
-	push_sock *s = arg;
-	return (nni_getopt_int(s->raw, buf, szp));
-}
-
-static void
-push_sock_send(void *arg, nni_aio *aio)
-{
-	push_sock *s = arg;
-
-	nni_msgq_aio_put(s->uwq, aio);
-}
-
-static void
-push_sock_recv(void *arg, nni_aio *aio)
-{
-	nni_aio_finish_error(aio, NNG_ENOTSUP);
-}
-
-static nni_proto_pipe_ops push_pipe_ops = {
-	.pipe_init  = push_pipe_init,
-	.pipe_fini  = push_pipe_fini,
-	.pipe_start = push_pipe_start,
-	.pipe_stop  = push_pipe_stop,
-};
-
-static nni_proto_sock_option push_sock_options[] = {
-	{
-	    .pso_name   = NNG_OPT_RAW,
-	    .pso_getopt = push_sock_getopt_raw,
-	    .pso_setopt = push_sock_setopt_raw,
-	},
-	// terminate list
-	{ NULL, NULL, NULL },
-};
-
-static nni_proto_sock_ops push_sock_ops = {
-	.sock_init    = push_sock_init,
-	.sock_fini    = push_sock_fini,
-	.sock_open    = push_sock_open,
-	.sock_close   = push_sock_close,
-	.sock_options = push_sock_options,
-	.sock_send    = push_sock_send,
-	.sock_recv    = push_sock_recv,
-};
-
-static nni_proto push_proto = {
-	.proto_version  = NNI_PROTOCOL_VERSION,
-	.proto_self     = { NNI_PROTO_PUSH_V0, "push" },
-	.proto_peer     = { NNI_PROTO_PULL_V0, "pull" },
-	.proto_flags    = NNI_PROTO_FLAG_SND,
-	.proto_pipe_ops = &push_pipe_ops,
-	.proto_sock_ops = &push_sock_ops,
-};
-
-int
-nng_push0_open(nng_socket *sidp)
-{
-	return (nni_proto_open(sidp, &push_proto));
-}