InputStream.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_INPUTSTREAM_H
#define YARP_OS_INPUTSTREAM_H
 
#include <yarp/conf/numeric.h>
 
#include <yarp/os/api.h>
 
#include <string>
 
namespace yarp::os {
 
class Bytes;
 
class YARP_os_API InputStream
{
public:
    InputStream();
 
    virtual ~InputStream();
 
    virtual void check();
 
    virtual int read();
 
    virtual yarp::conf::ssize_t read(Bytes& b, size_t offset, yarp::conf::ssize_t len);
 
    virtual yarp::conf::ssize_t read(yarp::os::Bytes& b) = 0;
 
 
    virtual yarp::conf::ssize_t partialRead(yarp::os::Bytes& b);
 
    virtual void close() = 0;
 
    virtual void interrupt();
 
    virtual bool isOk() const = 0;
 
    virtual bool setReadTimeout(double timeout);
 
    std::string readLine(const char terminal = '\n', bool* success = nullptr);
 
    yarp::conf::ssize_t readFull(Bytes& b);
 
    yarp::conf::ssize_t readDiscard(size_t len);
 
    typedef void (*readEnvelopeCallbackType)(void*, const yarp::os::Bytes& envelope);
 
    virtual bool setReadEnvelopeCallback(readEnvelopeCallbackType callback, void* data);
};
 
} // namespace yarp::os
 
#endif // YARP_OS_INPUTSTREAM_H