Zig

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.) Zig

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

    // 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.
    //

    const rest = try chilkat.Rest.init();
    defer rest.deinit();
    rest.connect("someserver.com", 80, false, false) catch {
        std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
        return;
    };

    const ws = try chilkat.WebSocket.init();
    defer ws.deinit();

    // Tell the WebSocket to use this connection.
    ws.useConnection(rest) catch {
        std.debug.print("{s}\n", .{try ws.getLastErrorText(alloc)});
        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() catch {};

    // Add any additional headers that might be desired.
    // Two common WebSocketSpecific headers are "Sec-WebSocket-Protocol" and "Origin".
    rest.addHeader("Sec-WebSocket-Protocol", "x-something") catch {};
    rest.addHeader("Origin", "http://someserver.com") catch {};

    // Do the open handshake.
    const response_body = rest.fullRequestNoBody(alloc, "GET", "/something") catch {
        std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
        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..)
    const status_code = rest.getResponseStatusCode();
    std.debug.print("Response status code: {d}\n", .{status_code});

    if (status_code != 101) {
        std.debug.print("{s}\n", .{response_body});
        std.debug.print("-- Failed because of unexpected response status code.\n", .{});
        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.
    ws.validateServerHandshake() catch {
        std.debug.print("{s}\n", .{try ws.getLastErrorText(alloc)});
        return;
    };

    std.debug.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 object...)
}