Soprano 2.9.4
Soprano::Server::DBusExportIterator Class Reference

Exports a Soprano Iterator via D-Bus. More...

#include <Soprano/Server/DBusExportIterator>

Inheritance diagram for Soprano::Server::DBusExportIterator:

Public Slots

void setDeleteOnClose (bool deleteOnClose)
bool registerIterator (const QString &dbusObjectPath, const QString &dbusClient=QString())
void unregisterIterator ()

Public Member Functions

 DBusExportIterator (StatementIterator it, QObject *parent=0)
 DBusExportIterator (NodeIterator it, QObject *parent=0)
 DBusExportIterator (QueryResultIterator it, QObject *parent=0)
 ~DBusExportIterator ()
StatementIterator statementIterator () const
NodeIterator nodeIterator () const
QueryResultIterator queryResultIterator () const
QString dbusObjectPath () const
bool deleteOnClose () const
Public Member Functions inherited from QObject
 QObject (QObject *parent=0)
 blockSignals (bool block)
 childEvent (QChildEvent *event)
 children ()
 connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type=Qt::AutoCompatConnection)
 connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type=Qt::AutoCompatConnection)
 connectNotify (const char *signal)
 customEvent (QEvent *event)
 deleteLater ()
 destroyed (QObject *obj=0)
 disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 disconnect (const char *signal=0, const QObject *receiver=0, const char *method=0)
 disconnect (const QObject *receiver, const char *method=0)
 disconnectNotify (const char *signal)
 dumpObjectInfo ()
 dumpObjectTree ()
 dynamicPropertyNames ()
 event (QEvent *e)
 eventFilter (QObject *watched, QEvent *event)
 findChild (const QString &name=QString()
 findChildren (const QString &name=QString()
 findChildren (const QRegExp &regExp)
 inherits (const char *className)
 installEventFilter (QObject *filterObj)
 isWidgetType ()
 killTimer (int id)
 metaObject ()
 moveToThread (QThread *targetThread)
 parent ()
 property (const char *name)
 receivers (const char *signal)
 removeEventFilter (QObject *obj)
 sender ()
 setParent (QObject *parent)
 setProperty (const char *name, const QVariant &value)
 signalsBlocked ()
 startTimer (int interval)
 thread ()
 timerEvent (QTimerEvent *event)
 tr (const char *sourceText, const char *comment=0, int n=-1)
 trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
 staticMetaObject
 QObject (QObject *parent, const char *name)
 checkConnectArgs (const char *signal, const QObject *object, const char *method)
 child (const char *objName, const char *inheritsClass=0, bool recursiveSearch=true)
 className ()
 insertChild (QObject *object)
 isA (const char *className)
 name ()
 name (const char *defaultName)
 normalizeSignalSlot (const char *signalSlot)
 removeChild (QObject *object)
 setName (const char *name)
Public Member Functions inherited from Soprano::Error::ErrorCache
virtual ~ErrorCache ()
virtual Error lastError () const

Additional Inherited Members

Protected Member Functions inherited from Soprano::Error::ErrorCache
 ErrorCache ()
void clearError () const
void setError (const Error &) const
void setError (const QString &errorMessage, int code=ErrorUnknown) const

Detailed Description

Exports a Soprano Iterator via D-Bus.

The DBusExportIterator can be used to export a single iterator via D-Bus. This may be useful in case one does not want to expose the complete Model API but restrict access via custom methods that return Soprano Iterators.

The most common usage is probably as a fire-and-forget class:

void myDbusMethod( const QDBusMessage& m ) {
Soprano::StatementIterator it = model->listStatements();
dbusIt->setDeleteOnClose( true );
dbusIt->registerIterator( myFancyDBusObjectPath, m.service() );
return myFancyDBusObjectPath;
}
Exports a Soprano Iterator via D-Bus.
bool registerIterator(const QString &dbusObjectPath, const QString &dbusClient=QString())
void setDeleteOnClose(bool deleteOnClose)
An iterator that provides a stream of Statements.

This is a class for advanced usage. In most situations using DBusExportModel or even ServerCore::registerAsDBusObject is probably enough.

Author
Sebastian Trueg trueg.nosp@m.@kde.nosp@m..org
See also
Soprano D-Bus Interface
Since
2.1

Definition at line 67 of file dbusexportiterator.h.

Constructor & Destructor Documentation

◆ DBusExportIterator() [1/3]

Soprano::Server::DBusExportIterator::DBusExportIterator ( StatementIterator it,
QObject * parent = 0 )

Create a new instance to export a StatementIterator

◆ DBusExportIterator() [2/3]

Soprano::Server::DBusExportIterator::DBusExportIterator ( NodeIterator it,
QObject * parent = 0 )

Create a new instance to export a NodeIterator

◆ DBusExportIterator() [3/3]

Soprano::Server::DBusExportIterator::DBusExportIterator ( QueryResultIterator it,
QObject * parent = 0 )

Create a new instance to export a QueryResultIterator

◆ ~DBusExportIterator()

Soprano::Server::DBusExportIterator::~DBusExportIterator ( )

Destructor

Member Function Documentation

◆ statementIterator()

StatementIterator Soprano::Server::DBusExportIterator::statementIterator ( ) const
Returns
The used StatementIterator or an invalid one if this DBusExportIterator does not export a StatementIterator.

◆ nodeIterator()

NodeIterator Soprano::Server::DBusExportIterator::nodeIterator ( ) const
Returns
The used NodeIterator or an invalid one if this DBusExportIterator does not export a NodeIterator.

◆ queryResultIterator()

QueryResultIterator Soprano::Server::DBusExportIterator::queryResultIterator ( ) const
Returns
The used QueryResultIterator or an invalid one if this DBusExportIterator does not export a QueryResultIterator.

◆ dbusObjectPath()

QString Soprano::Server::DBusExportIterator::dbusObjectPath ( ) const

The path this iterator is exported on. This is an empty string if the iterator is not exported.

◆ deleteOnClose()

bool Soprano::Server::DBusExportIterator::deleteOnClose ( ) const

The DBusExportIterator instance can delete itself once the iterator is closed. The default value is false, i.e. the creator has to delete the instance.

See also
setDeleteOnClose, Iterator::close

◆ setDeleteOnClose

void Soprano::Server::DBusExportIterator::setDeleteOnClose ( bool deleteOnClose)
slot

Set if the iterator should delete itself once it has been closed. The default value is false, i.e. the creator has to delete the instance.

Warning
This only works if the iterator is closed from the outside, i.e. by the D-Bus client.
See also
deleteOnClose

◆ registerIterator

bool Soprano::Server::DBusExportIterator::registerIterator ( const QString & dbusObjectPath,
const QString & dbusClient = QString() )
slot

Register the iterator under the given D-Bus object path.

See also
QDBusConnection::registerObject
Parameters
dbusObjectPathThe D-Bus object path to register the iterator under.
dbusClientThe optional D-Bus client which uses the iterator, i.e. which called the method that triggered the creation of the iterator. If set, the iterator will be closed once the client dies. In combination with setDeleteOnClose this class can thus be used in a fire-and-forget manner.

◆ unregisterIterator

void Soprano::Server::DBusExportIterator::unregisterIterator ( )
slot

Unregister the iterator from D-Bus.

See also
QDBusConnection::unregisterObject

The documentation for this class was generated from the following file: