Crate web_socket

Introduction

This library is an implementation of the WebSocket protocol, which provides a way for two-way communication between a client and server over a single TCP connection. This library provides an easy-to-use, modern, and intuitive WebSocket implementation for both client and server-side applications.

Installation

To use this library, add it as a dependency to your Rust project by adding the following line to your Cargo.toml file:

[dependencies]
web-socket = "0.5"

Example

You can run this example with: cargo run --example minimal

use tokio::io::*;
use web_socket::*;

async fn example<IO>(mut ws: WebSocket<CLIENT, IO>) -> Result<()>
where
    IO: Unpin + AsyncRead + AsyncWrite,
{
    let _ = ws.recv().await?; // ignore message: Request served by 4338e324
    for _ in 0..3 {
        ws.send("Copy Cat!").await?;

        match ws.recv().await? {
            Event::Data { ty, data } => {
                assert_eq!(ty, DataType::Complete(MessageType::Text));
                assert_eq!(&*data, b"Copy Cat!");
            }
            Event::Ping(data) => ws.send_ping(data).await?,
            Event::Pong(..) => {}
            Event::Error(..) => return ws.close(CloseCode::ProtocolError).await,
            Event::Close { .. } => return ws.close(()).await,
        }
    }
    ws.close("bye!").await
}

For more examples, see ./examples directory.

It passed all test of the autobahn testsuite

License

This project is licensed under Apache License 2.0

Structs

• WebSocket
  WebSocket implementation for both client and server

Enums

• CloseCode
  When closing an established connection an endpoint MAY indicate a reason for closure.
• DataType
  Data that is either complete or fragmented.
• Event
  Represent a websocket event
• Fragment
  Represents a fragment of a WebSocket message.
• MessageType
  It represent the type of data that is being sent over the WebSocket connection.

Constants

• CLIENT
  Used to represent WebSocket<CLIENT, IO> type.
• SERVER
  Used to represent WebSocket<SERVER, IO> type.

Traits

• CloseFrame
  This trait is responsible for encoding websocket closed frame.
• Message
  This trait is responsible for encoding websocket messages.