File mDNS.h

File List > arduino > libraries > common > mDNS > mDNS.h

Go to the documentation of this file.

/*
ESP8266 Multicast DNS (port of CC3000 Multicast DNS library)
Version 1.1
Copyright (c) 2013 Tony DiCola ([email protected])
ESP8266 port (c) 2015 Ivan Grokhotkov ([email protected])
MDNS-SD Suport 2015 Hristo Gochkov ([email protected])
Extended MDNS-SD support 2016 Lars Englund ([email protected])
Rewritten for ESP32 by Hristo Gochkov ([email protected])

This is a simple implementation of multicast DNS query support for an Arduino
running on ESP32 chip.

Usage:
- Include the ESP32 Multicast DNS library in the sketch.
- Call the begin method in the sketch's setup and provide a domain name (without
  the '.local' suffix, i.e. just provide 'foo' to resolve 'foo.local'), and the
  Adafruit CC3000 class instance.  Optionally provide a time to live (in seconds)
  for the DNS record--the default is 1 hour.
- Call the update method in each iteration of the sketch's loop function.

License (MIT license):
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  THE SOFTWARE.

*/

#pragma once

#include <Arduino.h>
#include <api/IPv6Address.h>

#define MDNS_UDP 0
#define MDNS_TCP 1

class mDNS {
  private:
    bool addServiceImpl(const char *name, const char *service, uint8_t proto, uint16_t port);
    bool addServiceTxtImpl(const char *service, uint8_t proto, const char *item);
    void cleanup();

    char *instanceName = NULL;

  public:
    mDNS();
    ~mDNS();

    bool begin(const char *hostname);
    void end();

    void setInstanceName(const char *name);
    bool addService(char *service, char *proto, uint16_t port);
    bool addServiceTxt(char *service, char *proto, char *key, char *value);
    // void enableArduino(uint16_t port = 3232, bool auth = false);
    // void disableArduino();
    // void enableWorkstation(esp_interface_t interface = ESP_IF_WIFI_STA);
    // void disableWorkstation();

    IPAddress queryHost(char *host, uint32_t timeout = 2000);
    int queryService(char *service, char *proto);

    String hostname(int idx);
    IPAddress IP(int idx);
    IPv6Address IPv6(int idx);
    uint16_t port(int idx);
    int numTxt(int idx);
    bool hasTxt(int idx, const char *key);
    String txt(int idx, const char *key);
    String txt(int idx, int txtIdx);
    String txtKey(int idx, int txtIdx);

    void setInstanceName(String name) {
        setInstanceName(name.c_str());
    }

    void setInstanceName(char *name) {
        setInstanceName((const char *)name);
    }

    bool addService(const char *service, const char *proto, uint16_t port) {
        return addService((char *)service, (char *)proto, port);
    }

    bool addService(String service, String proto, uint16_t port) {
        return addService(service.c_str(), proto.c_str(), port);
    }

    void addServiceTxt(const char *service, const char *proto, const char *key, const char *value) {
        addServiceTxt((char *)service, (char *)proto, (char *)key, (char *)value);
    }

    void addServiceTxt(String service, String proto, String key, String value) {
        addServiceTxt(service.c_str(), proto.c_str(), key.c_str(), value.c_str());
    }

    IPAddress queryHost(const char *host, uint32_t timeout = 2000) {
        return queryHost((char *)host, timeout);
    }

    IPAddress queryHost(String host, uint32_t timeout = 2000) {
        return queryHost(host.c_str(), timeout);
    }

    int queryService(const char *service, const char *proto) {
        return queryService((char *)service, (char *)proto);
    }

    int queryService(String service, String proto) {
        return queryService(service.c_str(), proto.c_str());
    }
};

typedef mDNS MDNSResponder;

extern MDNSResponder MDNS;