mdns_api.h

#ifndef NMOS_MDNS_API_H
#define NMOS_MDNS_API_H

#include "nmos/api_utils.h" // for web::http::experimental::listener::api_router and nmos::route_pattern
#include "nmos/slog.h" // for slog::base_gate and slog::severity, etc.

// This is an experimental extension to expose DNS Service Discovery (DNS-SD) via a REST API
// supporting unicast DNS and multicast DNS (mDNS)
namespace nmos
{
    struct base_model;

    namespace experimental
    {
        web::http::experimental::listener::api_router make_mdns_api(nmos::base_model& model, slog::base_gate& gate);

        // Patterns allow access to variable parts of the route path, both to allow common implementation
        // for similar endpoints, and to simplify consistent logging of values from URLs
        namespace patterns
        {
            // DNS-SD API
            const route_pattern mdns_api = make_route_pattern(U("api"), U("x-dns-sd"));

            // A domain name (regex could be better!)
            const nmos::route_pattern mdnsBrowseDomain = make_route_pattern(U("mdnsBrowseDomain"), U("[^_/][^/]+"));

            // A service type combines a registered service identifier (name) and the protocol, each prepended by an underscore ('_') and separated by a dot ('.')
            // For example, the IS-04 service types are "_nmos-query._tcp", "_nmos-registration._tcp" and "_nmos-node._tcp".
            // SRVNAME = *(1*DIGIT [HYPHEN]) ALPHA *([HYPHEN] ALNUM)
            // See https://tools.ietf.org/html/rfc6335#section-5.1
            // "The transport protocol(s) [...] is currently limited to one or more of TCP, UDP, SCTP, and DCCP."
            // See https://tools.ietf.org/html/rfc6335#section-8.1.1
            const nmos::route_pattern mdnsServiceType = make_route_pattern(U("mdnsServiceType"), U("_([0-9]{1,}-?)*[A-Za-z](-?[A-Za-z0-9])*\\._(tcp|udp|sctp|dccp)"));

            // A service (instance) name (regex could be better!)
            const nmos::route_pattern mdnsServiceName = make_route_pattern(U("mdnsServiceName"), U("[^/]{1,63}"));
        }
    }
}

#endif