KDNSSD::RemoteService

#include <KDNSSD/RemoteService>

Inheritance diagram for KDNSSD::RemoteService:

Public Types

typedef QExplicitlySharedDataPointer< RemoteServicePtr
 
- Public Types inherited from KDNSSD::ServiceBase
typedef QExplicitlySharedDataPointer< ServiceBasePtr
 

Signals

void resolved (bool successful)
 

Public Member Functions

 RemoteService (const QString &name, const QString &type, const QString &domain)
 
bool isResolved () const
 
bool resolve ()
 
void resolveAsync ()
 
- 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 id, void *data) 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

- 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

Describes a service published over DNS-SD, typically on a remote machine.

This class allows delayed or asynchronous resolution of services. As the name suggests, the service is normally on a remote machine, but the service could just as easily be published on the local machine.

RemoteService instances are normally provided by ServiceBrowser, but can be used to resolve any service if you know the name, type and domain for it.

Author
Jakub Stachowski
See also
ServiceBrowser

Definition at line 38 of file remoteservice.h.

Constructor & Destructor Documentation

KDNSSD::RemoteService::RemoteService ( const QString name,
const QString type,
const QString domain 
)

Creates an unresolved RemoteService representing the service with the given name, type and domain.

Parameters
namethe name of the service
typethe type of the service (see ServiceBrowser::ServiceBrowser())
domainthe domain of the service
See also
ServiceBrowser::isAvailable()

Definition at line 21 of file avahi-remoteservice.cpp.

Member Function Documentation

bool KDNSSD::RemoteService::isResolved ( ) const

Whether the service has been successfully resolved.

Returns
true if hostName() and port() will return valid values, false otherwise

Definition at line 100 of file avahi-remoteservice.cpp.

bool KDNSSD::RemoteService::resolve ( )

Resolves the host name and port of service synchronously.

The host name is not resolved into an IP address - use KResolver for that.

resolved(bool) is emitted before this function is returned.

resolve() will not cause RemoteService to monitor for changes in the hostname or port of the service.

Returns
true if successful, false on failure
See also
resolveAsync(), hostName(), port()

Definition at line 30 of file avahi-remoteservice.cpp.

void KDNSSD::RemoteService::resolveAsync ( )

Resolves the host name and port of service asynchronously.

The host name is not resolved into an IP address - use KResolver for that.

The resolved(bool) signal will be emitted when the resolution is complete, or when it fails.

Note that resolved(bool) may be emitted before this function returns in case of immediate failure.

RemoteService will keep monitoring the service for changes in hostname and port, and re-emit resolved(bool) when either changes.

See also
resolve(), hostName(), port()

Definition at line 40 of file avahi-remoteservice.cpp.

void KDNSSD::RemoteService::resolved ( bool  successful)
signal

Emitted when resolving is complete.

If operating in asynchronous mode this signal can be emitted several times (when the hostName or port of the service changes).

Parameters
successfultrue if the hostName and port were successfully resolved, false otherwise

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 Wed Oct 28 2020 22:45:27 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.