nautilus_common/runtime.rs
1// -------------------------------------------------------------------------------------------------
2// Copyright (C) 2015-2025 Nautech Systems Pty Ltd. All rights reserved.
3// https://nautechsystems.io
4//
5// Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6// You may not use this file except in compliance with the License.
7// You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16//! The centralized Tokio runtime for a running Nautilus system.
17
18use std::sync::OnceLock;
19
20use tokio::runtime::Runtime;
21
22static RUNTIME: OnceLock<tokio::runtime::Runtime> = OnceLock::new();
23
24/// Retrieves a reference to a globally shared Tokio runtime.
25/// The runtime is lazily initialized on the first call and reused thereafter.
26///
27/// This global runtime is intended for use cases where passing a runtime
28/// around is impractical. It uses default configuration values.
29///
30/// # Panics
31///
32/// Panics if the runtime could not be created, which typically indicates
33/// an inability to spawn threads or allocate necessary resources.
34pub fn get_runtime() -> &'static tokio::runtime::Runtime {
35 // Using default configuration values for now
36 RUNTIME.get_or_init(|| Runtime::new().expect("Failed to create tokio runtime"))
37}