NameClient.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_OS_IMPL_NAMECLIENT_H
#define YARP_OS_IMPL_NAMECLIENT_H
 
#include <yarp/os/Contact.h>
#include <yarp/os/ContactStyle.h>
#include <yarp/os/Nodes.h>
 
namespace yarp::os {
 
class Bottle;
class NameStore;
 
} // namespace yarp::os
 
namespace yarp::os::impl {
 
class NameServer;
 
class YARP_os_impl_API NameClient
{
private:
    NameClient();
    NameClient(const NameClient& nic);
 
public:
    virtual ~NameClient();
 
    static NameClient& getNameClient();
 
    static NameClient* create();
 
    Contact getAddress();
 
    Contact queryName(const std::string& name);
 
    Contact registerName(const std::string& name);
 
    Contact registerName(const std::string& name, const Contact& suggest);
 
    Contact unregisterName(const std::string& name);
 
    Contact probe(const std::string& cmd);
 
    static Contact extractAddress(const std::string& txt);
 
    static Contact extractAddress(const Bottle& bot);
 
    std::string send(const std::string& cmd, bool multi = true, const ContactStyle& style = ContactStyle());
 
    bool send(yarp::os::Bottle& cmd, yarp::os::Bottle& reply);
 
    void setFakeMode(bool fake = true);
 
    bool isFakeMode() const;
 
    void setScan(bool allow = true);
 
    void setSave(bool allow = true);
 
    bool didScan();
 
    bool didSave();
 
    bool updateAddress();
 
    bool setContact(const yarp::os::Contact& contact);
 
    void queryBypass(NameStore* store);
 
    NameStore* getQueryBypass();
 
    std::string getMode();
 
    yarp::os::Nodes& getNodes();
 
private:
    Contact address;
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) host;
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) mode;
    bool fake;
    NameServer* fakeServer;
    bool allowScan;
    bool allowSaveScan;
    bool reportScan;
    bool reportSaveScan;
    bool isSetup;
    NameStore* altStore;
    yarp::os::Nodes nodes;
 
    NameServer& getServer();
    void setup();
};
 
} // namespace yarp::os::impl
 
#endif // YARP_OS_IMPL_NAMECLIENT_H