KDNSSD::PublicService

#include <KDNSSD/PublicService>

Inheritance diagram for KDNSSD::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())
 
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
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- 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)
 
QString domain () const
 
QString hostName () const
 
bool operator!= (const ServiceBase &o) const
 
bool operator== (const ServiceBase &o) const
 
unsigned short port () const
 
QString serviceName () const
 
QMap< QString, QByteArraytextData () const
 
QString type () const
 
- Public Member Functions inherited from QSharedData
 QSharedData (const QSharedData &)
 

Protected Member Functions

void virtual_hook (int, void *) override
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Protected Member Functions inherited from KDNSSD::ServiceBase
 ServiceBase (ServiceBasePrivate *const d)
 

Additional Inherited Members

- Public Types inherited from KDNSSD::ServiceBase
typedef QExplicitlySharedDataPointer< ServiceBasePtr
 
- 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Attributes inherited from KDNSSD::ServiceBase
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();

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();
Author
Jakub Stachowski

Definition at line 47 of file publicservice.h.

Constructor & Destructor Documentation

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

Definition at line 27 of file avahi-publicservice.cpp.

Member Function Documentation

bool KDNSSD::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 129 of file avahi-publicservice.cpp.

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

Definition at line 135 of file avahi-publicservice.cpp.

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.

Definition at line 260 of file avahi-publicservice.cpp.

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.

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

Definition at line 73 of file avahi-publicservice.cpp.

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

Definition at line 109 of file avahi-publicservice.cpp.

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

Definition at line 63 of file avahi-publicservice.cpp.

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

Definition at line 93 of file avahi-publicservice.cpp.

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

Definition at line 119 of file avahi-publicservice.cpp.

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

Definition at line 83 of file avahi-publicservice.cpp.

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.

Definition at line 145 of file avahi-publicservice.cpp.

QStringList KDNSSD::PublicService::subtypes ( ) const

The subtypes of service.

See also
setSubTypes()

Definition at line 103 of file avahi-publicservice.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jul 6 2020 22:39:45 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.