Laravel Centrifugo Broadcaster

https://github.com/opekunov/laravel-centrifugo-broadcaster
Admin
A Laravel broadcast driver for Centrifugo 5-6 that enables real-time messaging and WebSocket...
Tokens:35,560
Snippets:405
Trust Score:6.2
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install the package

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/README.md

Use Composer to add the package to your Laravel project.

```bash
composer require opekunov/laravel-centrifugo-broadcaster
```

--------------------------------

### Install and Configure Laravel Centrifugo

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/QUICK-REFERENCE.md

Commands to install the package and required environment variables for connection.

```bash
# Install package
composer require opekunov/laravel-centrifugo-broadcaster

# Add to .env
CENTRIFUGO_SECRET=your_secret
CENTRIFUGO_APIKEY=your_api_key
CENTRIFUGO_URL=http://localhost:8000
BROADCAST_CONNECTION=centrifugo  # or BROADCAST_DRIVER in Laravel 10
```

--------------------------------

### Install broadcasting for Laravel 11+

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/README.md

Use the artisan command to automatically set up broadcasting configuration.

```bash
php artisan install:broadcasting
```

--------------------------------

### Install Centrifuge JavaScript Client

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/README.md

Install the required centrifuge package via npm.

```bash
npm install centrifuge
```

--------------------------------

### Install package via Composer

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/README.md

Run this command in your terminal to add the package to your project.

```bash
composer req opekunov/laravel-centrifugo-broadcaster
```

--------------------------------

### Handle Complete HTTP Responses

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/HttpResponse.md

A full example demonstrating how to perform a POST request, check status codes, and handle success or error states using the HttpClient.

```php
<?php
use Opekunov\Centrifugo\Http\HttpClient;
use Opekunov\Centrifugo\Exceptions\CentrifugoException;
use Opekunov\Centrifugo\Exceptions\CentrifugoConnectionException;

$httpClient = new HttpClient();

try {
    $response = $httpClient->post(
        'http://centrifugo:8000/api/channels',
        [
            'headers' => [
                'Content-Type' => 'application/json',
                'X-API-Key' => 'your-api-key',
            ],
            'body' => json_encode(['pattern' => '']),
            'timeout' => 5,
            'tries' => 2,
        ]
    );

    // Check response status
    echo "Status: " . $response->getStatusCode() . "\n";
    echo "Headers: " . json_encode($response->getHeaders()) . "\n";

    if ($response->isSuccessful()) {
        $data = json_decode($response->getBody(), true);
        echo "Channels: " . json_encode($data) . "\n";
    } elseif ($response->isClientError()) {
        echo "Invalid request: " . $response->getBody() . "\n";
    } elseif ($response->isServerError()) {
        echo "Server error: " . $response->getStatusCode() . "\n";
    }
} catch (CentrifugoConnectionException $e) {
    echo "Connection failed: " . $e->getMessage() . "\n";
} catch (CentrifugoException $e) {
    echo "Request error: " . $e->getMessage() . "\n";
}
```

--------------------------------

### Generate Subscription Tokens

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/configuration.md

Examples for generating subscription tokens with default or custom expiration times.

```php
// Default 2 minutes (120 seconds)
$token = $centrifugo->generateSubscriptionToken(
    $userId,
    $channel,
    Carbon::now()->addSeconds($centrifugo->getDefaultTokenExpiration())
);
```

```php
// 1 hour expiration for this token
$token = $centrifugo->generateSubscriptionToken(
    $userId,
    $channel,
    Carbon::now()->addHour()
);
```

--------------------------------

### Event Broadcasting Implementation

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoBroadcaster.md

Example of a Laravel event class configured for broadcasting and how to dispatch it.

```php
<?php
namespace App\Events;

use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Contracts\Broadcasting\ShouldBroadcastNow;

class MessageSent implements ShouldBroadcastNow
{
    public function __construct(
        public string $message,
        public int $userId
    ) {}

    public function broadcastOn()
    {
        return new PrivateChannel('chat');
    }

    public function broadcastAs()
    {
        return 'message.sent';
    }

    public function broadcastWith()
    {
        return [
            'message' => $this->message,
            'user_id' => $this->userId,
        ];
    }
}

event(new MessageSent('Hello', 42));
MessageSent::dispatch('Hello', 42);
```

--------------------------------

### Production Configuration (HTTPS with Default CA)

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/configuration.md

Production setup using system CA certificates for SSL verification.

```php
'centrifugo' => [
    'driver' => 'centrifugo',
    'secret' => env('CENTRIFUGO_SECRET'),
    'apikey' => env('CENTRIFUGO_APIKEY'),
    'url' => 'https://centrifugo.example.com:8000',
    'api_path' => '/api',
    'verify' => true,  // Use system CA certificates
    'timeout' => 10,
    'tries' => 3,
    'token_expire_time' => 3600,
],
```

--------------------------------

### Publishing to Channel Namespaces

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/QUICK-REFERENCE.md

Examples of publishing data to various channel types including public, private, user-specific, and room-based channels.

```php
// Public channels
$centrifugo->publish('public:news', $data);

// Private channels
$centrifugo->publish('private:messages', $data);

// User-specific
$centrifugo->publish('user:123:messages', $data);

// Rooms/Groups
$centrifugo->publish('room:42:chat', $data);
```

--------------------------------

### info()

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoInterface.md

Gets server node statistics.

```APIDOC
## info()

### Description
Get server node statistics.

### Returns
- **array** - The decoded JSON response from the Centrifugo server.
```

--------------------------------

### Example Decoded Connection Token

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/types.md

