KDNSSD 5.109.0
Signals | Public Member Functions | Protected Member Functions | List of all members
KDNSSD::PublicService

Represents a service to be published. More...

#include <KDNSSD/PublicService>

Signals

void published (bool successful)
 Emitted when publishing is complete.
 

Public Member Functions

 PublicService (const QString &name=QString(), const QString &type=QString(), unsigned int port=0, const QString &domain=QString(), const QStringList &subtypes=QStringList())
 Creates a service description that can be published.
 
bool isPublished () const
 Whether the service is currently published.
 
bool publish ()
 Publish the service synchronously.
 
void publishAsync ()
 Publish the service asynchronously.
 
void setDomain (const QString &domain)
 Sets the domain where the service is published.
 
void setPort (unsigned short port)
 Sets the port.
 
void setServiceName (const QString &serviceName)
 Sets the name of the service.
 
void setSubTypes (const QStringList &subtypes)
 Sets the subtypetypes of the service.
 
void setTextData (const QMap< QString, QByteArray > &textData)
 Sets new text properties.
 
void setType (const QString &type)
 Sets the service type.
 
void stop ()
 Stops publishing or aborts an incomplete publish request.
 
QStringList subtypes () const
 The subtypes of service.
 
- Public Member Functions inherited from KDNSSD::ServiceBase
 ServiceBase (const QString &name=QString(), const QString &type=QString(), const QString &domain=QString(), const QString &host=QString(), unsigned short port=0)
 Creates a ServiceBase object.
 
QString domain () const
 The domain that the service belongs to.
 
QString hostName () const
 The hostname of the service.
 
bool operator!= (const ServiceBase &o) const
 Compares services based on name, type and domain.
 
bool operator== (const ServiceBase &o) const
 Compares services based on name, type and domain.
 
unsigned short port () const
 The port number of the service.
 
QString serviceName () const
 The name of the service.
 
QMap< QString, QByteArray > textData () const
 Additional text data associated with the service.
 
QString type () const
 The type of the service.
 

Protected Member Functions

void virtual_hook (int, void *) override
 
- Protected Member Functions inherited from KDNSSD::ServiceBase
KDNSSD_NO_EXPORT ServiceBase (ServiceBasePrivate *const d)
 
virtual void virtual_hook (int, void *)
 

Additional Inherited Members

- Public Types inherited from KDNSSD::ServiceBase
typedef QExplicitlySharedDataPointer< ServiceBasePtr
 
- Protected Attributes inherited from KDNSSD::ServiceBase
std::unique_ptr< ServiceBasePrivate > const d
 

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

KDNSSD::PublicService *service = new KDNSSD::PublicService("My files", "_http._tcp", 80);
bool isOK = service->publish();
Represents a service to be published.
Definition publicservice.h:48
bool publish()
Publish the service synchronously.

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:

KDNSSD::PublicService *service = new KDNSSD::PublicService("My files", "_http._tcp", 80);
connect(service, SIGNAL(published(bool)), this, SLOT(wasPublished(bool)));
service->publishAsync();
void published(bool successful)
Emitted when publishing is complete.
void publishAsync()
Publish the service asynchronously.
Author
Jakub Stachowski

Constructor & Destructor Documentation

◆ PublicService()

KDNSSD::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
namea service name to use instead of the computer name
typeservice type, in the form _sometype._udp or _sometype._tcp
portport number, or 0 to "reserve" the service name
domainthe domain to publish the service on (see DomainBrowser)
subtypesoptional list of subtypes, each with a leading underscore
See also
ServiceBrowser::ServiceBrowser()

Member Function Documentation

◆ isPublished()

bool KDNSSD::PublicService::isPublished ( ) const

Whether the service is currently published.

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

◆ publish()

bool KDNSSD::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

◆ publishAsync()

void KDNSSD::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.

◆ published

void KDNSSD::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.

◆ setDomain()

void KDNSSD::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
domainthe new domain to publish the service on

◆ setPort()

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

Sets the port.

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

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

◆ setServiceName()

void KDNSSD::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
serviceNamethe new name of the service

◆ setSubTypes()

void KDNSSD::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
subtypesthe new list of subtypes

◆ setTextData()

void KDNSSD::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
textDatathe new text properties for the service
See also
ServiceBase::textData()

◆ setType()

void KDNSSD::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
typethe new type of the service

See PublicService() for details on the format of type

◆ stop()

void KDNSSD::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.

◆ subtypes()

QStringList KDNSSD::PublicService::subtypes ( ) const

The subtypes of service.

See also
setSubTypes()

◆ virtual_hook()

void KDNSSD::PublicService::virtual_hook ( int  ,
void *   
)
overrideprotectedvirtual

Reimplemented from KDNSSD::ServiceBase.