duyler / event-bus
Duyler event bus
Requires
- php: ^8.5
- ext-ev: *
- duyler/di: dev-main
- psr/event-dispatcher: ^1.0.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.80
- phpunit/phpunit: ^13.0
- rector/rector: ^2.0
- vimeo/psalm: ^6.10
README
The event bus implements cooperative multitasking between actors performed inside it. Each actor is performed inside a separate thread (Fiber) in an isolated DI container. Execution can be controlled using state handlers, events, and triggers to messages generated by actors.
Reactive Subscriptions
The event bus supports reactive subscriptions that allow actors to subscribe to events with status consideration.
onOne - Subscribe to a single event
Subscribe to a single event with status consideration:
use Duyler\EventBus\Build\Actor; use Duyler\EventBus\Build\Id; new Actor( id: 'SendNotification', handler: SendNotificationHandler::class, onOne: Id::success('CreateOrder'), argument: Order::class, );
Subscribe to a Fail status:
new Actor( id: 'HandleFailure', handler: HandleFailureHandler::class, onOne: Id::fail('ProcessPayment'), );
onAny - Subscribe to any of the events
Execute when any of the specified events occur:
use Duyler\EventBus\Build\Id; new Actor( id: 'LogActivity', handler: LogActivityHandler::class, onAny: [ Id::success('CreateOrder'), Id::success('UpdateOrder'), ], );
onAll - Subscribe to all events
Execute only when all specified events occur:
new Actor( id: 'CompleteCheckout', handler: CompleteCheckoutHandler::class, onAll: [ Id::success('ValidateCart'), Id::success('ProcessPayment'), ], );
External Events
External events require a status:
use Duyler\EventBus\Build\Event; $builder->addEvent(Event::success('OrderCreated', OrderDTO::class)); $builder->addEvent(Event::fail('PaymentFailed'));
Dispatch external events:
use Duyler\EventBus\Dto\Event; $bus->dispatchEvent(new Event( id: 'OrderCreated.Success', data: new OrderDTO(orderId: '123'), ));
Silent Actors
Silent actors do not generate events:
new Actor( id: 'InternalProcess', handler: InternalProcessHandler::class, silent: true, );
Scheduler
Event Bus includes a built-in task scheduler for executing periodic operations.
Adding Scheduled Tasks
use Duyler\EventBus\Dto\ScheduledTask; $busBuilder->addScheduledTask(new ScheduledTask( callback: function (): void { // Periodic task logic }, intervalMs: 1000, // Execute every 1000ms startDelayMs: 500, // Optional: delay before first run ));
GC Tasks
By default, Event Bus registers two garbage collection tasks:
GcCollectCyclesTask- collects GC cyclesGcMemCachesTask- clears memory caches
Configure intervals through BusConfig:
use Duyler\EventBus\BusConfig; new BusConfig( gcCollectCyclesInterval: 120000, // 2 minutes gcMemCachesInterval: 60000, // 1 minute );
Configuration
new BusConfig( schedulerCheckInterval: 100, // Task check interval (ms) );
Scheduler API
ScheduledTask DTO
| Property | Type | Description |
|---|---|---|
callback |
callable |
Function to execute periodically |
intervalMs |
int |
Execution interval in milliseconds |
startDelayMs |
int|null |
Optional delay before first execution |
BusConfig Scheduler Options
| Option | Type | Default | Description |
|---|---|---|---|
schedulerCheckInterval |
int |
100 |
Interval between task checks (ms) |
gcCollectCyclesInterval |
int |
120000 |
GC cycle collection interval (ms) |
gcMemCachesInterval |
int |
60000 |
Memory cache cleanup interval (ms) |