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

//! Middleware trait for packet processing.
//!
//! This module defines the `Middleware` trait, which allows for custom
//! processing of packets before they are handled by the main application logic.

use crate::models::Packet;
use crate::state::AuthData;
use async_trait::async_trait;

/// Trait for implementing middleware functionality.
#[async_trait]
pub trait Middleware: Send + Sync {
    /// Processes a packet before it's handled by the main application logic.
    ///
    /// # Arguments
    ///
    /// * `packet` - A mutable reference to the `Packet` being processed.
    /// * `auth_data` - A reference to the `AuthData` associated with the connection.
    ///
    /// # Returns
    ///
    /// Returns `true` if the packet should be processed further, `false` if it should be dropped.
    async fn handle(&self, packet: &mut Packet, auth_data: &AuthData) -> bool;
}