Contactable.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_CONTACTABLE_H
#define YARP_OS_CONTACTABLE_H
 
#include <yarp/os/Contact.h>
#include <yarp/os/PortReader.h>
#include <yarp/os/PortReport.h>
#include <yarp/os/PortWriter.h>
 
#ifndef YARP_NO_DEPRECATED // Since YARP 3.3
#define YARP_INCLUDING_DEPRECATED_HEADER_ON_PURPOSE
#  include <yarp/os/Mutex.h>
#undef YARP_INCLUDING_DEPRECATED_HEADER_ON_PURPOSE
#endif
 
#include <mutex>
 
// Forward declarations:
namespace yarp::os {
 
class Property;
 
class YARP_os_API Contactable
{
 
public:
    virtual ~Contactable();
 
    virtual bool open(const std::string& name) = 0;
 
    virtual bool open(const Contact& contact, bool registerName = true) = 0;
 
    virtual bool addOutput(const std::string& name) = 0;
 
    virtual bool addOutput(const std::string& name, const std::string& carrier) = 0;
 
    virtual bool addOutput(const Contact& contact) = 0;
 
    virtual void close() = 0;
 
    virtual void interrupt() = 0;
 
    virtual void resume() = 0;
 
    virtual Contact where() const = 0;
 
    virtual std::string getName() const;
 
 
    virtual bool setEnvelope(PortWriter& envelope) = 0;
 
 
    virtual bool getEnvelope(PortReader& envelope) = 0;
 
 
    virtual int getInputCount() = 0;
 
    virtual int getOutputCount() = 0;
 
    virtual void getReport(PortReport& reporter) = 0;
 
 
    virtual void setReporter(PortReport& reporter) = 0;
 
    virtual void resetReporter() = 0;
 
    virtual bool isWriting() = 0;
 
 
    virtual void setReader(PortReader& reader) = 0;
 
    virtual void setAdminReader(PortReader& reader) = 0;
 
    virtual void setInputMode(bool expectInput) = 0;
 
    virtual void setOutputMode(bool expectOutput) = 0;
 
    virtual void setRpcMode(bool expectRpc) = 0;
 
    virtual Type getType() = 0;
 
    virtual void promiseType(const Type& typ) = 0;
 
    virtual Property* acquireProperties(bool readOnly) = 0;
 
    virtual void releaseProperties(Property* prop) = 0;
 
    virtual void includeNodeInName(bool flag) = 0;
 
    void setReadOnly();
 
    void setWriteOnly();
 
    void setRpcServer();
 
    void setRpcClient();
 
#ifndef YARP_NO_DEPRECATED // Since YARP 3.3
YARP_WARNING_PUSH
YARP_DISABLE_DEPRECATED_WARNING
    YARP_DEPRECATED_MSG("Use setCallbackLock with std::mutex instead")
    virtual bool setCallbackLock(yarp::os::Mutex* mutex) = 0;
YARP_WARNING_POP
#endif
 
    virtual bool setCallbackLock(std::mutex* mutex = nullptr) = 0;
 
    virtual bool removeCallbackLock() = 0;
 
    virtual bool lockCallback() = 0;
 
    virtual bool tryLockCallback() = 0;
 
    virtual void unlockCallback() = 0;
};
 
} // namespace yarp::os
 
#endif // YARP_OS_CONTACTABLE_H