Dart

WebSocket Connect through SOCKS Proxy

See more WebSocket Examples

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

import 'package:chilkat/chilkat.dart';

void main() {
  // 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.  
  // 

  final rest = CkRest();
  final socket = 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.
  final bTls = false;
  final port = 80;
  final maxWaitMs = 5000;
  try {
    socket.connect('some-websocket-server.com', port, bTls, maxWaitMs);
  } on ChilkatException catch (e) {
    print('Connect Failure Error Code: ${socket.connectFailReason}');
    print(e.lastErrorText);
    return;
  }

  // Tell the Rest object to use the connected socket.
  try {
    rest.useConnection(socket, true);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final ws = CkWebSocket();

  // Tell the WebSocket to use this connection.
  try {
    ws.useConnection(rest);
  } on ChilkatException catch (e) {
    print(e.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.
  final String responseBody;
  try {
    responseBody = rest.fullRequestNoBody('GET', '/something');
  } on ChilkatException catch (e) {
    print(e.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..)
  final statusCode = rest.responseStatusCode;
  print('Response status code: $statusCode');

  if (statusCode != 101) {
    print(responseBody);
    print('-- 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. 
  try {
    ws.validateServerHandshake();
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('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...)

  print('Success.');
}