aboutsummaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2020-12-26 11:54:40 -0800
committerGarrett D'Amore <garrett@damore.org>2020-12-27 17:26:19 -0800
commit3d535b638667ad0fcfff4246fce61c0176a056c4 (patch)
treeec9b5054885e3898ac0f5f3ed203ab49534d11bb /docs/man
parentc3bfec2b38caaf34379a891e0ea30c7e48147c6f (diff)
downloadnng-3d535b638667ad0fcfff4246fce61c0176a056c4.tar.gz
nng-3d535b638667ad0fcfff4246fce61c0176a056c4.tar.bz2
nng-3d535b638667ad0fcfff4246fce61c0176a056c4.zip
fixes #972 Very slow pull/push performance compared to ZMQ
This refactors the pipeline protocol to use lightweight mq instead of the more expensive message queue structure. It also provides nicer backpressure and buffering support. The test suite was updated and converted to NUTS as well. This won't completely close the gap, but it should help quite a bit.
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/nng_push.7.adoc13
1 files changed, 11 insertions, 2 deletions
diff --git a/docs/man/nng_push.7.adoc b/docs/man/nng_push.7.adoc
index 18c48579..b630c2bb 100644
--- a/docs/man/nng_push.7.adoc
+++ b/docs/man/nng_push.7.adoc
@@ -1,6 +1,6 @@
= nng_push(7)
//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech>
// Copyright 2018 Capitar IT Group BV <info@capitar.com>
//
// This document is supplied under the terms of the MIT License, a
@@ -56,7 +56,16 @@ Only version 0 of this protocol is supported.
=== Protocol Options
-The _push_ protocol has no protocol-specific options.
+xref:nng_options.5.adoc#NNG_OPT_SENDBUF[`NNG_OPT_SENDBUF`]::
+
+ (`int`, 0 - 8192)
+ Normally this is set to zero, indicating that send operations are unbuffered.
+ In unbuffered operation, send operations will wait until a suitable peer is available to receive the message.
+ If this is set to a positive value (up to 8192), then an intermediate buffer is
+ provided for the socket with the specified depth (in messages).
+
+NOTE: Transport layer buffering may occur in addition to any socket
+ buffer determined by this option.
=== Protocol Headers