jgswift/qtcp

Web socket server/client using php and javascript

qtcp

Web socket client/server using php and javascript, _(*1)

, _(*2)

Installation

Install via composer:, _(*3)

php composer.phar require jgswift/qtcp:dev-master

Dependency

• php 5.5+
• html5 web sockets
• cboden/ratchet
• symfony/console
• jgswift/qtil
• jgswift/qio
• jgswift/observr
• jgswift/bubblr

Description

qtcp is an experimental abstraction layer for client/server applications using websockets, _(*4)

Usage

$app = new qtcp\Network\Application(['0.0.0.0',8081]);

$app->attach('connect',function($client) {
    $client->attach('event', function($client, $e) {
        /* do something with event */
    });

    $client->attach('disconnect', function() {
        /* teardown client here */
    });
});

$app->run();

Examples

Sample Stream

tests/Examples/SampleStream, _(*5)

The sample stream serves as a conceptual prototype to demonstrate the most basic functionality, _(*6)

Server

Configure, _(*7)

First, configure the host and port by editing the config.js, _(*8)

If you intend to run the client and server together on the same box, a likely configuration may be the following, _(*9)

var SampleStream = {
    host: 'localhost',
    port: 8081
};

Run, _(*10)

In terminal or via SSH, navigate to the directory qtcp is located in and start the server, _(*11)

$ cd vendor/jgswift/qtcp/
$ php tests/Examples/SampleStream/Server.php localhost:8081

The server will start and you will see, _(*12)

Starting server..
Server started.

Code, _(*13)

$app = new qtcp\Network\Application([$host,$port]);

$app->attach('connect',function($client) {
    $client->attach('event', function($client, $e) {
        /* send reply */
        $client->send(new qtcp\Network\Packet('event',['hello world!']));
    });

    $client->attach('disconnect', function() {
        /* do something with disconnect */
    });
});

$app->run();

Client

Open a web browser and navigate to http://localhost/your_project_directory/vendor/jgswift/qtcp/tests/Examples/SampleStream.
Note: Modify path if qtcp is in a different directory., _(*14)

A sample application will appear and click the button to send your first packet, _(*15)

Code, _(*16)

qtcp.network.client = new qtcp.client(
    "body",
    new qtcp.stream(
        new qtcp.resource(SampleStream.host,SampleStream.port)
    )
);

// attach packet processor for event packet
qtcp.network.client.attach("event",function(data) {
    $("#response").html(data[0]);
});

// connect to server
qtcp.network.client.connect();

// send event packet with some dummy data
$('input').on('click',function() {
    qtcp.network.client.send(new qtcp.network.packet("event"),{var1:"test"});
});

Currency Stream

tests/Examples/CurrencyStream, _(*17)

The currency stream example simulates a currency index which concurrently updates all clients with price changes., _(*18)

Server

Configure, _(*19)

Like above, configure the host and port by editing the config.js, _(*20)

If you intend to run the client and server together on the same box, a likely configuration may be the following, _(*21)

var CurrencyStream = {
    host: 'localhost',
    port: 8081
};

Run, _(*22)

In terminal or via SSH, navigate to the directory qtcp is located in and start the server, _(*23)

$ cd vendor/jgswift/qtcp/
$ php tests/Examples/CurrencyStream/Server.php

Alternatively, you may specify the host/port, _(*24)

$ php tests/Examples/CurrencyStream/Server.php 0.0.0.0:8081

The server will start and you will see, _(*25)

Starting server..
Server started.

Client

Open a web browser and navigate to http://localhost/your_project_directory/vendor/jgswift/qtcp/tests/Examples/CurrencyStream.
Note: Modify path if qtcp is in a different directory., _(*26)

The price streaming application will list a currency index. Check any boxes on the left to initiate streaming., _(*27)