Represents a service to be published. More...

#include <DNSSD/PublicService>

Inheritance diagram for DNSSD::PublicService:

Signals
void	published (bool successful)
Public Member Functions
	PublicService (const QString &name=QString(), const QString &type=QString(), unsigned int port=0, const QString &domain=QString(), const QStringList &subtypes=QStringList())
	~PublicService ()
bool	isPublished () const
bool	publish ()
void	publishAsync ()
void	setDomain (const QString &domain)
void	setPort (unsigned short port)
void	setServiceName (const QString &serviceName)
void	setSubTypes (const QStringList &subtypes)
void	setTextData (const QMap< QString, QByteArray > &textData)
void	setType (const QString &type)
void	stop ()
QStringList	subtypes () const
Protected Member Functions
virtual void	virtual_hook (int, void *)

Detailed Description

Represents a service to be published.

This class allows you to publish the existence of a network service provided by your application.

If you are providing a web server and want to advertise it on the local network, you might do

 DNSSD::PublicService *service = new DNSSD::PublicService("My files", "_http._tcp", 80);
 bool isOK = service->publish();

In this example publish() is synchronous: it will not return until publishing is complete. This is usually not too long but it can freeze an application's GUI for a moment. To publish asynchronously instead, do:

 DNSSD::PublicService *service = new DNSSD::PublicService("My files", "_http._tcp", 80);
 connect(service, SIGNAL(published(bool)), this, SLOT(wasPublished(bool)));
 service->publishAsync();

Author:: Jakub Stachowski

Definition at line 59 of file publicservice.h.

Constructor & Destructor Documentation

builddir build BUILD kdelibs dnssd dummy publicservice cpp builddir build BUILD kdelibs dnssd dummy publicservice cpp DNSSD::PublicService::PublicService	(	const QString &	name = `QString()`,
		const QString &	type = `QString()`,
		unsigned int	port = `0`,
		const QString &	domain = `QString()`,
		const QStringList &	subtypes = `QStringList()`
	)		`[explicit]`

Creates a service description that can be published.

If no name is given, the computer name is used instead. If there is already a service with the same name, type and domain a number will be appended to the name to make it unique.

If no domain is specified, the service is published on the link-local domain (.local).

The subtypes can be used to specify server attributes, such as "_anon" for anonymous FTP servers, or can specify a specific protocol (such as a web service interface) on top of a generic protocol like SOAP.

There is a comprehensive list of possible types available, but you are largely on your own for subtypes.

Parameters:

name	a service name to use instead of the computer name
type	service type, in the form _sometype._udp or _sometype._tcp
port	port number, or 0 to "reserve" the service name
domain	the domain to publish the service on (see DomainBrowser)
subtypes	optional list of subtypes, each with a leading underscore

See also:: ServiceBrowser::ServiceBrowser()

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

DNSSD::PublicService::~PublicService ( )

Definition at line 38 of file dummy-publicservice.cpp.

Member Function Documentation

bool DNSSD::PublicService::isPublished ( ) const

Whether the service is currently published.

Returns:: true if the service is being published to the domain, false otherwise

Definition at line 76 of file dummy-publicservice.cpp.

bool DNSSD::PublicService::publish ( )

Publish the service synchronously.

The method will not return (and hence the application interface will freeze, since KDElibs code should be executed in the main thread) until either the service is published or publishing fails.

published(bool) is emitted before this method returns.

Returns:: true if the service was successfully published, false otherwise

Definition at line 81 of file dummy-publicservice.cpp.

void DNSSD::PublicService::publishAsync ( )

Publish the service asynchronously.

Returns immediately and emits published(bool) when completed. Note that published(bool) may be emitted before this method returns when an error is detected immediately.

Definition at line 89 of file dummy-publicservice.cpp.

void DNSSD::PublicService::published ( bool successful ) [signal]

Emitted when publishing is complete.

It will also emitted when an already-published service is republished after a property of the service (such as the name or port) is changed.

void DNSSD::PublicService::setDomain ( const QString & domain )

Sets the domain where the service is published.

"local." means link-local, ie: the IP subnet on the LAN containing this computer.

If service is already published, it will be removed from the current domain and published on domain instead.

Parameters:

domain the new domain to publish the service on

Definition at line 46 of file dummy-publicservice.cpp.

void DNSSD::PublicService::setPort ( unsigned short port )

Sets the port.

If the service is already published, it will be re-announced with the new port.

Parameters:

port	the port of the service, or 0 to simply "reserve" the name

Definition at line 66 of file dummy-publicservice.cpp.

void DNSSD::PublicService::setServiceName ( const QString & serviceName )

Sets the name of the service.

If the service is already published, it will be re-announced with the new name.

Parameters:

serviceName the new name of the service

Definition at line 41 of file dummy-publicservice.cpp.

void DNSSD::PublicService::setSubTypes ( const QStringList & subtypes )

Sets the subtypetypes of the service.

If the service is already published, it will be re-announced with the new subtypes.

The existing list of substypes is replaced, so an empty list will cause all existing subtypes to be removed.

Parameters:

subtypes the new list of subtypes

Definition at line 61 of file dummy-publicservice.cpp.

void DNSSD::PublicService::setTextData ( const QMap< QString, QByteArray > & textData )

Sets new text properties.

If the service is already published, it will be re-announced with the new data.

Parameters:

textData the new text properties for the service

See also:: ServiceBase::textData()

Definition at line 51 of file dummy-publicservice.cpp.

void DNSSD::PublicService::setType ( const QString & type )

Sets the service type.

If the service is already published, it will be re-announced with the new type.

Parameters:

type	the new type of the service

See PublicService() for details on the format of type

Definition at line 56 of file dummy-publicservice.cpp.

void DNSSD::PublicService::stop ( )

Stops publishing or aborts an incomplete publish request.

Useful when you want to disable the service for some time.

Note that if you stop providing a service (without exiting the application), you should stop publishing it.

Definition at line 86 of file dummy-publicservice.cpp.

QStringList DNSSD::PublicService::subtypes ( ) const

The subtypes of service.

See also:: setSubTypes()

Definition at line 71 of file dummy-publicservice.cpp.

void DNSSD::PublicService::virtual_hook	(	int	,
		void *
	)		`[protected, virtual]`

Reimplemented from DNSSD::ServiceBase.

Definition at line 94 of file dummy-publicservice.cpp.

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

DNSSD

DNSSD::PublicService Class Reference

Signals

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

DNSSD

kdelibs