 |
VOOZH | about |
|
VOOZH | about |
This document describes the core architecture of the broadcasting system, including the BroadcastManager factory, the Broadcaster interface, and the available driver implementations (Pusher, Ably, Redis, Log, Null). It covers driver resolution, connection pooling strategies, and configuration patterns.
For information about channel authentication and authorization mechanisms, see Channel Authentication and Authorization. For event broadcasting workflows and queue integration, see Event Broadcasting and Queuing.
The broadcasting system follows a manager-driver pattern where BroadcastManager acts as a factory for creating and caching broadcaster instances. Each broadcaster implements the Broadcaster interface and handles communication with specific real-time services.
Sources: src/broadcasting/src/BroadcastManager.php1-465 src/broadcasting/src/Broadcasters/Broadcaster.php1-305 src/broadcasting/src/Contracts/Broadcaster.php1-26 src/broadcasting/src/BroadcastPoolProxy.php1-45
The BroadcastManager class serves as the central factory for creating and managing broadcaster instances. It resolves drivers based on configuration, caches instances, and optionally wraps them in connection pools.
Sources: src/broadcasting/src/BroadcastManager.php214-279 src/broadcasting/src/BroadcastManager.php244-259
| Method | Purpose | Line Reference |
|---|---|---|
driver(?string $name) | Get or create a driver instance | BroadcastManager.php224-229 |
connection(?string $driver) | Alias for driver() | BroadcastManager.php216-219 |
resolve(string $name) | Resolve driver with pool proxy if applicable | BroadcastManager.php244-259 |
doResolve(array $config) | Create actual broadcaster instance | BroadcastManager.php266-279 |
extend(string $driver, Closure $callback) | Register custom driver creator | BroadcastManager.php422-427 |
purge(?string $name) | Remove driver from cache | BroadcastManager.php412-417 |
Sources: src/broadcasting/src/BroadcastManager.php214-427
The manager also handles event queuing and provides convenient methods for initiating broadcasts:
Sources: src/broadcasting/src/BroadcastManager.php138-203
The Broadcaster interface defines three core methods that all drivers must implement:
Sources: src/broadcasting/src/Contracts/Broadcaster.php9-25
The abstract Broadcaster base class provides shared functionality for all drivers:
| Feature | Description | Line Reference |
|---|---|---|
| Channel registration | Store channel auth callbacks | Broadcaster.php72-85 |
| Pattern matching | Match channel names against patterns | Broadcaster.php283-286 |
| Parameter extraction | Extract route-like parameters from channels | Broadcaster.php119-128 |
| Implicit binding | Auto-resolve Eloquent models from parameters | Broadcaster.php189-206 |
| User retrieval | Get authenticated user with guard support | Broadcaster.php243-262 |
| Channel options | Store and retrieve per-channel configuration | Broadcaster.php267-278 |
Sources: src/broadcasting/src/Broadcasters/Broadcaster.php23-304
The base class supports Laravel-style route patterns in channel names:
Sources: src/broadcasting/src/Broadcasters/Broadcaster.php165-170 src/broadcasting/src/Broadcasters/Broadcaster.php119-128 tests/Broadcasting/BroadcasterTest.php52-75
Integrates with the Pusher Channels service using the Pusher PHP SDK.
Key Features:
private-, presence-, private-encrypted- prefixes)UsePusherChannelConventions traitConfiguration Example:
Sources: src/broadcasting/src/Broadcasters/PusherBroadcaster.php1-159 src/broadcasting/public/broadcasting.php51-73 src/broadcasting/src/BroadcastManager.php300-334
Integrates with the Ably Realtime service using the Ably REST PHP SDK.
Key Features:
private:, presence:, public: prefixes)Channel Format Mapping:
| Input Channel | Formatted Channel |
|---|---|
private-chat | private:chat |
presence-room | presence:room |
notifications | public:notifications |
Configuration Example:
Sources: src/broadcasting/src/Broadcasters/AblyBroadcaster.php1-204 src/broadcasting/src/Broadcasters/AblyBroadcaster.php156-170 src/broadcasting/public/broadcasting.php75-84 src/broadcasting/src/BroadcastManager.php339-350
Broadcasts events via Redis pub/sub channels.
Key Features:
RedisFactory for connection managementBroadcast Flow:
Configuration Example:
Sources: src/broadcasting/src/Broadcasters/RedisBroadcaster.php1-78 src/broadcasting/public/broadcasting.php86-89 src/broadcasting/src/BroadcastManager.php355-363
Logs broadcast events using PSR-3 logger. Useful for development and debugging.
Output Format:
Broadcasting [event.name] on channels [channel1, channel2] with payload:
{
"key": "value",
...
}
Sources: src/broadcasting/src/Broadcasters/LogBroadcaster.php1-39 src/broadcasting/src/BroadcastManager.php368-371
No-op implementation that discards all broadcasts. Used when broadcasting is disabled.
Sources: src/broadcasting/src/Broadcasters/NullBroadcaster.php1-31 src/broadcasting/src/BroadcastManager.php376-379
| Driver | Use Case | Connection Pooled | External Service | Authentication |
|---|---|---|---|---|
| Pusher | Production real-time apps | Yes | Pusher Channels | Token-based |
| Ably | Production real-time apps | Yes | Ably Realtime | Token-based |
| Redis | Self-hosted pub/sub | No | Redis Server | Channel-based |
| Log | Development/debugging | No | None | None |
| Null | Testing/disabled | No | None | None |
Sources: src/broadcasting/src/BroadcastManager.php61-62
Pusher and Ably drivers are wrapped in connection pools to reuse connections across requests in the Swoole/coroutine environment.
Sources: src/broadcasting/src/BroadcastPoolProxy.php1-45 src/broadcasting/src/BroadcastManager.php41-62 src/broadcasting/src/BroadcastManager.php252-258
Pool settings are defined per connection in the configuration:
The HasPoolProxy trait provides pool management functionality:
createPoolProxy() - Wraps driver in BroadcastPoolProxy['ably', 'pusher'])Sources: src/broadcasting/public/broadcasting.php67-72 src/broadcasting/public/broadcasting.php78-83 src/broadcasting/src/BroadcastManager.php41-62
The BroadcastPoolProxy extends PoolProxy and implements the Broadcaster interface, proxying all method calls through the pool:
Sources: src/broadcasting/src/BroadcastPoolProxy.php12-44
Broadcasting configuration is defined in config/autoload/broadcasting.php:
Sources: src/broadcasting/public/broadcasting.php1-100
The ConfigProvider registers the BroadcastManager as the implementation of Factory:
Sources: src/broadcasting/src/ConfigProvider.php1-28
The BroadcastManager provides methods to register authentication routes:
Default Middleware:
web middleware groupVerifyCsrfToken (CSRF protection disabled for these routes)Method Signatures:
| Method | Route | Purpose | Line Reference |
|---|---|---|---|
routes(array $attributes = []) | /broadcasting/auth | Channel authorization | BroadcastManager.php74-95 |
userRoutes(?array $attributes = null) | /broadcasting/user-auth | User authentication | BroadcastManager.php100-114 |
channelRoutes(?array $attributes = null) | /broadcasting/auth | Alias for routes() | BroadcastManager.php121-124 |
Sources: src/broadcasting/src/BroadcastManager.php74-124 src/broadcasting/src/BroadcastController.php1-33 tests/Broadcasting/BroadcastManagerTest.php124-182
The manager provides a helper to extract the socket ID from requests, used to prevent echo (broadcasting back to the sender):
Sources: src/broadcasting/src/BroadcastManager.php129-134
The manager supports custom driver registration via the extend() method:
Custom drivers must implement the Broadcaster interface.
Refresh this wiki