mirror of
https://github.com/rustfs/rustfs.git
synced 2026-08-06 21:33:14 +00:00
houseme
d6158c0481
Signed-off-by: houseme <housemecn@gmail.com> Co-authored-by: heihutu <heihutu@gmail.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: houseme <4829346+houseme@users.noreply.github.com> Co-authored-by: 安正超 <anzhengchao@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
95 lines
3.3 KiB
Rust
95 lines
3.3 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(TargetError)` - If the check fails.
|
|
/// `TargetError::Configuration` indicates a bad configuration (invalid URL, TLS settings, etc.).
|
|
/// Other variants indicate a connectivity or runtime failure.
|
|
///
|
|
/// # 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());
|
|
/// }
|
|
/// }
|
|
/// ```
|
|
///
|
|
pub async fn check_mqtt_broker_available(
|
|
broker_url: &str,
|
|
topic: &str,
|
|
username: Option<&str>,
|
|
password: Option<&str>,
|
|
) -> Result<(), crate::TargetError> {
|
|
use crate::target::mqtt::MQTTTlsConfig;
|
|
|
|
check_mqtt_broker_available_with_tls(broker_url, topic, username, password, &MQTTTlsConfig::default()).await
|
|
}
|
|
|
|
pub async fn check_mqtt_broker_available_with_tls(
|
|
broker_url: &str,
|
|
topic: &str,
|
|
username: Option<&str>,
|
|
password: Option<&str>,
|
|
tls: &crate::target::mqtt::MQTTTlsConfig,
|
|
) -> Result<(), crate::TargetError> {
|
|
use crate::target::mqtt::build_mqtt_options;
|
|
use rumqttc::{AsyncClient, QoS};
|
|
|
|
let url = rustfs_utils::parse_url(broker_url)
|
|
.map_err(|e| crate::TargetError::Configuration(format!("Broker URL parsing failed: {e}")))?;
|
|
let url = url.url();
|
|
|
|
// build_mqtt_options returns TargetError directly; Configuration variants propagate as-is.
|
|
let mqtt_options = build_mqtt_options(
|
|
"rustfs_check".to_string(),
|
|
url,
|
|
username,
|
|
password,
|
|
tls,
|
|
std::time::Duration::from_secs(5),
|
|
None,
|
|
)?;
|
|
let (client, mut eventloop) = AsyncClient::new(mqtt_options, 1);
|
|
|
|
// Try to connect and subscribe
|
|
client
|
|
.subscribe(topic, QoS::AtLeastOnce)
|
|
.await
|
|
.map_err(|e| crate::TargetError::Network(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(crate::TargetError::Network(format!("MQTT connection failed: {e}"))),
|
|
Err(_) => Err(crate::TargetError::Timeout("MQTT connection timed out".to_string())),
|
|
}
|
|
}
|