pmo

pmomdns (0.2.1)

Published 2026-11-12 20:30:43 +01:00 by eric

Installation

[registries.forgejo]
index = "sparse+" # Sparse index
# index = "" # Git

[net]
git-fetch-with-cli = true
cargo add pmomdns@0.2.1 --registry forgejo

About this package

Le démon mDNS unique du processus, avec recherche en unicast de secours : découverte AirPlay et Chromecast.

pmomdns

Le démon mDNS unique du processus, doublé d'une recherche en unicast de secours : la découverte des appareils AirPlay (_raop._tcp) et Chromecast (_googlecast._tcp) de PMOMusic.

Version Documentation

Fonctionnalités

  • Un seul ServiceDaemon (mdns-sd) par processus, créé au premier appel de daemon() ou de browse(). Il ne sort jamais de la crate : daemon() rend un Daemon qui n'annonce et ne retire que des services, sans shutdown.
  • browse(type) : un abonnement (Subscription) aux événements d'un type de service, vus par le démon et par une recherche en unicast (RFC 6762 §6.7) qui trouve les appareils même quand leurs réponses multicast n'arrivent pas. Plusieurs abonnés au même type partagent une seule recherche ; abandonner le dernier la ferme.
  • Ré-export de mdns_sd : une seule version de la bibliothèque pour tous les consommateurs.
  • Un type d'erreur unique, PmomdnsError.

Installation

[dependencies]
pmomdns = { version = "0.2", registry = "pmo" }

Depuis les sources : git clone du dépôt, puis cargo build. En développement conjoint avec pmomusic, make génère le patch local (.cargo/config.toml) qui résout pmomdns vers ce dossier.

Documentation

cargo doc --open, ou le wiki du dépôt (publié par la CI à chaque release).

use pmomdns::mdns_sd::ServiceEvent;

let events = pmomdns::browse("_raop._tcp.local.")?;
while let Some(event) = events.recv() {
    if let ServiceEvent::ServiceResolved(service) = event {
        println!("{} : {:?}", service.get_fullname(), service.get_addresses());
    }
}
# Ok::<(), pmomdns::PmomdnsError>(())

Pour annoncer un service, on prend le démon partagé : pmomdns::daemon()?.register(info).

API

Élément Rôle
daemon() Daemon (handle Clone) : register, unregister. Le démon est créé au premier appel et ne peut pas être arrêté
browse(service_type) Subscription : démon + recherche unicast, partagée entre abonnés
Subscription recv, recv_async, try_recv, recv_timeout (tous Option) ; désabonne au Drop
set_silent_rounds(n), silent_rounds(), DEFAULT_SILENT_ROUNDS Tours sans réponse avant le retrait d'un service par la recherche unicast ; global au processus, n ≥ 1 (sinon InvalidSilentRounds). pmomusic le renseigne depuis host.mdns.silent_rounds
mdns_sd Ré-export de la bibliothèque (ServiceEvent, ServiceInfo, ResolvedService…)
PmomdnsError DaemonCreation, InvalidServiceType, DaemonBusy, DaemonStopped, SubscriptionRefused, AnnouncementRefused, InvalidSilentRounds, Thread { operation: ThreadKind, source } ; #[non_exhaustive]
Result<T> Result<T, PmomdnsError>

