From f73cd76f54b8aead38689e0ea805d5d805dfbe96 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 30 Mar 2024 23:07:20 -0700 Subject: Staging work. converted nng_ipc. --- docs/man/nng_stream_send.3str.adoc | 74 -------------------------------------- 1 file changed, 74 deletions(-) delete mode 100644 docs/man/nng_stream_send.3str.adoc (limited to 'docs/man/nng_stream_send.3str.adoc') diff --git a/docs/man/nng_stream_send.3str.adoc b/docs/man/nng_stream_send.3str.adoc deleted file mode 100644 index 5a53e63c..00000000 --- a/docs/man/nng_stream_send.3str.adoc +++ /dev/null @@ -1,74 +0,0 @@ -= nng_stream_send(3str) -// -// 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_send - send to byte stream - -== SYNOPSIS - -[source, c] ----- -#include - -void nng_stream_send(nng_stream *s, nng_aio *aio); ----- - -== DESCRIPTION - -The `nng_stream_send()` function starts an asynchronous send over the -xref:nng_stream.5.adoc[byte stream] _s_ -from the scatter/gather vector located in the -asynchronous I/O structure _aio_. - -NOTE: The -xref:nng_aio_set_iov.3.adoc[`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 -xref:nng_aio_result.3.adoc[`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 -xref:nng_aio_count.3.adoc[`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] -xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], -xref:nng_aio_count.3.adoc[nng_aio_count(3)], -xref:nng_aio_result.3.adoc[nng_aio_result(3)], -xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov(3)], -xref:nng_strerror.3.adoc[nng_strerror(3)], -xref:nng_stream_close.3str.adoc[nng_stream_close(3str)], -xref:nng_stream_recv.3str.adoc[nng_stream_recv(3str)], -xref:nng_stream.5.adoc[nng_stream(5)] -- cgit v1.2.3-70-g09d2