Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. EvDriver.php

class EvDriver

Hierarchy

  • class \Revolt\EventLoop\Internal\AbstractDriver implements \Revolt\EventLoop\Driver
    • class \Revolt\EventLoop\Driver\EvDriver extends \Revolt\EventLoop\Internal\AbstractDriver

Expanded class hierarchy of EvDriver

1 file declares its use of EvDriver
DriverFactory.php in vendor/revolt/event-loop/src/EventLoop/DriverFactory.php

File

vendor/revolt/event-loop/src/EventLoop/Driver/EvDriver.php, line 17

Namespace

Revolt\EventLoop\Driver
View source
final class EvDriver extends AbstractDriver {
    
    /** @var array<string, \EvSignal>|null */
    private static ?array $activeSignals = null;
    public static function isSupported() : bool {
        return \extension_loaded("ev");
    }
    private \EvLoop $handle;
    
    /** @var array<string, \EvWatcher> */
    private array $events = [];
    private readonly \Closure $ioCallback;
    private readonly \Closure $timerCallback;
    private readonly \Closure $signalCallback;
    
    /** @var array<string, \EvSignal> */
    private array $signals = [];
    public function __construct() {
        parent::__construct();
        $this->handle = new \EvLoop();
        if (self::$activeSignals === null) {
            self::$activeSignals =& $this->signals;
        }
        $this->ioCallback = function (\EvIo $event) : void {
            
            /** @var StreamCallback $callback */
            $callback = $event->data;
            $this->enqueueCallback($callback);
        };
        $this->timerCallback = function (\EvTimer $event) : void {
            
            /** @var TimerCallback $callback */
            $callback = $event->data;
            $this->enqueueCallback($callback);
        };
        $this->signalCallback = function (\EvSignal $event) : void {
            
            /** @var SignalCallback $callback */
            $callback = $event->data;
            $this->enqueueCallback($callback);
        };
    }
    