An example of a decoded JWT token payload structure.

```php
[
    'typ' => 'JWT',
    'alg' => 'HS256',
]
// payload:
[
    'sub' => 'user-123',
    'exp' => 1704067200,
    'info' => [
        'username' => 'john',
        'avatar_url' => 'https://example.com/avatar.jpg',
    ],
    'channels' => [
        'notifications',
        'updates',
        'user:123:private',
    ],
]
```

--------------------------------

### Production Configuration (HTTPS with Self-Signed Cert)

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/configuration.md

Production setup requiring SSL verification and a specific path to the SSL key.

```php
'centrifugo' => [
    'driver' => 'centrifugo',
    'secret' => env('CENTRIFUGO_SECRET'),
    'apikey' => env('CENTRIFUGO_APIKEY'),
    'url' => env('CENTRIFUGO_URL', 'https://centrifugo.example.com:8000'),
    'api_path' => '/api',
    'verify' => true,
    'ssl_key' => env('CENTRIFUGO_SSL_KEY', '/etc/ssl/certs/centrifugo.pem'),
    'timeout' => 10,
    'tries' => 3,  // More retries for production
    'token_expire_time' => 3600,  // 1 hour
    'show_node_info' => false,
],
```

--------------------------------

### Channels Pattern Matching

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/types.md

Examples of using Centrifugo glob patterns with the channels() method.

```php
// Get all channels
$centrifugo->channels('');

// Get chat channels
$centrifugo->channels('chat:*');

// Get specific namespace
$centrifugo->channels('notifications:*');

// Get channels with numeric suffix
$centrifugo->channels('room:[0-9]*');
```

--------------------------------

### channels(string $pattern)

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoInterface.md

Gets a list of active channels.

```APIDOC
## channels(string $pattern = '')

### Description
Get list of active channels.

### Parameters
- **pattern** (string) - Optional

### Returns
- **array** - The decoded JSON response from the Centrifugo server.
```

--------------------------------

### POST /api/presence

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-endpoints.md

Get full presence information for a channel.

```APIDOC
## POST /api/presence

### Description
Get full presence information for a channel.

### Method
POST

### Endpoint
/api/presence

### Parameters
#### Request Body
- **channel** (string) - Required - Channel name

### Request Example
{
  "channel": "channel:name"
}

### Response
#### Success Response (200)
- **code** (int) - Status code (0 for success)
- **data** (object) - Map of client IDs to presence info

#### Response Example
{
  "code": 0,
  "data": {
    "presence": {
      "client_id_1": {
        "user": "user_1",
        "info": {
          "name": "John",
          "avatar": "https://..."
        }
      }
    }
  }
}
```

--------------------------------

### Get channel presence information

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoInterface.md

Retrieves full presence information for a channel.

```php
public function presence(string $channel): array;
```

--------------------------------

### Example Decoded Subscription Token

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/types.md

Shows the structure of a decoded JWT payload before signature verification.

```php
// After decoding JWT (before signature verification)
[
    'typ' => 'JWT',
    'alg' => 'HS256',
]
// payload:
[
    'sub' => 'user-123',
    'channel' => 'private:chat',
    'exp' => 1704067200,  // 2024-01-01 00:00:00 UTC
    'info' => [
        'username' => 'john',
        'role' => 'moderator',
    ],
]
```

--------------------------------

### Get Server Info Response

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-endpoints.md

Successful response containing node information and server metrics.

```json
{
  "code": 0,
  "data": {
    "nodes": [
      {
        "name": "centrifugo-1",
        "version": "5.0.0",
        "uptime": 3600,
        "metrics": {
          "num_clients": 1000,
          "num_channels": 150,
          "num_users": 800
        }
      }
    ]
  }
}
```

--------------------------------

### Get Server Info Request

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-endpoints.md

Empty request body for retrieving server statistics.

```json
{}
```

--------------------------------

### Get channel presence statistics

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoInterface.md

Retrieves the number of clients and unique users in a channel.

```php
public function presenceStats(string $channel): array;
```

--------------------------------

### Retrieve and Inspect Headers

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/HttpResponse.md

Get all response headers as an array and iterate through them to find specific values.

```php
$headers = $response->getHeaders();
// [
//     'HTTP/1.1 200 OK',
//     'Content-Type: application/json',
//     'Content-Length: 1024',
// ]

// Check for specific headers
foreach ($headers as $header) {
    if (str_starts_with($header, 'Content-Type')) {
        echo "Found: " . $header;
    }
}
```

--------------------------------

### Centrifugo API Response Formats

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoInterface.md

Examples of successful and error response arrays returned by interface methods.

```php
['code' => 0]  // code 0 = success
```

```php
[
    'error' => [
        'message' => 'Error description',
        'code' => error_code  // Error code from server
    ]
]
```

--------------------------------

### Initialize HttpClient

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/HttpClient.md

Instantiate the client with default settings or override them using an options array.

```php
// Default HTTP client
$httpClient = new HttpClient();

// With custom defaults
$httpClient = new HttpClient([
    'timeout' => 10,
    'verify_ssl' => false,
    'ssl_cert' => '/etc/ssl/certs/custom.pem'
]);

// Per-request options override these defaults
```

--------------------------------

### Basic Usage via Dependency Injection and Service Locator

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/QUICK-REFERENCE.md

Demonstrates publishing messages, retrieving presence/history, and generating tokens using the Centrifugo service.

