WanConnectionService.h

Go to the documentation of this file.

//=============================================================================
//
//   File : WanConnectionService.h
//   Creation date : Fri Aug 08 18:00:00 2008 GMT by Fabio Bas
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 2008 Fabio Bas (ctrlaltca at gmail dot com)
//
//   This program 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; either version 2
//   of the License, or (at your option) any later version.
//
//   This program 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 program. If not, write to the Free Software Foundation,
//   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
//   Original Copyright follows:
//=============================================================================

/***************************************************************************
                          WanConnectionService.h -  description
                             -------------------
    begin                : Mon Jul 25 2005
    copyright            : (C) 2005 by Diederik van der Boor
    email                : vdboor --at-- codingdomain.com
 ***************************************************************************/

#ifndef UPNP_WANCONNECTIONSERVICE_H
#define UPNP_WANCONNECTIONSERVICE_H

#include "Service.h"
#include "KviPointerList.h"

namespace UPnP
{

        struct PortMapping
        {
                QString protocol;
                QString remoteHost;
                int externalPort;
                QString internalClient;
                int internalPort;
                int leaseDuration;
                QString description;
                bool enabled;
        };

        class WanConnectionService : public Service
        {
        public: // public methods
                // The constructor
                WanConnectionService(const ServiceParameters & params);
                // The destructor
                virtual ~WanConnectionService();

                // Add a port mapping
                void addPortMapping(const QString & protocol, const QString & remoteHost, int externalPort,
                    const QString & internalClient, int internalPort, const QString & description,
                    bool enabled = true, int leaseDuration = 0);
                // Delete a port mapping
                void deletePortMapping(const QString & protocol, const QString & remoteHost, int externalPort);

                // Return the external IP address
                QString getExternalIpAddress() const;
                // Return true if NAT is enabled
                bool getNatEnabled() const;
                // Return the port mappings
                const KviPointerList<PortMapping> & getPortMappings() const;

                // Query for the external IP address
                void queryExternalIpAddress();
                // Query for the Nat status
                void queryNatEnabled();
                // Query for a port mapping entry
                void queryPortMappingEntry(int index);

        protected: // protected methods
                // The control point received a response to callAction()
                virtual void gotActionResponse(const QString & responseType, const QMap<QString, QString> & resultValues);

        private: // private attributes
                // The external IP address
                QString m_szExternalIpAddress;
                // True if NAT is enabled
                bool m_bNatEnabled;
                // The current port mappings
                KviPointerList<PortMapping> m_lPortMappings;
        };
}

#endif