upnpplib.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 _LIBUPNP_H_X_INCLUDED_
#define _LIBUPNP_H_X_INCLUDED_
 
#include <map>
#include <string>
 
#include "upnppexports.hxx"
 
#define LIBUPNPP_VERSION_MAJOR 1
#define LIBUPNPP_VERSION_MINOR 0
#define LIBUPNPP_VERSION_REVISION 3
#define LIBUPNPP_AT_LEAST(A,B,C)                                        \
    (LIBUPNPP_VERSION_MAJOR > (A) ||                                    \
     (LIBUPNPP_VERSION_MAJOR == (A) &&                                  \
      (LIBUPNPP_VERSION_MINOR > (B) ||                                  \
       (LIBUPNPP_VERSION_MINOR == (B) && LIBUPNPP_VERSION_REVISION >= (C)))))
 
// Let clients avoid including upnp.h if they don't need it for other reasons
#ifndef UPNP_E_SUCCESS
#define UPNP_E_SUCCESS  0
#endif
 
// Feature test defines to help client programs, esp. for features
// added without breaking api and avi
 
// upnp/av connection manager control api 
#define LIBUPNPP_HAS_UPNPAVCONMAN 1
 
namespace UPnPP {
 
class UPNPP_API LibUPnP {
public:
    ~LibUPnP();
 
    LibUPnP(const LibUPnP&) = delete;
    LibUPnP& operator=(const LibUPnP&) = delete;
 
    enum InitFlags {
        UPNPPINIT_FLAG_NONE = 0,
        UPNPPINIT_FLAG_NOIPV6 = 0x1,
        UPNPPINIT_FLAG_SERVERONLY = 0x2,
        UPNPPINIT_FLAG_RESANITIZE_URLS = 0x4,
    };
 
    enum InitOption {
        UPNPPINIT_OPTION_END = 0,
        UPNPPINIT_OPTION_IFNAMES,
        UPNPPINIT_OPTION_IPV4,
        UPNPPINIT_OPTION_PORT,
        UPNPPINIT_OPTION_SUBSCRIPTION_TIMEOUT,
        UPNPPINIT_OPTION_CLIENT_PRODUCT,
        UPNPPINIT_OPTION_CLIENT_VERSION,
        UPNPPINIT_OPTION_SUBSOPS_TIMEOUTMS,
        UPNPPINIT_OPTION_RESANITIZED_CHARS,
        UPNPPINIT_OPTION_BOOTID,
    };
 
    static bool init(unsigned int flags, ...);
 
    static LibUPnP* getLibUPnP(bool serveronly = false, std::string* hwaddr = 0,
                               const std::string ifname = std::string(),
                               const std::string ip = std::string(),
                               unsigned short port = 0);
 
    std::string host();
    std::string port();
    std::string hwaddr();
 
    bool setWebServerDocumentRoot(const std::string& rootpath);
    
    void setMaxContentLength(int bytes);
 
    bool ok() const;
 
    static std::string versionString();
 
    enum LogLevel {LogLevelNone, LogLevelError, LogLevelInfo, LogLevelDebug, LogLevelAll};
 
    static bool setLogFileName(const std::string& fn, LogLevel level = LogLevelError);
 
    static bool setLogLevel(LogLevel level);
 
    static int getInitError();
 
    static std::string makeDevUUID(const std::string& name, const std::string& hw);
 
    static std::string errAsString(const std::string& who, int code);
 
    class UPNPP_LOCAL Internal;
    Internal *m;
 
private:
    LibUPnP();
};
 
} // namespace UPnPP
 
#endif /* _LIBUPNP.H_X_INCLUDED_ */