From 5cf750697624d4fd63cfe26921209d7c30e1a2d2 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
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_send.3ipc.adoc | 71 -----------------------------------------
 1 file changed, 71 deletions(-)
 delete mode 100644 docs/man/nng_ipc_send.3ipc.adoc

(limited to 'docs/man/nng_ipc_send.3ipc.adoc')

diff --git a/docs/man/nng_ipc_send.3ipc.adoc b/docs/man/nng_ipc_send.3ipc.adoc
deleted file mode 100644
index d606ddd9..00000000
--- a/docs/man/nng_ipc_send.3ipc.adoc
+++ /dev/null
@@ -1,71 +0,0 @@
-= nng_ipc_send(3ipc)
-//
-// Copyright 2018 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_send - send to IPC connection
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-void nng_ipc_send(nng_ipc *conn, nng_aio *aio);
-----
-
-== DESCRIPTION
-
-The `nng_ipc_send()` function starts an asynchronous send over the
-IPC connection _conn_ from the scatter/gather vector located in the
-asynchronous I/O structure _aio_.
-
-NOTE: The <<nng_aio_set_iov.3#,`nng_aio_set_iov()`>> function must have been
-called first, to set the scatter/gather vector for _aio_.
-
-This function returns immediately, with no return value.
-Completion of the operation is signaled via the _aio_, and the final
-result may be obtained via <<nng_aio_result.3#,`nng_aio_result()`>>.
-That result will either be zero or an error code.
-
-The I/O operation completes as soon as at least one byte has been
-sent, or an error has occurred.
-Therefore, the number of bytes sent may be less than requested.
-The actual number of bytes sent can be determined with
-<<nng_aio_count.3#,`nng_aio_count()`>>.
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-[horizontal]
-`NNG_ECANCELED`:: The operation was canceled.
-`NNG_ECLOSED`:: The connection was closed.
-`NNG_ECONNRESET`:: The peer closed the connection.
-`NNG_EINVAL`:: The _aio_ does not contain a valid scatter/gather vector.
-`NNG_ENOMEM`:: Insufficient free memory to perform the operation.
-`NNG_ETIMEDOUT`:: Timeout waiting for data from the connection.
-
-== SEE ALSO
-
-[.text-left]
-<<nng_aio_alloc.3#,nng_aio_alloc(3)>>,
-<<nng_aio_count.3#,nng_aio_count(3)>>,
-<<nng_aio_result.3#,nng_aio_result(3)>>,
-<<nng_aio_set_iov.3#,nng_aio_set_iov(3)>>,
-<<nng_ipc_close.3ipc#,nng_ipc_close(3ipc)>>,
-<<nng_ipc_recv.3ipc#,nng_ipc_recv(3ipc)>>,
-<<nng_ipc.5#,nng_ipc(5)>>,
-<<nng_strerror.3#,nng_strerror(3)>>
-- 
cgit v1.2.3-70-g09d2

