nchan_subscriber

The `nchan_subscriber` directive specifies the channel ID for an Nchan subscriber.

Syntaxnchan_subscriber_channel_id string;
Defaultnone
Contextserver, location, if in location
Argumentsnone

Description

The nchan_subscriber directive is crucial in the Nchan module for configuring a subscriber's connection to a specific message channel. By designating a channel ID through this directive, the Nchan server will route messages published on that channel to the corresponding subscribers. This functionality facilitates a flexible pub/sub architecture that can handle multiple concurrent connections efficiently.

When a subscriber attempts to connect to an Nchan endpoint, the channel ID defined by nchan_subscriber tells Nchan which channel to listen to for incoming messages. This configuration can be specified multiple times in a location or server block, allowing for dynamic subscription management based on contextual parameters. Users can utilize various endpoint types—including WebSocket and long-polling—to implement real-time messaging sessions, reflecting modern web application needs for scalability and responsiveness.

Moreover, nchan_subscriber can work alongside a variety of alternative configurations, such as the nchan_subscriber_channel_id, which serves as an alias for clearer expression or alignment with application-specific logic. The directive accommodates multiple arguments, allowing for configurable behavior to suit diverse development needs.

Config Example

location /sub {
    nchan_subscriber_channel_id channel_id;
    nchan_subscriber_info;
}

Ensure that the channel ID matches the one used by publishers to avoid missing messages.

Using this directive without a corresponding publisher can lead to confusion or errors in message handling.

Multiple nchan_subscriber_channel_id directives in the same location can cause unexpected behavior if not managed correctly.

← Back to all directives