![]() |
SolarCapture C Bindings User Guide
SF-115721-CD
Issue 1
|
Node to limit the batch size sent to downstream nodes.
This node forwards packets from its input to its output, emitting at most 'max_packets' in each batch.
By default a batch of packets is emitted in each polling loop. If mode="on_idle", then packets are only emitted when the sc_thread is idle (via an idle callback).
Argument | Optional? | Default | Type | Description |
---|---|---|---|---|
max_packets | Yes | 64 | SC_PARAM_INT | The maximum number of packets in each batch. |
mode | Yes | NULL | SC_PARAM_STR | Set mode="on_idle" to only emit packets when thread is idle. |
Statistics exposed by the sc_batch_limiter node.
Name | Type | Data Type | Description |
---|---|---|---|
max_packets | int | config | The maximum number of packets sent per batch. |
fwd_on_idle | int | config | Set to 1 if mode is on_idle else 0. |
backlog | int | pkt_count | The current number of packets waiting to be forwarded. |