Qregistermetatype как пользоваться qt

Qt и Q_REGISTER_METATYPE — что это такое, и как его использовать?

Для класса QAbstractSocket генерируется сигнал error с параметром QAbstractSocket::SocketError socketError. В документации написано: «QAbstractSocket::SocketError is not a registered metatype, so for queued connections, you will have to register it with Q_REGISTER_METATYPE», но про этот Q_REGISTER_METATYPE нет упоминания вообще нигде. Сталкивался-ли кто-нить с этим жЫвотным? (А я пока погуглю, мало-ли).

one_more_hokum ★★★
08.08.08 11:28:17 MSD

Пользовательские типы в Qt по D-Bus

На хабре были статьи о D-Bus в Qt (раз) и немного затронули пользовательские типы (два). Здесь будет рассмотрена реализация передачи пользовательских типов, связанные с ней особенности, обходные пути.
Статья будет иметь вид памятки, с небольшим вкраплением сниппетов, и для себя и для коллег.
_{Примечание: изучалось под Qt 4.7(Спасибо Squeeze за это. ), поэтому некоторые действия могут оказаться бесполезными.}

Введение

Стандартные типы, для передачи которых не требуется лишних телодвижений есть в доке. Также реализована возможность передавать по D-Bus тип QVariant (QDBusVariant). Это позволяет передавать те типы, которые QVariant может принимать в конструкторе — от QRect до QVariantList и QVariantMap (двумерные массивы не работают как положено). Есть соблазн передавать свои типы преобразовывая их в QVariant. Лично я рекомендовал бы отказаться от такого способа, поскольку принимающая сторона не сможет различить несколько различных типов — все они будут для неё QVariant. На мой взгляд это может потенциально привести к ошибкам и усложнит поддержку.

Готовим свои типы

Для начала опишем типы, которые будут использоваться в приложениях.
Первый тип будет Money

struct Money < int summ; QString type; Money() : summ(0) , type() <>>; 

Для начала его надо задекларировать в системе типов:

Перед началом передачи типа, необходимо вызвать функции для регистрации типа
(«Money»);
qDBusRegisterMetaType();>
Для возможности его передачи по D-Bus типу необходимо добавит методы его разбора и сбора на стандартные типы (marshalling & demarshalling).

marshalling & demarshalling

friend QDBusArgument& operator <<(QDBusArgument& argument, const Money& arg) < argument.beginStructure(); argument << arg.summ; argument << arg.type; argument.endStructure(); return argument; >friend const QDBusArgument& operator >>(const QDBusArgument& argument, Money& arg) < argument.beginStructure(); argument >> arg.summ; argument >> arg.type; argument.endStructure(); return argument; > 

Чтобы не было так скучно, добавим еще несколько типов. Полностью файлы с типами выглядят так:
[types.h]

#include #include #include #include #include //Имя и путь D-Bus интерфейса для будущего сервиса namespace dbus < static QString serviceName() < return "org.student.interface"; >static QString servicePath() < return "/org/student/interface"; >> struct Money < int summ; QString type; Money() : summ(0) , type() <>friend QDBusArgument &operator<<(QDBusArgument &argument, const Money &arg); friend const QDBusArgument &operator>>(const QDBusArgument &argument, Money &arg); >; Q_DECLARE_METATYPE(Money) struct Letter < Money summ; QString text; QDateTime letterDate; Letter() : summ() , text() , letterDate() <>friend QDBusArgument &operator<<(QDBusArgument &argument, const Letter &arg); friend const QDBusArgument &operator>>(const QDBusArgument &argument, Letter &arg); >; Q_DECLARE_METATYPE(Letter) //Добавим к типам массив пользовательских писем typedef QList Stuff; Q_DECLARE_METATYPE(Stuff) struct Parcel < Stuff someFood; Letter letter; Parcel() : someFood() , letter() <>friend QDBusArgument &operator<<(QDBusArgument &argument, const Parcel &arg); friend const QDBusArgument &operator>>(const QDBusArgument &argument, Parcel &arg); >; Q_DECLARE_METATYPE(Parcel) 

