ksocketfactory.h

Go to the documentation of this file.

/*
 * This file is part of the KDE libraries
 * Copyright (C) 2007 Thiago Macieira <thiago@kde.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef KSOCKETFACTORY_H
#define KSOCKETFACTORY_H

#include <kdecore_export.h>
#include <QtCore/QString>
#include <QtNetwork/QNetworkProxy>
#include <QtNetwork/QHostAddress>

class QTcpSocket;
class QTcpServer;
class QUdpSocket;
class QUrl;

namespace KSocketFactory
{
    KDECORE_EXPORT QTcpSocket *connectToHost(const QString &protocol, const QString &host,
                                             quint16 port, QObject *parent = 0);

    KDECORE_EXPORT QTcpSocket *connectToHost(const QUrl &url, QObject *parent = 0);

    KDECORE_EXPORT void connectToHost(QTcpSocket *socket, const QString &protocol,
                                      const QString &host, quint16 port);

    KDECORE_EXPORT void connectToHost(QTcpSocket *socket, const QUrl &url);

    KDECORE_EXPORT QTcpSocket *synchronousConnectToHost(const QString &protocol,
                                                        const QString &host,
                                                        quint16 port, int msecs = 30000,
                                                        QObject *parent = 0);

    KDECORE_EXPORT QTcpSocket *synchronousConnectToHost(const QUrl &url, int msecs = 30000,
                                                        QObject *parent = 0);

    KDECORE_EXPORT void synchronousConnectToHost(QTcpSocket *socket, const QString &protocol,
                                                 const QString &host, quint16 port,
                                                 int msecs = 30000);

    KDECORE_EXPORT void synchronousConnectToHost(QTcpSocket *socket, const QUrl &url,
                                                 int msecs = 30000);

    KDECORE_EXPORT QTcpServer *listen(const QString &protocol, const QHostAddress &address = QHostAddress::Any,
                                      quint16 port = 0, QObject *parent = 0);

    // These functions below aren't done yet
    // Undocumented -> don't use!

    KDECORE_EXPORT QUdpSocket *datagramSocket(const QString &protocol, const QString &host, QObject *parent = 0);

#ifndef QT_NO_NETWORKPROXY
    KDECORE_EXPORT QNetworkProxy proxyForConnection(const QString &protocol, const QString &host);
    KDECORE_EXPORT QNetworkProxy proxyForListening(const QString &protocol);
    KDECORE_EXPORT QNetworkProxy proxyForDatagram(const QString &protocol, const QString &host);
#endif
}

#endif