NameSpace.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_OS_NAMESPACE_H
#define YARP_OS_NAMESPACE_H
 
#include <yarp/os/Contact.h>
#include <yarp/os/NameStore.h>
#include <yarp/os/Network.h>
#include <yarp/os/Value.h>
 
namespace yarp::os {
 
class YARP_os_API NameSpace
{
public:
    virtual ~NameSpace();
 
    virtual bool checkNetwork();
 
    virtual bool checkNetwork(double timeout);
 
    virtual Contact getNameServerContact() const = 0;
 
    virtual std::string getNameServerName() const;
 
    virtual Contact queryName(const std::string& name) = 0;
 
    virtual Contact registerName(const std::string& name) = 0;
 
    virtual Contact registerContact(const Contact& contact) = 0;
 
    virtual Contact unregisterName(const std::string& name) = 0;
 
    virtual Contact unregisterContact(const Contact& contact) = 0;
 
    virtual Contact registerAdvanced(const Contact& contact,
                                     NameStore* store)
    {
        YARP_UNUSED(store);
        return registerContact(contact);
    }
 
    virtual Contact unregisterAdvanced(const std::string& name,
                                       NameStore* store)
    {
        YARP_UNUSED(store);
        return unregisterName(name);
    }
 
    virtual bool setProperty(const std::string& name,
                             const std::string& key,
                             const Value& value) = 0;
 
    virtual Value *getProperty(const std::string& name,
                               const std::string& key) = 0;
 
    virtual bool connectPortToTopic(const Contact& src,
                                    const Contact& dest,
                                    const ContactStyle& style) = 0;
 
    virtual bool connectTopicToPort(const Contact& src,
                                    const Contact& dest,
                                    const ContactStyle& style) = 0;
 
    virtual bool disconnectPortFromTopic(const Contact& src,
                                         const Contact& dest,
                                         const ContactStyle& style) = 0;
 
    virtual bool disconnectTopicFromPort(const Contact& src,
                                         const Contact& dest,
                                         const ContactStyle& style) = 0;
 
    virtual bool connectPortToPortPersistently(const Contact& src,
                                               const Contact& dest,
                                               const ContactStyle& style) = 0;
 
    virtual bool disconnectPortToPortPersistently(const Contact& src,
                                                  const Contact& dest,
                                                  const ContactStyle& style) = 0;
 
    virtual bool localOnly() const = 0;
 
    virtual bool usesCentralServer() const = 0;
 
    virtual bool serverAllocatesPortNumbers() const = 0;
 
    virtual bool connectionHasNameOfEndpoints() const = 0;
 
    virtual Contact detectNameServer(bool useDetectedServer,
                                     bool& scanNeeded,
                                     bool& serverUsed) = 0;
 
    virtual bool writeToNameServer(PortWriter& cmd,
                                   PortReader& reply,
                                   const ContactStyle& style) = 0;
 
};
 
} // namespace yarp::os
 
#endif // YARP_OS_NAMESPACE_H