udp 10.2.11

A lightweight and efficient Rust library for building UDP servers with request-response handling.
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

use super::*;

/// Default server hook.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct DefaultServerHook;

/// Represents the hooks for managing the server's lifecycle, specifically for waiting and shutting down.
///
/// Accessors are generated by `#[derive(Data)]`; the hook getters return owned
/// `Arc` clones via `type(clone)`.
#[derive(Clone, Data)]
pub struct ServerControlHook {
    /// A hook that returns a future, which completes when the server's main task finishes.
    /// This is typically used to wait for the server to stop accepting connections before
    /// the application exits.
    #[get(type(clone))]
    #[get_mut(pub(crate))]
    #[set(pub(crate))]
    pub wait_hook: Arc<dyn Fn() -> SendableAsyncTask<()> + Send + Sync>,
    /// A hook that, when called, initiates a graceful shutdown of the server.
    /// This will stop the server from accepting new connections and allow existing ones
    /// to complete.
    #[get(type(clone))]
    #[get_mut(pub(crate))]
    #[set(pub(crate))]
    pub shutdown_hook: Arc<dyn Fn() -> SendableAsyncTask<()> + Send + Sync>,
}

/// Represents the state associated with a single connection handler.
///
/// This struct encapsulates the necessary context for processing a connection,
/// including a reference to the network socket. It is created
/// for each connection and passed to the relevant handlers.
///
/// The socket getter is generated by `#[derive(Getter)]` as an owned clone via
/// `type(clone)`; no mutable accessor is generated for this state.
#[derive(Clone, Getter)]
pub(crate) struct HandlerState {
    /// A reference to the underlying network socket for the connection.
    #[get(pub(crate), type(clone))]
    pub(super) socket: ArcRwLockUdpSocket,
}