README

Note: This repository is part of Dazzle Project - the next-gen library for PHP. The project's purpose is to provide PHP developers with a set of complete tools to build functional async applications. Please, make sure you read the attached README carefully and it is guaranteed you will be surprised how easy to use and powerful it is. In the meantime, you might want to check out the rest of our async libraries in Dazzle repository for the full extent of Dazzle experience.

Description

Dazzle Socket is a component that implements asynchronous tcp, udp and unix socket handling for PHP. The library also provides interface for implementing self inter-process communication via external services.

Feature Highlights

Dazzle Socket features:

Asynchronous handling of incoming and outcoming messages,
Support for TCP, UDP and Unix sockets,
...and more.

Provided Example(s)

Quickstart

Server file which accepts the range in format of $min-$max and returns randomized number.

$loop = new Loop(new SelectLoop);
$server = new SocketListener('tcp://127.0.0.1:2080', $loop);

$server->on('connect', function($server, SocketInterface $client) {
    $client->write("Hello!\n");
    $client->write("Welcome to Dazzle server!\n");
    $client->write("Tell me a range and I will randomize a number for you!\n\n");

    $client->on('data', function(SocketInterface $client, $data) use(&$buffer) {
        $client->write("Your number is: " . rand(...explode('-', $data)));
    });
});

$loop->onStart(function() use($server) {
    $server->start();
});
$loop->start();

Client file which sends the $min-$max format to the above server and gets the response.

$loop = new Loop(new SelectLoop);
$socket = new Socket('tcp://127.0.0.1:2080', $loop);

$socket->on('data', function($socket, $data) {
    printf("%s", $data);
});
$socket->write('1-100');

$loop->start();

Additional

Additional examples can be found in example directory. Below is the list of provided examples as a reference and preferred consumption order:

If any of the above examples has left you confused, please take a look in the tests directory as well.

Requirements

Dazzle Socket requires:

PHP-5.6 or PHP-7.0+,
UNIX or Windows OS.

Installation

To install this library make sure you have composer installed, then run following command:

$> composer require dazzle-php/socket

Tests

Tests can be run via:

$> vendor/bin/phpunit -d memory_limit=1024M

Versioning

Versioning of Dazzle libraries is being shared between all packages included in Dazzle Project. That means the releases are being made concurrently for all of them. On one hand this might lead to "empty" releases for some packages at times, but don't worry. In the end it is far much easier for contributors to maintain and -- what's the most important -- much more straight-forward for users to understand the compatibility and inter-operability of the packages.

Contributing

Thank you for considering contributing to this repository!

The contribution guide can be found in the contribution tips.
Open tickets can be found in issues section.
Current contributors are listed in graphs section
To contact the author(s) see the information attached in composer.json file.

License

Dazzle Socket is open-sourced software licensed under the MIT license.

"Everything is possible. The impossible just takes longer." ― Dan Brown

dazzle-php / socket

Maintainers

Details