aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/man/nng_close.3.adoc8
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.