ConnectionWriter.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2018 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_CONNECTIONWRITER_H
#define YARP_OS_CONNECTIONWRITER_H

#include <yarp/os/api.h>
#include <string>
#include <yarp/conf/numeric.h>

namespace yarp {
    namespace os {
        class ConnectionWriter;
        class ConnectionReader;
        class PortReader;
        class PortWriter;
        class Portable;
        class SizedWriter;
        class OutputStream;
    }
}

class YARP_OS_API yarp::os::ConnectionWriter {
public:

    virtual ~ConnectionWriter();

    virtual void appendBlock(const char *data, size_t len) = 0;

    YARP_DEPRECATED_INTERNAL_MSG("Use appendInt32 instead") // Since YARP 3.0.0
    virtual void appendInt(int data) final { appendInt32(static_cast<std::int32_t>(data)); }

    virtual void appendInt8(std::int8_t data) = 0;

    virtual void appendInt16(std::int16_t data) = 0;

    virtual void appendInt32(std::int32_t data) = 0;

    virtual void appendInt64(std::int64_t data) = 0;

    YARP_DEPRECATED_INTERNAL_MSG("Use appendFloat64 instead") // Since YARP 3.0.0
    virtual void appendDouble(double data) { appendFloat64(static_cast<yarp::conf::float64_t>(data)); }

    virtual void appendFloat32(yarp::conf::float32_t data) = 0;

    virtual void appendFloat64(yarp::conf::float64_t data) = 0;

    virtual void appendString(const char *str, int terminate = '\n') = 0;

    virtual void appendExternalBlock(const char *data, size_t len) = 0;

    virtual bool isTextMode() const = 0;

    virtual bool isBareMode() const = 0;

    virtual void declareSizes(int argc, int *argv) = 0;

    virtual void setReplyHandler(PortReader& reader) = 0;

    virtual void setReference(Portable *obj) = 0;


    virtual bool convertTextMode() = 0;


    virtual bool isValid() const = 0;

    virtual bool isActive() const = 0;

    virtual bool isError() const = 0;


    virtual void requestDrop() = 0;

    virtual bool isNull() const;


    virtual SizedWriter *getBuffer() const = 0;


    virtual void appendRawString(const std::string& str) {
        appendInt32(static_cast<std::int32_t>(str.length()));
        appendBlock((char*)str.c_str(), str.length());
    }

    static ConnectionWriter *createBufferedConnectionWriter();

    static bool writeToStream(PortWriter& portable, OutputStream& os);
};

#endif // YARP_OS_CONNECTIONWRITER_H