Skip to content
danogPublic

About

Use any async Rust library from PHP!

Resources

Stars

360 stars

Watchers

3 watching

Forks

Latest commit

 

History

72 Commits

Folders and files

Repository files navigation

php-tokio - Use any async Rust library from PHP!

Created by Daniil Gentili (@danog).

This library allows you to use any async rust library from PHP, asynchronously.

It's fully integrated with revolt: this allows full compatibility with amphp, PSL and reactphp.

Example

Here's an example, using the async Rust reqwest library to make asynchronous HTTP requests from PHP:

<?php

use Reqwest\Client;

use function Amp\async;
use function Amp\Future\await;

require 'vendor/autoload.php';

Client::init();

function test(int $delay): void {
    $url = "https://httpbin.org/delay/$delay";
    $t = time();
    echo "Making async reqwest to $url that will return after $delay seconds...".PHP_EOL;
    Client::get($url);
    $t = time() - $t;
    echo "Got response from $url after ~".$t." seconds!".PHP_EOL;
};

$futures = [];
$futures []= async(test(...), 5);
$futures []= async(test(...), 5);
$futures []= async(test(...), 5);

await($futures);

Usage:

cd examples/reqwest && \
    cargo build && \
    composer update && \
    php -d extension=../../target/debug/libexample_reqwest.so test.php

Result:

Making async reqwest to https://httpbin.org/delay/5 that will return after 5 seconds...
Making async reqwest to https://httpbin.org/delay/5 that will return after 5 seconds...
Making async reqwest to https://httpbin.org/delay/5 that will return after 5 seconds...
Got response from https://httpbin.org/delay/5 after ~5 seconds!
Got response from https://httpbin.org/delay/5 after ~5 seconds!
Got response from https://httpbin.org/delay/5 after ~5 seconds!

See the source code of the example for more info on how it works!

Usage

In your extension, make your async methods' class a #[php_async_impl], and expose EventLoop::init() (or EventLoop::init_with(), to choose the Tokio runtime) and EventLoop::wakeup(). The PHP side watches the stream that init() returns:

$stream = \MyExtension::init();
stream_set_blocking($stream, false);
Revolt\EventLoop::onReadable($stream, fn () => \MyExtension::wakeup());

Don't close the stream: init() returns the same one every time. php-tokio shuts the event loop down at the end of every request (EventLoop::shutdown() does it earlier), once the futures borrowing from their callers completed.

The main example of a complete integration is MadelineProto's native crypto extension, madeline_crypto:

  • native/src/php.rs is the Rust side: a runtime of its own with EventLoop::init_with(), EventLoop::wakeup(), fallible suspension with EventLoop::try_suspend_on(), and an orderly shutdown with EventLoop::drain() and EventLoop::shutdown().
  • src/MTProtoTools/Crypt/NativeExecutor.php is the PHP side: it watches the stream, keeps the Revolt watcher unreferenced while no operation is pending, and closes the bridge in a shutdown function.

Built with php-tokio

Here's a list of async PHP extensions built with php-tokio (add yours by editing this file!):

About

Use any async Rust library from PHP!

Resources

Stars

360 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages