1
0
mirror of https://github.com/danog/amp.git synced 2024-12-12 09:29:45 +01:00
amp/lib/Reactor.php
2015-03-16 15:00:17 -04:00

126 lines
4.4 KiB
PHP

<?php
namespace Amp;
interface Reactor {
/**
* Start the event reactor and assume program flow control
*
* @param callable $onStart Optional callback to invoke immediately upon reactor start
*/
public function run(callable $onStart = null);
/**
* Execute a single event loop iteration
*
* @param bool $noWait If TRUE, return immediately when no watchers are immediately ready to trigger
*/
public function tick($noWait = false);
/**
* Stop the event reactor
*/
public function stop();
/**
* Schedule a callback for immediate invocation in the next event loop iteration
*
* Though it can't be enforced at the interface level all timer/stream scheduling methods
* should return a unique integer identifying the relevant watcher.
*
* @param callable $callback Any valid PHP callable
*/
public function immediately(callable $callback);
/**
* Schedule a callback to execute once
*
* Time intervals are measured in milliseconds.
*
* Though it can't be enforced at the interface level all timer/stream scheduling methods
* should return a unique integer identifying the relevant watcher.
*
* @param callable $callback Any valid PHP callable
* @param int $msDelay The delay in milliseconds before the callback will trigger (may be zero)
*/
public function once(callable $callback, $msDelay);
/**
* Schedule a recurring callback to execute every $interval seconds until cancelled
*
* Time intervals are measured in milliseconds.
*
* Though it can't be enforced at the interface level all timer/stream scheduling methods
* should return a unique integer identifying the relevant watcher.
*
* @param callable $callback Any valid PHP callable
* @param int $msDelay The delay in milliseconds before the callback will trigger (may be zero)
*/
public function repeat(callable $callback, $msDelay);
/**
* Schedule an event to trigger once at the specified time
*
* @param callable $callback Any valid PHP callable
* @param mixed[int|string] $unixTimeOrStr A future unix timestamp or string parsable by strtotime()
* @throws \InvalidArgumentException On invalid future time
*/
public function at(callable $callback, $unixTimeOrStr);
/**
* Watch a stream resource for readable data and trigger the callback when actionable
*
* Though it can't be enforced at the interface level all timer/stream scheduling methods
* should return a unique integer identifying the relevant watcher.
*
* @param resource $stream A stream resource to watch for readable data
* @param callable $callback Any valid PHP callable
* @param bool $enableNow Should the watcher be enabled now or held for later use?
*/
public function onReadable($stream, callable $callback, $enableNow = true);
/**
* Watch a stream resource to become writable and trigger the callback when actionable
*
* Though it can't be enforced at the interface level all timer/stream scheduling methods
* should return a unique integer identifying the relevant watcher.
*
* @param resource $stream A stream resource to watch for writability
* @param callable $callback Any valid PHP callable
* @param bool $enableNow Should the watcher be enabled now or held for later use?
*/
public function onWritable($stream, callable $callback, $enableNow = true);
/**
* Cancel an existing timer/stream watcher
*
* @param int $watcherId
*/
public function cancel($watcherId);
/**
* Temporarily disable (but don't cancel) an existing timer/stream watcher
*
* @param int $watcherId
*/
public function disable($watcherId);
/**
* Enable a disabled timer/stream watcher
*
* @param int $watcherId
*/
public function enable($watcherId);
/**
* An optional "last-chance" exception handler for errors resulting during callback invocation
*
* If a reactor callback throws and no onError() callback is specified the exception will
* bubble up the stack. onError() callbacks are passed a single parameter: the uncaught
* exception that resulted in the callback's invocation.
*
* @param callable $onErrorCallback
*/
public function onError(callable $onErrorCallback);
}