Sabre\Event\Loop\Loop Class Reference

A simple eventloop implementation. More...

Collaboration diagram for Sabre\Event\Loop\Loop:

Public Member Functions
	setTimeout (callable $cb, $timeout)
	Executes a function after x seconds. More...
	setInterval (callable $cb, $timeout)
	Executes a function every x seconds. More...
	clearInterval ($intervalId)
	Stops a running internval. More...
	nextTick (callable $cb)
	Runs a function immediately at the next iteration of the loop. More...
	addReadStream ($stream, callable $cb)
	Adds a read stream. More...
	addWriteStream ($stream, callable $cb)
	Adds a write stream. More...
	removeReadStream ($stream)
	Stop watching a stream for reads. More...
	removeWriteStream ($stream)
	Stop watching a stream for writes. More...
	run ()
	Runs the loop. More...
	tick ($block=false)
	Executes all pending events. More...
	stop ()
	Stops a running eventloop. More...

Protected Member Functions
	runNextTicks ()
	Executes all 'nextTick' callbacks. More...
	runTimers ()
	Runs all pending timers. More...
	runStreams ($timeout)
	Runs all pending stream events. More...

Protected Attributes
	$running = false
	$timers = []
	$nextTick = []
	$readStreams = []
	$writeStreams = []
	$readCallbacks = []
	$writeCallbacks = []

Detailed Description

A simple eventloop implementation.

This eventloop supports:

• nextTick
• setTimeout for delayed functions
• setInterval for repeating functions
• stream events using stream_select

Copyright

