mirror of
https://github.com/rustfs/rustfs.git
synced 2026-08-06 05:17:42 +00:00
houseme
9ce3c7742c
Signed-off-by: houseme <housemecn@gmail.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
94 lines
3.2 KiB
Rust
94 lines
3.2 KiB
Rust
// Copyright 2024 RustFS Team
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
/// Check if MQTT Broker is available
|
|
///
|
|
/// # Arguments
|
|
/// * `broker_url` - URL of MQTT Broker, for example `mqtt://localhost:1883`
|
|
/// * `topic` - Topic for testing connections
|
|
/// * `username` - Optional username for authentication
|
|
/// * `password` - Optional password for authentication
|
|
/// # Returns
|
|
/// * `Ok(())` - If the connection is successful
|
|
/// * `Err(String)` - If the connection fails, contains an error message
|
|
///
|
|
/// # Example
|
|
/// ```rust,no_run
|
|
/// #[tokio::main]
|
|
/// async fn main() {
|
|
/// let result = rustfs_targets::check_mqtt_broker_available(
|
|
/// "mqtt://localhost:1883",
|
|
/// "test/topic",
|
|
/// Some("myuser"),
|
|
/// Some("mypass"),
|
|
/// ).await;
|
|
/// if result.is_ok() {
|
|
/// println!("MQTT Broker is available");
|
|
/// } else {
|
|
/// println!("MQTT Broker is not available: {}", result.err().unwrap());
|
|
/// }
|
|
/// }
|
|
/// ```
|
|
/// # Note
|
|
/// Need to add `rumqttc` and `url` dependencies in `Cargo.toml`
|
|
/// ```toml
|
|
/// [dependencies]
|
|
/// rumqttc = "0.25.0"
|
|
/// url = "2.5.7"
|
|
/// tokio = { version = "1", features = ["full"] }
|
|
/// ```
|
|
///
|
|
pub async fn check_mqtt_broker_available(
|
|
broker_url: &str,
|
|
topic: &str,
|
|
username: Option<&str>,
|
|
password: Option<&str>,
|
|
) -> Result<(), String> {
|
|
use rumqttc::{AsyncClient, MqttOptions, QoS};
|
|
let url = rustfs_utils::parse_url(broker_url).map_err(|e| format!("Broker URL parsing failed:{e}"))?;
|
|
let url = url.url();
|
|
|
|
match url.scheme() {
|
|
"tcp" | "ssl" | "ws" | "wss" | "mqtt" | "mqtts" | "tls" | "tcps" => {}
|
|
_ => return Err("unsupported broker url scheme".to_string()),
|
|
}
|
|
|
|
let host = url.host_str().ok_or("Broker is missing host")?;
|
|
let port = url.port().unwrap_or(1883);
|
|
let mut mqtt_options = MqttOptions::new("rustfs_check", host, port);
|
|
|
|
// Set credentials if provided
|
|
if let Some(user) = username
|
|
&& !user.is_empty()
|
|
{
|
|
let pass = password.unwrap_or("");
|
|
mqtt_options.set_credentials(user, pass);
|
|
}
|
|
|
|
mqtt_options.set_keep_alive(std::time::Duration::from_secs(5));
|
|
let (client, mut eventloop) = AsyncClient::new(mqtt_options, 1);
|
|
|
|
// Try to connect and subscribe
|
|
client
|
|
.subscribe(topic, QoS::AtLeastOnce)
|
|
.await
|
|
.map_err(|e| format!("MQTT subscription failed:{e}"))?;
|
|
// Wait for eventloop to receive at least one event
|
|
match tokio::time::timeout(std::time::Duration::from_secs(3), eventloop.poll()).await {
|
|
Ok(Ok(_)) => Ok(()),
|
|
Ok(Err(e)) => Err(format!("MQTT connection failed:{e}")),
|
|
Err(_) => Err("MQTT connection timeout".to_string()),
|
|
}
|
|
}
|