[types.cpp]

#include "types.h" #include #include //Регистрация типов статической структурой static struct RegisterTypes < RegisterTypes() < qRegisterMetaType("Money"); qDBusRegisterMetaType(); qRegisterMetaType("Letter"); qDBusRegisterMetaType(); qRegisterMetaType("Stuff"); qDBusRegisterMetaType(); qRegisterMetaType("Parcel"); qDBusRegisterMetaType(); > > RegisterTypes; //------------------------ QDBusArgument& operator <<(QDBusArgument& argument, const Money& arg) < argument.beginStructure(); argument << arg.summ; argument << arg.type; argument.endStructure(); return argument; >const QDBusArgument& operator >>(const QDBusArgument& argument, Money& arg) < argument.beginStructure(); argument >> arg.summ; argument >> arg.type; argument.endStructure(); return argument; > //------------------------ QDBusArgument& operator <<(QDBusArgument& argument, const Letter& arg) < argument.beginStructure(); argument << arg.summ; argument << arg.text; argument << arg.letterDate; argument.endStructure(); return argument; >const QDBusArgument& operator >>(const QDBusArgument& argument, Letter& arg) < argument.beginStructure(); argument >> arg.summ; argument >> arg.text; argument >> arg.letterDate; argument.endStructure(); return argument; > //------------------------ QDBusArgument& operator <<(QDBusArgument& argument, const Parcel& arg) < argument.beginStructure(); argument << arg.someFood; argument << arg.letter; argument.endStructure(); return argument; >const QDBusArgument& operator >>(const QDBusArgument& argument, Parcel& arg) < argument.beginStructure(); argument >> arg.someFood; argument >> arg.letter; argument.endStructure(); return argument; > 

Отмечу, что для использования массивов можно использовать QList и для них не требуется маршаллизация и демаршаллизация, если для переменных уже есть преобразования.

Начинаем строить

Предположим есть два Qt приложения, которым нужно общаться по D-Bus. Одно приложение будет регистрироваться как сервис, а второе с этим сервисом взаимодействовать.

Я ленивый и мне лень создавать отдельный QDBus адаптер. Поэтому, для того что бы разделять внутренние методы и интерфейс D-Bus, интерфейсные методы отмечу макросом Q_SCRIPTABLE.

[student.h]

#include #include "../lib/types.h" class Student : public QObject < Q_OBJECT Q_CLASSINFO("D-Bus Interface", "org.student.interface") public: Student(QObject *parent = 0); ~Student(); signals: Q_SCRIPTABLE Q_NOREPLY void needHelp(Letter reason); void parcelRecived(QString parcelDescription); public slots: Q_SCRIPTABLE void reciveParcel(Parcel parcelFromParents); void sendLetterToParents(QString letterText); private: void registerService(); >; 

Тег Q_NOREPLY отмечает, что D-Bus не должен ждать ответа от метода.
Для регистрации сервиса с методами отмеченных Q_SCRIPTABLE используется такой код:

[Регистрация сервиса]

void Student::registerService() < QDBusConnection connection = QDBusConnection::connectToBus(QDBusConnection::SessionBus, dbus::serviceName()); if (!connection.isConnected()) qDebug()<<(QString("DBus connect false")); else qDebug()<<(QString("DBus connect is successfully")); if (!connection.registerObject(dbus::servicePath(), this, QDBusConnection::ExportScriptableContents)) < qDebug()<<(QString("DBus register object false. Error: %1").arg(connection.lastError().message())); >else qDebug() <<(QString("DBus register object successfully")); if (!connection.registerService(dbus::serviceName())) < qDebug()<<(QString("DBus register service false. Error: %1").arg(connection.lastError().message())); >else qDebug()

Полностью cpp файл выглядит так:
[student.cpp]

