Contact.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_CONTACT_H
#define YARP_OS_CONTACT_H
 
#include <yarp/conf/compiler.h>
#include <yarp/conf/system.h>
 
#include <yarp/os/NestedContact.h>
 
#include <string>
 
namespace yarp::os {
class Searchable;
} // namespace yarp::os
 
 
namespace yarp::os {
 
class YARP_os_API Contact
{
public:
    Contact(const std::string& name = std::string(),
            const std::string& carrier = std::string(),
            const std::string& hostname = std::string(),
            int port = -1);
 
    Contact(const std::string& hostname,
            int port);
 
    Contact(const std::string& carrier,
            const std::string& hostname,
            int port);
 
    Contact(const Contact& rhs);
 
    Contact(Contact&& rhs) noexcept;
 
    virtual ~Contact();
 
    Contact& operator=(const Contact& rhs);
 
    Contact& operator=(Contact&& rhs) noexcept;
 
    static Contact fromConfig(const Searchable& config);
 
    static Contact fromString(const std::string& txt);
 
    std::string getName() const;
 
    void setName(const std::string& name);
 
    std::string getRegName() const;
 
    std::string getHost() const;
 
    void setHost(const std::string& hostname);
 
    int getPort() const;
 
 
    void setPort(int port);
 
    std::string getCarrier() const;
 
    void setCarrier(const std::string& carrier);
 
    const NestedContact& getNested() const;
 
    void setNestedContact(const yarp::os::NestedContact& nestedContact);
 
    bool hasTimeout() const;
 
    float getTimeout() const;
 
    void setTimeout(float timeout);
 
    void setSocket(const std::string& carrier,
                   const std::string& hostname,
                   int port);
 
    bool isValid() const;
 
    std::string toString() const;
 
    std::string toURI(bool includeCarrier = true) const;
 
    static std::string convertHostToIp(const char* name);
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
    class Private;
    Private* mPriv;
#endif // DOXYGEN_SHOULD_SKIP_THIS
};
 
} // namespace yarp::os
 
#endif // YARP_OS_CONTACT_H