roadrunner-php / broadcast

:electric_plug: RoadRunner Broadcast SDK

RoadRunner Broadcast Plugin Bridge

This repository contains the codebase bridge for broadcast RoadRunner plugin.

Installation

To install application server and broadcast codebase

$ composer require spiral/roadrunner-broadcast

You can use the convenient installer to download the latest available compatible version of RoadRunner assembly:

$ composer require spiral/roadrunner-cli --dev
$ vendor/bin/rr get

Usage

For example, such a configuration would be quite feasible to run:

rpc:
  listen: tcp://127.0.0.1:6001

server:
  # Don't forget to create a "worker.php" file
  command: "php worker.php" 
  relay: "pipes"

http:
  address: 127.0.0.1:80
  # Indicate that HTTP support ws protocol
  middleware: [ "websockets" ]

websockets:
    broker: default
    path: "/ws"

broadcast:
    default:
        driver: memory
        config: {}

Read more about all available brokers on the documentation page.

After configuring and starting the RoadRunner server, the corresponding API will become available to you.

<?php

use Spiral\Goridge\RPC\RPC;
use Spiral\RoadRunner\Broadcast\Broadcast;

require __DIR__ . '/vendor/autoload.php';

$broadcast = new Broadcast(RPC::create('tcp://127.0.0.1:6001'));

//
// Now we can send a message to a specific topic
//
$broadcast->publish('channel-1', 'message for channel #1');

Select Specific Topic

Alternatively, you can also use a specific topic (or set of topics) as a separate entity and post directly to it.

// Now we can select the topic we need to work only with it
$topic = $broadcast->join(['channel-1', 'channel-2']);

// And send messages there
$topic->publish('message');
$topic->publish(['another message', 'third message']);

Read more about all the possibilities in the documentation page.

Client

In addition to the server (PHP) part, the client part is also present in most projects. In most cases, this is a browser in which the connection to the server is made using the WebSocket protocol.

const ws = new WebSocket('ws://127.0.0.1/broadcast');

ws.onopen = e => {
    const message = {
        command: 'join',
        topics:  ['channel-1', 'channel-2']
    };

    ws.send(JSON.stringify(message));
};

ws.onmessage = e => {
    const message = JSON.parse(e.data);

    console.log(`${message.topic}: ${message.payload}`);
}

Examples

Examples are available in the corresponding directory ./example.

License

The MIT License (MIT). Please see LICENSE for more information. Maintained by Spiral Scout.

broadcast's Issues

Consume Go message and batch Job to PHP

How would we consume message from Go and batch them in Job in PHP? Any example to make it possible?

Need some documentation for this library

Is there any documentation for this library? If now, any examples

Can't get the default configuration to work

Hi, and thanks for the great ecosystem!

I am having a trouble getting the broadcast plugin to work. I've followed the example:

websockets:
    broker: default
    path: "/ws"

broadcast:
    default:
        driver: memory
        config: {}

Then I have

$rpc = \Spiral\Goridge\RPC\RPC::create('tcp://127.0.0.1:6001');
$broadcast = new Broadcast($rpc);
$broadcast->publish('channel-1', 'message for channel #1');

But in the logs I can see

backend-payments-1  | 2022-09-14T06:16:11.349Z	DEBUG	broadcast   	message was published	{"msg": "messages:{topics:\"channel-1\" payload:\"message for channel #1\"}"}
backend-payments-1  | 2022-09-14T06:16:11.349Z	WARN	broadcast   	no publishers was registered

From what I can see the error is triggered here

https://github.com/roadrunner-server/broadcast/blob/master/plugin.go#L99

Which can only happen if there are no registered publishers. They re registered by the method call of GetDriver, but for Gods love, I didn't find anywhere this method to be called, neither in endure or roadrunner, so not sure how to proceed to resolve the issue.

Support for RoadRunner 2.0

As stated here, there are plans to use RR with broadcasting on 2.0, but I haven't seen if there is an update on progress, or what will break with the new version.