```php
use Opekunov\\\Centrifugo\\\Centrifugo;
use Carbon\\\Carbon;

// Via dependency injection (recommended)
public function example(Centrifugo $centrifugo)
{
    // Publish message
    $centrifugo->publish('channel', ['message' => 'Hello']);
    
    // Broadcast to multiple channels
    $centrifugo->broadcast(['ch1', 'ch2'], ['alert' => 'Update']);
    
    // Get presence
    $presence = $centrifugo->presence('channel');
    
    // Get history
    $history = $centrifugo->history('channel', limit: 10);
    
    // Generate tokens
    $connToken = $centrifugo->generateConnectionToken('user123');
    $subToken = $centrifugo->generateSubscriptionToken(
        'user123', 'channel', Carbon::now()->addHour()
    );
}

// Via service locator
$centrifugo = app('centrifugo');
$centrifugo->publish('channel', ['data']);
```

--------------------------------

### POST /api/presence_stats

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-endpoints.md

Get aggregated presence statistics for a channel.

```APIDOC
## POST /api/presence_stats

### Description
Get aggregated presence statistics.

### Method
POST

### Endpoint
/api/presence_stats

### Parameters
#### Request Body
- **channel** (string) - Required - Channel name

### Request Example
{
  "channel": "channel:name"
}

### Response
#### Success Response (200)
- **code** (int) - Status code (0 for success)
- **data** (object) - Contains presence_stats with num_clients and num_users

#### Response Example
{
  "code": 0,
  "data": {
    "presence_stats": {
      "num_clients": 42,
      "num_users": 38
    }
  }
}
```

--------------------------------

### View class hierarchy

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/README.md

Overview of the package's service providers, broadcasters, interfaces, and exception handling classes.

```text
Illuminate\Support\ServiceProvider
└── CentrifugoServiceProvider
    ├── boot() - registers 'centrifugo' driver
    └── register() - registers service bindings

Illuminate\Broadcasting\Broadcasters\Broadcaster
└── CentrifugoBroadcaster
    ├── auth(Request $request) - channel authentication
    └── broadcast(array $channels, $event, array $payload) - broadcast events

CentrifugoInterface (interface)
└── Centrifugo (main class)
    ├── publish/broadcast/publishMany - messaging
    ├── presence/presenceStats/history - channel info
    ├── subscribe/unsubscribe/disconnect - subscriptions
    ├── channels/info/rpc - server operations
    └── generateConnectionToken/generateSubscriptionToken - authentication

Exception (PHP built-in)
└── CentrifugoException
    └── CentrifugoConnectionException

Http\HttpClient
└── post(string $url, array $options) → HttpResponse

Http\HttpResponse
├── getStatusCode() → int
├── isSuccessful() → bool
├── isClientError() → bool
└── isServerError() → bool
```

--------------------------------

### Boot Method Implementation

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoServiceProvider.md

Extends the Laravel broadcast manager to include the Centrifugo driver.

```php
public function boot(BroadcastManager $broadcastManager)
{
    $broadcastManager->extend('centrifugo', function ($app) {
        return new CentrifugoBroadcaster($app->make('centrifugo'));
    });
}
```

--------------------------------

### Optimizing Performance with Batching

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/QUICK-REFERENCE.md

Demonstrates efficient publishing methods using batch requests and broadcasting to multiple channels compared to individual requests.

```php
// ✅ Good - Single batch request
$centrifugo->publishMany([
    ['channel' => 'ch1', 'data' => [...]], 
    ['channel' => 'ch2', 'data' => [...]],
]);

// ❌ Slow - Multiple requests
$centrifugo->publish('ch1', [...]);
$centrifugo->publish('ch2', [...]);

// ✅ Good - Broadcast to multiple channels
$centrifugo->broadcast(['ch1', 'ch2'], $data);

// ❌ Slow - Same message, multiple requests
```

--------------------------------

### Instantiate Centrifugo Class

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/Centrifugo.md

Shows how to initialize the Centrifugo client using the Laravel service container, direct instantiation with configuration, or dependency injection.

```php
// Using Laravel service container (recommended)
$centrifugo = app('centrifugo');

// Or using the class directly with explicit config
$centrifugo = new Centrifugo([
    'url' => 'http://localhost:8000',
    'api_path' => '/api',
    'secret' => 'your-secret-key',
    'apikey' => 'your-api-key',
    'timeout' => 3,
    'tries' => 1,
]);

// Or using dependency injection
public function someController(Centrifugo $centrifugo) {
    // $centrifugo is ready to use
}
```

--------------------------------

### Get server node statistics

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoInterface.md

Retrieves statistics for the server node.

```php
public function info(): array;
```

--------------------------------

### HttpClient Constructor

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/HttpClient.md

Initializes a new instance of the HttpClient with optional default configuration settings.

```APIDOC
## Constructor

### Signature
`public function __construct(array $options = [])`

### Parameters
- **options** (array) - Optional - Default HTTP options merged with every request. Supported keys: `timeout` (int, default 30), `verify_ssl` (bool, default true), `ssl_cert` (string|null, default null).
```

--------------------------------

### View Package File Structure

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/README.md

Displays the directory layout of the source code, highlighting the main broadcaster class, service provider, and HTTP transport components.

```text
src/
├── Centrifugo.php                  # Main class
├── CentrifugoBroadcaster.php       # Laravel broadcaster
├── CentrifugoServiceProvider.php   # Service registration
├── Contracts/
│   └── CentrifugoInterface.php     # Public API interface
├── Exceptions/
│   ├── CentrifugoException.php     # Base exception
│   └── CentrifugoConnectionException.php  # Network errors
└── Http/
    ├── HttpClient.php             # HTTP transport
    └── HttpResponse.php           # Response wrapper
```

--------------------------------

