Skip to content

Async, streaming plaintext TCP/IP and secure TLS socket server and client connections for ReactPHP.

License

Notifications You must be signed in to change notification settings

reactphp/socket

Repository files navigation

SocketClient Component

Async ConnectionManager to open TCP/IP and SSL/TLS based connections.

Introduction

Think of this library as an async version of fsockopen() or [stream_socket_client()](http://php.net/manual/en/function.stream-socket- client.php).

Before you can actually transmit and receive data to/from a remote server, you have to establish a connection to the remote end. Establishing this connection through the internet/network takes some time as it requires several steps in order to complete:

  1. Resolve remote target hostname via DNS (+cache)
  2. Complete TCP handshake (2 roundtrips) with remote target IP:port
  3. Optionally enable SSL/TLS on the new resulting connection

Usage

In order to use this project, you'll need the following react boilerplate code to initialize the main loop and select your DNS server if you have not already set it up anyway.

$loop = React\EventLoop\Factory::create();

$dnsResolverFactory = new React\Dns\Resolver\Factory();
$dns = $dnsResolverFactory->createCached('8.8.8.8', $loop);

Async TCP/IP connections

The React\SocketClient\ConnectionManager provides a single promise-based getConnection($host, $ip) method which resolves as soon as the connection succeeds or fails.

$connectionManager = new React\SocketClient\ConnectionManager($loop, $dns);

$connectionManager->getConnection('www.google.com', 80)->then(function (React\Stream\Stream $stream) {
    $stream->write('...');
    $stream->close();
});

Async SSL/TLS connections

The SecureConnectionManager class decorates a given ConnectionManager instance by enabling SSL/TLS encryption as soon as the raw TCP/IP connection succeeds. It provides the same promise- based getConnection($host, $ip) method which resolves with a Stream instance that can be used just like any non-encrypted stream.

$secureConnectionManager = new React\SocketClient\SecureConnectionManager($connectionManager, $loop);

$secureConnectionManager->getConnection('www.google.com', 443)->then(function (React\Stream\Stream $stream) {
    $stream->write("GET / HTTP/1.0\r\nHost: www.google.com\r\n\r\n");
    ...
});