SSDP/src/include/Network/SSDP/Server.h

Go to the documentation of this file.

/****
 * Server.h
 *
 * Copyright 2019 mikee47 <mike@sillyhouse.net>
 *
 * This file is part of the Sming SSDP 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 <Network/UdpConnection.h>
#include "MessageQueue.h"
#include <Data/CString.h>
 
#define UPNP_VERSION_IS(ver) (F(MACROQUOTE(ver)) == MACROQUOTE(UPNP_VERSION))
 
namespace SSDP
{
DECLARE_FSTR(BASE_SERVER_ID)
DECLARE_FSTR(defaultProductNameAndVersion);
 
String getServerId(const String& productNameAndVersion);
 
using ReceiveDelegate = Delegate<void(BasicMessage& message)>;
 
using SendDelegate = Delegate<void(Message& msg, MessageSpec& ms)>;
 
class Server : private UdpConnection
{
public:
    static constexpr uint8_t multicastTtl{2};
 
    Server() : messageQueue(MessageDelegate(&Server::onMessage, this))
    {
    }
 
    bool begin(ReceiveDelegate receiveCallback, SendDelegate sendCallback);
 
    void end();
 
    bool isActive()
    {
        return active;
    }
 
    bool sendMessage(const Message& msg);
 
    bool buildMessage(Message& msg, MessageSpec& ms);
 
    void setProduct(const String& name, const String& version)
    {
        String s;
        s += name;
        s += '/';
        s += version;
        productNameAndVersion = s;
    }
 
public:
    MessageQueue messageQueue;
 
protected:
    void onReceive(pbuf* buf, IpAddress remoteIP, uint16_t remotePort) override;
 
private:
    /*
     * Need a separate UDP connection for sending requests
     */
    class UdpOut : public UdpConnection
    {
    protected:
        void onReceive(pbuf* buf, IpAddress remoteIP, uint16_t remotePort) override;
    };
 
    void onTimer();
    void onMessage(MessageSpec* ms);
 
    ReceiveDelegate receiveDelegate{nullptr};
    SendDelegate sendDelegate{nullptr};
    UdpOut out;
    bool active{false};
    CString productNameAndVersion;
};
 
extern Server server;
 
} // namespace SSDP