thruster/socket

Thruster Socket Component

Socket Component

[] (https://github.com/ThrusterIO/socket/releases) [] (LICENSE) [] (https://travis-ci.org/ThrusterIO/socket) [] (https://scrutinizer-ci.com/g/ThrusterIO/socket) [] (https://scrutinizer-ci.com/g/ThrusterIO/socket) [] (https://packagist.org/packages/thruster/socket), _(*1)

[] (mailto:team@thruster.io), _(*2)

The Thruster Socket Component., _(*3)

Library for building an evented socket server., _(*4)

The socket component provides a more usable interface for a socket-layer server or client based on the EventLoop and Stream components., _(*5)

Server

The server can listen on a port and will emit a connection event whenever a client connects., _(*6)

Connection

The Connection is a readable and writable Stream. The incoming connection represents the server-side end of the connection., _(*7)

It MUST NOT be used to represent an outgoing connection in a client-side context. If you want to establish an outgoing connection, use the SocketClient component instead., _(*8)

Install

Via Composer, _(*9)

``` bash $ composer require thruster/socket, <sub>(*10)</sub>

## Usage

Here is a server that closes the connection if you send it anything.
```php
$loop = new EventLoop();

$socket = new Server($loop);
$socket->on('connection', function ($conn) {
    $conn->write("Hello world!\n");

    $conn->on('data', function ($data) use ($conn) {
        $conn->close();
    });
});
$socket->listen(1337);

$loop->run();

You can change the host the socket is listening on through a second parameter provided to the listen method:, <sub>(*11)</sub>

$socket->listen(1337, '192.168.0.1');

Testing

bash $ composer test, <sub>(*12)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*13)</sub>

License

Please see License File for more information., <sub>(*14)</sub>