service.hxx

/* Copyright (C) 2006-2016 J.F.Dockes
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 *   02110-1301 USA
 */
#ifndef _SERVICE_H_X_INCLUDED_
#define _SERVICE_H_X_INCLUDED_
 
#include <sys/types.h>
 
#include <functional>
#include <iostream>
#include <string>
 
#include "libupnpp/upnppexports.hxx"
#include "libupnpp/log.hxx"
#include "libupnpp/soaphelp.hxx"
#include "libupnpp/upnperrcodes.hxx"
#include "libupnpp/control/cdircontent.hxx"
 
namespace UPnPClient {
 
class UPnPDeviceDesc;
class UPnPServiceDesc;
class Service;
 
class UPNPP_API VarEventReporter {
public:
    virtual ~VarEventReporter() = default;
    virtual void changed(const char *nm, int val)  = 0;
    virtual void changed(const char *nm, const char *val) = 0;
    virtual void changed(const char * /*nm*/, UPnPDirObject /*meta*/) {}
    virtual void changed(const char * /*nm*/, std::vector<int> /*ids*/) {}
    virtual void autorenew_failed() {}
};
 
typedef
std::function<void (const std::unordered_map<std::string, std::string>&)>
evtCBFunc;
 
enum ActionOptionsMask {AOM_TIMEOUTMS = 0x1};
struct ActionOptions {
    uint32_t active_options{0};
    int timeoutms{-1};
};
 
class UPNPP_API Service {
public:
    Service(const UPnPDeviceDesc& device, const UPnPServiceDesc& service);
    
    Service();
 
    virtual ~Service();
 
    // Can't copy these because this does not make sense for the
    // member function callback.
    Service(const Service&) = delete;
    Service& operator=(const Service&) = delete;
 
    bool initFromDescription(const UPnPDeviceDesc& description);
 
    bool ok();
    
    virtual bool reSubscribe();
 
    const std::string& getFriendlyName() const;
    const std::string& getDeviceId() const;
    const std::string& getServiceType() const;
    const std::string& getActionURL() const;
    const std::string& getModelName() const;
    const std::string& getManufacturer() const;
 
    virtual int runAction(const UPnPP::SoapOutgoing& args,
                          UPnPP::SoapIncoming& data, ActionOptions *opts=nullptr);
 
    int runTrivialAction(const std::string& actionName, ActionOptions *opts=nullptr);
 
    template <class T> int runSimpleGet(const std::string& actnm,
                                        const std::string& valnm,
                                        T *valuep, ActionOptions *opts=nullptr);
 
    template <class T> int runSimpleAction(const std::string& actnm,
                                           const std::string& valnm,
                                           T value, ActionOptions *opts=nullptr);
 
    virtual VarEventReporter *getReporter();
 
    virtual void installReporter(VarEventReporter* reporter);
 
    virtual bool serviceTypeMatch(const std::string& tp) = 0;
    
protected:
 
    virtual bool serviceInit(const UPnPDeviceDesc&, const UPnPServiceDesc&) {
        return true;
    }
 
    bool registerCallback(evtCBFunc c);
 
    virtual void registerCallback() {}
 
    void unregisterCallback();
 
private:
    class UPNPP_LOCAL Internal;
    Internal *m{nullptr};
};
 
} // namespace UPnPClient
 
#endif /* _SERVICE_H_X_INCLUDED_ */