pmo

pmossdp (0.2.4)

Published 2026-11-14 05:20:44 +01:00 by eric

Installation

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

[net]
git-fetch-with-cli = true
cargo add pmossdp@0.2.4 --registry forgejo

About this package

SSDP (Simple Service Discovery Protocol) : annonces NOTIFY, M-SEARCH, écoute. Autonome et léger : utilisable depuis un agent embarqué.

pmossdp

SSDP (Simple Service Discovery Protocol) pour UPnP : annonces NOTIFY, réponses et envois M-SEARCH, écoute des annonces. Autonome et léger : utilisable depuis un agent embarqué.

Contenu

Élément Rôle
SsdpServer Mode appareil : annonce des SsdpDevice (alive périodique, byebye à l'arrêt) et répond aux M-SEARCH
SsdpDevice Identité d'un appareil annoncé (UUID, type, LOCATION, SERVER, types de notification)
SsdpClient Mode point de contrôle : envoie des M-SEARCH, reçoit les annonces et les réponses (SsdpEvent)

Organisation : lib.rs (réexports et constantes SSDP_MULTICAST_ADDR, SSDP_PORT, MAX_AGE), server.rs, client.rs, device.rs, util.rs (date HTTP, hasard léger, attente interruptible, jonction du groupe multicast).

Le client utilise un port éphémère pour ses recherches (les réponses arrivent en unicast) et écoute séparément le port 1900, partagé avec le serveur, pour les annonces alive / byebye. Ne pas faire partir les recherches du port 1900 : le noyau répartirait les réponses entre les sockets liés à ce port. Le port 1900 est partagé (SO_REUSEADDR + SO_REUSEPORT) avec le serveur et les autres applications UPnP, et le multicast est livré à chaque socket. Voir la documentation de SsdpClient (rustdoc).

Utilisation

[dependencies]
pmossdp = { version = "0.2", registry = "pmo" }
use pmossdp::{SsdpDevice, SsdpServer};

let device = SsdpDevice::new(
    "0f3c…".into(),
    "urn:schemas-upnp-org:device:MediaRenderer:1".into(),
    "http://192.168.1.10:8080/desc.xml".into(),
    "Linux UPnP/1.1 MonApp/1.0".into(),
);
let mut ssdp = SsdpServer::new();
ssdp.start()?;
ssdp.add_device(device);
# Ok::<(), std::io::Error>(())

Points d'attention :

  • Un match sur SsdpEvent prévoit une branche _ (énumération #[non_exhaustive]).
  • Les messages SSDP illisibles sont ignorés (journal trace!) : jamais d'erreur ni de panique côté réseau.
  • Jamais de block_on ni d'attente de verrou longue côté appelant dans un contexte asynchrone : add_device et remove_device sont synchrones mais courts (aucune pause).

Adresse locale

Serveur. Il émet sur chaque interface IPv4 active hors boucle locale. La LOCATION d'un appareil dont l'hôte est une adresse IPv4 prend, pour chaque NOTIFY, l'adresse de la machine sur le réseau concerné ; la réponse à un M-SEARCH prend l'adresse que la machine emploie pour joindre le demandeur (pmoutils::ip_utils::local_ip_towards). SsdpDevice::with_fixed_location garde la LOCATION donnée (adresse ou nom imposés). Sans interface utilisable (hors ligne), l'interface multicast par défaut est utilisée.

Client. Pour choisir l'interface multicast de sortie, il appelle pmoutils::guess_local_ip(). Si elle échoue (aucune route, machine hors ligne), il continue avec l'interface multicast par défaut et le signale par un avertissement (tracing::warn!).

Dépendances

  • pmoutils (registre pmo) : guess_local_ip, ip_utils::local_ip_towards (à partir de la version de pmoutils qui la publie : remonter l'exigence de Cargo.toml en conséquence). En développement conjoint, un patch local (.cargo/config.toml, généré par make) la résout vers pmo/pmoutils ; en cas de montée de version mineure de pmoutils, remonter l'exigence dans Cargo.toml.
  • socket2 : options de socket (SO_REUSEADDR, SO_REUSEPORT, interface multicast).
  • if-addrs : interfaces à rejoindre en multicast. tracing.

Développement

make help        # commandes (kit crate-kit)
make ci          # fmt-check + clippy + tests + doc
make jjrelease   # release : pousse et tague (workflow Gitea ensuite)

Les tests unitaires couvrent les parseurs purs (en-têtes, max-age, NOTIFY / réponses / M-SEARCH, ST), SsdpDevice et les utilitaires. tests/multicast.rs joue le serveur, le client et un émetteur brut sur le réseau réel (port 1900) ; un sondage préalable ignore les scénarios quand le multicast est inutilisable (PMOSSDP_MULTICAST_REQUIS=1 force l'échec). Ces tests partagent le port : ils s'exécutent l'un après l'autre (verrou de série).

Plateformes : Unix et Windows (SO_REUSEPORT positionné sous Unix par socket2).

Licence

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

Dependencies

ID Version
if-addrs ^0.15
pmoutils ^0.2
socket2 ^0.6
tracing ^0.1

Keywords

ssdp upnp discovery network multicast
Details
Cargo
2026-11-14 05:20:44 +01:00
4
CECILL-2.1
749 KiB
Assets (1)
Versions (7) View all
0.2.4 2026-11-14
0.2.3 2026-11-12
0.2.2 2026-11-12
0.2.1 2026-11-08
0.2.0 2026-11-08