ConnectionReader.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_CONNECTIONREADER_H
#define YARP_OS_CONNECTIONREADER_H
 
#include <yarp/conf/numeric.h>
 
#include <yarp/os/Bytes.h>
#include <yarp/os/Contact.h>
#include <yarp/os/Searchable.h>
 
#include <string>
 
namespace yarp {
namespace os {
class ConnectionWriter;
class PortReader;
class Portable;
class InputStream;
} // namespace os
} // namespace yarp
 
 
namespace yarp {
namespace os {
 
class YARP_os_API ConnectionReader
{
public:
    virtual ~ConnectionReader();
 
    virtual bool expectBlock(char* data, size_t len) = 0;
 
    virtual std::string expectText(const char terminatingChar = '\n') = 0;
 
    virtual std::string expectString()
    {
        std::string ret;
        std::int32_t len = expectInt32();
        if (!isError()) {
            ret.resize(static_cast<size_t>(len));
            expectBlock(const_cast<char*>(ret.data()), len);
        }
        return ret;
    }
 
    YARP_DEPRECATED_INTERNAL_MSG("Use expectInt32 instead") // Since YARP 3.0.0
    virtual int expectInt() final
    {
        return static_cast<int>(expectInt32());
    }
 
    virtual std::int8_t expectInt8() = 0;
 
    virtual std::int16_t expectInt16() = 0;
 
    virtual std::int32_t expectInt32() = 0;
 
    virtual std::int64_t expectInt64() = 0;
 
    YARP_DEPRECATED_INTERNAL_MSG("Use expectFloat64 instead") // Since YARP 3.0.0
    virtual double expectDouble()
    {
        return static_cast<double>(expectFloat64());
    }
 
    virtual yarp::conf::float32_t expectFloat32() = 0;
 
    virtual yarp::conf::float64_t expectFloat64() = 0;
 
    virtual bool isTextMode() const = 0;
 
    virtual bool isBareMode() const = 0;
 
    virtual bool convertTextMode() = 0;
 
    virtual size_t getSize() const = 0;
 
 
    virtual ConnectionWriter* getWriter() = 0;
 
    virtual Bytes readEnvelope();
 
    virtual Portable* getReference() const = 0;
 
    virtual Contact getRemoteContact() const = 0;
 
    virtual Contact getLocalContact() const = 0;
 
    virtual bool isValid() const = 0;
 
    virtual bool isActive() const = 0;
 
    virtual bool isError() const = 0;
 
    virtual void requestDrop() = 0;
 
    virtual const Searchable& getConnectionModifiers() const = 0;
 
    virtual bool pushInt(int x) = 0;
 
    virtual bool setSize(size_t len) = 0;
 
    static ConnectionReader* createConnectionReader(InputStream& is);
 
    static bool readFromStream(PortReader& portable, InputStream& is);
 
    virtual void setParentConnectionReader(ConnectionReader* parentConnectionReader);
};
 
} // namespace os
} // namespace yarp
 
#endif // YARP_OS_CONNECTIONREADER_H