### Get server statistics

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/Centrifugo.md

Retrieves information and metrics about the running Centrifugo server nodes.

```php
$info = $centrifugo->info();

// Response structure contains details about:
// - Running nodes
// - Connections count
// - Uptime
// - Memory usage
// - And other server metrics
```

--------------------------------

### Development Configuration

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/configuration.md

Standard configuration for local development environments using HTTP.

```php
'centrifugo' => [
    'driver' => 'centrifugo',
    'secret' => env('CENTRIFUGO_SECRET', 'dev-secret'),
    'apikey' => env('CENTRIFUGO_APIKEY', 'dev-key'),
    'url' => env('CENTRIFUGO_URL', 'http://localhost:8000'),
    'api_path' => '/api',
    'verify' => false,
    'timeout' => 5,
    'tries' => 1,
    'token_expire_time' => 300,  // 5 minutes
],
```

--------------------------------

### Get default token expiration

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoInterface.md

Returns the default expiration time for tokens in seconds.

```php
public function getDefaultTokenExpiration(): int;
```

--------------------------------

### Boot Method Signature

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoServiceProvider.md

The boot method signature for the service provider.

```php
public function boot(BroadcastManager $broadcastManager): void
```

--------------------------------

### Get active channels

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoInterface.md

Retrieves a list of active channels, optionally filtered by a pattern.

```php
public function channels(string $pattern = ''): array;
```

--------------------------------

### HttpClient::post() Options

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/types.md

Configuration array structure for HTTP requests made by the broadcaster.

```APIDOC
## HttpClient Options Array

### Description
Configuration options used when performing HTTP requests via the broadcaster client.

### Fields
- **headers** (array) - HTTP headers as key-value pairs (Default: [])
- **body** (string) - Request body (Default: '')
- **timeout** (int|float) - Request timeout in seconds (Default: 30)
- **tries** (int) - Retry attempts on connection error (Default: 1)
- **verify_ssl** (bool) - Verify SSL certificate (Default: true)
- **ssl_cert** (string|null) - Client certificate path (Default: null)
```

--------------------------------

### Set environment variables

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/README.md

Define the required and optional environment variables in your .env file.

```text
CENTRIFUGO_SECRET=token_hmac_secret_key-from-centrifugo-config
CENTRIFUGO_APIKEY=api_key-from-centrifugo-config
CENTRIFUGO_URL=http://localhost:8000
```

```text
CENTRIFUGO_SSL_KEY=/etc/ssl/some.pem
CENTRIFUGO_VERIFY=false
CENTRIFUGO_API_PATH=/api
CENTRIFUGO_SHOW_NODE_INFO=false
CENTRIFUGO_TIMEOUT=10
CENTRIFUGO_TRIES=1
CENTRIFUGO_TOKEN_EXPIRE=120
```

--------------------------------

### Configure HTTP Client Options

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/types.md

Defines the structure for the options array passed to HttpClient::post().

```php
[
    'headers' => [
        'Content-Type' => 'application/json',
        'X-API-Key' => 'key',
    ],
    'body' => '{"data": "..."}',
    'timeout' => 5,
    'tries' => 3,
    'verify_ssl' => true,
    'ssl_cert' => '/path/to/cert.pem',
]
```

--------------------------------

### Authentication Implementation

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoBroadcaster.md

Shows how to configure channel authentication in Laravel and handle the token request on the frontend.

```php
Broadcast::channel('private:chat', function ($user) {
    return true;
});
```

```javascript
const sub = client.newSubscription('private:chat', {
    getToken: async (ctx) => {
        const res = await fetch('/broadcasting/auth', {
            method: 'POST',
            headers: { 'Content-Type': 'application/json' },
            body: JSON.stringify(ctx),
        });
        return (await res.json()).token;
    },
});
```

--------------------------------

### Get channel message history

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoInterface.md

Retrieves message history from a channel with optional pagination parameters.

```php
public function history(
    string $channel,
    int $limit = 0,
    ?int $offset = null,
    ?string $epoch = null,
    bool $reverse = false
): array;
```

--------------------------------

### Instantiate HttpClient

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoServiceProvider.md

Creates a new HttpClient instance for use with the Centrifugo service.

```php
$http = new HttpClient;
return new Centrifugo($config, $http);
```

--------------------------------

### Project Directory Structure

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/INDEX.md

Visual representation of the package file organization.

```text
output/
├── INDEX.md (this file)
├── README.md (overview and quick start)
├── configuration.md (config options)
├── types.md (type definitions)
├── errors.md (exceptions)
├── api-endpoints.md (HTTP API reference)
└── api-reference/
    ├── Centrifugo.md (main class)
    ├── CentrifugoBroadcaster.md (Laravel broadcaster)
    ├── CentrifugoServiceProvider.md (service setup)
    ├── CentrifugoInterface.md (interface definition)
    ├── HttpClient.md (HTTP transport)
    └── HttpResponse.md (response wrapper)
```

--------------------------------

### Get Presence API Request and Response

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-endpoints.md

Use the /api/presence endpoint to retrieve active client information for a channel.

```http
POST /api/presence HTTP/1.1
Host: localhost:8000
Content-Type: application/json
X-API-Key: my-api-key
Content-Length: 28

{"channel":"chat:room1"}
```

```json
{
  "code": 0,
  "data": {
    "presence": {
      "client1": {
        "user": "user_123",
        "info": {"name": "John"}
      }
    }
  }
}
```

--------------------------------

### Run Quick Tests

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/tests/README.md

Execute unit, security, and HTTP client tests without requiring a running Centrifugo server.

