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

// 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 iceoryx2_bb_derive_macros::ZeroCopySend;
use iceoryx2_bb_elementary_traits::zero_copy_send::ZeroCopySend;
use iceoryx2_cal::zero_copy_connection::ChannelId;

use crate::{
    active_request::RequestId,
    identifiers::{UniqueClientId, UniqueNodeId, UniqueServerId},
};

/// Request header used by
/// [`MessagingPattern::RequestResponse`](crate::service::messaging_pattern::MessagingPattern::RequestResponse)
#[derive(Debug, Copy, Clone, ZeroCopySend)]
#[repr(C)]
pub struct RequestHeader {
    pub(crate) node_id: UniqueNodeId,
    pub(crate) client_id: UniqueClientId,
    pub(crate) channel_id: ChannelId,
    pub(crate) request_id: RequestId,
    pub(crate) number_of_elements: u64,
}

impl RequestHeader {
    /// Returns the [`UniqueClientId`] of the [`Client`](crate::port::client::Client)
    /// which sent the [`RequestMut`](crate::request_mut::RequestMut)
    pub fn client_id(&self) -> UniqueClientId {
        self.client_id
    }

    /// Returns how many elements are stored inside the requests's payload.
    ///
    /// # Details when using
    /// [`CustomPayloadMarker`](crate::service::builder::CustomPayloadMarker)
    ///
    /// In this case the number of elements relates to the element defined in the
    /// [`MessageTypeDetails`](crate::service::static_config::message_type_details::MessageTypeDetails).
    /// When the element has a `payload.size == 40` and the `RequestMut::payload().len() == 120` it
    /// means that it contains 3 elements (3 * 40 == 120).
    pub fn number_of_elements(&self) -> u64 {
        self.number_of_elements
    }

    /// Returns the [`UniqueNodeId`] of the source node that published the
    /// [`RequestMut`](crate::request_mut::RequestMut).
    pub fn node_id(&self) -> UniqueNodeId {
        self.node_id
    }
}

/// Response header used by
/// [`MessagingPattern::RequestResponse`](crate::service::messaging_pattern::MessagingPattern::RequestResponse)
#[derive(Debug, Copy, Clone, ZeroCopySend)]
#[repr(C)]
pub struct ResponseHeader {
    pub(crate) node_id: UniqueNodeId,
    pub(crate) server_id: UniqueServerId,
    pub(crate) request_id: RequestId,
    pub(crate) number_of_elements: u64,
}

impl ResponseHeader {
    /// Returns the [`UniqueNodeId`] of the source node that published the
    /// [`Response`](crate::response::Response).
    pub fn node_id(&self) -> UniqueNodeId {
        self.node_id
    }

    /// Returns the [`UniqueServerId`] of the [`Server`](crate::port::server::Server)
    /// which sent the [`Response`](crate::response::Response)
    pub fn server_id(&self) -> UniqueServerId {
        self.server_id
    }

    /// Returns how many elements are stored inside the [`Response`](crate::response::Response)s
    /// payload.
    ///
    /// # Details when using
    /// [`CustomPayloadMarker`](crate::service::builder::CustomPayloadMarker)
    ///
    /// In this case the number of elements relates to the element defined in the
    /// [`MessageTypeDetails`](crate::service::static_config::message_type_details::MessageTypeDetails).
    /// When the element has a `payload.size == 40` and the `ResponseMut::payload().len() == 120` it
    /// means that it contains 3 elements (3 * 40 == 120).
    pub fn number_of_elements(&self) -> u64 {
        self.number_of_elements
    }
}