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_free.3ipc.adoc | 59 -----------------------------------------
 1 file changed, 59 deletions(-)
 delete mode 100644 docs/man/nng_ipc_free.3ipc.adoc

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

diff --git a/docs/man/nng_ipc_free.3ipc.adoc b/docs/man/nng_ipc_free.3ipc.adoc
deleted file mode 100644
index 646122a0..00000000
--- a/docs/man/nng_ipc_free.3ipc.adoc
+++ /dev/null
@@ -1,59 +0,0 @@
-= nng_ipc_free(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_free - free IPC connection
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-#include <nng/supplemental/ipc/ipc.h>
-
-void nng_ipc_free(nng_ipc *conn);
-----
-
-== DESCRIPTION
-
-The `nng_ipc_free()` function closes the supplied IPC connection, _conn_,
-and frees the underlying resources associated with it.
-
-If any operations are pending (such as <<nng_ipc_send.3ipc#,`nng_ipc_send()`>>
-or <<nng_ipc_recv.3ipc#,`nng_ipc_recv()`>>) they will be terminated with
-an `NNG_ECLOSED` error condition.
-
-WARNING: It is important that the application ensure that no further accesses
-are made to _conn_, as the memory backing it will be reclaimed for other uses.
-
-NOTE: Closing the connection while data is in transmission will likely
-lead to loss of that data.
-There is no automatic linger or flush to ensure that the socket send buffers
-have completely transmitted.
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-<<nng_strerror.3#,nng_strerror(3)>>,
-<<nng_ipc_close.3ipc#,nng_ipc_close(3ipc)>>,
-<<nng_ipc_recv.3ipc#,nng_ipc_recv(3ipc)>>,
-<<nng_ipc_send.3ipc#,nng_ipc_send(3ipc)>>,
-<<nng_ipc.5#,nng_ipc(5)>>
-- 
cgit v1.2.3-70-g09d2

