Giter Club home page Giter Club logo

websocket-bundle's Introduction

Simple Symfony 4 websocket bundle

This small bundle is a Ratchet abstraction for Symfony 4. Just create message handlers and your server is set.

Installation

Open a command console, enter your project directory and execute:

$ composer require gonzakpo/websocket-bundle

Create handlers

Create services implementing HandlerInterface:

<?php

// src/Handler/WelcomeHandler.php
namespace App\Handler;

use Ratchet\ConnectionInterface;
use RollandRock\WebsocketBundle\Client\ClientStack;
use RollandRock\WebsocketBundle\Handler\HandlerInterface;

class WelcomeHandler implements HandlerInterface
{
    public static function getName(): string
    {
        return 'welcome';
    }

    public function handle(ClientStack $clientStack, ConnectionInterface $from, array $data)
    {
        // Handle the "welcome" message sent by $from, containing $data.
        // You also have access to the whole clients stack
    }
}

Configure handlers

The default port is 4242. You can change it. Also, the default clients that will be provided will be instances of RollandRock\WebsocketBundle\Client. You can extend it to fit your needs and specify it in the config.

rolland_rock_websocket:
    port: 3240
    client: App\Client\Client

Run the server

    php bin/console rr:websocket:server

Send messages

The messages need to have the following format :

    {
      "type": "welcome",
      "data": {
        /* some data */
      }
    }

Author

Gonzalo Alonso - [email protected]

By

Pierre Rolland - [email protected]

websocket-bundle's People

Contributors

gonzaloalonsod avatar

Stargazers

 avatar  avatar  avatar Selim Can CABA avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.