mahelbir/mclient

Simple async request wrapper for Guzzle

2.1 2024-04-27 18:06 UTC

Requires

• php: >=7.1
• ext-curl: *
• guzzlehttp/guzzle: >=7.0.0

MIT

• Mahmuthan Elbir

README

Mclient acts as a straightforward asynchronous wrapper around Guzzle for making HTTP requests.

Requirements

PHP 7.1+

Guzzle 7.0+

Installation

Simply add a dependency on mahelbir/mclient to your composer.json file if you use Composer to manage the dependencies of your project:

composer require mahelbir/mclient

Although it's recommended to use Composer, you can actually include files anyway you want.

Usage

$mclient = new \Mahelbir\Mclient();

//Library options
$mclient->setTimeout(10); // total seconds
$mclient->setConnectTimeout(5);
$mclient->setConcurrency(100);

// Async multiple requests
$mclient->request(
    'GET',
    'https://httpbin.org/get',
    ['X-CUSTOM-HEADER' => 'Value'],
    ['proxy' => '127.0.0.1:8080'],
    'request_1_extra_data'
);
$mclient->post(
    'https://httpbin.org/post',
    ['key' => 'value'],
    ['User-Agent' => 'Googlebot'],
    ['allow_redirects' => false],
    'request_2_extra_data'
);
$mclient->post(
    'https://httpbin.org/post',
    '{"key": "value"}',
    ['content-type' => 'application/json']
);
$mclient->get(
    'https://httpbin.org/get?q=1',
    [],
    [],
    [],
    ['request_3_extra_data' => 'value_extra']
);
$mclient->get(
    'https://httpbin.org/get',
    ["q" => 2]
);

// Mclient supports all the request options available in Guzzle, with the addition of an 'interface' option (https://docs.guzzlephp.org/en/stable/request-options.html)
$mclient->get('https://google.com', [], [], ['interface' => '2001:db8:3333:4444:5555:6666:7777:8888']);

$responses = $mclient->execute();
foreach ($responses as $response) {
    $status = $response['code'];
    $body = $response['body'];
    $headers = $response['headers'];
    $request = $response['request'];
    $extra = $response['extra'];
}

// Pass true parameter to retrieve the first/single response
$mclient->get('https://httpbin.org/get');
$response = $mclient->execute(true);

License

The MIT License (MIT). Please see License File for more information.