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. --- docs/man/nng_ipc_setopt.3ipc.adoc | 57 --------------------------------------- 1 file changed, 57 deletions(-) delete mode 100644 docs/man/nng_ipc_setopt.3ipc.adoc (limited to 'docs/man/nng_ipc_setopt.3ipc.adoc') diff --git a/docs/man/nng_ipc_setopt.3ipc.adoc b/docs/man/nng_ipc_setopt.3ipc.adoc deleted file mode 100644 index b22bda98..00000000 --- a/docs/man/nng_ipc_setopt.3ipc.adoc +++ /dev/null @@ -1,57 +0,0 @@ -= nng_ipc_setopt(3ipc) -// -// Copyright 2019 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// Copyright 2019 Devolutions -// -// 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_setopt - set option on IPC connection - -== SYNOPSIS - -[source, c] ----- -#include -#include - -int nng_ipc_setopt(nng_ipc *conn, const char *name, const void *data, size_t size); ----- - -== DESCRIPTION - -The `nng_ipc_setopt()` is used to set the option _name_ for the -<> _conn_. -The value to set is copied from _data_, which should be _size_ bytes -in length. - -=== Options - -There are no options defined for modification on IPC connections at this time. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_ECLOSED`:: The connection _conn_ is closed. -`NNG_EINVAL`:: Either _data_ or _size_ are invalid. -`NNG_ENOTSUP`:: The option _name_ is not supported. -`NNG_EREADONLY`:: The option _name_ may not be modified. - -== SEE ALSO - -[.text-left] -<>, -<>, -<>, -<>, -<> -- cgit v1.2.3-70-g09d2