iceoryx2 0.9.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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

// Copyright (c) 2023 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::{config, identifiers::UniqueNodeId, service::dynamic_config::DynamicConfig};
use core::fmt::Debug;
use iceoryx2_bb_elementary_traits::zero_copy_send::ZeroCopySend;
use iceoryx2_cal::named_concept::{NamedConceptConfiguration, NamedConceptMgmt};
use iceoryx2_log::fatal_panic;

pub(crate) fn dynamic_config_storage_config<Service: crate::service::Service>(
    global_config: &config::Config,
) -> <Service::DynamicStorage<DynamicConfig> as NamedConceptMgmt>::Configuration {
    <<Service::DynamicStorage<DynamicConfig> as NamedConceptMgmt>::Configuration>::default()
        .prefix(&global_config.global.prefix)
        .suffix(&global_config.global.service.dynamic_config_storage_suffix)
        .path_hint(global_config.global.root_path())
}

pub(crate) fn static_config_storage_config<Service: crate::service::Service>(
    global_config: &config::Config,
) -> <Service::StaticStorage as NamedConceptMgmt>::Configuration {
    let origin = "static_config_storage_config";
    let msg = "Unable to generate static config storage directory";
    let mut path_hint = *global_config.global.root_path();
    fatal_panic!(from origin, when path_hint.add_path_entry(&global_config.global.service.directory),
            "{} since the combination of root directory and service directory entry result in an invalid directory \"{}{}\".",
            msg, path_hint, global_config.global.service.directory);

    <<Service::StaticStorage as NamedConceptMgmt>::Configuration>::default()
        .prefix(&global_config.global.prefix)
        .suffix(&global_config.global.service.static_config_storage_suffix)
        .path_hint(&path_hint)
}

pub(crate) fn connection_config<Service: crate::service::Service>(
    global_config: &config::Config,
) -> <Service::Connection as NamedConceptMgmt>::Configuration {
    <<Service::Connection as NamedConceptMgmt>::Configuration>::default()
        .prefix(&global_config.global.prefix)
        .suffix(&global_config.global.service.connection_suffix)
        .path_hint(global_config.global.root_path())
}

pub(crate) fn event_config<Service: crate::service::Service>(
    global_config: &config::Config,
) -> <Service::Event as NamedConceptMgmt>::Configuration {
    <<Service::Event as NamedConceptMgmt>::Configuration>::default()
        .prefix(&global_config.global.prefix)
        .suffix(&global_config.global.service.event_connection_suffix)
        .path_hint(global_config.global.root_path())
}

pub(crate) fn data_segment_config<Service: crate::service::Service>(
    global_config: &config::Config,
) -> <Service::SharedMemory as NamedConceptMgmt>::Configuration {
    <<Service::SharedMemory as NamedConceptMgmt>::Configuration>::default()
        .prefix(&global_config.global.prefix)
        .suffix(&global_config.global.service.data_segment_suffix)
        .path_hint(global_config.global.root_path())
}

pub(crate) fn resizable_data_segment_config<Service: crate::service::Service>(
    global_config: &config::Config,
) -> <Service::ResizableSharedMemory as NamedConceptMgmt>::Configuration {
    <<Service::ResizableSharedMemory as NamedConceptMgmt>::Configuration>::default()
        .prefix(&global_config.global.prefix)
        .suffix(&global_config.global.service.data_segment_suffix)
        .path_hint(global_config.global.root_path())
}

pub(crate) fn node_monitoring_config<Service: crate::service::Service>(
    global_config: &config::Config,
) -> <Service::Monitoring as NamedConceptMgmt>::Configuration {
    <<Service::Monitoring as NamedConceptMgmt>::Configuration>::default()
        .prefix(&global_config.global.prefix)
        .suffix(&global_config.global.node.monitor_suffix)
        .path_hint(&global_config.global.node_dir())
}

pub(crate) fn node_details_path(
    global_config: &config::Config,
    node_id: &UniqueNodeId,
) -> iceoryx2_bb_system_types::path::Path {
    let origin = "node_details_path";
    let mut path = global_config.global.node_dir();
    fatal_panic!(from origin, when path.add_path_entry(&node_id.as_file_name().into()),
                    "The node path exceeds the maximum path length.");
    path
}

pub(crate) fn node_details_config<Service: crate::service::Service>(
    global_config: &config::Config,
    node_id: &UniqueNodeId,
) -> <Service::StaticStorage as NamedConceptMgmt>::Configuration {
    <<Service::StaticStorage as NamedConceptMgmt>::Configuration>::default()
        .prefix(&global_config.global.prefix)
        .suffix(&global_config.global.node.static_config_suffix)
        .path_hint(&node_details_path(global_config, node_id))
}

pub(crate) fn port_tag_config<Service: crate::service::Service>(
    global_config: &config::Config,
    node_id: &UniqueNodeId,
) -> <Service::StaticStorage as NamedConceptMgmt>::Configuration {
    <<Service::StaticStorage as NamedConceptMgmt>::Configuration>::default()
        .prefix(&global_config.global.prefix)
        .suffix(&global_config.global.node.port_tag_suffix)
        .path_hint(&node_details_path(global_config, node_id))
}

pub(crate) fn service_tag_config<Service: crate::service::Service>(
    global_config: &config::Config,
    node_id: &UniqueNodeId,
) -> <Service::StaticStorage as NamedConceptMgmt>::Configuration {
    <<Service::StaticStorage as NamedConceptMgmt>::Configuration>::default()
        .prefix(&global_config.global.prefix)
        .suffix(&global_config.global.node.service_tag_suffix)
        .path_hint(&node_details_path(global_config, node_id))
}

pub(crate) fn blackboard_mgmt_config<
    Service: crate::service::Service,
    T: ZeroCopySend + Send + Sync + Debug + 'static,
>(
    global_config: &config::Config,
) -> <Service::BlackboardMgmt<T> as NamedConceptMgmt>::Configuration {
    <<Service::BlackboardMgmt<T> as NamedConceptMgmt>::Configuration>::default()
        .prefix(&global_config.global.prefix)
        .suffix(&global_config.global.service.blackboard_mgmt_suffix)
        .path_hint(global_config.global.root_path())
}

pub(crate) fn blackboard_data_config<Service: crate::service::Service>(
    global_config: &config::Config,
) -> <Service::BlackboardPayload as NamedConceptMgmt>::Configuration {
    <<Service::BlackboardPayload as NamedConceptMgmt>::Configuration>::default()
        .prefix(&global_config.global.prefix)
        .suffix(&global_config.global.service.blackboard_data_suffix)
        .path_hint(global_config.global.root_path())
}