```bash
# Run all unit tests (no server required)
composer test:unit

# Run security tests
composer test:security

# Run HTTP client tests
composer test:http
```

--------------------------------

### Configure Centrifuge Frontend Client

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/README.md

Initialize the Centrifuge client, handle connection events, and implement token-based subscription authentication.

```js
import { Centrifuge, UnauthorizedError } from 'centrifuge';

// CONNECTION_TOKEN must be obtained from Centrifugo::generateConnectionToken(...)
const client = new Centrifuge('ws://localhost:8000/connection/websocket', {
  token: 'CONNECTION_TOKEN'
});

// Connection state events
client.on('connected', (ctx) => {
  console.log('Connected:', ctx.client, 'transport:', ctx.transport);
});

client.on('disconnected', (ctx) => {
  console.log('Disconnected:', ctx.code, ctx.reason);
});

// Getting a subscription token from your Laravel application.
// Don't forget to add 'path' => [..., 'broadcasting/auth'] to your application's cors.php file
async function getSubscriptionToken(ctx) {
  const res = await fetch('/broadcasting/auth', {
    method: 'POST',
    headers: new Headers({ 'Content-Type': 'application/json' }),
    body: JSON.stringify(ctx),
  });
  if (!res.ok) {
    if (res.status === 403) {
      throw new UnauthorizedError();
    }
    throw new Error(`Unexpected status code ${res.status}`);
  }
  const data = await res.json();
  return data.token;
}

// Subscribe to a private channel
const sub = client.newSubscription('private:chat', {
  getToken: getSubscriptionToken,
});

// Listen for messages
sub.on('publication', (ctx) => {
  console.log('New message:', ctx.data);
});

sub.on('subscribed', (ctx) => {
  console.log('Subscribed to', ctx.channel);
});

sub.subscribe();
client.connect();
```

--------------------------------

### Server Info Methods

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/README.md

Methods for retrieving server statistics and configuration information.

```APIDOC
## info()
Retrieves server statistics.

## showNodeInfo()
Checks the node information configuration.

## getDefaultTokenExpiration()
Retrieves the default token TTL.
```

--------------------------------

### Verify Server Readiness

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/tests/README.md

Manual checks to ensure the Centrifugo server is reachable and healthy.

```bash
# Wait for servers to be ready: 
php tests/Docker/wait-for-server.php http://localhost:8001 http://localhost:8002

# Verify Centrifugo is responding: 
curl http://localhost:8001/health
```

--------------------------------

### Initialize and Use HttpClient in Centrifugo

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/HttpClient.md

Shows the instantiation of HttpClient within the constructor and the structure of a POST request in the sendData method.

```php
// In Centrifugo::__construct()
$this->httpClient = $httpClient ?? new HttpClient();

// In Centrifugo::sendData()
$response = $this->httpClient->post($url, [
    'headers' => [
        'Content-Type' => 'application/json',
        'X-API-Key' => $this->config['apikey'],
    ],
    'body' => $json,
    'timeout' => $this->config['timeout'],
    'tries' => intval($this->config['tries'] ?? 1),
    'url' => $url,
    // SSL options added for HTTPS URLs...
]);
```

--------------------------------

### Create a Broadcastable Event

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/README.md

Implement the ShouldBroadcastNow interface to define event data and target channels for broadcasting.

```php
<?php
// App/Events/SendMessageEvent.php

namespace App\Events;

use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Contracts\Broadcasting\ShouldBroadcastNow;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

//Use "implements ShouldBroadcast" if you want add event to queue
class SendMessageEvent implements ShouldBroadcastNow
{
    use Dispatchable, InteractsWithSockets, SerializesModels;

    /**
     * @var string Message text
     */
    private $messageText;

    public function __construct(string $messageText)
    {
        $this->messageText = $messageText;
    }

    /**
     * The event's broadcast name.
     *
     * @return string
     */
    public function broadcastAs()
    {
        //example event broadcast name. Show in Web Socket JSON
        return 'message.new';
    }


    /**
     * Get the data to broadcast.
     *
     * @return array
     */
    public function broadcastWith()
    {
        return ['message' => $this->messageText];
    }

    /**
     * Get the channels the event should broadcast on.
     *
     * @return \Illuminate\Broadcasting\Channel|array
     */
    public function broadcastOn()
    {
        return new Channel('public:chat');
        // or return new PrivateChannel('private:chat');
    }
}
```

--------------------------------

### Subscribe with Full Options

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/QUICK-REFERENCE.md

Subscribes a user to a channel while providing additional user information and custom subscription data.

```php
$centrifugo->subscribe(
    'notifications:user-' . $user->id,
    (string) $user->id,
    info: ['username' => $user->name, 'avatar' => $user->avatar_url],
    data: ['subscription_time' => time()]
);
```

--------------------------------

### Null and Empty Array Handling

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/types.md

Demonstrates how null parameters and empty arrays are treated in the package, specifically regarding payload generation.

```php
?int $offset = null        // null means not provided
?string $epoch = null      // null means not provided
?HttpClient $httpClient = null  // null means create default
?array $config = null      // null means load from container
```

```php
array $info = []           // Empty info is meaningful (omit from payload)
```

```php
// generateConnectionToken with empty arrays
$payload = ['sub' => 'user-123'];  // info and channels omitted
// vs with values
$payload = [
    'sub' => 'user-123',
    'info' => ['key' => 'value'],
    'channels' => ['ch1'],
];
```

--------------------------------

### Authentication Methods

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/INDEX.md

Methods for generating connection and subscription tokens.

