Skip to main content Skip to footer

Throttle Documentation

Version: 2.0.2

Retrieved: 2025-10-09 15:16:24


Throttle

The module will limit the number of messages that can pass through the module for a specific interval.

Settings

The Interval decides the time-frame used for allowing Max Messages Per Interval to pass through. The Delay Between Messages can be used to delay the acceptance for the next message to arrive.

Name Requirements Purpose Default
Interval Number 0-86400000 Time-frame in ms for each interval. 1000
Max Messages Per Interval Number 0-86400000 Max messages per interval 10
Delay Between Messages Number 0-86400000 Delay until accepting a new message 0

Interval Explanation

When using interval the messages will be discarded if the number of messages is more than the Max Messages Per Interval setting. At each interval the counter will reset and accept new messages. Messages not accepted will be thrown away.

Delay Explanation

When only delay is used (Interval is set to 0) the messages will never be discarded. They will only be delayed, so the flow will slow down using this feature. Be careful when sending a lot of messages over a long period of time when using this feature since buffer/memory will grow.

Note

  • If you have both the Interval and Delay Between Messages set to 0 message will just pass through.
  • If you have both the Interval and Delay Between Messages set to > 0 the functionality will be combined. Messages might be discarded, but the delay will not allow a new message in until the delay expires.

Input

Any message

Output

Same as input when the message is allowed to pass