smart-crowd/centrifuge-broadcaster

Centrifuge and centrifugo broadcaster for laravel 5.1

v1.0 2015-10-31 15:24 UTC

Requires

• guzzlehttp/guzzle: 6.*
• illuminate/broadcasting: 5.1.*
• illuminate/container: 5.1.*
• predis/predis: ^1.0

Requires (Dev)

• mockery/mockery: ~0.9.1
• orchestra/testbench: ~3.0
• phpunit/phpunit: ~4.0

MIT

• Paul Klementev

• laravel
• centrifuge
• centrifugo
• broadcaster

README

Centrifuge and centrifugo broadcaster for laravel 5.1

Centrifuge is not supported at this time because changes made during the upgrade Centrifugo to 1.0 broken backward compatibility.

If you can not go to Centrifugo, use the package version 0.3.1

Installation

1. composer require smart-crowd/centrifuge-broadcaster
2. In config/broadcasting:

    'default' => 'centrifuge',
    'connections' => [
        ...
        'centrifuge' => [
            'driver'          => 'centrifuge',
            'transport'       => 'http', // or redis
            'redisConnection' => 'default', // for redis transport only
            'baseUrl'         => 'http://myapp.exapmle:8000',
            'secret'          => 'f27d79a1-821f-4e3f-47b2-7cb308768c77',
            'topLevelFields'  => [
                /**
                 * to implement
                 * http://fzambia.gitbooks.io/centrifugal/content/mixed/exclude_sender.html
                 * you should pass in payload `centClientId` field
                 */
                'centClientId' => 'client',
            ],
        ]
    ]

1. Add provider and alias in config/app.php

    'providers' => [
        ...
        SmartCrowd\Centrifuge\CentrifugeServiceProvider::class
    ],
    
    'aliases' => [
        ...
        'Centrifuge' => SmartCrowd\Centrifuge\CentrifugeFacade::class
    ]

Server configuration

http://fzambia.gitbooks.io/centrifugal/content/index.html

Send messages to centrifugo

You should just fire broadcastable event. See http://laravel.com/docs/5.1/events#broadcasting-events. Don't forget, that events are broadcasted into queued jobs, so configure your queues.

Connect from client

Use oficial centrifuge client library https://github.com/centrifugal/centrifuge-js. In your view:

<script src="https://cdn.jsdelivr.net/sockjs/1.0/sockjs.min.js"></script>
<script src="https://rawgit.com/centrifugal/centrifuge-js/master/centrifuge.js"></script>

<script>
    var centrifuge = new Centrifuge({!! json_encode(Centrifuge::getConnection($isSockJS = true)) !!});

    centrifuge.connect();

    centrifuge.on('connect', function() {
        var subscription = centrifuge.subscribe('test-channel', function(message) {
            console.log(message);
        });
    });
</script>