[eclipse-iceoryx#674] Rename Monitor to Service

Author: orecham

iceoryx2-cli/iox2-service/src/cli.rs

@@ -58,7 +58,7 @@ pub struct DetailsOptions {
 }
 
 #[derive(Parser)]
-pub struct MonitorOptions {
+pub struct DiscoveryOptions {
     #[clap(
         short,
         long,
@@ -93,8 +93,8 @@ pub enum Action {
     )]
     Details(DetailsOptions),
     #[clap(
-        about = "Start a service monitor", 
-        help_template = help_template("iox2 service monitor", false)
+        about = "Runs the service discovery service within a process", 
+        help_template = help_template("iox2 service discovery", false)
     )]
-    Monitor(MonitorOptions),
+    Discovery(DiscoveryOptions),
 }

iceoryx2-cli/iox2-service/src/commands.rs

@@ -18,8 +18,8 @@ use iceoryx2_cli::filter::Filter;
 use iceoryx2_cli::output::ServiceDescription;
 use iceoryx2_cli::output::ServiceDescriptor;
 use iceoryx2_cli::Format;
-use iceoryx2_services_discovery::service::Monitor;
-use iceoryx2_services_discovery::service::MonitorConfig;
+use iceoryx2_services_discovery::service_discovery::DiscoveryConfig;
+use iceoryx2_services_discovery::service_discovery::Service as DiscoveryService;
 
 use crate::cli::OutputFilter;
 
@@ -96,16 +96,16 @@ impl ChangeDetails {
 }
 
 #[derive(serde::Serialize)]