    /**
     * {@inheritdoc}
     */
    public function cancel(string $callbackId) : void {
        parent::cancel($callbackId);
        unset($this->events[$callbackId]);
    }
    public function __destruct() {
        foreach ($this->events as $event) {
            
            /** @psalm-suppress all */
            if ($event !== null) {
                // Events may have been nulled in extension depending on destruct order.
                $event->stop();
            }
        }
        // We need to clear all references to events manually, see
        // https://bitbucket.org/osmanov/pecl-ev/issues/31/segfault-in-ev_timer_stop
        $this->events = [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function run() : void {
        $active = self::$activeSignals;
        \assert($active !== null);
        foreach ($active as $event) {
            $event->stop();
        }
        self::$activeSignals =& $this->signals;
        foreach ($this->signals as $event) {
            $event->start();
        }
        try {
            parent::run();
        } finally {
            foreach ($this->signals as $event) {
                $event->stop();
            }
            self::$activeSignals =& $active;
            foreach ($active as $event) {
                $event->start();
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function stop() : void {
        $this->handle
            ->stop();
        parent::stop();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getHandle() : \EvLoop {
        return $this->handle;
    }
    protected function now() : float {
        return (double) \hrtime(true) / 1000000000;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function dispatch(bool $blocking) : void {
        $this->handle
            ->run($blocking ? \Ev::RUN_ONCE : \Ev::RUN_ONCE | \Ev::RUN_NOWAIT);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function activate(array $callbacks) : void {
        $this->handle
            ->nowUpdate();
        $now = $this->now();
        foreach ($callbacks as $callback) {
            if (!isset($this->events[$id = $callback->id])) {
                if ($callback instanceof StreamReadableCallback) {
                    \assert(\is_resource($callback->stream));
                    $this->events[$id] = $this->handle
                        ->io($callback->stream, \Ev::READ, $this->ioCallback, $callback);
                }
                elseif ($callback instanceof StreamWritableCallback) {
                    \assert(\is_resource($callback->stream));
                    $this->events[$id] = $this->handle
                        ->io($callback->stream, \Ev::WRITE, $this->ioCallback, $callback);
                }
                elseif ($callback instanceof TimerCallback) {
                    $interval = $callback->interval;
                    $this->events[$id] = $this->handle
                        ->timer(\max(0, $callback->expiration - $now), $callback->repeat ? $interval : 0, $this->timerCallback, $callback);
                }
                elseif ($callback instanceof SignalCallback) {
                    $this->events[$id] = $this->handle
                        ->signal($callback->signal, $this->signalCallback, $callback);
                }
                else {
                    // @codeCoverageIgnoreStart
                    throw new \Error("Unknown callback type: " . \get_class($callback));
                    // @codeCoverageIgnoreEnd
                }
            }
            else {
                $this->events[$id]
                    ->start();
            }
            if ($callback instanceof SignalCallback) {
                
                /** @psalm-suppress PropertyTypeCoercion */
                $this->signals[$id] = $this->events[$id];
            }
        }
    }
    protected function deactivate(DriverCallback $callback) : void {
        if (isset($this->events[$id = $callback->id])) {
            $this->events[$id]
                ->stop();
            if ($callback instanceof SignalCallback) {
                unset($this->signals[$id]);
            }
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AbstractDriver::$callbackFiber private property
AbstractDriver::$callbackQueue private property @var \SplQueue&lt;DriverCallback&gt;
AbstractDriver::$callbacks private property @var array&lt;string, DriverCallback&gt;
AbstractDriver::$enableDeferQueue private property @var array&lt;string, DriverCallback&gt;
AbstractDriver::$enableQueue private property @var array&lt;string, DriverCallback&gt;
AbstractDriver::$errorCallback private property
AbstractDriver::$errorHandler private property @var null|\Closure(\Throwable):void
AbstractDriver::$fiber private property
AbstractDriver::$idle private property
AbstractDriver::$internalSuspensionMarker private property
AbstractDriver::$interrupt private property @var null|\Closure():mixed
AbstractDriver::$interruptCallback private property
AbstractDriver::$microtaskQueue private property @var \SplQueue&lt;array{\Closure, array}&gt;
AbstractDriver::$nextId private property @var string Next callback identifier.
AbstractDriver::$queueCallback private property
AbstractDriver::$runCallback private property
AbstractDriver::$stopped private property
AbstractDriver::$suspensions private property @var \WeakMap&lt;object, \WeakReference&lt;DriverSuspension&gt;&gt;
AbstractDriver::createCallbackFiber private function
AbstractDriver::createErrorCallback private function
AbstractDriver::createLoopFiber private function
AbstractDriver::defer public function Defer the execution of a callback. Overrides Driver::defer
AbstractDriver::delay public function Delay the execution of a callback. Overrides Driver::delay
AbstractDriver::disable public function Disable a callback immediately. Overrides Driver::disable
AbstractDriver::enable public function Enable a callback to be active starting in the next tick. Overrides Driver::enable
AbstractDriver::enqueueCallback final protected function
AbstractDriver::error final protected function Invokes the error handler with the given exception.
AbstractDriver::getErrorHandler public function Gets the error handler closure or {@code null} if none is set. Overrides Driver::getErrorHandler
AbstractDriver::getIdentifiers public function Returns all registered non-cancelled callback identifiers. Overrides Driver::getIdentifiers
AbstractDriver::getSuspension public function Returns an object used to suspend and resume execution of the current fiber or {main}. Overrides Driver::getSuspension
AbstractDriver::getType public function Returns the type of the callback identified by the given callback identifier. Overrides Driver::getType
AbstractDriver::invokeCallbacks private function
AbstractDriver::invokeInterrupt private function
AbstractDriver::invokeMicrotasks private function
AbstractDriver::isEmpty private function
AbstractDriver::isEnabled public function Returns whether the callback identified by the given callback identifier is currently enabled. Overrides Driver::isEnabled
AbstractDriver::isReferenced public function Returns whether the callback identified by the given callback identifier is currently referenced. Overrides Driver::isReferenced
AbstractDriver::isRunning public function Overrides Driver::isRunning
AbstractDriver::onReadable public function Execute a callback when a stream resource becomes readable or is closed for reading. Overrides Driver::onReadable
AbstractDriver::onSignal public function Execute a callback when a signal is received. Overrides Driver::onSignal 1
AbstractDriver::onWritable public function Execute a callback when a stream resource becomes writable or is closed for writing. Overrides Driver::onWritable
AbstractDriver::queue public function Queue a microtask. Overrides Driver::queue
AbstractDriver::reference public function Reference a callback. Overrides Driver::reference
AbstractDriver::repeat public function Repeatedly execute a callback. Overrides Driver::repeat
AbstractDriver::setErrorHandler public function Set a callback to be executed when an error occurs. Overrides Driver::setErrorHandler
AbstractDriver::setInterrupt private function
AbstractDriver::tick private function Executes a single tick of the event loop.
AbstractDriver::unreference public function Unreference a callback. Overrides Driver::unreference
AbstractDriver::__debugInfo public function Returns some useful information about the event loop. Overrides Driver::__debugInfo
EvDriver::$activeSignals private static property @var array&lt;string, \EvSignal&gt;|null
EvDriver::$events private property @var array&lt;string, \EvWatcher&gt;
EvDriver::$handle private property
EvDriver::$ioCallback private property
EvDriver::$signalCallback private property
EvDriver::$signals private property @var array&lt;string, \EvSignal&gt;
EvDriver::$timerCallback private property
EvDriver::activate protected function Activates (enables) all the given callbacks. Overrides AbstractDriver::activate
EvDriver::cancel public function Cancel a callback. Overrides AbstractDriver::cancel
EvDriver::deactivate protected function Deactivates (disables) the given callback. Overrides AbstractDriver::deactivate
EvDriver::dispatch protected function Dispatches any pending read/write, timer, and signal events. Overrides AbstractDriver::dispatch
EvDriver::getHandle public function Get the underlying loop handle. Overrides Driver::getHandle
EvDriver::isSupported public static function
EvDriver::now protected function Returns the current event loop time in second increments. Overrides AbstractDriver::now
EvDriver::run public function Run the event loop. Overrides AbstractDriver::run
EvDriver::stop public function Stop the event loop. Overrides AbstractDriver::stop
EvDriver::__construct public function Overrides AbstractDriver::__construct
EvDriver::__destruct public function
RSS feed
Powered by Drupal