#include "student.h" #include #include #include Student::Student(QObject *parent) : QObject(parent) < registerService(); >Student::~Student() < >void Student::reciveParcel(Parcel parcelFromParents) < QString letterText = parcelFromParents.letter.text; letterText.append(QString("\n Money: %1 %2").arg(parcelFromParents.letter.summ.summ).arg(parcelFromParents.letter.summ.type)); Stuff sendedStuff = parcelFromParents.someFood; QString stuffText; foreach(QVariant food, sendedStuff) < stuffText.append(QString("Stuff: %1\n").arg(food.toString())); >QString parcelDescription; parcelDescription.append(letterText); parcelDescription.append("\n"); parcelDescription.append(stuffText); emit parcelRecived(parcelDescription); > void Student::sendLetterToParents(QString letterText) < Letter letterToParents; letterToParents.text = letterText; letterToParents.letterDate = QDateTime::currentDateTime(); emit needHelp(letterToParents); >void Student::registerService() < QDBusConnection connection = QDBusConnection::connectToBus(QDBusConnection::SessionBus, dbus::serviceName()); if (!connection.isConnected()) qDebug()<<(QString("DBus connect false")); else qDebug()<<(QString("DBus connect is successfully")); if (!connection.registerObject(dbus::servicePath(), this, QDBusConnection::ExportScriptableContents)) < qDebug()<<(QString("DBus register object false. Error: %1").arg(connection.lastError().message())); >else qDebug() <<(QString("DBus register object successfully")); if (!connection.registerService(dbus::serviceName())) < qDebug()<<(QString("DBus register service false. Error: %1").arg(connection.lastError().message())); >else qDebug()

Этот класс может успешно работать по D-Bus’у используя привычные конструкции.
Для вызова метода его интерфейса можно использовать QDBusConnection::send:

[Вызов D-Bus метода без ответа]

const QString studentMethod = "reciveParcel"; QDBusMessage sendParcel = QDBusMessage::createMethodCall(dbus::serviceName(), dbus::servicePath(), "", studentMethod); QList arg; arg.append(qVariantFromValue(parentsParcel)); sendParcel.setArguments(arg); if ( !QDBusConnection::sessionBus().send(sendParcel) )

Метод qVariantFromValue с помощью черной магии, void указателей и тем, что мы зарегистрировали тип, преобразует его в QVariant. Обратно его можно получить через шаблон метода QVariant::value или через qvariant_cast.

Если нужен ответ метода, то можно использовать другие методы QDBusConnection — для синхронного call и для асинхронного callWithCallback, asyncCall.

[Синхронный вызов D-Bus метода с ожиданием ответа]

const QString studentMethod = "reciveParcel"; QDBusMessage sendParcel = QDBusMessage::createMethodCall(dbus::serviceName(), dbus::servicePath(), "", studentMethod); QList arg; arg.append(qVariantFromValue(parentsParcel)); sendParcel.setArguments(arg); int timeout = 25; //Максимальное время ожидания ответа, если не указывать - 25 секунд QDBusReply reply = QDBusConnection::sessionBus().call(sendParcel, QDBus::Block, timeout); //QDBus::Block блокирует цикл событий(event loop) до получения ответа if (!reply.isValid()) < qDebug()<int returnedValue = reply.value(); 

[Асинхронный вызов D-Bus метода]

const QString studentMethod = "reciveParcel"; QDBusMessage sendParcel = QDBusMessage::createMethodCall(dbus::serviceName(), dbus::servicePath(), "", studentMethod); QList arg; arg.append(qVariantFromValue(parentsParcel)); sendParcel.setArguments(arg); int timeout = 25; //Максимальное время ожидания ответа, если не указывать - 25 секунд bool isCalled = QDBusConnection::sessionBus().callWithCallback(sendParcel, this, SLOT(standartSlot(int)), SLOT(errorHandlerSlot(const QDBusMessage&)), timeout) if (!isCalled)

