KDNSSD 5.109.0
Public Types | Signals | Public Member Functions | List of all members
KDNSSD::DomainBrowser

Browses recommended domains for browsing or publishing to. More...

#include <KDNSSD/DomainBrowser>

Public Types

enum  DomainType { Browsing , Publishing }
 A type of domain recommendation. More...
 

Signals

void domainAdded (const QString &domain)
 A new domain has been discovered.
 
void domainRemoved (const QString &domain)
 A domain has disappeared from the browsed list.
 

Public Member Functions

 DomainBrowser (DomainType type, QObject *parent=nullptr)
 Standard constructor.
 
QStringList domains () const
 The current known list of domains of the requested DomainType.
 
bool isRunning () const
 Whether the browsing has been started.
 
void startBrowse ()
 Starts browsing.
 

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

connect(browser, SIGNAL(domainAdded(QString)),
this, SLOT(browsingDomainAdded(QString));
connect(browser, SIGNAL(domainRemoved(QString)),
this, SLOT(browsingDomainRemove(QString));
browser->startBrowse();
Browses recommended domains for browsing or publishing to.
Definition domainbrowser.h:44
void domainRemoved(const QString &domain)
A domain has disappeared from the browsed list.
void startBrowse()
Starts browsing.
void domainAdded(const QString &domain)
A new domain has been discovered.
@ Browsing
Domains recommended for browsing for services on (using ServiceBrowser)
Definition domainbrowser.h:52

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

Member Enumeration Documentation

◆ 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)

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
typethe type of domain to search for
parentparent object (see QObject documentation)
See also
startBrowse() and ServiceBrowser::isAvailable()

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
domainthe 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
domainthe 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

◆ isRunning()

bool KDNSSD::DomainBrowser::isRunning ( ) const

Whether the browsing has been started.

Returns
true if startBrowse() has been called, false otherwise

◆ 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()