aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-06-25 17:26:56 -0700
committerGarrett D'Amore <garrett@damore.org>2018-06-25 17:26:56 -0700
commit91f9061ad9289afffb0111c03a8390d0f82d7114 (patch)
treef20b7572c2658c3f39914feaa16c4f1d41853f2b /docs
parent5ecea06b1f39a93735e8b2f711b125d0b1a84d16 (diff)
downloadnng-91f9061ad9289afffb0111c03a8390d0f82d7114.tar.gz
nng-91f9061ad9289afffb0111c03a8390d0f82d7114.tar.bz2
nng-91f9061ad9289afffb0111c03a8390d0f82d7114.zip
fixes #552 man pages do not document NNG_ETIMEDOUT
Diffstat (limited to 'docs')
-rw-r--r--docs/man/nng_recv.3.adoc3
-rw-r--r--docs/man/nng_recvmsg.3.adoc3
-rw-r--r--docs/man/nng_send.3.adoc3
-rw-r--r--docs/man/nng_sendmsg.3.adoc3
4 files changed, 8 insertions, 4 deletions
diff --git a/docs/man/nng_recv.3.adoc b/docs/man/nng_recv.3.adoc
index 301eecc9..c86e9cdf 100644
--- a/docs/man/nng_recv.3.adoc
+++ b/docs/man/nng_recv.3.adoc
@@ -71,13 +71,14 @@ This function returns 0 on success, and non-zero otherwise.
== ERRORS
[horizontal]
-`NNG_EAGAIN`:: The socket _s_ cannot accept data for sending.
+`NNG_EAGAIN`:: The operation would block, but `NNG_FLAG_NONBLOCK` was specified.
`NNG_ECLOSED`:: The socket _s_ is not open.
`NNG_EINVAL`:: An invalid set of _flags_ was specified.
`NNG_EMSGSIZE`:: The received message did not fit in the size provided.
`NNG_ENOMEM`:: Insufficient memory is available.
`NNG_ENOTSUP`:: The protocol for socket _s_ does not support receiving.
`NNG_ESTATE`:: The socket _s_ cannot receive data in this state.
+`NNG_ETIMEDOUT`:: The operation timed out.
== SEE ALSO
diff --git a/docs/man/nng_recvmsg.3.adoc b/docs/man/nng_recvmsg.3.adoc
index d8900c84..bdcb4894 100644
--- a/docs/man/nng_recvmsg.3.adoc
+++ b/docs/man/nng_recvmsg.3.adoc
@@ -52,12 +52,13 @@ This function returns 0 on success, and non-zero otherwise.
== ERRORS
[horizontal]
-`NNG_EAGAIN`:: The socket _s_ cannot accept data for sending.
+`NNG_EAGAIN`:: The operation would block, but `NNG_FLAG_NONBLOCK` was specified.
`NNG_ECLOSED`:: The socket _s_ is not open.
`NNG_EINVAL`:: An invalid set of _flags_ was specified.
`NNG_ENOMEM`:: Insufficient memory is available.
`NNG_ENOTSUP`:: The protocol for socket _s_ does not support receiving.
`NNG_ESTATE`:: The socket _s_ cannot receive data in this state.
+`NNG_ETIMEDOUT`:: The operation timed out.
== SEE ALSO
diff --git a/docs/man/nng_send.3.adoc b/docs/man/nng_send.3.adoc
index 03367893..ef31cbbe 100644
--- a/docs/man/nng_send.3.adoc
+++ b/docs/man/nng_send.3.adoc
@@ -79,13 +79,14 @@ This function returns 0 on success, and non-zero otherwise.
== ERRORS
[horizontal]
-`NNG_EAGAIN`:: The socket _s_ cannot accept data for sending.
+`NNG_EAGAIN`:: The operation would block, but `NNG_FLAG_NONBLOCK` was specified.
`NNG_ECLOSED`:: The socket _s_ is not open.
`NNG_EINVAL`:: An invalid set of _flags_ was specified.
`NNG_EMSGSIZE`:: The value of _size_ is too large.
`NNG_ENOMEM`:: Insufficient memory is available.
`NNG_ENOTSUP`:: The protocol for socket _s_ does not support sending.
`NNG_ESTATE`:: The socket _s_ cannot send data in this state.
+`NNG_ETIMEDOUT`:: The operation timed out.
== SEE ALSO
diff --git a/docs/man/nng_sendmsg.3.adoc b/docs/man/nng_sendmsg.3.adoc
index 68351647..10b8d370 100644
--- a/docs/man/nng_sendmsg.3.adoc
+++ b/docs/man/nng_sendmsg.3.adoc
@@ -73,13 +73,14 @@ This function returns 0 on success, and non-zero otherwise.
== ERRORS
[horizontal]
-`NNG_EAGAIN`:: The socket _s_ cannot accept data for sending.
+`NNG_EAGAIN`:: The operation would block, but `NNG_FLAG_NONBLOCK` was specified.
`NNG_ECLOSED`:: The socket _s_ is not open.
`NNG_EINVAL`:: An invalid set of _flags_ was specified.
`NNG_EMSGSIZE`:: The value of _size_ is too large.
`NNG_ENOMEM`:: Insufficient memory is available.
`NNG_ENOTSUP`:: The protocol for socket _s_ does not support sending.
`NNG_ESTATE`:: The socket _s_ cannot send data in this state.
+`NNG_ETIMEDOUT`:: The operation timed out.
== SEE ALSO