summaryrefslogtreecommitdiff
path: root/docs/ref/str/nng_stream_send.adoc
blob: 48352c34f26be170af8043313df3b108c453f074 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
## nng_stream_send

Send to byte stream.

### Synopsis

```c
#include <nng/nng.h>

void nng_stream_send(nng_stream *s, nng_aio *aio);
```

### Description

The `nng_stream_send` function starts an asynchronous send over the byte stream _s_ from the scatter/gather vector located in the asynchronous I/O structure _aio_.

NOTE: The xref:../aio/nng_aio_set_iov.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:../aio/nng_aio_result.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:../aio/nng_aio_count.adoc[`nng_aio_count`].

### 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

xref:../aio/index.adoc[Asynchronous I/O],
xref:nng_aio_count.adoc[nng_aio_count],
xref:nng_aio_result.adoc[nng_aio_result],
xref:nng_aio_set_iov.adoc[nng_aio_set_iov]