Rust

WebSocket Connect

See more WebSocket Examples

Demonstrates how to establish a WebSocket connection. Once the connection is established, messages may be sent back-and-forth. Messages are sent in frames, where the last frame in the message is indicated by a "final" bit. A frame constitutes the entire message if the first frame sent has the "final" bit sent. (In most cases, you'll probably be sending single-frame messages.) Rust

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// --------------------------------------------------
// A WebSocket connection begins life as an HTTP GET request containing a few special header fields,
// such as "Upgrade: websocket".   

// Your application will use the Chilkat Rest class to send the initial HTTP GET.  This allows you
// to use the full capability of the Chilkat Rest class to customize the GET for any particular situation.
// For example:
// 
//   - If custom HTTP request header fields must be added.
//   - If authentication is required, such as OAuth2, OAuth1, Basic HTTP Auth, etc.
//   - If HTTPS, SSH Tunneling, Proxies (HTTP or SOCKS), or other advanced connection or TLS features are required.
// 

let rest = chilkat::Rest::new();
if rest.connect("someserver.com", 80, false, false).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-something");
let _ = rest.add_header("Origin", "http://someserver.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 object...)