diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-07-04 09:55:24 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-07-04 09:55:24 -0700 |
| commit | 68d117eb856b42e57cc3e912496d84d7bd8002fd (patch) | |
| tree | c0ba5b5ff2bf3cb21046090bc3663a15a622d1b3 /docs | |
| parent | 77d35b527b509e41f4c9a24d5fd56de02d93a503 (diff) | |
| download | nng-68d117eb856b42e57cc3e912496d84d7bd8002fd.tar.gz nng-68d117eb856b42e57cc3e912496d84d7bd8002fd.tar.bz2 nng-68d117eb856b42e57cc3e912496d84d7bd8002fd.zip | |
fixes #574 nng_close should indicate warning against transmit truncation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/nng_close.3.adoc | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/man/nng_close.3.adoc b/docs/man/nng_close.3.adoc index d7a5a11d..dcad5cd4 100644 --- a/docs/man/nng_close.3.adoc +++ b/docs/man/nng_close.3.adoc @@ -34,6 +34,14 @@ in `NNG_ECLOSED`. Threads waiting for operations on the socket when this call is executed may also return with an `NNG_ECLOSED` result. +NOTE: Closing the socket 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. +It is recommended to wait a brief period after calling +`<<nng_send.3#,nng_send()>>` or similar functions, before calling this +function. + == RETURN VALUES This function returns 0 on success, and non-zero otherwise. |