Copyright (C) 2007-2015 fruux GmbH. (https://fruux.com/)

Author

Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 18 of file Loop.php.

Member Function Documentation

addReadStream()

Sabre\Event\Loop\Loop::addReadStream	(		$stream,
		callable	$cb
	)

Adds a read stream.

The callback will be called as soon as there is something to read from the stream.

You MUST call removeReadStream after you are done with the stream, to prevent the eventloop from never stopping.

Parameters

resource	$stream
callable	$cb

Returns

void

Definition at line 132 of file Loop.php.

                                                  {
 
        $this->readStreams[(int)$stream] = $stream;
        $this->readCallbacks[(int)$stream] = $cb;
 
    }

References GuzzleHttp\Psr7\$stream.

addWriteStream()

Sabre\Event\Loop\Loop::addWriteStream	(		$stream,
		callable	$cb
	)

Adds a write stream.

The callback will be called as soon as the system reports it's ready to receive writes on the stream.

You MUST call removeWriteStream after you are done with the stream, to prevent the eventloop from never stopping.

Parameters

resource	$stream
callable	$cb

Returns

void

Definition at line 152 of file Loop.php.

                                                   {
 
        $this->writeStreams[(int)$stream] = $stream;
        $this->writeCallbacks[(int)$stream] = $cb;
 
    }

References GuzzleHttp\Psr7\$stream.

clearInterval()

Sabre\Event\Loop\Loop::clearInterval

(

$intervalId

)

Stops a running internval.

Parameters

array

$intervalId

Returns

void

Definition at line 100 of file Loop.php.

                                        {
 
        $intervalId[1] = false;
 
    }

nextTick()

Sabre\Event\Loop\Loop::nextTick

(

callable

$cb

)

Runs a function immediately at the next iteration of the loop.

Parameters

callable

$cb

Returns

void

Definition at line 112 of file Loop.php.

                                    {
 
        $this->nextTick[] = $cb;
 
    }

References Sabre\Event\Loop\Loop\nextTick().

Referenced by Sabre\Event\Promise\invokeCallback(), Sabre\Event\Loop\Loop\nextTick(), Sabre\Event\Loop\Loop\runNextTicks(), Sabre\Event\Loop\Loop\runStreams(), Sabre\Event\Promise\PromiseTest\testWaitRejectedException(), Sabre\Event\Promise\PromiseTest\testWaitRejectedNonScalar(), Sabre\Event\Promise\PromiseTest\testWaitRejectedScalar(), Sabre\Event\Promise\PromiseTest\testWaitResolve(), and Sabre\Event\Loop\Loop\tick().

Here is the call graph for this function:

Here is the caller graph for this function:

removeReadStream()

Sabre\Event\Loop\Loop::removeReadStream

(

$stream

)

Stop watching a stream for reads.

Parameters

resource

$stream

Returns

void

Definition at line 165 of file Loop.php.

                                       {
 
        unset(
            $this->readStreams[(int)$stream],
            $this->readCallbacks[(int)$stream]
        );
 
    }

References GuzzleHttp\Psr7\$stream.

removeWriteStream()

Sabre\Event\Loop\Loop::removeWriteStream

(

$stream

)

Stop watching a stream for writes.

Parameters

resource

$stream

Returns

void

Definition at line 180 of file Loop.php.

                                        {
 
        unset(
            $this->writeStreams[(int)$stream],
            $this->writeCallbacks[(int)$stream]
        );
 
    }

References GuzzleHttp\Psr7\$stream.

run()

Sabre\Event\Loop\Loop::run

(

)

Runs the loop.

This function will run continiously, until there's no more events to handle.

Returns

void

Definition at line 198 of file Loop.php.

                   {
 
        $this->running = true;
 
        do {
 
            $hasEvents = $this->tick(true);
 
        } while ($this->running && $hasEvents);
        $this->running = false;
 
    }

References Sabre\Event\Loop\Loop\tick().

Referenced by Sabre\Event\Promise\FunctionsTest\testAll(), Sabre\Event\Promise\PromiseTest\testAll(), Sabre\Event\Promise\FunctionsTest\testAllReject(), Sabre\Event\Promise\PromiseTest\testAllReject(), Sabre\Event\Promise\FunctionsTest\testAllRejectThenResolve(), Sabre\Event\Promise\PromiseTest\testAllRejectThenResolve(), Sabre\Event\Promise\PromiseTest\testChain(), Sabre\Event\Promise\PromiseTest\testChainPromise(), Sabre\Event\Promise\PromiseTest\testExecutorFail(), Sabre\Event\Promise\PromiseTest\testExecutorSuccess(), Sabre\Event\Promise\PromiseTest\testFail(), Sabre\Event\Promise\PromiseTest\testFromFailureHandler(), Sabre\Event\Promise\PromiseTest\testPendingFail(), Sabre\Event\Promise\PromiseTest\testPendingResult(), Sabre\Event\Promise\FunctionsTest\testRace(), Sabre\Event\Promise\FunctionsTest\testRaceReject(), Sabre\Event\Promise\FunctionsTest\testReject(), Sabre\Event\Promise\FunctionsTest\testResolve(), and Sabre\Event\Promise\PromiseTest\testSuccess().

Here is the call graph for this function:

Here is the caller graph for this function:

runNextTicks()

Sabre\Event\Loop\Loop::runNextTicks ( )

protected

Executes all 'nextTick' callbacks.

return void

Definition at line 268 of file Loop.php.

                                      {
 
        $nextTick = $this->nextTick;
        $this->nextTick = [];
 
        foreach ($nextTick as $cb) {
            $cb();
        }
 
    }

References Sabre\Event\Loop\Loop\$nextTick, and Sabre\Event\Loop\Loop\nextTick().

Referenced by Sabre\Event\Loop\Loop\tick().

Here is the call graph for this function:

Here is the caller graph for this function:

runStreams()

Sabre\Event\Loop\Loop::runStreams (   $timeout )

protected

Runs all pending stream events.

Parameters

float

$timeout

Definition at line 308 of file Loop.php.

                                            {
 
        if ($this->readStreams || $this->writeStreams) {
 
            $read = $this->readStreams;
            $write = $this->writeStreams;
            $except = null;
            if (stream_select($read, $write, $except, null, $timeout)) {
 
                // See PHP Bug https://bugs.php.net/bug.php?id=62452
                // Fixed in PHP7
                foreach ($read as $readStream) {
                    $readCb = $this->readCallbacks[(int)$readStream];
                    $readCb();
                }
                foreach ($write as $writeStream) {
                    $writeCb = $this->writeCallbacks[(int)$writeStream];
                    $writeCb();
                }
 
            }
 
        } elseif ($this->running && ($this->nextTick || $this->timers)) {
            usleep($timeout !== null ? $timeout * 1000000 : 200000);
        }
 
    }

References Sabre\Event\Loop\Loop\$readStreams, Sabre\Event\Loop\Loop\$writeStreams, and Sabre\Event\Loop\Loop\nextTick().

Referenced by Sabre\Event\Loop\Loop\tick().

Here is the call graph for this function:

Here is the caller graph for this function:

runTimers()

Sabre\Event\Loop\Loop::runTimers ( )

protected

Runs all pending timers.

After running the timer callbacks, this function returns the number of seconds until the next timer should be executed.

If there's no more pending timers, this function returns null.

Returns

float

Definition at line 289 of file Loop.php.

                                   {
 
        $now = microtime(true);
        while (($timer = array_pop($this->timers)) && $timer[0] < $now) {
            $timer[1]();
        }
        // Add the last timer back to the array.
        if ($timer) {
            $this->timers[] = $timer;
            return $timer[0] - microtime(true);
        }
 
    }

Referenced by Sabre\Event\Loop\Loop\tick().

Here is the caller graph for this function:

setInterval()

Sabre\Event\Loop\Loop::setInterval	(	callable	$cb,
			$timeout
	)

Executes a function every x seconds.

The value this function returns can be used to stop the interval with clearInterval.

Parameters

callable	$cb
float	$timeout

Returns

array

Definition at line 71 of file Loop.php.

                                                 {
 
        $keepGoing = true;
        $f = null;
 
        $f = function() use ($cb, &$f, $timeout, &$keepGoing) {
            if ($keepGoing) {
                $cb();
                $this->setTimeout($f, $timeout);
            }
        };
        $this->setTimeout($f, $timeout);
 
        // Really the only thing that matters is returning the $keepGoing
        // boolean value.
        //
        // We need to pack it in an array to allow returning by reference.
        // Because I'm worried people will be confused by using a boolean as a
        // sort of identifier, I added an extra string.
        return ['I\'m an implementation detail', &$keepGoing];
 
    }

References $f, and Sabre\Event\Loop\Loop\setTimeout().

Here is the call graph for this function:

setTimeout()

Sabre\Event\Loop\Loop::setTimeout	(	callable	$cb,
			$timeout
	)

Executes a function after x seconds.

Parameters

callable	$cb
float	$timeout	timeout in seconds

Returns

void

Definition at line 27 of file Loop.php.

                                                {
 
        $triggerTime = microtime(true) + ($timeout);
 
        if (!$this->timers) {
            // Special case when the timers array was empty.
            $this->timers[] = [$triggerTime, $cb];
            return;
        }
 
        // We need to insert these values in the timers array, but the timers
        // array must be in reverse-order of trigger times.
        //
        // So here we search the array for the insertion point.
        $index = count($this->timers) - 1;
        while (true) {
            if ($triggerTime < $this->timers[$index][0]) {
                array_splice(
                    $this->timers,
                    $index + 1,
                    0,
                    [[$triggerTime, $cb]]
                );
                break;
            } elseif ($index === 0) {
                array_unshift($this->timers, [$triggerTime, $cb]);
                break;
            }
            $index--;
 
        }
 
    }

References $index.

Referenced by Sabre\Event\Loop\Loop\setInterval().

Here is the caller graph for this function:

stop()

Sabre\Event\Loop\Loop::stop

(

)

Stops a running eventloop.

Returns

void

Definition at line 257 of file Loop.php.

                    {
 
        $this->running = false;
 
    }

tick()

Sabre\Event\Loop\Loop::tick

(

$block = false

)

Executes all pending events.

If $block is turned true, this function will block until any event is triggered.

If there are now timeouts, nextTick callbacks or events in the loop at all, this function will exit immediately.

This function will return true if there are any events left in the loop after the tick.

Parameters

bool

$block

Returns

bool

Definition at line 226 of file Loop.php.

                                  {
 
        $this->runNextTicks();
        $nextTimeout = $this->runTimers();
 
        // Calculating how long runStreams should at most wait.
        if (!$block) {
            // Don't wait
            $streamWait = 0;
        } elseif ($this->nextTick) {
            // There's a pending 'nextTick'. Don't wait.
            $streamWait = 0;
        } elseif (is_numeric($nextTimeout)) {
            // Wait until the next Timeout should trigger.
            $streamWait = $nextTimeout;
        } else {
            // Wait indefinitely
            $streamWait = null;
        }
 
        $this->runStreams($streamWait);
 
        return ($this->readStreams || $this->writeStreams || $this->nextTick || $this->timers);
 
    }

References Sabre\Event\Loop\Loop\nextTick(), Sabre\Event\Loop\Loop\runNextTicks(), Sabre\Event\Loop\Loop\runStreams(), and Sabre\Event\Loop\Loop\runTimers().

Referenced by Sabre\Event\Loop\Loop\run(), and Sabre\Event\Promise\wait().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$nextTick

Sabre\Event\Loop\Loop::$nextTick = []

protected

Definition at line 355 of file Loop.php.

Referenced by Sabre\Event\Loop\Loop\runNextTicks().

$readCallbacks

Sabre\Event\Loop\Loop::$readCallbacks = []

protected

Definition at line 376 of file Loop.php.

$readStreams

Sabre\Event\Loop\Loop::$readStreams = []

protected

Definition at line 362 of file Loop.php.

Referenced by Sabre\Event\Loop\Loop\runStreams().

$running

Sabre\Event\Loop\Loop::$running = false

protected

Definition at line 341 of file Loop.php.

$timers

Sabre\Event\Loop\Loop::$timers = []

protected

Definition at line 348 of file Loop.php.

$writeCallbacks

Sabre\Event\Loop\Loop::$writeCallbacks = []

protected

Definition at line 383 of file Loop.php.

$writeStreams

Sabre\Event\Loop\Loop::$writeStreams = []

protected

Definition at line 369 of file Loop.php.

Referenced by Sabre\Event\Loop\Loop\runStreams().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/sabre/event/lib/Loop/Loop.php