```APIDOC
## Authentication Methods

### generateConnectionToken(userId, exp, info, channels)
- **Description**: Generates a connection JWT.

### generateSubscriptionToken(userId, channel, exp, info, override)
- **Description**: Generates a subscription JWT.
```

--------------------------------

### Verify Singleton Behavior

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoServiceProvider.md

Demonstrates that the Centrifugo service is registered as a singleton within the application container.

```php
$c1 = app('centrifugo');
$c2 = app(Centrifugo::class);

$c1 === $c2  // true - same instance
```

--------------------------------

### Configure Environment Variables

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/INDEX.md

Required environment variables for connecting to a Centrifugo server.

```text
CENTRIFUGO_SECRET=...
CENTRIFUGO_APIKEY=...
CENTRIFUGO_URL=http://localhost:8000
CENTRIFUGO_API_PATH=/api
CENTRIFUGO_TIMEOUT=3
CENTRIFUGO_TRIES=1
CENTRIFUGO_TOKEN_EXPIRE=120
CENTRIFUGO_VERIFY=false
CENTRIFUGO_SSL_KEY=
CENTRIFUGO_SHOW_NODE_INFO=false
BROADCAST_CONNECTION=centrifugo  (Laravel 11+)
BROADCAST_DRIVER=centrifugo      (Laravel 10 and below)
```

--------------------------------

### Accessing Configuration via Facade

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/configuration.md

Retrieving Centrifugo connection settings from the Laravel broadcasting configuration.

```php
// Check Laravel broadcast configuration
$config = config('broadcasting.connections.centrifugo');

// Access specific setting
$timeout = config('broadcasting.connections.centrifugo.timeout');
$apiKey = config('broadcasting.connections.centrifugo.apikey');
```

--------------------------------

### Implement basic usage in a controller

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/README.md

Inject the Centrifugo service to publish messages, check presence, and generate subscription tokens.

```php
<?php
namespace App\Http\Controllers;

use Opekunov\Centrifugo\Centrifugo;
use Carbon\Carbon;

class ChatController
{
    public function sendMessage(Centrifugo $centrifugo)
    {
        // Publish message to channel
        $centrifugo->publish('chat:room1', [
            'message' => 'Hello world',
            'user_id' => auth()->id(),
        ]);

        // Get channel presence
        $presence = $centrifugo->presence('chat:room1');
        
        // Generate subscription token
        $token = $centrifugo->generateSubscriptionToken(
            auth()->id(),
            'chat:room1',
            Carbon::now()->addHour()
        );

        return response()->json(['token' => $token]);
    }
}
```

--------------------------------

### Configuring SSL/TLS Connections

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/QUICK-REFERENCE.md

Configuration snippets for connecting via HTTPS, including standard CA verification and self-signed certificate paths.

```php
// Using HTTPS with default CA certificates
'url' => 'https://centrifugo.example.com:8000',
'verify' => true,

// Using HTTPS with self-signed certificate
'url' => 'https://centrifugo.local:8000',
'verify' => true,
'ssl_key' => '/etc/ssl/certs/centrifugo.pem',
```

--------------------------------

### SSL/TLS Environment Configuration

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/configuration.md

Environment variables for configuring SSL verification and certificate paths.

```env
CENTRIFUGO_SSL_KEY=/etc/ssl/certs/centrifugo.pem
CENTRIFUGO_VERIFY=true
```

```env
CENTRIFUGO_VERIFY=false
```

--------------------------------

### Run Tests in CI/CD

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/tests/README.md

Automated workflow for running the full test suite in CI/CD environments.

```bash
# Full test suite on both v5 and v6
composer test:docker

# Or step by step
composer test:docker:setup        # Start both servers + wait
composer test:integration:v5      # Run against v5
composer test:integration:v6      # Run against v6
composer test:docker:cleanup      # Stop containers
```

--------------------------------

### Execute Request with Retry Logic

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/HttpClient.md

Demonstrates performing an HTTP POST request with automatic retry configuration and exception handling for connection failures.

```php
$httpClient = new HttpClient();

try {
    // This will retry up to 3 times if connection fails
    $response = $httpClient->post('http://centrifugo:8000/api/channels', [
        'headers' => ['X-API-Key' => 'key'],
        'body' => json_encode(['pattern' => '']),
        'tries' => 3,
        'timeout' => 5,
    ]);
    
    $channels = json_decode($response->getBody(), true);
} catch (CentrifugoConnectionException $e) {
    // Connection error after 3 attempts
    echo "Connection failed: " . $e->getMessage();
} catch (CentrifugoException $e) {
    // Other error (invalid response, parsing error, etc.)
    echo "Request failed: " . $e->getMessage();
}
```

--------------------------------

### Subscription Methods

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/INDEX.md

Methods for managing user subscriptions and connections.

```APIDOC
## Subscription Methods

### subscribe(channel, user, info, data)
- **Description**: Adds a user to a channel.

### unsubscribe(channel, user)
- **Description**: Removes a user from a channel.

### disconnect(userId)
- **Description**: Disconnects a user entirely.
```

--------------------------------

### Configure SSL/TLS for Centrifugo

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-endpoints.md

Use these settings in the configuration file to enable HTTPS and optional mutual TLS authentication.

```php
'centrifugo' => [
    'url' => 'https://centrifugo.example.com:8000',
    'verify' => true,  // Verify certificate
    'ssl_key' => '/path/to/cert.pem',  // Optional: client certificate
],
```

--------------------------------

### Configure Centrifugo Connection

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoBroadcaster.md

Set the default broadcast driver and connection parameters in config/broadcasting.php.

