nadylib/leaky-bucket

An fiber-based implementation of the LeakyBucket algorithm

0.1.0 2024-04-28 12:54 UTC

Requires

• php: >=8.1.17
• psr/log: ^1|^2|^3
• revolt/event-loop: ^1.0

Requires (Dev)

• composer-phar/php-cs-fixer: ^3.51.0
• composer-phar/phpstan: ^1.10
• nadybot/nadystyle: ^1.0
• phpunit/phpunit: ^10.0
• squizlabs/php_codesniffer: ^3.8
• thecodingmachine/phpstan-safe-rule: ^1.2

AGPL-3.0-or-later

• Nadyita

README

An async Leaky Bucket implementation using the Revolt EventLoop

Usage

use Nadylib\LeakyBucket\LeakyBucket;

$bucket = new Nadylib\LeakyBucket\LeakyBucket(
	size: 5,
	refillDelay: 1.0,
	refillAmount: 1
);

There is only 1 function of interest: LeakyBucket::take(<amount>):

use Nadylib\LeakyBucket\LeakyBucket;

$bucket = new Nadylib\LeakyBucket\LeakyBucket(
	size: 5,
	refillDelay: 1.0,
	refillAmount: 1
);
for ($i = 1; $i <= 7; $i++) {
	$bucket->take(1);
	$time = (new DateTimeImmutable())->format("H:i:s.v");
	echo("[{$time}] Taken.\n");
}

The first 5 takes will take immediately, while 6 and 7 take 1s each. There is no sleep involved, just async fibers, so this is absolutely safe to use.

use Nadylib\LeakyBucket\LeakyBucket;
use Revolt\EventLoop;

$bucket = new Nadylib\LeakyBucket\LeakyBucket(
	size: 5,
	refillDelay: 1.0,
	refillAmount: 1
);
for ($i = 1; $i <= 7; $i++) {
	$bucket->take(callback: function() {
		$time = (new DateTimeImmutable())->format("H:i:s.v");
		echo("[{$time}] Taken.\n");
	});
}
EventLoop::run();

This will behave exactly the same, but the call to $bucket->take() will always return immediately.

When using the callback version, make sure to call EventLoop::run() at the end, because the main fiber/thread is never suspended, but always returns immediately, so you have to make sure the event loop finishes its work. In a real world environment, this will not be necessary, because your code will run in a global event loop anyway.