Search.h

Go to the documentation of this file.

/****
 * Search.h
 *
 * Copyright 2019 mikee47 <mike@sillyhouse.net>
 * Copyright 2020 slaff <slaff@attachix.com>
 *
 * This file is part of the Sming UPnP Library
 *
 * This library is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, version 3 or later.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this library.
 * If not, see <https://www.gnu.org/licenses/>.
 *
 ****/

#pragma once

#include "DeviceControl.h"
#include "ServiceControl.h"

namespace UPnP
{
struct Search {
    enum class Kind {
        none,   
        ssdp,   
        desc,   
        device,  
        service, 
    };

    Search() = default;

    Search(const Search&) = delete;

    Search(Kind kind, const String& urn) : kind(kind), urn(urn)
    {
    }

    Search(Kind kind, const Urn& urn) : Search(kind, String(urn))
    {
    }

    virtual ~Search()
    {
    }

    virtual explicit operator bool() const = 0;

    String toString(Search::Kind kind) const
    {
        switch(kind) {
        case Kind::ssdp:
            return F("SSDP");
        case Kind::desc:
            return F("Description");
        case Kind::device:
            return F("Device");
        case Kind::service:
            return F("Service");
        default:
            assert(false);
            return nullptr;
        }
    }

    String toString() const
    {
        String s = toString(kind);
        s += " {";
        s += urn;
        s += '}';
        return s;
    }

    Kind kind;
    String urn;
};

struct SsdpSearch : public Search {
    using Callback = Delegate<void(SSDP::BasicMessage& message)>;

    SsdpSearch(const Urn& urn, Callback callback) : Search(Kind::ssdp, urn), callback(callback)
    {
    }

    explicit operator bool() const override
    {
        return bool(callback);
    }

    Callback callback;
};

struct DescriptionSearch : public Search {
    using Callback = Delegate<void(HttpConnection& connection, XML::Document* description)>;

    DescriptionSearch(const Urn& urn, Callback callback) : Search(Kind::desc, urn), callback(callback)
    {
    }

    explicit operator bool() const override
    {
        return bool(callback);
    }

    Callback callback;
};

struct DeviceSearch : public Search {
    using Callback = Delegate<bool(DeviceControl& device)>;

    DeviceSearch(const ObjectClass& cls, Callback callback)
        : Search(Kind::device, cls.objectType()), cls(cls), callback(callback)
    {
    }

    explicit operator bool() const override
    {
        return bool(callback);
    }

    const ObjectClass& cls;
    Callback callback;
};

struct ServiceSearch : public Search {
    using Callback = Delegate<bool(DeviceControl& device, ServiceControl& service)>;

    ServiceSearch(const ObjectClass& cls, Callback callback)
        : Search(Kind::service, cls.objectType()), cls(cls), callback(callback)
    {
    }

    explicit operator bool() const override
    {
        return bool(callback);
    }

    const ObjectClass& cls;
    Callback callback;
};

} // namespace UPnP