```php
// In your config/broadcasting.php
'default' => env('BROADCAST_DRIVER', 'centrifugo'),

'connections' => [
    'centrifugo' => [
        'driver' => 'centrifugo',
        'secret' => env('CENTRIFUGO_SECRET'),
        'apikey' => env('CENTRIFUGO_APIKEY'),
        'url' => env('CENTRIFUGO_URL', 'http://localhost:8000'),
    ],
]
```

--------------------------------

### Configure Centrifugo connection in broadcasting.php

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/configuration.md

Add this array to the connections key within the config/broadcasting.php file to enable the Centrifugo driver.

```php
'centrifugo' => [
    'driver' => 'centrifugo',
    'secret' => env('CENTRIFUGO_SECRET'),
    'apikey' => env('CENTRIFUGO_APIKEY'),
    'url' => env('CENTRIFUGO_URL', 'http://localhost:8000'),
    'api_path' => env('CENTRIFUGO_API_PATH', '/api'),
    'verify' => env('CENTRIFUGO_VERIFY', false),
    'ssl_key' => env('CENTRIFUGO_SSL_KEY', null),
    'show_node_info' => env('CENTRIFUGO_SHOW_NODE_INFO', false),
    'timeout' => env('CENTRIFUGO_TIMEOUT', 3),
    'tries' => env('CENTRIFUGO_TRIES', 1),
    'token_expire_time' => env('CENTRIFUGO_TOKEN_EXPIRE', 120),
],
```

--------------------------------

### Run Integration Tests

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/tests/README.md

Execute tests against Centrifugo server instances using Docker. Requires Docker and Docker Compose.

```bash
# Full cycle: start both v5 & v6, run tests on both, cleanup
composer test:docker

# Test only against Centrifugo v5
composer test:docker:v5

# Test only against Centrifugo v6
composer test:docker:v6

# Run integration tests against a running server (default: localhost:8001)
composer test:integration

# Run against a specific server URL
CENTRIFUGO_URL=http://localhost:8002 composer test:integration
```

--------------------------------

### Instantiate HttpResponse

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/HttpResponse.md

Create a new instance of the HttpResponse class, typically handled internally by the HttpClient.

```php
// Typically created internally by HttpClient
$response = new HttpResponse([
    'body' => '{"result": "success"}',
    'headers' => [
        'HTTP/1.1 200 OK',
        'Content-Type: application/json',
        'Content-Length: 22',
    ]
]);
```

--------------------------------

### Retrieve Server Info via PHP Client

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-endpoints.md

Method call to retrieve server information and statistics.

```php
$info = $centrifugo->info();
```

--------------------------------

### Generate Tokens with Expiration

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/types.md

Demonstrates passing UNIX timestamps, Carbon instances, or zero for no expiration.

```php
use Carbon\Carbon;

// Using UNIX timestamp
$token = $centrifugo->generateConnectionToken(
    'user123',
    time() + 3600  // Expires in 1 hour
);

// Using Carbon
$token = $centrifugo->generateConnectionToken(
    'user123',
    Carbon::now()->addHour()  // Expires in 1 hour
);

// No expiration
$token = $centrifugo->generateConnectionToken(
    'user123',
    0  // No expiration
);
```

--------------------------------

### subscribe(string $channel, string $user, array $info, array $data)

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoInterface.md

Subscribes a user to a channel.

```APIDOC
## subscribe(string $channel, string $user, array $info = [], array $data = [])

### Description
Subscribe a user to a channel (server-side).

### Parameters
- **channel** (string) - Required
- **user** (string) - Required
- **info** (array) - Optional
- **data** (array) - Optional

### Returns
- **array** - The decoded JSON response from the Centrifugo server.
```

--------------------------------

### POST /api/batch

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-endpoints.md

Send multiple commands in a single request.

```APIDOC
## POST /api/batch

### Description
Send multiple commands in a single request.

### Method
POST

### Endpoint
/api/batch

### Parameters
#### Request Body
- **commands** (array) - Required - Array of command objects, each with one method key

### Request Example
{
  "commands": [
    {
      "publish": {
        "channel": "channel1",
        "data": {"message": "hello1"}
      }
    },
    {
      "publish": {
        "channel": "channel2",
        "data": {"message": "hello2"}
      }
    }
  ]
}

### Response
#### Success Response (200)
- **code** (int) - Status code (0 for success)

#### Response Example
{
  "code": 0
}
```

--------------------------------

### Generate Authentication Tokens

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/QUICK-REFERENCE.md

Create connection and subscription tokens for WebSocket authentication, utilizing Carbon for expiration management.

```php
use Carbon\Carbon;

// Connection token (for WebSocket auth)
$token = $centrifugo->generateConnectionToken(
    userId: 'user123',
    exp: Carbon::now()->addDay(),
    info: ['username' => 'john'],
    channels: ['notifications']  // auto-subscribe
);

// Subscription token (for channel auth)
$token = $centrifugo->generateSubscriptionToken(
    userId: 'user123',
    channel: 'private:chat',
    exp: Carbon::now()->addHours(2),
    info: ['room' => 'general'],
    override: ['presence' => true]
);

// Use default expiration from config
$token = $centrifugo->generateSubscriptionToken(
    'user123',
    'channel',
    Carbon::now()->addSeconds($centrifugo->getDefaultTokenExpiration())
);
```

--------------------------------

### Troubleshoot Docker Containers

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/tests/README.md

Commands to inspect container status, view logs, or force cleanup of resources.

