Skip to main content

Send ping

Sends a ping to the remote server

Function SendPing(Val Connection) Export

ParameterCLI optionTypeRequiredDescription
Connection-ArbitraryConnection, See CreateConnection
Returns

Map Of KeyAndValue - Execution result

Caution

NOCLI: this method is not available in CLI version

1C:Enterprise/OneScript code example
Address = "wss://127.0.0.1:8443";
NeedProxy = True;
NeedTLS = True;

Headers = New Map;
Headers.Insert("X-Trace-Id", "OPI-WS-TEST");

If NeedTls Then
TLSSettings = OPI_WebSocket.GetTlsSettings(True);
EndIf;

If NeedProxy Then

ProxyAddress = "127.0.0.1";
ProxyPort = "8071";
ProxyType = "http";

ProxtUser = "proxyuser";
ProxyPassword = "12we...";

ProxySettings = OPI_AddIns.GetProxySettings(ProxyAddress
, ProxyPort
, ProxyType
, ProxtUser
, ProxyPassword);

EndIf;

Connection = OPI_WebSocket.CreateConnection(Address, TLSSettings, ProxySettings, Headers);

If OPI_WebSocket.IsClientObject(Connection) Then

Result = OPI_WebSocket.SendPing(Connection);

// Skipping all responses from the server until the last one
While True Do

LastMessage = OPI_WebSocket.GetMessage(Connection, 3000);

If LastMessage["result"] Then
// Next message
Check = LastMessage;
Else
// No more messages
Break;
EndIf;

EndDo;

Else
Result = Connection;
Check = Connection;
EndIf;
Result
{
"result": true
}