InputProtocol.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_INPUTPROTOCOL_H
#define YARP_OS_INPUTPROTOCOL_H
 
#include <yarp/os/Connection.h>
#include <yarp/os/ConnectionReader.h>
#include <yarp/os/InputStream.h>
#include <yarp/os/OutputStream.h>
#include <yarp/os/Property.h>
#include <yarp/os/Route.h>
#include <yarp/os/SizedWriter.h>
 
#include <string>
 
namespace yarp::os {
class OutputProtocol;
class Contactable;
} // namespace yarp::os
 
 
namespace yarp::os {
 
class YARP_os_API InputProtocol
{
public:
    virtual ~InputProtocol() = default;
 
    virtual bool open(const std::string& name) = 0;
 
    virtual void close() = 0;
 
    virtual void interrupt() = 0;
 
    virtual const Route& getRoute() const = 0;
 
    virtual ConnectionReader& beginRead() = 0;
 
    virtual void endRead() = 0;
 
    virtual void reply(SizedWriter& writer) = 0;
 
    virtual Connection& getConnection() = 0;
 
    virtual Connection& getReceiver() = 0;
 
    virtual bool isOk() const = 0;
 
    virtual OutputProtocol& getOutput() = 0;
 
    virtual void suppressReply() = 0;
 
    virtual OutputStream& getOutputStream() = 0;
 
    virtual InputStream& getInputStream() = 0;
 
    virtual void setEnvelope(const std::string& str) = 0;
 
    virtual bool setTimeout(double timeout) = 0;
 
    virtual void attachPort(Contactable* port) = 0;
 
    virtual bool isReplying() const = 0;
};
 
} // namespace yarp::os
 
#endif // YARP_OS_INPUTPROTOCOL_H