README

简介

适用于 laravel >= 5.3 的 Centrifuge 广播器

要求

• PHP 5.6.4+ 或更高版本
• Laravel 5.3 或更高版本
• Centrifugo 服务器 1.6.1 或更高版本（见 此处）

安装

使用 composer 安装此包

composer require laracomponents/centrifuge-broadcaster

打开 config/app.php 并将以下内容添加到 providers 数组中

'providers' => [
    // ...
    LaraComponents\Centrifuge\CentrifugeServiceProvider::class,

    // And uncomment BroadcastServiceProvider
    App\Providers\BroadcastServiceProvider::class,
],

打开 config/broadcasting.php 并将以下内容添加到其中

'connections' => [
    'centrifuge' => [
        'driver' => 'centrifuge',
        'secret' => env('CENTRIFUGE_SECRET'), // you secret key
        'url' => env('CENTRIFUGE_URL', 'https://:8000'), // centrifuge api url
        'redis_api' => env('CENTRIFUGE_REDIS_API', false), // enable or disable Redis API
        'redis_connection' => env('CENTRIFUGE_REDIS_CONNECTION', 'default'), // name of redis connection
        'redis_prefix' => env('CENTRIFUGE_REDIS_PREFIX', 'centrifugo'), // prefix name for queue in Redis
        'redis_num_shards' => env('CENTRIFUGE_REDIS_NUM_SHARDS', 0), // number of shards for redis API queue
        'verify' => env('CENTRIFUGE_VERIFY', false), // Verify host ssl if centrifuge uses this
        'ssl_key' => env('CENTRIFUGE_SSL_KEY', null), // Self-Signed SSl Key for Host (require verify=true)
    ],
    // ...
],

对于 redis 配置，在 config/database.php 中添加一个新的连接

'redis' => [
    'centrifuge' => [
        'host' => env('REDIS_HOST', '127.0.0.1'),,
        'password' => env('REDIS_PASSWORD', null),
        'port' =>  env('REDIS_PORT', 6379),
        'database' => 0,
    ],
    // ...
],

您还可以在 .env 文件中添加配置

CENTRIFUGE_SECRET=very-long-secret-key
CENTRIFUGE_URL=https://:8000
CENTRIFUGE_REDIS_API=false
CENTRIFUGE_REDIS_CONNECTION=centrifuge
CENTRIFUGE_REDIS_PREFIX=centrifugo
CENTRIFUGE_REDIS_NUM_SHARDS=0
CENTRIFUGE_SSL_KEY=/etc/ssl/some.pem
CENTRIFUGE_VERIFY=false

不要忘记安装广播驱动程序

BROADCAST_DRIVER=centrifuge

基本用法

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

有关广播事件的说明，请参阅 Laravel 官方文档

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

<?php

namespace App\Http\Controllers;

use LaraComponents\Centrifuge\Centrifuge;

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

        // Generate token
        $token = $centrifuge->generateToken('user id', 'timestamp', 'info');

        // Generate api sign
        $apiSign = $centrifuge->generateApiSign('data');

        // ...
    }
}

可用方法

许可证

MIT 许可证（MIT）。请参阅 许可证文件 了解更多信息。