mirror of
https://bitbucket.org/smil3y/kdelibs.git
synced 2025-02-23 18:32:49 +00:00
140 lines
3.9 KiB
C++
140 lines
3.9 KiB
C++
/* This file is part of the KDE project
|
|
*
|
|
* Copyright (C) 2004, 2005 Jakub Stachowski <qbast@go2.pl>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public License
|
|
* along with this library; see the file COPYING.LIB. If not, write to
|
|
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef DNSSDREMOTESERVICE_H
|
|
#define DNSSDREMOTESERVICE_H
|
|
|
|
#include <QtCore/QObject>
|
|
#include <QtCore/QMetaType>
|
|
#include <dnssd/servicebase.h>
|
|
|
|
namespace DNSSD
|
|
{
|
|
class RemoteServicePrivate;
|
|
|
|
/**
|
|
* @class RemoteService remoteservice.h DNSSD/RemoteService
|
|
* @short 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 ServiceBrowser
|
|
*/
|
|
class KDNSSD_EXPORT RemoteService : public QObject, public ServiceBase
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
typedef KSharedPtr<RemoteService> Ptr;
|
|
|
|
/**
|
|
* Creates an unresolved RemoteService representing the service with
|
|
* the given name, type and domain
|
|
*
|
|
* @param name the name of the service
|
|
* @param type the type of the service (see ServiceBrowser::ServiceBrowser())
|
|
* @param domain the domain of the service
|
|
*
|
|
* @see ServiceBrowser::isAvailable()
|
|
*/
|
|
RemoteService(const QString& name, const QString& type, const QString& domain);
|
|
|
|
virtual ~RemoteService();
|
|
|
|
/**
|
|
* 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 resolve(), hostName(), port()
|
|
*/
|
|
void resolveAsync();
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @return @c true if successful, @c false on failure
|
|
*
|
|
* @see resolveAsync(), hostName(), port()
|
|
*/
|
|
bool resolve();
|
|
|
|
/**
|
|
* Whether the service has been successfully resolved
|
|
*
|
|
* @return @c true if hostName() and port() will return
|
|
* valid values, @c false otherwise
|
|
*/
|
|
bool isResolved() const;
|
|
|
|
Q_SIGNALS:
|
|
/**
|
|
* 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).
|
|
*
|
|
* @param successful @c true if the hostName and port were
|
|
* successfully resolved, @c false otherwise
|
|
*/
|
|
void resolved(bool successful);
|
|
|
|
protected:
|
|
virtual void virtual_hook(int id, void *data);
|
|
private:
|
|
friend class RemoteServicePrivate;
|
|
|
|
};
|
|
|
|
}
|
|
|
|
Q_DECLARE_METATYPE(DNSSD::RemoteService::Ptr)
|
|
|
|
#endif
|