gruz/laravel-ratchet

A Laravel 8 compatible fork of Ratchet Server built for Laravel

Maintainers

Details

github.com/gruz/laravel-ratchet

Source

Installs: 127

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 47

8.0.2 2021-01-16 11:26 UTC

Requires

MIT 401c04b28ade1e45ad14d9a995d82824395a9fbf

laravel

This package is auto-updated.

Last update: 2024-03-16 20:07:56 UTC

README

This package enables you to create and run a fully functioning WebSocket server in your Laravel app. It can optionally receive messages broadcast over ZeroMQ.

Requirements

  • PHP 7.1+
  • Laravel 8+
  • ZeroMQ
  • ext-zmq for PHP

Installation

$ composer require gruz/laravel-ratchet

The service provider is loaded automatically in Laravel 5.5 using Package Autodiscovery.

Publish the vendor files so you can configure your server defaults.

$ php artisan vendor:publish --provider="Askedio\LaravelRatchet\Providers\LaravelRatchetServiceProvider"

Starting the Server

After completing installation, the quickest way to start a standard WebSocket server is simply by running:

$ php artisan ratchet:serve --driver=WsServer

This will run a simple example server based on src/Examples/Pusher.php.

It's possible to create a WampServer or an IoServer also. Use the --help switch on the command to find out more.

You should create your own server class inside your app folder by extending one of the core Ratchet server classes: RatchetWsServer.php or RatchetWampServer.php.

Then update your config/ratchet.php file to point to your server class.

Use with Laravel Broadcasting

To use broadcasting in your Laravel app with the server you create, you will need a ZeroMQ broadcast driver for Laravel (e.g. this one).

You will also need to tell your Ratchet server to bind to a ZeroMQ socket. You can do this simply by passing the -z option, i.e.:

$ php artisan ratchet:serve --driver=WsServer -z

This will connect to the socket you define in your config/ratchet.php settings and listen for messages from ZeroMQ.

To handle messages published via ZeroMQ, simply add a public function onEntry($messages) method to your server class. This will allow you to receive messages inside your Ratchet server instance and determine how to route them.