Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Signals | Public Member Functions | Friends | List of all members
QDBusServer Class Reference

\inmodule QtDBus More...

#include <qdbusserver.h>

+ Inheritance diagram for QDBusServer:
+ Collaboration diagram for QDBusServer:

Signals

void newConnection (const QDBusConnection &connection)
 This signal is emitted when a new client connection connection is established to the server.
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QDBusServer (const QString &address, QObject *parent=nullptr)
 Constructs a QDBusServer with the given address, and the given parent.
 
 QDBusServer (QObject *parent=nullptr)
 Constructs a QDBusServer with the given parent.
 
virtual ~QDBusServer ()
 Destructs a QDBusServer.
 
bool isConnected () const
 Returns true if this QDBusServer object is connected.
 
QDBusError lastError () const
 Returns the last error that happened in this server.
 
QString address () const
 Returns the address this server is associated with.
 
void setAnonymousAuthenticationAllowed (bool value)
 
bool isAnonymousAuthenticationAllowed () const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QString > bindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThread * thread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectList & children () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Friends

class QDBusConnectionPrivate
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

\inmodule QtDBus

The QDBusServer class provides peer-to-peer communication between processes on the same computer.

Definition at line 20 of file qdbusserver.h.

Constructor & Destructor Documentation

◆ QDBusServer() [1/2]

QDBusServer::QDBusServer ( const QString & address,
QObject * parent = nullptr )
explicit

Constructs a QDBusServer with the given address, and the given parent.

Definition at line 28 of file qdbusserver.cpp.

References QDBusConnectionManager::createServer(), QDBusConnectionManager::instance(), Q_ASSERT, and qdbus_loadLibDBus().

+ Here is the call graph for this function:

◆ QDBusServer() [2/2]

QDBusServer::QDBusServer ( QObject * parent = nullptr)
explicit

Constructs a QDBusServer with the given parent.

The server will listen for connections in {/tmp} (on Unix systems) or on a TCP port bound to localhost (elsewhere).

Definition at line 50 of file qdbusserver.cpp.

◆ ~QDBusServer()

QDBusServer::~QDBusServer ( )
virtual

Destructs a QDBusServer.

Definition at line 65 of file qdbusserver.cpp.

References QObject::deleteLater(), QDBusConnectionManager::instance(), QDBusConnectionPrivate::lock, manager, QDBusConnectionPrivate::ref, QDBusConnectionPrivate::serverConnectionNames, QDBusConnectionPrivate::serverObject, and QBasicAtomicInteger< T >::storeRelaxed().

+ Here is the call graph for this function:

Member Function Documentation

◆ address()

QString QDBusServer::address ( ) const

Returns the address this server is associated with.

Definition at line 106 of file qdbusserver.cpp.

References QString::fromUtf8(), and QDBusConnectionPrivate::server.

+ Here is the call graph for this function:

◆ isAnonymousAuthenticationAllowed()

bool QDBusServer::isAnonymousAuthenticationAllowed ( ) const
Since
5.3

Returns true if anonymous authentication is allowed.

See also
setAnonymousAuthenticationAllowed()

Definition at line 143 of file qdbusserver.cpp.

References QDBusConnectionPrivate::anonymousAuthenticationAllowed.

◆ isConnected()

bool QDBusServer::isConnected ( ) const

Returns true if this QDBusServer object is connected.

If it isn't connected, you need to call the constructor again.

Definition at line 88 of file qdbusserver.cpp.

References QDBusConnectionPrivate::server.

◆ lastError()

QDBusError QDBusServer::lastError ( ) const

Returns the last error that happened in this server.

This function is provided for low-level code.

Definition at line 98 of file qdbusserver.cpp.

References QDBusError::Disconnected, QDBusUtil::disconnectedErrorMessage(), and QDBusConnectionPrivate::lastError.

+ Here is the call graph for this function:

◆ newConnection

void QDBusServer::newConnection ( const QDBusConnection & connection)
signal

This signal is emitted when a new client connection connection is established to the server.

Referenced by qDBusNewConnection().

+ Here is the caller graph for this function:

◆ setAnonymousAuthenticationAllowed()

void QDBusServer::setAnonymousAuthenticationAllowed ( bool value)
Since
5.3

If value is set to true, an incoming connection can proceed even if the connecting client is not authenticated as a user.

By default, this value is false.

See also
isAnonymousAuthenticationAllowed()

Definition at line 128 of file qdbusserver.cpp.

References QDBusConnectionPrivate::anonymousAuthenticationAllowed.

Friends And Related Symbol Documentation

◆ QDBusConnectionPrivate

friend class QDBusConnectionPrivate
friend

Definition at line 41 of file qdbusserver.h.

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