KDNSSD::DomainBrowser Class Reference

#include <KDNSSD/DomainBrowser>

Inheritance diagram for KDNSSD::DomainBrowser:

Public Types
enum	DomainType { Browsing , Publishing }
Public Types inherited from QObject
typedef	QObjectList

Signals
void	domainAdded (const QString &domain)
void	domainRemoved (const QString &domain)

Public Member Functions
	DomainBrowser (DomainType type, QObject *parent=nullptr)
QStringList	domains () const
bool	isRunning () const
void	startBrowse ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Browses recommended domains for browsing or publishing to.

Usage of this class is very simple. If you are interested in browsing for services, simple do

KDNSSD::DomainBrowser *browser =
    new KDNSSD::DomainBrowser(KDNSSD::DomainBrowser::Browsing, this);
connect(browser, SIGNAL(domainAdded(QString)),
        this, SLOT(browsingDomainAdded(QString));
connect(browser, SIGNAL(domainRemoved(QString)),
        this, SLOT(browsingDomainRemove(QString));
browser->startBrowse();

If you are interested in domains where you can register services, usage is identical except that you should pass KDNSSD::DomainBrowser::Registering to the constructor.

Author

Jakub Stachowski

Definition at line 43 of file domainbrowser.h.

Member Enumeration Documentation

DomainType

enum KDNSSD::DomainBrowser::DomainType

A type of domain recommendation.

Enumerator
Browsing	Domains recommended for browsing for services on (using ServiceBrowser)
Publishing	Domains recommended for publishing to (using PublicService)

Definition at line 50 of file domainbrowser.h.

Constructor & Destructor Documentation

DomainBrowser()

KDNSSD::DomainBrowser::DomainBrowser ( DomainType type, QObject * parent = nullptr )

explicit

Standard constructor.

The global DNS-SD configuration (for example, the global Avahi configuration for the Avahi backend) will be used.

Parameters

type	the type of domain to search for
parent	parent object (see QObject documentation)

See also

startBrowse() and ServiceBrowser::isAvailable()

Definition at line 22 of file avahi-domainbrowser.cpp.

~DomainBrowser()

KDNSSD::DomainBrowser::~DomainBrowser ( )

overridedefault

Definition at line 24 of file dummy-domainbrowser.cpp.

Member Function Documentation

domainAdded

void KDNSSD::DomainBrowser::domainAdded ( const QString & domain )

signal

A new domain has been discovered.

If the requested DomainType is Browsing, this will also be emitted for the domains specified in the global configuration.

Parameters

domain

the name of the domain

See also

domainRemoved()

domainRemoved

void KDNSSD::DomainBrowser::domainRemoved ( const QString & domain )

signal

A domain has disappeared from the browsed list.

Emitted when domain has been removed from browsing list or the publishing list (depending on which list was requested in the constructor).

Parameters

domain

the name of the domain

See also

domainAdded()

domains()

QStringList KDNSSD::DomainBrowser::domains

(

)

const

The current known list of domains of the requested DomainType.

Returns

a list of currently known domain names

Definition at line 140 of file avahi-domainbrowser.cpp.

isRunning()

bool KDNSSD::DomainBrowser::isRunning

(

)

const

Whether the browsing has been started.

Returns

true if startBrowse() has been called, false otherwise

Definition at line 146 of file avahi-domainbrowser.cpp.

startBrowse()

void KDNSSD::DomainBrowser::startBrowse

(

)

Starts browsing.

Only the first call to this function will have any effect.

Browsing stops when the DomainBrowser object is destroyed.

Warning

The domainAdded() signal may be emitted before this function returns.

See also

domainAdded() and domainRemoved()

Definition at line 30 of file avahi-domainbrowser.cpp.

---

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

• domainbrowser.h
• avahi-domainbrowser.cpp
• dummy-domainbrowser.cpp
• mdnsd-domainbrowser.cpp