(PHP ActiveX) WebSocket Connect through SOCKS Proxy

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

// 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.  
// 

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Rest')
$rest = new COM("Chilkat.Rest");
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Socket')
$socket = new COM("Chilkat.Socket");

// 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.
$bTls = 0;
$port = 80;
$maxWaitMs = 5000;
$success = $socket->Connect('some-websocket-server.com',$port,$bTls,$maxWaitMs);
if ($success != 1) {
    print 'Connect Failure Error Code: ' . $socket->ConnectFailReason . "\n";
    print $socket->LastErrorText . "\n";
    exit;
}

// Tell the Rest object to use the connected socket.
$success = $rest->UseConnection($socket,1);
if ($success != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.WebSocket')
$ws = new COM("Chilkat.WebSocket");

// Tell the WebSocket to use this connection.
$success = $ws->UseConnection($rest);
if ($success != 1) {
    print $ws->LastErrorText . "\n";
    exit;
}

// 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.
$responseBody = $rest->fullRequestNoBody('GET','/something');
if ($rest->LastMethodSuccess != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

// 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..)
$statusCode = $rest->ResponseStatusCode;
print 'Response status code: ' . $statusCode . "\n";

if ($statusCode != 101) {
    print $responseBody . "\n";
    print '-- Failed because of unexpected response status code.' . "\n";
    exit;
}

// 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 != 1) {
    print $ws->LastErrorText . "\n";
    exit;
}

print 'WebSocket connection successful.' . "\n";

// 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...)

print 'Success.' . "\n";

?>