tqdbusconnection.h

Go to the documentation of this file.

/* qdbusconnection.h TQT_DBusConnection object
 *
 * Copyright (C) 2005 Harald Fernengel <harry@kdevelop.org>
 * Copyright (C) 2005-2007 Kevin Krammer <kevin.krammer@gmx.at>
 *
 * Licensed under the Academic Free License version 2.1
 *
 * 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.
 *
 */

#ifndef TQDBUSCONNECTION_H
#define TQDBUSCONNECTION_H

#include "tqdbusmacros.h"
#include <tqstring.h>

class TQT_DBusConnectionPrivate;
class TQT_DBusError;
class TQT_DBusMessage;
class TQT_DBusObjectBase;
class TQObject;

class TQDBUS_EXPORT TQT_DBusConnection
{
public:
    enum BusType
    {
        SessionBus,

        SystemBus,

        // TODO find out about ActivationBus purpose
        ActivationBus
    };

    TQT_DBusConnection();

    TQT_DBusConnection(const TQString &name);

    TQT_DBusConnection(const TQT_DBusConnection &other);

    ~TQT_DBusConnection();

    TQT_DBusConnection &operator=(const TQT_DBusConnection &other);

    bool isConnected() const;

    TQT_DBusError lastError() const;

    enum NameRequestMode
    {
        NoReplace = 0,

        AllowReplace = 1,

        ReplaceExisting = 2
    };

    bool requestName(const TQString &name, int modeFlags = NoReplace);

    TQString uniqueName() const;

    bool send(const TQT_DBusMessage &message) const;

    TQT_DBusMessage sendWithReply(const TQT_DBusMessage &message, TQT_DBusError *error = 0) const;

    int sendWithAsyncReply(const TQT_DBusMessage &message, TQObject *receiver,
                           const char *slot) const;

    void flush() const;

    void dispatch() const;

    void scheduleDispatch() const;

    bool connect(TQObject* object, const char* slot);

    bool disconnect(TQObject* object, const char* slot);

    bool registerObject(const TQString& path, TQT_DBusObjectBase* object);

    void unregisterObject(const TQString &path);

    static TQT_DBusConnection sessionBus();

    static TQT_DBusConnection systemBus();

    static TQT_DBusConnection addConnection(BusType type,
                                         const TQString &name = default_connection_name);

    static TQT_DBusConnection addConnection(const TQString &address,
                                         const TQString &name = default_connection_name);

    // TODO check why this doesn't close the D-Bus connection
    static void closeConnection(const TQString &name = default_connection_name);

    QT_STATIC_CONST char *default_connection_name;

private:
    TQT_DBusConnectionPrivate *d;
};

#endif