WireLink.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_WIRELINK_H
#define YARP_OS_WIRELINK_H
 
#include <yarp/os/api.h>
 
#include <string>
 
namespace yarp::os {
 
class PortReader;
class PortWriter;
class UnbufferedContactable;
 
class YARP_os_API WireLink
{
public:
    WireLink();
 
    ~WireLink();
 
    bool isValid() const;
 
    bool setOwner(yarp::os::PortReader& owner);
 
    bool attachAsClient(yarp::os::UnbufferedContactable& port);
 
    bool attachAsClient(yarp::os::PortReader& reader);
 
    bool attachAsServer(yarp::os::UnbufferedContactable& port);
 
    bool setStreamingMode(bool streaming);
 
    bool write(PortWriter& writer);
 
    bool write(const PortWriter& writer, PortReader& reader) const;
 
    bool callback(PortWriter& writer, PortReader& reader, const std::string& tag = "");
 
    bool canWrite() const;
 
    bool canRead() const;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
    class Private;
    Private* mPriv;
#endif // DOXYGEN_SHOULD_SKIP_THIS
};
 
} // namespace yarp::os
 
#endif // YARP_OS_WIRELINK_H