Также можно воспользоваться методами класса QDBusAbstractInterface, в которых не участвует QDBusMessage.
Кстати, для отправки сигналов нет необходимости регистрировать интерфейс, их можно отправлять тем же методом send:

[Отправка сигнала]

QDBusMessage msg = QDBusMessage::createSignal(dbus::servicePath(), dbus::serviceName(), "someSignal"); msg  

#include #include "../lib/types.h" class Parents : public QObject < Q_OBJECT public: Parents(QObject *parent = 0); ~Parents(); private slots: void reciveLetter(const Letter letterFromStudent); private: void connectToDBusSignal(); void sendHelpToChild(const Letter letterFromStudent) const; void sendParcel(const Parcel parentsParcel) const; Letter writeLetter(const Letter letterFromStudent) const; Stuff poskrestiPoSusekam() const; >; 

#include "parents.h" #include #include Parents::Parents(QObject *parent) : QObject(parent) < connectToDBusSignal(); >Parents::~Parents() < >void Parents::reciveLetter(const Letter letterFromStudent) < qDebug()void Parents::connectToDBusSignal() < bool isConnected = QDBusConnection::sessionBus().connect( "", dbus::servicePath(), dbus::serviceName(), "needHelp", this, SLOT(reciveLetter(Letter))); if(!isConnected) qDebug()void Parents::sendHelpToChild(const Letter letterFromStudent) const < Parcel preparingParcel; preparingParcel.letter = writeLetter(letterFromStudent); preparingParcel.someFood = poskrestiPoSusekam(); sendParcel(preparingParcel); >void Parents::sendParcel(const Parcel parentsParcel) const < const QString studentMethod = "reciveParcel"; QDBusMessage sendParcel = QDBusMessage::createMethodCall(dbus::serviceName(), dbus::servicePath(), "", studentMethod); QListarg; arg.append(qVariantFromValue(parentsParcel)); sendParcel.setArguments(arg); if ( !QDBusConnection::sessionBus().send( sendParcel) ) < qDebug()<> Letter Parents::writeLetter(const Letter letterFromStudent) const < QString text = "We read about you problem so send some help"; Letter parentLetter; parentLetter.text = text; Money summ; summ.summ = letterFromStudent.text.count(",")*100; summ.summ += letterFromStudent.text.count(".")*50; summ.summ += letterFromStudent.text.count(" ")*5; summ.type = "USD"; parentLetter.summ = summ; parentLetter.letterDate = QDateTime::currentDateTime(); return parentLetter; >Stuff Parents::poskrestiPoSusekam() const

… class Student : public QObject < Q_OBJECT Q_CLASSINFO("D-Bus Interface", "org.student.interface") Q_CLASSINFO("D-Bus Introspection", "" "\n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" ) public: Student(QObject *parent = 0); … 

QDBusArgument arg; arg 

qRegisterMetaType("PhotoFormat"); 

Q_DECLARE_METATYPE(PhotoFormat); 

QVariant var = qVariantFromValue(PhotoFotmat("Name", 23, 22)); PhotoFormat format = qVariantValue(var); 

qRegisterMetaTypeStreamOperators("PhotoFormat"); 

QDataStream &operator<<(QDataStream &out, const PhotoFormat &obj); QDataStream &operator>>(QDataStream &in, PhotoFormat &obj); 

QDataStream & operator <<(QDataStream &out, const PhotoFormat &obj)   QString name = obj.getFormatName();  QSizeF size = obj.getSize();  qreal dst1 = obj.getTopPateDistance();  qreal dst2 = obj.getNoseChinDistance();   out   return out; >  QDataStream & operator >>(QDataStream &in, PhotoFormat &obj)   QString name;  QSizeF size;  qreal dst1;  qreal dst2;   in >> name >> size >> dst1 >> dst2;   obj.setFormanName(name);  obj.setSize(size);  obj.setTopPateDistance(dst1);  obj.setNoseChinDistance(dst2);   return in; >