4 client
crate-kit edited this page 2026-11-12 00:36:01 +00:00

pmossdp > client

Module: client

Contents

Structs

Enums


pmossdp::client::SsdpClient

Struct

Client SSDP : envoie des M-SEARCH et décode les messages reçus en SsdpEvent.

C'est un point de contrôle UPnP.

Fonctionnement

Le client utilise deux sockets :

  • un socket sur un port UDP éphémère, qui envoie les M-SEARCH et reçoit leurs réponses (unicast, renvoyées au port d'envoi) ;
  • un socket d'écoute du port 1900, qui a rejoint le groupe multicast sur chaque interface IPv4 non bouclée et reçoit les annonces NOTIFY (SsdpEvent::Alive et SsdpEvent::ByeBye). Il est ouvert avec SO_REUSEADDR / SO_REUSEPORT, donc il cohabite avec un SsdpServer du même processus et avec les autres applications UPnP de la machine : chacune reçoit sa copie des datagrammes multicast. Les réponses unicast, elles, ne passent jamais par ce socket (elles seraient réparties entre les sockets liés au même port, d'où le port éphémère pour les recherches).

Le client est Clone : les copies partagent les mêmes sockets (une pour envoyer, une pour recevoir dans run_event_loop, par exemple).

Exemple

use pmossdp::{SsdpClient, SsdpEvent};

# fn main() -> std::io::Result<()> {
let client = SsdpClient::new()?;
let ecoute = client.clone();
std::thread::spawn(move || {
    ecoute.run_event_loop(|event| match event {
        SsdpEvent::SearchResponse { location, .. } => println!("trouvé : {location}"),
        SsdpEvent::Alive { usn, .. } => println!("arrivée : {usn}"),
        SsdpEvent::ByeBye { usn, .. } => println!("départ : {usn}"),
        _ => {}
    })
});
client.send_msearch("ssdp:all", 3)?;
# Ok(())
# }

Limites

  • Une seule boucle d'événements par client (et ses copies) : deux appels à run_event_loop se partageraient les datagrammes.
  • Mode sans écoute. Si le port 1900 ne peut pas être ouvert (programme qui le monopolise), new le signale par un warn! et le client ne reçoit plus que les réponses aux M-SEARCH : pas d'événement Alive ni ByeBye.
  • Groupes rejoints à la création. Les groupes multicast de l'écoute sont rejoints sur les interfaces présentes à l'appel de new ; une interface apparue ensuite n'est pas écoutée. En revanche l'interface de sortie des M-SEARCH est recalculée à chaque envoi ; c'est une seule interface (la principale), donc un appareil qui ne s'annonce pas lui-même sur les autres réseaux n'y est pas cherché.
  • IPv4 seulement.

Methods:

  • fn new() -> std::io::Result<Self> - Crée un client SSDP : socket de recherche sur un port éphémère (multicast sortant sur
  • fn send_msearch(self: &Self, st: &str, mx: u32) -> std::io::Result<()> - Envoie un M-SEARCH en multicast vers 239.255.255.250:1900.
  • fn stop(self: &Self) - Demande l'arrêt de run_event_loop pour ce client et toutes ses
  • fn run_event_loop<F>(self: &Self, on_event: F) - Reçoit les messages SSDP et appelle on_event pour chacun, jusqu'à l'appel de

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> Self

pmossdp::client::SsdpEvent

Enum

Message SSDP reçu par un SsdpClient, déjà décodé.

Les noms d'en-têtes sont insensibles à la casse à la réception. Un message dont un en-tête obligatoire manque est ignoré (il ne produit aucun événement, seulement une trace trace!).

L'énumération est #[non_exhaustive] : la spécification UPnP prévoit d'autres messages (ssdp:update), donc un match doit prévoir une branche _.

Variants:

  • Alive{ usn: String, nt: String, location: String, server: String, max_age: u32, from: std::net::SocketAddr } - Annonce NOTIFY avec NTS: ssdp:alive : un appareil ou un service est présent.
  • ByeBye{ usn: String, nt: String, from: std::net::SocketAddr } - Annonce NOTIFY avec NTS: ssdp:byebye : l'appareil ou le service s'en va.
  • SearchResponse{ usn: String, st: String, location: String, server: String, max_age: u32, from: std::net::SocketAddr } - Réponse (HTTP/1.1 200 OK, en unicast) à un M-SEARCH envoyé par ce client.

Traits: Eq

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> Self
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
  • PartialEq
    • fn eq(self: &Self, other: &Self) -> bool