cspcl 0.5.0

Rust bindings for the cspcl library
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

use crate::cspcl_sys;
use crate::error::{Error, Result};
use crate::instance::{ConnectionStats, SharedRawCspcl, ensure_initialized, raw_ptr, recv_lock};
use crate::peer::RemotePeer;

/// Metadata and payload for a bundle received from CSPCL.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ReceivedBundle {
    pub data: Vec<u8>,
    pub src_addr: u8,
    pub src_port: u8,
}

/// Metadata for a bundle written into a caller-provided buffer.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ReceivedBundleView {
    pub len: usize,
    pub src_addr: u8,
    pub src_port: u8,
}

impl ReceivedBundle {
    pub fn remote_peer(&self) -> RemotePeer {
        RemotePeer::new(self.src_addr, self.src_port)
    }
}

impl ReceivedBundleView {
    pub fn remote_peer(&self) -> RemotePeer {
        RemotePeer::new(self.src_addr, self.src_port)
    }
}

/// Shared outbound handle backed by the native CSPCL connection pool.
#[derive(Clone)]
pub struct Sender {
    raw: SharedRawCspcl,
}

impl Sender {
    pub(crate) fn new(raw: SharedRawCspcl) -> Self {
        Self { raw }
    }

    /// Send a serialized bundle to a destination CSP node/port.
    pub fn send_bundle(&self, bundle: &[u8], dest_addr: u8, dest_port: u8) -> Result<()> {
        if bundle.is_empty() {
            return Err(
                Error::from_code(cspcl_sys::cspcl_error_t_CSPCL_ERR_INVALID_PARAM).unwrap_err(),
            );
        }
        ensure_initialized(&self.raw)?;

        unsafe {
            Error::from_code(cspcl_sys::cspcl_send_bundle(
                raw_ptr(&self.raw),
                bundle.as_ptr(),
                bundle.len(),
                dest_addr,
                dest_port,
            ))?;
        }
        Ok(())
    }

    pub fn connection_stats(&self) -> ConnectionStats {
        self.raw.connection_stats()
    }
}

/// Blocking receive handle. Concurrent receives are serialized per instance.
#[derive(Clone)]
pub struct Receiver {
    raw: SharedRawCspcl,
}

impl Receiver {
    pub(crate) fn new(raw: SharedRawCspcl) -> Self {
        Self { raw }
    }

    /// Receive a bundle with the provided timeout in milliseconds.
    pub fn recv_bundle(&self, timeout_ms: u32) -> Result<ReceivedBundle> {
        let mut buffer = vec![0u8; cspcl_sys::CSPCL_MAX_BUNDLE_SIZE as usize];
        let received = self.recv_bundle_into(&mut buffer, timeout_ms)?;
        buffer.truncate(received.len);
        Ok(ReceivedBundle {
            data: buffer,
            src_addr: received.src_addr,
            src_port: received.src_port,
        })
    }

    /// Receive a bundle into a caller-provided buffer.
    pub fn recv_bundle_into(
        &self,
        buffer: &mut [u8],
        timeout_ms: u32,
    ) -> Result<ReceivedBundleView> {
        ensure_initialized(&self.raw)?;
        let _guard = recv_lock(&self.raw).lock().expect("receiver lock poisoned");

        let mut len = buffer.len();
        let mut src_addr: u8 = 0;
        let mut src_port: u8 = 0;

        unsafe {
            Error::from_code(cspcl_sys::cspcl_recv_bundle(
                raw_ptr(&self.raw),
                buffer.as_mut_ptr(),
                &mut len,
                &mut src_addr,
                &mut src_port,
                timeout_ms,
            ))?;
        }

        Ok(ReceivedBundleView {
            len,
            src_addr,
            src_port,
        })
    }
}