-struct SerializableMonitorConfig {
+struct SerializableDiscoveryConfig {
     publish_events: bool,
     max_subscribers: usize,
     send_notifications: bool,
     max_listeners: usize,
     include_internal: bool,
 }
 
-impl SerializableMonitorConfig {
-    fn from_config(config: &MonitorConfig) -> Self {
+impl SerializableDiscoveryConfig {
+    fn from_config(config: &DiscoveryConfig) -> Self {
         Self {
             publish_events: config.publish_events,
             max_subscribers: config.max_subscribers,
@@ -124,32 +124,34 @@ impl SerializableMonitorConfig {
 /// * `rate` - The update rate in milliseconds between monitor refreshes
 /// * `publish_events` - Whether to publish events about service changes
 /// * `send_notifications` - Whether to send notifications about service changes
-pub fn monitor(
+pub fn discovery(
     rate: u64,
     publish_events: bool,
     max_subscribers: usize,
     send_notifications: bool,
     max_listeners: usize,
     format: Format,
 ) -> Result<()> {
-    let monitor_config = MonitorConfig {
+    let monitor_config = DiscoveryConfig {
         publish_events,
         max_subscribers,
         send_notifications,
         max_listeners,
         include_internal: false,
     };
 
-    let mut monitor = Monitor::<ipc::Service>::create(&monitor_config, &Config::global_config())
-        .map_err(|e| anyhow::anyhow!("failed to create service monitor: {:?}", e))?;
+    let mut service =
+        DiscoveryService::<ipc::Service>::create(&monitor_config, &Config::global_config())
+            .map_err(|e| anyhow::anyhow!("failed to create service monitor: {:?}", e))?;
 
+    println!("=== Service Discovery Service Started ===");
     println!(
         "{}",
-        format.as_string(&SerializableMonitorConfig::from_config(&monitor_config))?
+        format.as_string(&SerializableDiscoveryConfig::from_config(&monitor_config))?
     );
 
     while !SignalHandler::termination_requested() {
-        match monitor.spin() {
+        match service.spin() {
             Ok((added, removed)) => {
                 for service in added {
                     println!(

iceoryx2-cli/iox2-service/src/main.rs

@@ -65,10 +65,10 @@ fn main() -> Result<()> {
                     error!("Failed to retrieve service details: {}", e);
                 }
             }
-            Action::Monitor(options) => {
+            Action::Discovery(options) => {
                 let should_publish = options.disable_publish == false;
                 let should_notify = options.disable_notify == false;
-                if let Err(_e) = commands::monitor(
+                if let Err(_e) = commands::discovery(
                     options.rate,
                     should_publish,
                     options.max_subscribers,

iceoryx2-services/discovery/src/lib.rs

@@ -10,106 +10,14 @@
 //
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
-#![warn(missing_docs)]
-
-//! # iceoryx2-services-discovery
-//!
-//! A service for discovery and monitoring of other iceoryx2 services.
-//!
-//! This crate provides utilities for discovering, tracking, and monitoring services
-//! in an iceoryx2 system. It enables applications to detect when services become
-//! available or unavailable, and to react to these changes.
-//!
-//! ## Features
-//!
-//! - **Service Tracking**: Track the availability of services in the system
-//! - **Service Monitoring**: Monitor services and receive notifications when they appear or disappear
-//!
-//! ## Usage Examples
-//!
-//! ### Tracking Services
-//!
-//! ```rust
-//! use iceoryx2::config::Config;
-//! use iceoryx2_discovery::service::Tracker;
-//! use iceoryx2::service::YourServiceType;
-//!
-//! // Create a new tracker for your service type
-//! let mut tracker = Tracker::<YourServiceType>::new();
-//!
-//! // Sync with the system to discover services
-//! let (added_services, removed_services) = tracker.sync(&Config::global_config());
-//!
-//! // Process newly discovered services
-//! for service_id in added_services {
-//!     if let Some(service_details) = tracker.get(&service_id) {
-//!         println!("Discovered service: {:?}", service_details.static_details.name());
-//!     }
-//! }
-//! ```
-//!
-//! ### Monitoring Services
+//! # Discovery Services
 //!
-//! ```rust
-//! use iceoryx2_discovery::service::Monitor;
-//! use iceoryx2::service::YourServiceType;
+//! The `iceoryx2-services-discovery` crate provides discovery services for the components
+//! of an iceoryx2 system. These services enable other applications built on iceoryx2 to
+//! get informed of the presense of these components.
 //!
-//! // Create a new service monitor
-//! let mut monitor = Monitor::<YourServiceType>::new();
-//!
-//! // Periodically call spin() to detect and publish service changes
-//! loop {
-//!     monitor.spin();
-//!     std::thread::sleep(std::time::Duration::from_secs(1));
-//! }
-//! ```
-//!
-//! ### Subscribing to Service Discovery Events
-//!
-//! ```rust
-//! use iceoryx2::config::Config;
-//! use iceoryx2::node::{Node, NodeBuilder};
-//! use iceoryx2::port::subscriber::Subscriber;
-//! use iceoryx2::prelude::ServiceName;
-//! use iceoryx2_discovery::service::DiscoveryEvent;
-//! use iceoryx2::service::YourServiceType;
-//!
-//! // Create a node
-//! let node = NodeBuilder::new()
-//!     .config(Config::global_config())
-//!     .create::<YourServiceType>()
-//!     .expect("Failed to create node");
-//!
-//! // Create a subscriber for discovery events
-//! let service_name = ServiceName::new("iox2://monitor/services")
-//!     .expect("Failed to create service name");
-//!
-//! let publish_subscribe = node
-//!     .service_builder(&service_name)
-//!     .publish_subscribe::<DiscoveryEvent>()
-//!     .create()
-//!     .expect("Failed to create publish-subscribe service");
-//!
-//! let subscriber = publish_subscribe
-//!     .subscriber_builder()
-//!     .create()
-//!     .expect("Failed to create subscriber");
-//!
-//! // Process discovery events
-//! while let Some(event) = subscriber.receive() {
-//!     match event.payload() {
-//!         DiscoveryEvent::Added(config) => println!("Service added: {:?}", config.name()),
-//!         DiscoveryEvent::Removed(config) => println!("Service removed: {:?}", config.name()),
-//!     }
-//! }
-//! ```
-//!
-//! ## Integration with iceoryx2
-//!
-//! This crate is designed to work seamlessly with the core iceoryx2 library and provides
-//! a higher-level API for service discovery. It builds upon the service management
-//! capabilities of iceoryx2 to provide a more convenient interface for tracking and
-//! monitoring services.
 
-/// Utilities for service discovery and monitoring
-pub mod service;
+#![warn(missing_docs)]
+
+/// Discovery and tracking of services in an iceoryx2 system
+pub mod service_discovery;

iceoryx2-services/discovery/src/service/mod.rs

@@ -0,0 +1,60 @@
+// Copyright (c) 2025 Contributors to the Eclipse Foundation
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information regarding copyright ownership.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Apache Software License 2.0 which is available at
+// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
+// which is available at https://opensource.org/licenses/MIT.
+//
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+//! # Service Discovery
+//!
+//! This module provides functionality for discovering and tracking services in an iceoryx2 system.
+//!
+//! The service discovery system consists of two main components:
+//!
+//! 1. **Service**: A service that tracks and publishes information about other services in the system.
+//!    It detects when services are added or removed and notifies interested parties about these changes.
+//!
+//! 2. **Tracker**: A component that keeps track of services in the system. It maintains a list of
+//!    currently available services and can detect changes in the service landscape.
+//!
+//! ## Usage
+//!
+//! To use the service discovery system, you typically create a `Service` instance with appropriate
+//! configuration, and then periodically call its `spin` method to process service changes and emit
+//! events/notifications.
+//!
+//! ```rust,no_run
+//! use iceoryx2_services_discovery::service_discovery::{Service, DiscoveryConfig};
+//! use iceoryx2::prelude::*;
+//!
+//! // Create a service discovery service
+//! let config = DiscoveryConfig::default();
+//! let mut service = Service::<ipc::Service>::create(&config, &Config::global_config()).expect("Failed to create service");
+//!
+//! // Periodically process service changes
+//! loop {
+//!     match service.spin() {
+//!         Ok((added, removed)) => {
+//!             println!("Added {} services, removed {} services", added.len(), removed.len());
+//!         }
+//!         Err(e) => {
+//!             eprintln!("Error spinning service: {:?}", e);
+//!             break;
+//!         }
+//!     }
+//!     // Sleep or do other work...
+//! }
+
+/// A service discovery service that tracks and publishes information about services in the system.
+mod service;
+
+/// A tracker for services that maintains a list of currently available services.
+mod tracker;
+
+pub use service::*;
+pub use tracker::*;