TwoWayStream.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2020 Istituto Italiano di Tecnologia (IIT)
 * Copyright (C) 2006-2010 RobotCub Consortium
 * All rights reserved.
 *
 * This software may be modified and distributed under the terms of the
 * BSD-3-Clause license. See the accompanying LICENSE file for details.
 */
 
#ifndef YARP_OS_TWOWAYSTREAM_H
#define YARP_OS_TWOWAYSTREAM_H
 
#include <yarp/conf/numeric.h>
 
#include <yarp/os/Contact.h>
#include <yarp/os/InputStream.h>
#include <yarp/os/OutputStream.h>
 
namespace yarp {
namespace os {
 
class YARP_os_API TwoWayStream
{
public:
    virtual ~TwoWayStream();
 
    virtual InputStream& getInputStream() = 0;
 
    virtual OutputStream& getOutputStream() = 0;
 
    virtual const Contact& getLocalAddress() const = 0;
 
    virtual const Contact& getRemoteAddress() const = 0;
 
    virtual bool isOk() const = 0;
 
    virtual void reset() = 0;
 
    virtual void close() = 0;
 
    virtual void beginPacket() = 0;
 
    virtual void endPacket() = 0;
};
 
 
class YARP_os_API NullStream : public TwoWayStream, public InputStream, public OutputStream
{
private:
    Contact address;
 
public:
    virtual ~NullStream();
 
    InputStream& getInputStream() override;
    OutputStream& getOutputStream() override;
 
    const Contact& getLocalAddress() const override;
    const Contact& getRemoteAddress() const override;
 
    bool isOk() const override;
    void reset() override;
    void close() override;
    void beginPacket() override;
    void endPacket() override;
 
    using yarp::os::InputStream::read;
    yarp::conf::ssize_t read(Bytes& b) override;
 
    using yarp::os::OutputStream::write;
    void write(const Bytes& b) override;
};
 
} // namespace os
} // namespace yarp
 
#endif // YARP_OS_TWOWAYSTREAM_H