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 <string>
#include <vector>

#include "libupnpp/upnppexports.hxx"

namespace UPnPProvider {

class UpnpDevice;

class UPNPP_API UpnpService {
public:
    UpnpService(const std::string& stp,const std::string& sid,
                const std::string& xmlfn, UpnpDevice *dev, bool noevents=false);

    virtual ~UpnpService();

    virtual bool getEventData(bool all, std::vector<std::string>& names,
                              std::vector<std::string>& values);

    UpnpDevice *getDevice();
    virtual const std::string& getServiceType() const;
    virtual const std::string& getServiceId() const;
    virtual const std::string& getXMLFn() const;

    bool noevents() const;

    virtual const std::string errString(int error) const;

    virtual const std::string serviceErrString(int) const {
        return "";
    }

    // Common (service-type-independant) error codes
    enum UPnPError {
        UPNP_INVALID_ACTION = 401,
        UPNP_INVALID_ARGS = 402,
        UPNP_INVALID_VAR = 404,
        // This one mine...
        UPNP_ACTION_CONFLICT = 409,
        UPNP_ACTION_FAILED = 501,

        /* 600-699 common action errors */
        UPNP_ARG_VALUE_INVALID = 600,
        UPNP_ARG_VALUE_OUT_OF_RANGE = 601,
        UPNP_OPTIONAL_ACTION_NOT_IMPLEMENTED = 602,
        UPNP_OUT_OF_MEMORY = 603,
        UPNP_HUMAN_INTERVENTION_REQUIRED = 604,
        UPNP_STRING_ARGUMENT_TOO_LONG = 605,
        UPNP_ACTION_NOT_AUTHORIZED = 606,
        UPNP_SIGNATURE_FAILING = 607,
        UPNP_SIGNATURE_MISSING = 608,
        UPNP_NOT_ENCRYPTED = 609,
        UPNP_INVALID_SEQUENCE = 610,
        UPNP_INVALID_CONTROL_URLS = 611,
        UPNP_NO_SUCH_SESSION = 612,
    };

    
private:
    class UPNPP_LOCAL Internal;
    Internal *m;
};

} // End namespace UPnPProvider


#endif /* _SERVICE_H_X_INCLUDED_ */