(PHP Extension) WebSocket Connect through SOCKS Proxy

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

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.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.
// 

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

//  Set the SOCKS proxy domain or IP address, port, and SOCKS version number (4 or 5)
$socket->put_SocksHostname('192.168.1.79');
$socket->put_HttpProxyPort(1080);
$socket->put_SocksVersion(5);

//  Provide authentication to the SOCKS proxy, if needed.
$socket->put_SocksUsername('SOCKS_PROXY_LOGIN');
$socket->put_SocksPassword('SOCKS_PROXY_PASSWORD');

//  Connect to the websocket server through the HTTP proxy.
$bTls = false;
$port = 80;
$maxWaitMs = 5000;
$success = $socket->Connect('some-websocket-server.com',$port,$bTls,$maxWaitMs);
if ($success != true) {
    print 'Connect Failure Error Code: ' . $socket->get_ConnectFailReason() . "\n";
    print $socket->lastErrorText() . "\n";
    exit;
}

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

$ws = new CkWebSocket();

//  Tell the WebSocket to use this connection.
$success = $ws->UseConnection($rest);
if ($success != true) {
    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->get_LastMethodSuccess() != true) {
    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->get_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 != true) {
    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";

?>