From 6f05a391fe0023a442b0d03a4a7db7e4bec16c4a Mon Sep 17 00:00:00 2001 From: bit-aloo Date: Wed, 22 Jan 2025 20:55:31 +0530 Subject: [PATCH] add suggested changes --- roles/jd-client/src/lib/mod.rs | 8 ++++---- roles/translator/src/lib/mod.rs | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/roles/jd-client/src/lib/mod.rs b/roles/jd-client/src/lib/mod.rs index 01e32cb76..25e83a393 100644 --- a/roles/jd-client/src/lib/mod.rs +++ b/roles/jd-client/src/lib/mod.rs @@ -371,11 +371,11 @@ impl JobDeclaratorClient { .await; } - /// Notifies the JD-Client to shut down gracefully. + /// Closes JDC role and any open connection associated with it. /// - /// This method triggers the shutdown process by sending a notification. - /// It ensures that any ongoing operations are properly handled before - /// the jd-client stops functioning. + /// Note that this method will result in a full exit of the running + /// jd-client and any open connection most be re-initiated upon new + /// start. #[allow(dead_code)] pub fn shutdown(&self) { self.shutdown.notify_one(); diff --git a/roles/translator/src/lib/mod.rs b/roles/translator/src/lib/mod.rs index b04267f67..d2b837d9d 100644 --- a/roles/translator/src/lib/mod.rs +++ b/roles/translator/src/lib/mod.rs @@ -288,11 +288,11 @@ impl TranslatorSv2 { task_collector.safe_lock(|t| t.push((task.abort_handle(), "init task".to_string()))); } - /// Notifies the translator to shut down gracefully. + /// Closes Translator role and any open connection associated with it. /// - /// This method triggers the shutdown process by sending a notification. - /// It ensures that any ongoing operations are properly handled before - /// the translator stops functioning. + /// Note that this method will result in a full exit of the running + /// Translator and any open connection most be re-initiated upon new + /// start. pub fn shutdown(&self) { self.shutdown.notify_last(); }