https://github.com/AstroHQ/astro-dnssd
Simple Rust wrapper around DNS-SD
https://github.com/AstroHQ/astro-dnssd
dns-sd rust rust-wrapper
Last synced: about 1 year ago
JSON representation
Simple Rust wrapper around DNS-SD
- Host: GitHub
- URL: https://github.com/AstroHQ/astro-dnssd
- Owner: AstroHQ
- License: apache-2.0
- Created: 2018-12-25T14:55:54.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2025-01-27T17:55:35.000Z (about 1 year ago)
- Last Synced: 2025-03-31T03:11:46.718Z (about 1 year ago)
- Topics: dns-sd, rust, rust-wrapper
- Language: Rust
- Size: 138 KB
- Stars: 23
- Watchers: 7
- Forks: 5
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Astro DNS-SD
[](https://dev.azure.com/AstroHQ/astro-dnssd/_build/latest?definitionId=1&branchName=master)
[](https://github.com/AstroHQ/astro-dnssd)
[](https://crates.io/crates/astro-dnssd)
[](https://docs.rs/astro-dnssd)
Minimal but friendly safe wrapper around dns-sd(Bonjour, mDNS, Zeroconf DNS) APIs.
[Documentation](https://crates.io/crates/astro-dnssd)
## Features
### Complete
- Service registration
- TXTRecord support for service registration via HashMap
- Service browsing
### Todo
- Record creation
- Name resolution
- Port map
- Tests
- Documentation
## Build Requirements
`astro-dnssd` requires the Bonjour SDK (as of 0.3 on windows, it's optional, see win-bonjour feature flag)
- **Windows:** Download the SDK [here]( https://developer.apple.com/bonjour/)
- **Linux:** Install `avahi-compat-libdns_sd` for your distro of choice.
## Technical Background
This [website](http://www.dns-sd.org/) provides a good overview of the DNS-SD protocol.
## Example
```rust
use astro_dnssd::DNSServiceBuilder;
use env_logger::Env;
use std::thread::sleep;
use std::time::Duration;
fn main() {
env_logger::from_env(Env::default().default_filter_or("trace")).init();
println!("Registering service...");
let service = DNSServiceBuilder::new("_http._tcp", 8080)
.with_key_value("status".into(), "open".into())
.register();
{
match service {
Ok(service) => {
println!("Registered... waiting 20s");
sleep(Duration::from_secs(20));
println!("Dropping... {:?}", service);
}
Err(e) => {
println!("Error registering: {:?}", e);
}
}
}
log::info!("Drop should have happened");
sleep(Duration::from_secs(5));
}
```
## License
Licensed under either of
- Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))
- MIT license
([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.