blob: fd8b3a80edc14acef141af3da9dc4c3589176749 [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtNetwork module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QNETWORKPROXY_H
#define QNETWORKPROXY_H
#include <QtNetwork/qhostaddress.h>
#include <QtCore/qshareddata.h>
#ifndef QT_NO_NETWORKPROXY
QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE
QT_MODULE(Network)
class QUrl;
class QNetworkProxyQueryPrivate;
class Q_NETWORK_EXPORT QNetworkProxyQuery
{
public:
enum QueryType {
TcpSocket,
UdpSocket,
TcpServer = 100,
UrlRequest
};
QNetworkProxyQuery();
QNetworkProxyQuery(const QUrl &requestUrl, QueryType queryType = UrlRequest);
QNetworkProxyQuery(const QString &hostname, int port, const QString &protocolTag = QString(),
QueryType queryType = TcpSocket);
QNetworkProxyQuery(quint16 bindPort, const QString &protocolTag = QString(),
QueryType queryType = TcpServer);
QNetworkProxyQuery(const QNetworkProxyQuery &other);
~QNetworkProxyQuery();
QNetworkProxyQuery &operator=(const QNetworkProxyQuery &other);
bool operator==(const QNetworkProxyQuery &other) const;
inline bool operator!=(const QNetworkProxyQuery &other) const
{ return !(*this == other); }
QueryType queryType() const;
void setQueryType(QueryType type);
int peerPort() const;
void setPeerPort(int port);
QString peerHostName() const;
void setPeerHostName(const QString &hostname);
int localPort() const;
void setLocalPort(int port);
QString protocolTag() const;
void setProtocolTag(const QString &protocolTag);
QUrl url() const;
void setUrl(const QUrl &url);
private:
QSharedDataPointer<QNetworkProxyQueryPrivate> d;
};
Q_DECLARE_TYPEINFO(QNetworkProxyQuery, Q_MOVABLE_TYPE);
class QNetworkProxyPrivate;
class Q_NETWORK_EXPORT QNetworkProxy
{
public:
enum ProxyType {
DefaultProxy,
Socks5Proxy,
NoProxy,
HttpProxy,
HttpCachingProxy,
FtpCachingProxy
};
enum Capability {
TunnelingCapability = 0x0001,
ListeningCapability = 0x0002,
UdpTunnelingCapability = 0x0004,
CachingCapability = 0x0008,
HostNameLookupCapability = 0x0010
};
Q_DECLARE_FLAGS(Capabilities, Capability)
QNetworkProxy();
QNetworkProxy(ProxyType type, const QString &hostName = QString(), quint16 port = 0,
const QString &user = QString(), const QString &password = QString());
QNetworkProxy(const QNetworkProxy &other);
QNetworkProxy &operator=(const QNetworkProxy &other);
~QNetworkProxy();
bool operator==(const QNetworkProxy &other) const;
inline bool operator!=(const QNetworkProxy &other) const
{ return !(*this == other); }
void setType(QNetworkProxy::ProxyType type);
QNetworkProxy::ProxyType type() const;
void setCapabilities(Capabilities capab);
Capabilities capabilities() const;
bool isCachingProxy() const;
bool isTransparentProxy() const;
void setUser(const QString &userName);
QString user() const;
void setPassword(const QString &password);
QString password() const;
void setHostName(const QString &hostName);
QString hostName() const;
void setPort(quint16 port);
quint16 port() const;
static void setApplicationProxy(const QNetworkProxy &proxy);
static QNetworkProxy applicationProxy();
private:
QSharedDataPointer<QNetworkProxyPrivate> d;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(QNetworkProxy::Capabilities)
class Q_NETWORK_EXPORT QNetworkProxyFactory
{
public:
QNetworkProxyFactory();
virtual ~QNetworkProxyFactory();
virtual QList<QNetworkProxy> queryProxy(const QNetworkProxyQuery &query = QNetworkProxyQuery()) = 0;
static void setUseSystemConfiguration(bool enable);
static void setApplicationProxyFactory(QNetworkProxyFactory *factory);
static QList<QNetworkProxy> proxyForQuery(const QNetworkProxyQuery &query);
static QList<QNetworkProxy> systemProxyForQuery(const QNetworkProxyQuery &query = QNetworkProxyQuery());
};
QT_END_NAMESPACE
QT_END_HEADER
#endif // QT_NO_NETWORKPROXY
#endif // QHOSTINFO_H