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

// Copyright (c) 2026 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

//! Generates a system-wide [`UniqueId`]. For a detailed documentation, see [`UniqueSystemId`].

pub use iceoryx2_bb_posix::unique_system_id::*;

use crate::node::global_management_segment::GlobalManagementSegment;
pub use crate::unique_id_generator::*;

impl From<UniqueSystemIdCreationError> for UniqueIdGeneratorGenerateError {
    fn from(_: UniqueSystemIdCreationError) -> Self {
        UniqueIdGeneratorGenerateError::GenerationError
    }
}

impl UniqueIdGenerator for UniqueSystemId {
    /// Generates a system-wide unique ID by using the process ID and the incremented static
    /// atomic counter from the global management segment.
    fn generate<Service: service::Service>(
        entity: Entity,
        config: &Config,
    ) -> Result<UniqueId, UniqueIdGeneratorGenerateError> {
        let id = match entity {
            Entity::Node(_) => {
                let node_counter = match GlobalManagementSegment::<Service>::open_or_create(config)
                {
                    Ok(mgmt) => mgmt.increment_node_counter(),
                    Err(e) => {
                        fail!(from "UniqueIdGenerator::generate()",
                        with UniqueIdGeneratorGenerateError::GenerationError,
                        "Unable to generate unique id since the global management segment could not be opened. {e:?}");
                    }
                };
                UniqueSystemId::from_counter(node_counter)?
            }
            _ => UniqueSystemId::new()?,
        };
        Ok(unsafe { UniqueId::from_raw_id(id.value()) })
    }

    fn pid(
        id: UniqueId,
    ) -> Result<iceoryx2_bb_posix::process::ProcessId, UniqueIdGeneratorDetailsError> {
        Ok(UniqueSystemId::from(id.value()).pid())
    }

    fn creation_time(
        id: UniqueId,
    ) -> Result<iceoryx2_bb_posix::clock::Time, UniqueIdGeneratorDetailsError> {
        Ok(UniqueSystemId::from(id.value()).creation_time())
    }
}