sdk/fidl/fuchsia.net.mdns/service_subscriber.fidl

// Copyright 2022 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

library fuchsia.net.mdns;

/// Discoverable protocol for finding service instances.
// TODO(dalesat): rename `ServiceSubscriber`.
@available(added=9)
@discoverable
closed protocol ServiceSubscriber2 {
    /// Subscribes to a service. The subscription lasts until `subscriber` is unbound.
    ///
    /// + request `service` name of the type of service to which to subscribe. For example, cast
    ///   uses '_googlecast._tcp.'. If this value is not a valid service name, `subscriber` is
    ///   closed immediately and an error message is logged.
    /// + request `options` options to be applied to the subscription.
    /// + request `listener` client end of the `ServiceSubscriptionListener` channel.
    strict SubscribeToService(resource struct {
        service service_name;
        options ServiceSubscriptionOptions;
        listener client_end:ServiceSubscriptionListener;
    });

    /// Subscribes to all services. The subscription lasts until `subscriber` is unbound.
    ///
    /// + request `options` options to be applied to the subscription.
    /// + request `listener` client end of the `ServiceSubscriptionListener` channel.
    @available(added=9)
    strict SubscribeToAllServices(resource struct {
        options ServiceSubscriptionOptions;
        listener client_end:ServiceSubscriptionListener;
    });
};

/// Options for `ServiceSubscriber.SubscribeToService`.
@available(added=9)
type ServiceSubscriptionOptions = table {
    /// The media (wired, wireless, both) of the interfaces on which the service should be
    /// susbsribed. The default is both wired and wireless media.
    1: media Media;

    /// The IP versions (V4, V6, both) with which the service should subscribed. The default value
    /// is both IPv4 and IPv6.
    2: ip_versions IpVersions;

    // Whether the subscription excludes services published locally. The default value is false.
    3: exclude_local bool;

    // Whether the subscription excludes services published via local proxies. The default value
    // is false.
    4: exclude_local_proxies bool;
};

/// Client-implemented interface for subscribers. Method replies are used to
/// throttle traffic. The service won't necessarily wait for a reply before
/// calling another method.
@available(added=9)
closed protocol ServiceSubscriptionListener {
    /// Notifies the subscriber that a service instance has been discovered.
    strict OnInstanceDiscovered(struct {
        instance ServiceInstance;
    }) -> ();

    /// Notifies the subscriber that addresses or text for a known service
    /// instance have changed.
    strict OnInstanceChanged(struct {
        instance ServiceInstance;
    }) -> ();

    /// Notifies the subscriber that a known service instance has been lost.
    strict OnInstanceLost(struct {
        service service_name;
        instance instance_name;
    }) -> ();

    /// Notifies the subscriber that a PTR query has been sent.
    strict OnQuery(struct {
        resource_type ResourceType;
    }) -> ();
};

/// DNS resource types.
type ResourceType = strict enum {
    /// Domain name pointer.
    PTR = 12;

    /// Any (wildcard) type.
    ANY = 255;
};