citadel_proto 0.13.0

Networking library for the Citadel Protocol
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

//! Peer Packet Processing Module for Citadel Protocol
//!
//! This module provides the core functionality for handling peer-to-peer communication
//! in the Citadel Protocol network. It manages group broadcasts, peer commands,
//! server interactions, and signal handling between peers.
//!
//! # Features
//!
//! - Group broadcast management
//! - Peer command processing
//! - Server interaction handling
//! - Signal processing between peers
//! - Disconnect signal management
//!
//! # Important Notes
//!
//! - Requires established peer connections
//! - Handles peer session state
//! - Manages error propagation
//! - Supports ticket-based operations
//!
//! # Related Components
//!
//! - `CitadelSession`: Manages peer sessions
//! - `NodeResult`: Handles operation results
//! - `Ticket`: Tracks peer operations
//! - `NetworkError`: Manages error states

use crate::error::NetworkError;
use crate::prelude::{ConnectFail, NodeResult, Ticket};
use crate::proto::session::CitadelSession;
use citadel_crypt::ratchets::Ratchet;

pub mod group_broadcast;
pub mod peer_cmd_packet;
pub mod server;
pub mod signal_handler_interface;

pub(crate) fn send_dc_signal_peer<T: Into<String>, R: Ratchet>(
    session: &CitadelSession<R>,
    ticket: Ticket,
    err: T,
) -> Result<(), NetworkError> {
    let session_cid = session.session_cid.get().expect("Should exist");
    session
        .send_to_kernel(NodeResult::ConnectFail(ConnectFail {
            ticket,
            cid_opt: Some(session_cid),
            error_message: err.into(),
        }))
        .map_err(|err| NetworkError::Generic(err.to_string()))?;

    Ok(())
}