nautilus_live/data/client.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
16use std::cell::Ref;
17
18use nautilus_common::{clock::Clock, messages::DataEvent};
19use nautilus_data::client::DataClient;
20
21#[async_trait::async_trait]
22pub trait LiveDataClient: DataClient {
23 /// Establishes a connection for live data.
24 ///
25 /// # Errors
26 ///
27 /// Returns an error if connection fails.
28 async fn connect(&mut self) -> anyhow::Result<()>;
29
30 /// Disconnects the live data client.
31 ///
32 /// # Errors
33 ///
34 /// Returns an error if disconnection fails.
35 async fn disconnect(&mut self) -> anyhow::Result<()>;
36
37 fn get_message_channel(&self) -> tokio::sync::mpsc::UnboundedSender<DataEvent>;
38
39 fn get_clock(&self) -> Ref<'_, dyn Clock>;
40}