klocalsocket.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 KLOCALSOCKET_H
#define KLOCALSOCKET_H

#include <kdecore_export.h>
#include <QtCore/QString>
#include <QtNetwork/QTcpSocket>
#include <QtNetwork/QTcpServer>

class KLocalSocketPrivate;
class KDECORE_EXPORT KLocalSocket : public QTcpSocket
{
    Q_OBJECT
public:
    enum LocalSocketType {
        UnixSocket,             
        AbstractUnixSocket,     
        UnknownLocalSocketType = -1
    };

    explicit KLocalSocket(QObject *parent = 0);
    virtual ~KLocalSocket();

    void connectToPath(const QString &path, OpenMode mode = ReadWrite);
    void connectToPath(const QString &path, LocalSocketType type, OpenMode mode = ReadWrite);
    void disconnectFromPath();

    LocalSocketType localSocketType() const;

    QString localPath() const;
    QString peerPath() const;

private:
    using QAbstractSocket::connectToHost;
    using QAbstractSocket::disconnectFromHost;

protected Q_SLOTS:
    void connectToHostImplementation(const QString &hostName, quint16 port, OpenMode mode);
    void disconnectFromHostImplementation();

private:
    Q_DISABLE_COPY(KLocalSocket)
    friend class KLocalSocketPrivate;
    KLocalSocketPrivate * const d;
};

class KLocalSocketServerPrivate;
class KDECORE_EXPORT KLocalSocketServer : public QObject
{
    Q_OBJECT
public:
    explicit KLocalSocketServer(QObject *parent = 0);
    virtual ~KLocalSocketServer();

    bool listen(const QString &path, KLocalSocket::LocalSocketType type = KLocalSocket::UnixSocket);

    void close();

    bool isListening() const;

    void setMaxPendingConnections(int numConnections);
    int maxPendingConnections() const;

    KLocalSocket::LocalSocketType localSocketType() const;
    QString localPath() const;

    bool waitForNewConnection(int msec = 0, bool *timedOut = 0);

    virtual bool hasPendingConnections() const;
    virtual KLocalSocket *nextPendingConnection();

    QAbstractSocket::SocketError serverError() const;
    QString errorString() const;

protected:
    virtual void incomingConnection(int handle);

Q_SIGNALS:
    void newConnection();

private:
    Q_PRIVATE_SLOT(d, void _k_newConnectionActivity())
    Q_DISABLE_COPY(KLocalSocketServer)
    friend class KLocalSocketServerPrivate;
    KLocalSocketServerPrivate * const d;
};

#endif