iceoryx2 0.10.0

iceoryx2: Lock-Free Zero-Copy Interprocess Communication
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
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

// Copyright (c) 2025 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the
// terms of the Apache Software License 2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
// which is available at https://opensource.org/licenses/MIT.
//
// SPDX-License-Identifier: Apache-2.0 OR MIT

use crate::service::static_config::message_type_details::MessageTypeDetails;
use iceoryx2_cal::{shared_memory::ShmPointer, shm_allocator::PointerOffset};

#[derive(Debug)]
pub struct Chunk {
    pub(crate) header: *const u8,
    pub(crate) user_header: *const u8,
    pub(crate) payload: *const u8,
}

impl Chunk {
    pub(crate) fn new(message_type_details: &MessageTypeDetails, offset: usize) -> Self {
        let header = offset as *const u8;
        Self {
            user_header: message_type_details.user_header_ptr_from_header(header),
            payload: message_type_details.payload_ptr_from_header(header),
            header: offset as *const u8,
        }
    }

    pub fn header_ptr(&self) -> *const u8 {
        self.header
    }

    pub fn user_header_ptr(&self) -> *const u8 {
        self.user_header
    }

    pub fn payload_ptr(&self) -> *const u8 {
        self.payload
    }
}

#[derive(Debug, Clone)]
pub struct ChunkMut {
    pub(crate) offset: PointerOffset,
    pub(crate) header: *mut u8,
    pub(crate) user_header: *mut u8,
    pub(crate) payload: *mut u8,
    pub(crate) size: usize,
}

impl ChunkMut {
    pub fn new(
        message_type_details: &MessageTypeDetails,
        shm_pointer: ShmPointer,
        size: usize,
    ) -> Self {
        Self {
            user_header: message_type_details
                .user_header_ptr_from_header(shm_pointer.data_ptr)
                .cast_mut(),
            payload: message_type_details
                .payload_ptr_from_header(shm_pointer.data_ptr)
                .cast_mut(),
            header: shm_pointer.data_ptr,
            offset: shm_pointer.offset,
            size,
        }
    }

    pub fn offset(&self) -> PointerOffset {
        self.offset
    }

    pub fn header_ptr(&self) -> *const u8 {
        self.header
    }

    pub fn header_mut_ptr(&mut self) -> *mut u8 {
        self.header
    }

    pub fn user_header_ptr(&self) -> *const u8 {
        self.user_header
    }

    pub fn user_header_mut_ptr(&mut self) -> *mut u8 {
        self.user_header
    }

    pub fn payload_ptr(&self) -> *const u8 {
        self.payload
    }

    pub fn payload_mut_ptr(&mut self) -> *mut u8 {
        self.payload
    }

    pub fn to_shm_pointer(&self) -> ShmPointer {
        ShmPointer {
            offset: self.offset,
            data_ptr: self.header,
        }
    }

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