zenoh_protocol/network/
request.rs

1//
2// Copyright (c) 2022 ZettaScale Technology
3//
4// This program and the accompanying materials are made available under the
5// terms of the Eclipse Public License 2.0 which is available at
6// http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
7// which is available at https://www.apache.org/licenses/LICENSE-2.0.
8//
9// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
10//
11// Contributors:
12//   ZettaScale Zenoh Team, <zenoh@zettascale.tech>
13//
14use core::sync::atomic::AtomicU32;
15
16use zenoh_buffers::buffer::Buffer;
17
18use crate::{core::WireExpr, zenoh::RequestBody};
19
20/// The resolution of a RequestId
21pub type RequestId = u32;
22pub type AtomicRequestId = AtomicU32;
23
24pub mod flag {
25    pub const N: u8 = 1 << 5; // 0x20 Named         if N==1 then the key expr has name/suffix
26    pub const M: u8 = 1 << 6; // 0x40 Mapping       if M==1 then key expr mapping is the one declared by the sender, else it is the one declared by the receiver
27    pub const Z: u8 = 1 << 7; // 0x80 Extensions    if Z==1 then an extension will follow
28}
29
30/// # Request message
31///
32/// ```text
33/// Flags:
34/// - N: Named          if N==1 then the key expr has name/suffix
35/// - M: Mapping        if M==1 then key expr mapping is the one declared by the sender, else it is the one declared by the receiver
36/// - Z: Extension      if Z==1 then at least one extension is present
37///
38///  7 6 5 4 3 2 1 0
39/// +-+-+-+-+-+-+-+-+
40/// |Z|M|N| Request |
41/// +-+-+-+---------+
42/// ~ request_id:z32~  (*)
43/// +---------------+
44/// ~ key_scope:z16 ~
45/// +---------------+
46/// ~  key_suffix   ~  if N==1 -- <u8;z16>
47/// +---------------+
48/// ~   [req_exts]  ~  if Z==1
49/// +---------------+
50/// ~  RequestBody  ~  -- Payload
51/// +---------------+
52///
53/// (*) The resolution of the request id is negotiated during the session establishment.
54///     This implementation limits the resolution to 32bit.
55/// ```
56#[derive(Debug, Clone, PartialEq, Eq)]
57pub struct Request {
58    pub id: RequestId,
59    pub wire_expr: WireExpr<'static>,
60    pub ext_qos: ext::QoSType,
61    pub ext_tstamp: Option<ext::TimestampType>,
62    pub ext_nodeid: ext::NodeIdType,
63    pub ext_target: ext::QueryTarget,
64    pub ext_budget: Option<ext::BudgetType>,
65    pub ext_timeout: Option<ext::TimeoutType>,
66    pub ext_ts_stack: Option<ext::TsStackType>,
67    pub payload: RequestBody,
68}
69
70pub mod ext {
71    use core::{num::NonZeroU32, time::Duration};
72
73    use serde::Deserialize;
74
75    use crate::{zextz64, zextzbuf};
76
77    pub type QoS = zextz64!(0x1, false);
78    pub type QoSType = crate::network::ext::QoSType<{ QoS::ID }>;
79
80    pub type Timestamp = zextzbuf!(0x2, false);
81    pub type TimestampType = crate::network::ext::TimestampType<{ Timestamp::ID }>;
82
83    pub type NodeId = zextz64!(0x3, true);
84    pub type NodeIdType = crate::network::ext::NodeIdType<{ NodeId::ID }>;
85
86    pub type Target = zextz64!(0x4, true);
87    // ```text
88    // - Target (0x03)
89    //  7 6 5 4 3 2 1 0
90    // +-+-+-+-+-+-+-+-+
91    // %     target    %
92    // +---------------+
93    // ```
94    // The `zenoh::queryable::Queryable`s that should be target of a `zenoh::Session::get()`.
95    #[repr(u8)]
96    #[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize)]
97    pub enum QueryTarget {
98        /// Let Zenoh find the BestMatching queryable capabale of serving the query.
99        #[default]
100        BestMatching,
101        /// Deliver the query to all queryables matching the query's key expression.
102        All,
103        /// Deliver the query to all queryables matching the query's key expression that are declared as complete.
104        AllComplete,
105    }
106
107    impl QueryTarget {
108        pub const DEFAULT: Self = Self::BestMatching;
109
110        #[cfg(feature = "test")]
111        #[doc(hidden)]
112        pub fn rand() -> Self {
113            use rand::prelude::*;
114            let mut rng = rand::thread_rng();
115
116            *[
117                QueryTarget::All,
118                QueryTarget::AllComplete,
119                QueryTarget::BestMatching,
120            ]
121            .choose(&mut rng)
122            .unwrap()
123        }
124    }
125
126    // The maximum number of responses
127    pub type Budget = zextz64!(0x5, false);
128    pub type BudgetType = NonZeroU32;
129
130    // The timeout of the request
131    pub type Timeout = zextz64!(0x6, false);
132    pub type TimeoutType = Duration;
133
134    pub type TsStack = zextzbuf!(0x7, false);
135    pub type TsStackType = crate::network::timestamp_stack::TsStackType<{ TsStack::ID }>;
136}
137
138impl Request {
139    pub fn payload_size(&self) -> usize {
140        match &self.payload {
141            RequestBody::Query(q) => {
142                q.ext_body.as_ref().map_or(0, |b| b.payload.len())
143                    + q.ext_attachment.as_ref().map_or(0, |a| a.buffer.len())
144            }
145        }
146    }
147
148    #[cfg(feature = "test")]
149    #[doc(hidden)]
150    pub fn rand() -> Self {
151        use core::num::NonZeroU32;
152
153        use rand::Rng;
154
155        let mut rng = rand::thread_rng();
156        let wire_expr = WireExpr::rand();
157        let id: RequestId = rng.gen();
158        let payload = RequestBody::rand();
159        let ext_qos = ext::QoSType::rand();
160        let ext_tstamp = rng.gen_bool(0.5).then(ext::TimestampType::rand);
161        let ext_nodeid = ext::NodeIdType::rand();
162        let ext_target = ext::QueryTarget::rand();
163        let ext_budget = if rng.gen_bool(0.5) {
164            NonZeroU32::new(rng.gen())
165        } else {
166            None
167        };
168        let ext_timeout = if rng.gen_bool(0.5) {
169            Some(ext::TimeoutType::from_millis(rng.gen()))
170        } else {
171            None
172        };
173        let ext_ts_stack = rng.gen_bool(0.5).then(ext::TsStackType::rand);
174
175        Self {
176            wire_expr,
177            id,
178            payload,
179            ext_qos,
180            ext_tstamp,
181            ext_nodeid,
182            ext_target,
183            ext_budget,
184            ext_timeout,
185            ext_ts_stack,
186        }
187    }
188}
zenoh_protocol/network/request.rs

zenoh_protocol/network/
request.rs
