Rust

WebSocket Connect through HTTP Proxy

See more WebSocket Examples

This example shows how to establish a WebSocket connection through an HTTP proxy server. Rust

// 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 HTTP Proxy example.
// We first use the Chilkat Socket object to establish a connection to the WebSocket server through an HTTP 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 = chilkat::Rest::new();
let socket = chilkat::Socket::new();

// Set the HTTP proxy domain or IP address, and port.
socket.set_http_proxy_hostname("192.168.1.79");
socket.set_http_proxy_port(808);

// Provide authentication to the HTTP proxy, if needed.
socket.set_http_proxy_username("HTTP_PROXY_LOGIN");
socket.set_http_proxy_password("HTTP_PROXY_PASSWORD");
socket.set_http_proxy_auth_method("Basic");

// Indicate that HTTP requests (i.e. the WebSocket opening handshake) will be sent over the socket.
// This is important for how the HTTP proxy connection is established.
socket.set_http_proxy_for_http(true);

// Connect to the websocket server through the HTTP proxy.
let b_tls = false;
let port = 80;
let max_wait_ms = 5000;
if socket.connect("some-websocket-server.com", port, b_tls, max_wait_ms).is_err() {
    println!("Connect Failure Error Code: {}", socket.connect_fail_reason());
    println!("{}", socket.last_error_text());
    return;
}

// Tell the Rest object to use the connected socket.
if rest.use_connection(&socket, true).is_err() {
    println!("{}", rest.last_error_text());
    return;
}

let ws = chilkat::WebSocket::new();

// Tell the WebSocket to use this connection.
if ws.use_connection(&rest).is_err() {
    println!("{}", ws.last_error_text());
    return;
}

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

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

// Do the open handshake.
let Ok(response_body) = rest.full_request_no_body("GET", "/something") else {
    println!("{}", rest.last_error_text());
    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..)
let status_code = rest.response_status_code();
println!("Response status code: {}", status_code);

if status_code != 101 {
    println!("{}", response_body);
    println!("-- 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. 
if ws.validate_server_handshake().is_err() {
    println!("{}", ws.last_error_text());
    return;
}

println!("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...)

println!("Success.");