ConnectionWriter.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006 RobotCub Consortium
 * Authors: Paul Fitzpatrick
 * CopyPolicy: Released under the terms of the LGPLv2.1 or later, see LGPL.TXT
 */

#ifndef YARP_OS_CONNECTIONWRITER_H
#define YARP_OS_CONNECTIONWRITER_H

#include <yarp/os/ConstString.h>
#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;

    virtual void appendInt(int data) = 0;

    virtual void appendInt64(const YARP_INT64& data) = 0;

    virtual void appendDouble(double 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() = 0;

    virtual bool isBareMode() = 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() = 0;

    virtual bool isActive() = 0;

    virtual bool isError() = 0;


    virtual void requestDrop() = 0;

    virtual bool isNull() const;


    virtual SizedWriter *getBuffer() = 0;


    virtual void appendRawString(const ConstString& str) {
        appendInt(str.length());
        appendBlock((char*)str.c_str(), str.length());
    }

    static ConnectionWriter *createBufferedConnectionWriter();

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

#endif // YARP_OS_CONNECTIONWRITER_H