view util/throttle.lua @ 14027:4a288b082f42 13.0

mod_s2s: Fix traceback when outgoing s2s queue is full (thanks tom) When session.send() is used, no 'origin' field is included in the event, leading to an error attempting to index nil.
author Kim Alvefur <zash@zash.se>
date Sun, 04 Jan 2026 17:54:48 +0100
parents d10957394a3c
children d649d011df45
line wrap: on
line source


local gettime = require "prosody.util.time".now
local setmetatable = setmetatable;

local _ENV = nil;
-- luacheck: std none

local throttle = {};
local throttle_mt = { __index = throttle };

function throttle:update()
	local newt = gettime();
	local elapsed = newt - self.t;
	self.t = newt;
	local balance = (self.rate * elapsed) + self.balance;
	if balance > self.max then
		self.balance = self.max;
	else
		self.balance = balance;
	end
	return self.balance;
end

function throttle:peek(cost)
	cost = cost or 1;
	return self.balance >= cost or self:update() >= cost;
end

function throttle:poll(cost, split)
	if self:peek(cost) then
		self.balance = self.balance - cost;
		return true;
	else
		local balance = self.balance;
		if split then
			self.balance = 0;
		end
		return false, balance, (cost-balance);
	end
end

local function create(max, period)
	return setmetatable({ rate = max / period, max = max, t = gettime(), balance = max }, throttle_mt);
end

return {
	create = create;
};