compio-ws 0.3.0

WebSocket library for the compio runtime
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

<div align="center">
    <a href='https://compio.rs'>
        <img height="150" src="https://github.com/compio-rs/compio-logo/raw/refs/heads/master/generated/colored-with-text.svg">
    </a>
</div>

---

# compio-ws

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/compio-rs/compio/blob/master/LICENSE)
[![crates.io](https://img.shields.io/crates/v/compio-ws)](https://crates.io/crates/compio-ws)
[![docs.rs](https://img.shields.io/badge/docs.rs-compio--ws-latest)](https://docs.rs/compio-ws)
[![Check](https://github.com/compio-rs/compio/actions/workflows/ci_check.yml/badge.svg)](https://github.com/compio-rs/compio/actions/workflows/ci_check.yml)
[![Test](https://github.com/compio-rs/compio/actions/workflows/ci_test.yml/badge.svg)](https://github.com/compio-rs/compio/actions/workflows/ci_test.yml)

WebSocket library for compio.

This crate provides WebSocket client and server support for compio applications, built on top of the tungstenite WebSocket library. It enables real-time bidirectional communication over TCP connections with optional TLS support.

## Features

- WebSocket client and server support
- Built on tungstenite
- TLS/SSL support with multiple backends:
  - `native-tls`: Platform-specific TLS
  - `rustls`: Pure Rust TLS implementation
- Certificate verification options (platform-verifier, native-certs, webpki-roots)

## Usage

Use `compio` directly with `ws` feature enabled:

```bash
cargo add compio --features ws
```

For secure WebSocket connections (wss://), enable a TLS backend:

```bash
cargo add compio --features ws,rustls # or native-tls
```

Example:

```rust
use compio::ws::connect_async;

let (mut ws_stream, _) = connect_async("wss://example.com/socket").await?;

// Send and receive messages
ws_stream.send(Message::text("Hello WebSocket!")).await?;
let msg = ws_stream.next().await.unwrap()?;
```