OutputProtocol.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_OUTPUTPROTOCOL_H
#define YARP_OS_OUTPUTPROTOCOL_H
 
#include <yarp/os/Connection.h>
#include <yarp/os/ConnectionWriter.h>
#include <yarp/os/InputStream.h>
#include <yarp/os/Property.h>
#include <yarp/os/Route.h>
#include <yarp/os/SizedWriter.h>
 
namespace yarp::os {
class InputProtocol;
class Contactable;
} // namespace yarp::os
 
namespace yarp::os {
class YARP_os_API OutputProtocol
{
public:
    virtual ~OutputProtocol() = default;
 
    virtual bool open(const Route& route) = 0;
 
    virtual void rename(const Route& route) = 0;
 
    virtual void close() = 0;
 
    virtual const Route& getRoute() const = 0;
 
    virtual bool isOk() const = 0;
 
    virtual Connection& getConnection() = 0;
 
    virtual Connection& getReceiver() = 0;
 
    virtual Connection& getSender() = 0;
 
    virtual bool write(SizedWriter& writer) = 0;
 
    virtual void interrupt() = 0;
 
 
    virtual InputProtocol& getInput() = 0;
 
    virtual OutputStream& getOutputStream() = 0;
 
    virtual InputStream& getInputStream() = 0;
 
    virtual bool setTimeout(double timeout) = 0;
 
    virtual void attachPort(Contactable* port) = 0;
 
    virtual void beginWrite() = 0;
};
 
} // namespace yarp::os
 
#endif // YARP_OS_OUTPUTPROTOCOL_H