```bash
# Check if containers are running
cd tests/Docker && docker compose ps

# View Centrifugo logs
cd tests/Docker && docker compose logs centrifugo-v5
cd tests/Docker && docker compose logs centrifugo-v6

# Force cleanup
cd tests/Docker && docker compose down --volumes --remove-orphans
```

--------------------------------

### Environment Configuration

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/QUICK-REFERENCE.md

Required and optional environment variables for configuring the Centrifugo connection.

```bash
# Required
CENTRIFUGO_SECRET=your_secret
CENTRIFUGO_APIKEY=your_api_key

# Optional
CENTRIFUGO_URL=http://localhost:8000
CENTRIFUGO_API_PATH=/api
CENTRIFUGO_TIMEOUT=3
CENTRIFUGO_TRIES=1
CENTRIFUGO_TOKEN_EXPIRE=120
CENTRIFUGO_VERIFY=false
CENTRIFUGO_SSL_KEY=

# Set broadcast driver (Laravel 11+)
BROADCAST_CONNECTION=centrifugo

# Set broadcast driver (Laravel 10 and below)
BROADCAST_DRIVER=centrifugo
```

--------------------------------

### Generate Test Coverage Report

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/tests/README.md

Generate an HTML coverage report using PHPUnit.

```bash
./vendor/bin/phpunit --coverage-html coverage/
```

--------------------------------

### Handle Server Misconfiguration Exception

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/errors.md

Catch CentrifugoConnectionException when SSL certificate verification fails due to incorrect configuration.

```php
try {
    $centrifugo = new Centrifugo([
        'url' => 'https://localhost:8000',
        'secret' => 'secret',
        'apikey' => 'key',
        'verify' => true,
        'ssl_key' => '/path/to/wrong/cert.pem',  // Certificate doesn't match
    ]);
    
    $centrifugo->info();
} catch (CentrifugoConnectionException $e) {
    // Message: "SSL: certificate verify failed" or similar
}
```

--------------------------------

### Publish with Error Handling

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/QUICK-REFERENCE.md

Wraps the publish method in a try-catch block to handle connection and general Centrifugo exceptions gracefully.

```php
function publishSafe($centrifugo, $channel, $data) {
    try {
        return $centrifugo->publish($channel, $data);
    } catch (CentrifugoConnectionException $e) {
        Log::warning('Publish connection error', ['channel' => $channel]);
        return false;
    } catch (CentrifugoException $e) {
        Log::error('Publish error', ['channel' => $channel, 'error' => $e->getMessage()]);
        return false;
    }
}
```

--------------------------------

### Subscription Parameters

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/types.md

Parameters used for subscribe() and unsubscribe() methods.

```php
[
    'channel' => 'notifications:user-123',
    'user' => 'user-123',
    'info' => ['role' => 'admin'],      // optional
    'data' => ['message' => 'Welcome'], // optional
]
```

```php
[
    'channel' => 'notifications:user-123',
    'user' => 'user-123',
]
```

--------------------------------

### showNodeInfo

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/Centrifugo.md

Checks if server node info should be included in authentication responses.

```APIDOC
## showNodeInfo

### Description
Check if server node info should be included in authentication responses.

### Method
PHP Method

### Signature
`public function showNodeInfo(): bool`

### Returns
- **bool** - Returns true if node info should be included.
```

--------------------------------

### Define Publish Parameters

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/types.md

Data structures for single and multiple message publishing via publish() and publishMany().

```php
[
    'channel' => 'channel:name',
    'data' => [
        'message' => 'Hello',
        'timestamp' => 1234567890,
    ]
]
```

```php
[
    ['channel' => 'channel:1', 'data' => ['msg' => 'Hello']],
    ['channel' => 'channel:2', 'data' => ['msg' => 'World']],
]
```

--------------------------------

### Server Operations

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/QUICK-REFERENCE.md

Methods for retrieving server information, performing RPCs, and checking configuration.

```APIDOC
## Server Operations

### info()
Retrieves server information and statistics.

### rpc(string $method, array $data)
Performs a remote procedure call to the Centrifugo server.

### showNodeInfo()
Retrieves node configuration information.

### getDefaultTokenExpiration()
Returns the configured default token expiration time.
```

--------------------------------

### Access Centrifugo via Facade

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-reference/CentrifugoServiceProvider.md

Use the Centrifugo facade if it has been manually configured in your application.

```php
use Opekunov\Centrifugo\Facades\Centrifugo;

Centrifugo::publish('channel', ['data']);
```

--------------------------------

### Retrieve Channels via PHP Client

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-endpoints.md

Methods for fetching all channels or filtering them by a specific pattern.

```php
// All channels
$channels = $centrifugo->channels();

// Filtered by pattern
$channels = $centrifugo->channels('chat:*');
```

--------------------------------

### Batch Request Format

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/_autodocs/api-endpoints.md

Structure for sending multiple commands in a single HTTP request.

```json
POST /api/batch

Headers:
  Content-Type: application/json
  X-API-Key: {api_key}

Body:
{
  "commands": [
    {"publish": {...}},
    {"publish": {...}},
    ...
  ]
}
```

--------------------------------

### Manage Docker Environment Manually

Source: https://github.com/opekunov/laravel-centrifugo-broadcaster/blob/3.x/tests/README.md

Commands for granular control over the Centrifugo Docker containers during testing.

```bash
# Start both Centrifugo v5 (port 8001) and v6 (port 8002)
composer test:docker:setup

# Start only v5
composer test:docker:setup:v5

# Start only v6
composer test:docker:setup:v6

# Run integration tests against v5
composer test:integration:v5

# Run integration tests against v6
composer test:integration:v6

# Stop all containers
composer test:docker:cleanup
```
Tokens:
Raw