netflex/message-channel

此包最新版本(v5.0.2)的许可证信息不可用。

v5.0.2 2024-08-16 15:57 UTC

This package is auto-updated.

Last update: 2024-09-16 16:09:39 UTC


README

Stable version Build status License: MIT Contributors Downloads

[只读] Netflex MessageChannel 组件的子树分割(参见 netflex/framework

这个库允许您使用 Netflex MessageChannel API 通过 WebSocket 向连接的客户端发送实时消息。

安装

只需将此包作为依赖项添加到基于 Netflex SDKv2 的项目中,即可使用,无需额外的设置。

composer require netflex/message-channel

使用方法

<?php

use MessageChannel;

MessageChannel::broadcast(['status' => 'Hello World']);

这将向 MessageChannel API 服务器发送此消息,然后通过 WebSocket 将该消息转发给其连接的客户端。

处理传入的消息

要处理传入的消息,您必须注册一个处理程序。这可以在应用程序的配置文件 config/message-channel.php 中进行配置

<?php

return [
  'handler' => [
    'endpoint' => 'https://my-endpoint-to-handle-incoming-messages',
    'method' => 'post' // This is optional, 'post' is the default method
  ]
];

向特定客户端/主题发送消息

客户端可以注册一个 '主题'。如果您使用例如用户ID作为主题,然后您可以向这个特定的主题转发消息。

<?php

use MessageChannel;

// Only clients listening for the 'news' topic will receive this message
MessageChannel::broadcast(['status' => 'Hello World'], 'news');

与 Laravel 的广播系统一起使用

此包还提供了一个驱动程序,使其能够与 Laravel 的广播系统一起工作。

将以下内容添加到应用程序的 config/broadcasting.php

<?php

return [
  'default' => 'message-channel',

  'connections' => [

    'message-channel' => [
      'driver' => 'netflex'
    ]
  ]
];