(JavaScript) WebSocket Connect through SOCKS Proxy

This example shows how to establish a WebSocket connection through a SOCKS proxy.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// --------------------------------------------------
// This example borrows the code from the REST using SOCKS Proxy example.
// We first use the Chilkat Socket object to establish a connection to the WebSocket server through a SOCKS proxy.
// Next, the Rest object uses the Socket object for its connection.
// Finally, the WebSocket object uses the Rest object for its connection.  
// 

var rest = new CkRest();
var socket = new CkSocket();

// Set the SOCKS proxy domain or IP address, port, and SOCKS version number (4 or 5)
socket.SocksHostname = "192.168.1.79";
socket.HttpProxyPort = 1080;
socket.SocksVersion = 5;

// Provide authentication to the SOCKS proxy, if needed.
socket.SocksUsername = "SOCKS_PROXY_LOGIN";
socket.SocksPassword = "SOCKS_PROXY_PASSWORD";

// Connect to the websocket server through the HTTP proxy.
var bTls = false;
var port = 80;
var maxWaitMs = 5000;
success = socket.Connect("some-websocket-server.com",port,bTls,maxWaitMs);
if (success !== true) {
    console.log("Connect Failure Error Code: " + socket.ConnectFailReason);
    console.log(socket.LastErrorText);
    return;
}

// Tell the Rest object to use the connected socket.
success = rest.UseConnection(socket,true);
if (success !== true) {
    console.log(rest.LastErrorText);
    return;
}

var ws = new CkWebSocket();

// Tell the WebSocket to use this connection.
success = ws.UseConnection(rest);
if (success !== true) {
    console.log(ws.LastErrorText);
    return;
}

// Add the standard WebSocket open handshake headers that will be needed.
// (This adds the required HTTP request headers to the rest object.)
ws.AddClientHeaders();

// Add any additional headers that might be desired.
// Two common WebSocketSpecific headers are "Sec-WebSocket-Protocol" and "Origin".
rest.AddHeader("Sec-WebSocket-Protocol","x-some-websocket-subprotocol");
rest.AddHeader("Origin","http://some-websocket-server.com");

// Do the open handshake.
var responseBody = rest.FullRequestNoBody("GET","/something");
if (rest.LastMethodSuccess !== true) {
    console.log(rest.LastErrorText);
    return;
}

// If successful, the HTTP response status code should be 101,
// and the response body will be empty. (If it failed, we'll have a look
// at the response body..)
var statusCode = rest.ResponseStatusCode;
console.log("Response status code: " + statusCode);

if (statusCode !== 101) {
    console.log(responseBody);
    console.log("-- Failed because of unexpected response status code.");
    return;
}

// We have the expected 101 response, so let's now validate the 
// contents of the response, such as the value sent by the server in the
// Sec-WebSocket-Accept header. 
success = ws.ValidateServerHandshake();
if (success !== true) {
    console.log(ws.LastErrorText);
    return;
}

console.log("WebSocket connection successful.");

// The application may now begin sending and receiving frames on the WebSocket connection.
// (At this point, we're done with the rest and socket objects...)

console.log("Success.");