KviIrcConnectionTarget.h

Go to the documentation of this file.

#ifndef _KVI_IRCCONNECTIONTARGET_H_
#define _KVI_IRCCONNECTIONTARGET_H_
//=============================================================================
//
//   File : KviIrcConnectionTarget.h
//   Creation date : Tue 08 Jun 2004 14:11:59 by Szymon Stefanek
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 2004-2010 Szymon Stefanek <pragma at kvirc dot net>
//
//   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.
//
//=============================================================================

#include "kvi_settings.h"
#include "KviQString.h"
#include "KviHeapObject.h"

class KviIrcNetwork;
class KviIrcServer;
class KviProxy;

class KVIRC_API KviIrcConnectionTarget : public KviHeapObject
{
        friend class KviIrcConnectionTargetResolver;

public:
        // pServer is a shallow pointer: this class makes a copy of it internally, must NOT be null
        // pProxy may be null if a proxy is not desired. this class makes a copy of it internally
        KviIrcConnectionTarget(
            const KviIrcNetwork * pNetwork,
            const KviIrcServer * pServer,
            const KviProxy * pProxy = 0,
            const QString & szBindAddress = QString());
        ~KviIrcConnectionTarget();

private:
        KviIrcNetwork * m_pNetwork; // owned, never null, it's a COPY of the entry in the db
        KviIrcServer * m_pServer;   // owned, never null, it's a COPY of the entry in the db
        KviProxy * m_pProxy;        // owned, may be null, it's a COPY of the entry in the db
        QString m_szBindAddress;    // forced bind address

public:
        KviIrcServer * server()
        {
                return m_pServer;
        }

        KviIrcNetwork * network()
        {
                return m_pNetwork;
        }

        KviProxy * proxy()
        {
                return m_pProxy;
        }

        const QString & bindAddress()
        {
                return m_szBindAddress;
        }

        bool hasBindAddress()
        {
                return (!m_szBindAddress.isEmpty());
        }

protected:
        // this is for KviIrcConnectionTargetResolver only
        void clearProxy();
        void setBindAddress(const QString & szBindAddress)
        {
                m_szBindAddress = szBindAddress;
        }
};

#endif