switchy_mdns 0.3.0

Switchy mdns service discovery package
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# switchy_mdns

mDNS service registration for MoosicBox servers.

## Features

- **Service Registration**: Register MoosicBox servers on the local network via mDNS
- **Simulator**: Simulated mDNS daemon for testing (enabled by default)

## Cargo Features

| Feature            | Default | Description                                                          |
| ------------------ | ------- | -------------------------------------------------------------------- |
| `simulator`        | Yes     | Provides a simulated mDNS daemon for testing                         |
| `fail-on-warnings` | No      | Enables strict warning handling through the `moosicbox_assert` crate |

## Installation

```toml
[dependencies]
switchy_mdns = "0.1.4"

# Or disable default features (disables the simulator)
switchy_mdns = { version = "0.1.4", default-features = false }
```

## Usage

### Registering a Service

```rust,no_run
use switchy_mdns::register_service;

async fn example() -> Result<(), switchy_mdns::RegisterServiceError> {
    register_service("my-server", "192.168.1.100", 8080).await?;
    Ok(())
}
```

## Public API

- `register_service(instance_name, ip, port)`: Registers a MoosicBox mDNS service instance
- `SERVICE_TYPE`: The service type constant used for registration (`_moosicboxserver._tcp.local.`)
- `RegisterServiceError`: Error type returned by `register_service`
    - `RegisterServiceError::MdnsSd`: Underlying `mdns_sd` daemon or registration error
    - `RegisterServiceError::IO`: Hostname lookup I/O error
- `switchy_mdns::service::MdnsServiceDaemon`: Trait abstraction for service daemon implementations
- `switchy_mdns::service::MdnsSdServiceDaemon`: Wrapper for real `mdns_sd::ServiceDaemon`
- `switchy_mdns::service::simulator::SimulatorServiceDaemon`: Simulator daemon (available with `simulator` feature)

## License

This project is licensed under the MPL-2.0 License.