TsgcWebSocketServerMethods › Ping

Ping Metodo

Invia un frame ping WebSocket a tutti i client connessi.

Sintassi

procedure Ping(const aText: string = '');

Parametri

NomeTipoDescrizione
aTextconst stringPayload facoltativo da inserire nel frame ping; passare una stringa vuota per inviare un ping senza payload.

Note

Ping itera l'elenco delle connessioni attive e invia un frame ping WebSocket a ciascun client, tornando una volta che i frame sono stati consegnati ai socket sottostanti. È un modo conveniente per mantenere attive le connessioni inattive o per verificare manualmente la raggiungibilità, in aggiunta al meccanismo automatico HeartBeat. Quando il timeout di HeartBeat è configurato, il server chiude qualsiasi connessione che non risponde entro la finestra temporale; senza timeout la chiamata è di tipo fire-and-forget e le eventuali risposte pong vengono consegnate in modo asincrono tramite gli eventi di connessione standard. Le eccezioni generate durante la scrittura vengono instradate a OnException.

Esempio


oServer.Ping('keepalive');

Torna ai Metodi