---
title: "Periodic Manager"
package: "WebSocketBundle"
version: "1.x"
canonical_url: "https://www.babdev.com/open-source/packages/websocketbundle/docs/1.x/periodic-manager"
package_supported: true
version_released: false
notice:
  - "Version 1.x of WebSocketBundle has not been released yet. Its API may change before release."
---
# Periodic Manager

The `BabDev\WebSocketBundle\PeriodicManager\PeriodicManager` interface represents a class which is used to dynamically manage periodic functions.

Periodic managers are initialized during the `BabDev\WebSocketBundle\Event\BeforeRunServer` event and the manager is responsible for registering its actions to the event loop.

The bundle will autoconfigure periodic managers with the `babdev_websocket_server.periodic_manager` service tag, which is required to ensure managers are correctly registered.

## Required Methods

### `getName()`

A manager must provide a unique name, these names are used in conjunction with the `BabDev\WebSocketBundle\PeriodicManager\PeriodicManagerRegistry`.

### `register()`

The `register()` method is used to initialize the periodic manager using the provided event loop.

### `cancelTimers()`

The `cancelTimers()` method is called during the `BabDev\WebSocketBundle\Event\AfterServerClosed` event and allows for graceful shutdown of periodic functions owned by the manager.

## Example Manager

```php
<?php declare(strict_types=1);

namespace App\WebSocket\PeriodicManager;

use BabDev\WebSocketBundle\PeriodicManager\PeriodicManager;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use React\EventLoop\LoopInterface;
use React\EventLoop\TimerInterface;

final class EchoPeriodicManager implements PeriodicManager, LoggerAwareInterface
{
    use LoggerAwareTrait;

    private ?LoopInterface $loop = null;

    private ?TimerInterface $timer = null;

    public function getName(): string
    {
        return 'echo';
    }

    public function register(LoopInterface $loop): void
    {
        $this->loop = $loop;

        // Register the timer to run every 15 seconds
        $this->timer = $loop->addPeriodicTimer(
            15,
            function (): void {
                // The timer runs inside the event loop, so an exception thrown here stops the websocket server; catch the errors you expect and let anything else stop the server
                try {
                    $this->echo();
                } catch (\RuntimeException $exception) {
                    $this->logger?->error(
                        'The echo manager failed.',
                        [
                            'exception' => $exception,
                        ],
                    );
                }
            },
        );
    }

    public function cancelTimers(): void
    {
        if (!$this->timer instanceof TimerInterface) {
            return;
        }

        $this->loop?->cancelTimer($this->timer);

        $this->timer = null;
    }

    private function echo(): void
    {
        echo 'This is a demo';
    }
}
```