broadcastt / broadcastt-laravel-http
Laravel 广播 HTTP API 库
Requires
- php: ^8.0
- broadcastt/broadcastt-php-http: ^0.4.3
- illuminate/broadcasting: ^9.0|^10.0
- illuminate/support: ^9.0|^10.0
Requires (Dev)
- graham-campbell/testbench: ^6.0
- mockery/mockery: ^1.0
- orchestra/testbench: ^7.0|^8.0
- phpunit/phpunit: ^9.5
README
实时网络应用是未来。 Broadcastt 提供工具,帮助开发者创建实时应用。
Laravel HTTP 库
请注意,此库仍在测试版,尚未达到第一个重大版本。
语义版本 2.0.0
主版本零(0.y.z)用于初始开发。任何内容都可能随时更改。公共 API 应不视为稳定。
此库与 Laravel 5.5+ 兼容
这是一个 Laravel 的 HTTP 库。如果您正在寻找客户端库或不同的服务器库,请查看我们的 库列表。
有关教程和更深入的文档,请访问 官方网站。
文档
第一步
使用 Composer 安装此包
composer require broadcastt/broadcastt-laravel-http
Broadcastt 服务提供程序会自动注册。
Broadcastt\Laravel\BroadcasttServiceProvider
如果您想,您可以注册 Broadcastt 外观。
'Broadcastt' => Broadcastt\Laravel\Facades\Broadcastt::class
配置
要仅配置 Broadcasting 驱动程序,您必须修改 config/broadcasting.php
文件。您必须在 connections
数组中有一个项目,其驱动程序设置为 broadcastt
。
'broadcastt' => [
'driver' => 'broadcastt',
'id' => env('BROADCASTER_APP_ID'),
'key' => env('BROADCASTER_APP_KEY'),
'secret' => env('BROADCASTER_APP_SECRET'),
'cluster' => env('BROADCASTER_APP_CLUSTER'),
],
推荐的方法是使用环境变量或使用 .env
来配置这些数据。
您还可以使用 PUSHER_APP_KEY
、PUSHER_APP_SECRET
、PUSHER_APP_ID
和 PUSHER_APP_CLUSTER
环境变量分别。
要配置外观的其他连接,您应该发布 config/broadcastt.php
。
php artisan vendor:publish --provider="Broadcastt\Laravel\BroadcasttServiceProvider"
在发布的 config/broadcasting.php
文件中,您可以定义许多连接。
id
(整数)
应用程序的 ID
key
(字符串)
应用程序的密钥
secret
(字符串)
应用程序的秘密
cluster
(字符串)可选
应用程序的集群
默认值:eu
其他选项
useTLS
(字符串)
将 scheme
改为 https
和将 port
改为 443
的简写方式
debug
(布尔值)
为所有请求开启调试
默认值:false
basePath
(字符串)
请求将调用的路径的基础
默认值:/apps/{AppId}
scheme
(字符串)
例如 http 或 https
默认值:http
host
(字符串)
主机,例如 cluster.broadcasttapp.com。不允许尾部反斜杠
默认值:eu.broadcasttapp.xyz
如果初始化时未设置集群
port
(字符串)
http 端口
默认值:80
timeout
(字符串)
http 超时
默认值:30
使用广播器的用法
BroadcasttServiceProvider
为广播注册了一个驱动程序,因此您可以在 config/broadcasting.php
中使用 broadcastt
驱动程序进行广播。
例如,您可以设置 BROADCAST_DRIVER
环境变量为 broadcastt
。
使用外观的用法
client($connection = null)
返回一个客户端实例
connection($connection = null)
client($connection = null)
的别名
trigger($channels, $name, $data, $socketId = null, $jsonEncoded = false)
通过提供事件名称和有效负载来触发事件。
可选地提供socket ID以排除客户端(很可能是发送者)。
triggerBatch($batch = [], $encoded = false)
同时触发多个事件。
get($path, $params = [])
使用同步http客户端获取任意REST API资源。
所有请求签名都自动处理。
贡献
欢迎所有愿意帮助使这个库“更强大、更好、更快、更强”的人。