From e312b6c6c78ccec15a10d1be9fde49eb938cd693 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 16 Oct 2019 14:41:54 +0000 Subject: [PATCH] doc: add documentation for write- and read-quanta Signed-off-by: Quentin Young --- doc/user/bgp.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index c99a5c49a3..bb60bad947 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -2167,6 +2167,8 @@ Dumping Messages and Routing Tables Other BGP Commands ------------------ +The following are available in the top level *enable* mode: + .. index:: clear bgp \* .. clicmd:: clear bgp \* @@ -2202,6 +2204,24 @@ Other BGP Commands Clear peer using soft reconfiguration in this address-family and sub-address-family. +The following are available in the ``router bgp`` mode: + +.. index:: write-quanta (1-64) +.. clicmd:: write-quanta (1-64) + + BGP message Tx I/O is vectored. This means that multiple packets are written + to the peer socket at the same time each I/O cycle, in order to minimize + system call overhead. This value controls how many are written at a time. + Under certain load conditions, reducing this value could make peer traffic + less 'bursty'. In practice, leave this settings on the default (64) unless + you truly know what you are doing. + +.. index:: read-quanta (1-10) +.. index:: read-quanta (1-10) + + Unlike Tx, BGP Rx traffic is not vectored. Packets are read off the wire one + at a time in a loop. This setting controls how many iterations the loop runs + for. As with write-quanta, it is best to leave this setting on the default. .. _bgp-displaying-bgp-information: -- 2.39.5