view util/throttle.lua @ 14020:3c2bfa6a69df

prosodyctl shell: Move non-error result lines back to stdout, suppress with --quiet We're figuring out how to keep usability and support machine-readability too. We moved the status line (repl-result) to stderr so that when parsing something like a table, it didn't get in the way. However sometimes the status line is the thing we want to parse (e.g. invite creation). Parsing stderr loses one of the purposes of stderr - to have an error-only channel to emit stuff out of band (such as error messages). So the new approach is: - Status line on stdout, unless it's an error - If you're parsing the output ("content") of the command, pass --quiet to suppress the status line.
author Matthew Wild <mwild1@gmail.com>
date Tue, 30 Dec 2025 16:30:43 +0000
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;
};