README

Centrifugo 广播驱动程序

简介

这是基于

• LaraComponents/centrifuge-broadcaster
• centrifugal/phpcent

要求

• PHP 7.4+ 或更高版本 = Luzifer 或 Laravel 7+
• Centrifugo 服务器 2.1.0 或更高版本（见 此处）

依赖

• guzzlehttp/guzzle

安装

使用 composer 需要此包

composer require lucify/centrifugo

打开您的 config/broadcasting.php 并添加新的连接，如下所示

    'centrifugo' => [
        'driver'  => 'centrifugo',
        'secret'  => env('CENTRIFUGO_SECRET'),
        'apikey'  => env('CENTRIFUGO_APIKEY'),
        'url'     => env('CENTRIFUGO_URL', 'https://:8000'),
        'verify'  => env('CENTRIFUGO_VERIFY', false), // Verify host ssl if centrifugo uses this
        'ssl_key' => env('CENTRIFUGO_SSL_KEY', null), // Self-Signed SSl Key for Host (require verify=true)
    ],

将这三行添加到您的 .env 文件中

CENTRIFUGO_SECRET=very-long-secret-key-from-centrifugo-config
CENTRIFUGO_APIKEY=long-secret-apikey-from-centrifugo-config
CENTRIFUGO_URL=http://your-centrifulo.url

这些行是可选的

CENTRIFUGO_SSL_KEY=/etc/ssl/some.pem
CENTRIFUGO_VERIFY=true

不要忘记更改 .env 文件中的 BROADCAST_DRIVER 设置

BROADCAST_DRIVER=centrifugo

基本用法

要配置 Centrifugo 服务器，请阅读 官方文档

有关广播事件的详细信息，请参阅 Laravel 官方文档

一个简单的客户端使用示例

<?php

namespace App\Http\Controllers;

use Lucify\Broadcasting\Centrifugo\Socket;

class ExampleController extends Controller
{
    public function home(Socket $centrifugo)
    {
        // Send message into channel
        $centrifugo->publish('channel-name', [
            'key' => 'value'
        ]);

        // Generate connection token
        $token = $centrifugo->generateConnectionToken('user id', 'timestamp', 'info');

        // Generate private channel token
        $apiSign = $centrifuge->generatePrivateChannelToken('client', 'channel', 'timestamp', 'info');

        // ...
    }
}

可用方法

许可证

MIT 许可证（MIT）。有关更多信息，请参阅 许可证文件。