Particularités

  • Un seul démon partagé. Un ServiceDaemon tient les sockets UDP 5353 et sa boucle : deux démons dans un processus, ce sont deux écouteurs et deux caches. Les consommateurs passent toujours par daemon() et browse(), jamais par ServiceDaemon::new(). Le Daemon rendu n'a pas de shutdown : un appelant ne peut pas arrêter le démon des autres.
  • browse(), et pas de browse sur le démon. Le démon pose ses questions depuis le port 5353 ; les appareils répondent par multicast, ce qui n'arrive jamais sur certains réseaux (borne filtrant le multicast, macOS dont mDNSResponder tient le port). browse() ajoute une recherche en unicast, et partage un seul abonnement du démon entre tous les abonnés d'un type (le démon n'en garde qu'un par type : un second browse direct écraserait le premier). Un fil de fusion rediffuse les événements : un ServiceResolved n'est rendu que quand la description du service change ; la description du démon prime sur celle de la recherche unicast, qui n'en voit qu'une partie ; un abonné tardif reçoit d'abord les services déjà résolus. Un ServiceRemoved n'est rendu qu'une fois par service : le démon le donne s'il voit le retrait ; la recherche unicast le donne quand l'appareil dit au revoir (PTR de TTL 0) ou reste sans répondre pendant silent_rounds tours de question de suite (5 par défaut, ≈ 100 s en régime établi), sauf si le démon décrit lui-même ce service (il fait alors foi). Un tour sans interface utilisable (réseau tombé) ne compte pas. Les adresses annoncées avec le bit cache-flush remplacent les précédentes.
  • Ré-export de mdns_sd. Les consommateurs ne déclarent pas mdns-sd eux-mêmes : la version est celle de pmomdns. Monter mdns-sd est donc un changement d'API de cette crate.
  • Contrainte flume / if-addrs. Les événements du démon passent par flume 0.12, version de mdns-sd 0.21 : flume doit rester sur la même version que mdns-sd, pas celle d'un workspace voisin (0.11 dans pmomusic). if-addrs suit aussi mdns-sd, pour énumérer les interfaces comme lui. Les deux se montent avec mdns-sd.
  • Modules internes (privés) :
    • registry : un suivi par type de service, ses abonnés et le fil de fusion ;
    • merge : ce qui a déjà été rendu (dédoublonnage, services connus d'un abonné tardif) ;
    • subscription : le handle rendu par browse() ;
    • settings : les réglages du processus (tours sans réponse) ;
    • wire : le strict nécessaire du format DNS (fabriquer une question, lire PTR / SRV / TXT / A, compression de noms comprise) ;
    • catalog : accumule les enregistrements reçus, dit ce qui manque (SRV, TXT, A) et rend les services complets sous la forme ResolvedService de mdns-sd, une fois par changement ;
    • unicast : un fil par recherche, une prise UDP par interface IPv4 (port éphémère), questions à 1 s, 2 s puis toutes les 20 s.
  • Erreurs. Pas de repli silencieux : la création du démon et le lancement d'un fil échouent avec PmomdnsError. Un échec d'envoi d'une question unicast est ignoré (réseau tombé, interface sans multicast) : la question suivante réessaie.

Limites

(Détail dans la documentation de la crate, cargo doc --open.)

  • La recherche unicast ne lit que l'IPv4 (enregistrements A) ; l'IPv6 n'est pas vérifié.
  • Questions unicast à 1 s, 2 s puis toutes les 20 s, non réglables ; seul le nombre de tours sans réponse avant retrait se règle (5 par défaut, ≈ 100 s). Ce défaut est un choix, pas une mesure.
  • Un tour sans interface utilisable ne compte pas pour le retrait. Un service retiré par le démon mais encore annoncé en unicast n'est ré-émis que si sa description change.
  • Un démon mdns-sd qui s'arrête de lui-même n'est ni détecté ni recréé (non testé).
  • daemon() et browse() sont synchrones (verrou global, sockets, fils) ; durée non mesurée. Un verrou empoisonné est récupéré tel quel.
  • Testé sur macOS ; Linux (Raspberry Pi) non vérifié.

Développement

make help   # commandes (kit crate-kit)
make ci     # fmt-check + clippy + tests + doc
cargo test live -- --ignored --nocapture   # recherche unicast sur un réseau réel avec appareils

Les tests unitaires sont dans src/tests/ (un fichier par module) ; tests/api.rs couvre l'API publique sans appareil. Le test live_unicast_search_finds_devices est #[ignore] : il demande un réseau avec des appareils AirPlay et Chromecast.

Dépendances

  • mdns-sd : démon mDNS, ServiceInfo, ResolvedService.
  • flume (0.12, features async, select) : canaux, même version que mdns-sd.
  • if-addrs : interfaces réseau, même version que mdns-sd.
  • socket2 : prises UDP liées à une interface (multicast sortant, TTL).
  • thiserror : PmomdnsError. tracing : journal de débogage.

License

CeCILL v2.1 (voir LICENSE, traduction anglaise : LICENSE.en).

Dependencies

ID Version
flume ^0.12
if-addrs ^0.15
mdns-sd ^0.21
mio ^1
socket2 ^0.6
thiserror ^2.0
tracing ^0.1
proptest ^1

Keywords

mdns bonjour discovery airplay chromecast
Details
Cargo
2026-11-12 20:30:43 +01:00
4
CECILL-2.1
258 KiB
Assets (1)
Versions (2) View all
0.2.1 2026-11-12
0.1.0 2026-11-12