From 3fd24aae784e12dc83c8344b8459c34200ab077c Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Tue, 31 Dec 2024 17:48:05 -0800 Subject: [PATCH] docs: remove some old converted content --- docs/man/nng_socket_id.3.adoc | 51 ----------------------- docs/man/nng_stream.5.adoc | 77 ----------------------------------- 2 files changed, 128 deletions(-) delete mode 100644 docs/man/nng_socket_id.3.adoc delete mode 100644 docs/man/nng_stream.5.adoc diff --git a/docs/man/nng_socket_id.3.adoc b/docs/man/nng_socket_id.3.adoc deleted file mode 100644 index 3501f6b29..000000000 --- a/docs/man/nng_socket_id.3.adoc +++ /dev/null @@ -1,51 +0,0 @@ -= nng_socket_id(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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_socket_id - return numeric socket identifier - -== SYNOPSIS - -[source, c] ----- -#include - -int nng_socket_id(nng_socket s); ----- - -== DESCRIPTION - -The `nng_socket_id()` function returns a positive identifier for the socket _s_, -if it is valid. -Otherwise it returns `-1`. - -NOTE: A socket is considered valid if it was ever opened with a protocol -constructor, such as the xref:nng_req_open.3.adoc[`nng_req0_open()`] function. -Sockets that are allocated on the stack or statically should be -initialized with the macro -xref:nng_socket.5.adoc#NNG_SOCKET_INITIALIZER[`NNG_SOCKET_INITIALIZER`] -to ensure that they cannot be confused with a valid socket before they are opened. - -== RETURN VALUES - -This function returns the positive value for the socket identifier, or -`-1` if the socket is invalid. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:nng_socket.5.adoc[nng_socket(5)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_stream.5.adoc b/docs/man/nng_stream.5.adoc deleted file mode 100644 index b3921e468..000000000 --- a/docs/man/nng_stream.5.adoc +++ /dev/null @@ -1,77 +0,0 @@ -= nng_stream(5) -// -// Copyright 2020 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_stream - byte stream - -== SYNOPSIS - -[source, c] ----- -#include - -typedef struct nng_stream nng_stream; ----- - -== DESCRIPTION - -An `nng_stream` (((byte stream))) represents a byte stream. -This may correspond to an underlying connection such a TCP connection or -a connected UNIX domain socket or named pipe. - -NOTE: The `nng_stream` object is used for raw byte stream connections, and -should not be confused with a pipe object created on -xref:nng_socket.5.adoc[socket] using the -xref:nng_listen.3.adoc[`nng_listen()`], -xref:nng_dial.3.adoc[`nng_dial()`] or related functions. - -These objects are created either establishing an outgoing connection -with -xref:nng_stream_dialer_dial.3str.adoc[`nng_stream_dialer_dial()`] -or by accepting in incoming connection with -xref:nng_stream_listener_accept.3str.adoc[`nng_stream_listener_accept()`]. - -Byte streams are reliable in that data -will not be delivered out of order, or with portions missing. - -Data can be sent using -xref:nng_stream_send.3str.adoc[`nng_stream_send()`] or -received with -xref:nng_stream_recv.3str.adoc[`nng_stream_recv()`]. - -When the connection is no longer needed, it should be freed with -xref:nng_stream_free.3str.adoc[`nng_stream_free()`]. - -TIP: It is possible to close the connection, without freeing it, by -using -xref:nng_stream_close.3str.adoc[`nng_stream_close()`]. - -Byte streams may, depending on the underlying technology, -support various read-only -xref:nng_options.5.adoc[options], which -can be accessed using the -xref:nng_stream_get.3str.adoc[`nng_stream_get()`]. - -== SEE ALSO - -[.text-left] -xref:libnng.3.adoc[libnng(3)], -xref:nng_stream_close.3str.adoc[nng_stream_close(3str)], -xref:nng_stream_dialer_dial.3str.adoc[nng_stream_dialer_dial(3str)], -xref:nng_stream_free.3str.adoc[nng_stream_free(3str)], -xref:nng_stream_get.3str.adoc[nng_stream_get(3str)], -xref:nng_stream_listener_accept.3str.adoc[nng_stream_listener_accept(3str)], -xref:nng_stream_recv.3str.adoc[nng_stream_recv(3str)], -xref:nng_stream_send.3str.adoc[nng_stream_send(3str)], -xref:nng_options.5.adoc[nng_options(5)], -xref:nng.7.adoc[nng(7)],