Crate zeroconf[−][src]
zeroconf
is a cross-platform library that wraps underlying ZeroConf/mDNS implementations
such as Bonjour or Avahi, providing an easy and idiomatic way to both register and
browse services.
This crate provides the cross-platform MdnsService
and MdnsBrowser
available for each
supported platform as well as platform-specific modules for lower-level access to the mDNS
implementation should that be necessary.
Most users of this crate need only MdnsService
and MdnsBrowser
.
Examples
Register a service
When registering a service, you may optionally pass a "context" to pass state through the
callback. The only requirement is that this context implements the Any
trait, which most
types will automatically. See MdnsService
for more information about contexts.
use std::any::Any; use std::sync::{Arc, Mutex}; use std::time::Duration; use zeroconf::{MdnsService, ServiceRegistration, TxtRecord}; use zeroconf::prelude::*; #[derive(Default, Debug)] pub struct Context { service_name: String, } fn main() { let mut service = MdnsService::new("_http._tcp", 8080); let mut txt_record = TxtRecord::new(); let context: Arc<Mutex<Context>> = Arc::default(); txt_record.insert("foo", "bar").unwrap(); service.set_registered_callback(Box::new(on_service_registered)); service.set_context(Box::new(context)); service.set_txt_record(txt_record); let event_loop = service.register().unwrap(); loop { // calling `poll()` will keep this service alive event_loop.poll(Duration::from_secs(0)).unwrap(); } } fn on_service_registered( result: zeroconf::Result<ServiceRegistration>, context: Option<Arc<dyn Any>>, ) { let service = result.unwrap(); println!("Service registered: {:?}", service); let context = context .as_ref() .unwrap() .downcast_ref::<Arc<Mutex<Context>>>() .unwrap() .clone(); context.lock().unwrap().service_name = service.name().clone(); println!("Context: {:?}", context); // ... }
Browsing services
use std::any::Any; use std::sync::Arc; use std::time::Duration; use zeroconf::{MdnsBrowser, ServiceDiscovery}; use zeroconf::prelude::*; fn main() { let mut browser = MdnsBrowser::new("_http._tcp"); browser.set_service_discovered_callback(Box::new(on_service_discovered)); let event_loop = browser.browse_services().unwrap(); loop { // calling `poll()` will keep this browser alive event_loop.poll(Duration::from_secs(0)).unwrap(); } } fn on_service_discovered( result: zeroconf::Result<ServiceDiscovery>, _context: Option<Arc<dyn Any>>, ) { println!("Service discovered: {:?}", result.unwrap()); // ... }
Re-exports
pub use browser::ServiceDiscoveredCallback; |
pub use browser::ServiceDiscovery; |
pub use service::ServiceRegisteredCallback; |
pub use service::ServiceRegistration; |
Modules
browser | Trait definition for cross-platform browser |
error | Utilities regarding error handling |
event_loop | Trait definition for cross-platform event loop |
ffi | Utilities related to FFI bindings |
linux | Linux-specific ZeroConf bindings |
prelude | Crate prelude |
service | Trait definition for cross-platform service. |
txt_record | TxtRecord utilities common to all platforms |
Enums
NetworkInterface | Represents a network interface for mDNS services |
Type Definitions
EventLoop | Type alias for the platform-specific structure responsible for polling the mDNS event loop |
MdnsBrowser | Type alias for the platform-specific mDNS browser implementation |
MdnsService | Type alias for the platform-specific mDNS service implementation |
Result | Result type for this library |
TxtRecord | Type alias for the platform-specific structure responsible for storing and accessing TXT record data |