robotrt-buffer-core 0.1.0-beta.1

RobotRT modular robotics runtime and middleware components.
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

use core_types::BufferId;
use memmap2::Mmap;

mod config;
mod header;
mod rate_limiter;
mod reader;
mod segment_io;
mod writer;

pub use config::{ShmRateLimitConfig, ShmTransportConfig};
use rate_limiter::TokenBucket;

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct SharedMemoryBufferRef {
    pub buffer_id: BufferId,
    pub offset: usize,
    pub len: usize,
}

#[derive(Debug)]
pub struct SharedMemoryLease {
    mmap: Mmap,
    offset: usize,
    len: usize,
}

impl SharedMemoryLease {
    pub fn as_slice(&self) -> &[u8] {
        &self.mmap[self.offset..self.offset + self.len]
    }

    pub fn len(&self) -> usize {
        self.len
    }

    pub fn is_empty(&self) -> bool {
        self.len == 0
    }
}

pub struct SharedMemoryWriter {
    cfg: ShmTransportConfig,
    next_buffer_id: u64,
    rate_limiter: Option<TokenBucket>,
}

pub struct SharedMemoryReader {
    cfg: ShmTransportConfig,
}