Swift

WebSocket Connect through SOCKS Proxy

See more WebSocket Examples

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

func chilkatTest() {
    var success: Bool = 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.  
    // 

    let rest = CkoRest()!
    let socket = CkoSocket()!

    // 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: Bool = false
    var port: Int = 80
    var maxWaitMs: Int = 5000
    success = socket.connect(hostname: "some-websocket-server.com", port: port, ssl: bTls, maxWaitMs: maxWaitMs)
    if success != true {
        print("Connect Failure Error Code: \(socket.connectFailReason.intValue)")
        print("\(socket.lastErrorText!)")
        return
    }

    // Tell the Rest object to use the connected socket.
    success = rest.useConnection(connection: socket, autoReconnect: true)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    let ws = CkoWebSocket()!

    // Tell the WebSocket to use this connection.
    success = ws.useConnection(connection: rest)
    if success != true {
        print("\(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(name: "Sec-WebSocket-Protocol", value: "x-some-websocket-subprotocol")
    rest.addHeader(name: "Origin", value: "http://some-websocket-server.com")

    // Do the open handshake.
    var responseBody: String? = rest.fullRequestNoBody(httpVerb: "GET", uriPath: "/something")
    if rest.lastMethodSuccess != true {
        print("\(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: Int = rest.responseStatusCode.intValue
    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. 
    success = ws.validateServerHandshake()
    if success != true {
        print("\(ws.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.")

}