doc: update distributor lib guide for new burst API
authorDavid Hunt <david.hunt@intel.com>
Mon, 20 Mar 2017 10:08:40 +0000 (10:08 +0000)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Wed, 29 Mar 2017 14:46:58 +0000 (16:46 +0200)
Signed-off-by: David Hunt <david.hunt@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
doc/guides/prog_guide/packet_distrib_lib.rst

index b5bdabb..ee2b1a6 100644 (file)
@@ -42,6 +42,10 @@ The model of operation is shown in the diagram below.
 
    Packet Distributor mode of operation
 
+There are two modes of operation of the API in the distributor library,
+one which sends one packet at a time to workers using 32-bits for flow_id,
+and an optimized mode which sends bursts of up to 8 packets at a time to workers, using 15 bits of flow_id.
+The mode is selected by the type field in the ``rte_distributor_create()`` function.
 
 Distributor Core Operation
 --------------------------