Discuss this help topic in SecureBlackbox Forum

TElHTTPSClient.StartWS

TElHTTPSClient     See also     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


Starts a WebSocket session.

Declaration

[C#/Java]
    int StartWS(string URL, out TElWebSocketClient WSClient, out TElSocket Socket);

[VB.NET]
    Function StartWS(ByVal URL As String, Out WSClient As TElWebSocketClient, Out Socket As TElSocket) As Integer

[Pascal]
    function StartWS(const URL : string; out WSClient : TElWebSocketClient; out Socket : TElSocket) : integer;

[C++]
    int32_t StartWS(const std::string &URL, TElWebSocketClient &WSClient, TElSocket &Socket);

[PHP]
    integer StartWS(string $URL, TElWebSocketClient &$WSClient, TElSocket &$Socket)

Parameters

  • URL - specifies the resource address.URLs like ws://host.com or wss://host.com are accepted.
  • WSClient - the client that will handle the WS connection.
  • Socket - returns the socket to which the connection has been established.

Return value

HTTP result code.

Description

Use this method to send a request to the remote server to establish a WS connection. This method is superceded by OnBeforeWebSocketClientUsed and OnWebSocketConnectionEstablished events.

Discuss this help topic in SecureBlackbox Forum