socketcluster_server 0.2.1

SocketCluster protocol V1 server library
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

//! Data models for the WebSocket server.
//!
//! This module defines the core data structures used in the WebSocket communication,
//! including the `Event` enum and the `Packet` struct.

use serde::{Deserialize, Serialize};
use serde_json::Value;

/// Represents different types of events in the WebSocket communication.
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub enum Event {
    /// Handshake event for establishing a connection.
    #[serde(rename = "#handshake")]
    Handshake,
    /// Subscribe event for joining a channel.
    #[serde(rename = "#subscribe")]
    Subscribe,
    /// Publish event for sending a message to a channel.
    #[serde(rename = "#publish")]
    Publish,
    /// Unsubscribe event for leaving a channel.
    #[serde(rename = "#unsubscribe")]
    Unsubscribe,
    /// Authenticate event for user authentication. 
    /// !NOTE: Not used in the current implementation
    #[serde(rename = "#authenticate")]
    Authenticate,
    /// Disconnect event for closing the connection.
    #[serde(rename = "#disconnect")]
    Disconnect,
    /// Custom event for application-specific purposes.
    Custom(String),
}

/// Represents a packet of data exchanged in the WebSocket communication.
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
pub struct Packet {
    /// The type of event associated with this packet.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub event: Option<Event>,
    /// The main payload of the packet.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<Value>,
    /// Client-generated ID for the packet.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cid: Option<u64>,
    /// Server-generated ID for the response packet. Should match the `cid` of the request packet.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rid: Option<u64>,
    /// Error information, if any.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<Value>,
}