push_stream_ping_message_text

Устанавливает пользовательский текст для ping-сообщений, отправляемых клиентам в модуле push stream NGINX.

Синтаксисpush_stream_ping_message_text text;
По умолчаниюnone
Контекстhttp
Аргументы1

Описание

push_stream_ping_message_text директива задаёт пользовательский текст, который отправляется как ping-сообщение подключённым подписчикам в модуле push stream. Это особенно полезно для поддержания соединений и информирования клиентского приложения о том, что сервер по-прежнему доступен и корректно функционирует.
Ping-сообщения отправляются с регулярными интервалами для проверки статуса соединения и предотвращения таймаутов, которые могут приводить к потере соединения из-за неактивности. По умолчанию это сообщение может быть простой строкой, а фактическая частота отправки ping-сообщений контролируется другой директивой, которая задаёт периодичность.
Использование этой директивы в конфигурации позволяет более гибко настраивать способ взаимодействия сервера с клиентами, что может улучшить опыт пользователей, предоставляя регулярные обновления или контрольные сигналы (heartbeats). Важно убедиться, что сообщение не превышает ограничений по размеру, установленных другими связанными параметрами конфигурации, чтобы избежать возможных ошибок передачи.

Пример конфига

http {
    push_stream_ping_message_text "Heartbeat";
    push_stream_shared_memory_size 32M;

    server {
        location /pub {
            push_stream_publisher admin;
            push_stream_channels_path $arg_id;
        }
        location ~ /sub/(.*) {
            push_stream_subscriber;
            push_stream_channels_path $1;
        }
    }
}

Убедитесь, что текст ping-сообщения не превышает 255 bytes, чтобы избежать проблем с подключением клиента.

Чрезмерное использование ping-сообщений может привести к увеличению сетевого трафика; важно соблюдать баланс.

← Ко всем директивам