DNSSD::DomainBrowser Class Reference

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

#include <DNSSD/DomainBrowser>

Inheritance diagram for DNSSD::DomainBrowser:

List of all members.

Public Types
enum	DomainType { Browsing, Publishing }
Signals
void	domainAdded (const QString &domain)
void	domainRemoved (const QString &domain)
Public Member Functions
	DomainBrowser (DomainType type, QObject *parent=0)
	~DomainBrowser ()
QStringList	domains () const
bool	isRunning () const
void	startBrowse ()

---

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

 DNSSD::DomainBrowser *browser =
     new DNSSD::DomainBrowser(DNSSD::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 DNSSD::DomainBrowser::Registering to the constructor.

Author:

Jakub Stachowski

Definition at line 54 of file domainbrowser.h.

---

Member Enumeration Documentation

enum DNSSD::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 61 of file domainbrowser.h.

---

Constructor & Destructor Documentation

DNSSD::DomainBrowser::DomainBrowser	(	DomainType	type,
		QObject *	parent = 0
	)		[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 27 of file dummy-domainbrowser.cpp.

DNSSD::DomainBrowser::~DomainBrowser

(

)

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

---

Member Function Documentation

void DNSSD::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()

void DNSSD::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()

QStringList DNSSD::DomainBrowser::domains

(

)

const

The current known list of domains of the requested DomainType.

Returns:

a list of currently known domain names

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

bool DNSSD::DomainBrowser::isRunning

(

)

const

Whether the browsing has been started.

Returns:

true if startBrowse() has been called, false otherwise

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

void DNSSD::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 34 of file dummy-domainbrowser.cpp.

---

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

• domainbrowser.h
• dummy-domainbrowser.cpp