ISerialMsgs.cpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
// Autogenerated by Thrift Compiler (0.14.1-yarped)
//
// This is an automatically generated file.
// It could get re-generated if the ALLOW_IDL_GENERATION flag is on.
 
#include <yarp/conf/version.h>
#include <ISerialMsgs.h>
#include <yarp/os/LogComponent.h>
#include <yarp/os/LogStream.h>
 
#include <yarp/os/idl/WireTypes.h>
 
#include <algorithm>
 
namespace
{
    YARP_LOG_COMPONENT(SERVICE_LOG_COMPONENT, "ISerialMsgs")
}
 
//ISerialMsgs_getRemoteProtocolVersion_helper declaration
class ISerialMsgs_getRemoteProtocolVersion_helper :
public yarp::os::Portable
{
public:
    ISerialMsgs_getRemoteProtocolVersion_helper() = default;
    bool write(yarp::os::ConnectionWriter& connection) const override;
    bool read(yarp::os::ConnectionReader& connection) override;
 
    yarp::os::ApplicationNetworkProtocolVersion helper_proto;
};
 
bool ISerialMsgs_getRemoteProtocolVersion_helper::write(yarp::os::ConnectionWriter& connection) const
{
    yarp::os::idl::WireWriter writer(connection);
    if (!writer.writeListHeader(1)) {
        return false;
    }
    if (!writer.writeString("getRemoteProtocolVersion")) {
        return false;
    }
    return true;
}
 
bool ISerialMsgs_getRemoteProtocolVersion_helper ::read(yarp::os::ConnectionReader & connection)
 {
    yarp::os::idl::WireReader reader(connection);
    if (!reader.readListHeader()) {
        reader.fail();
        return false;
    }
 
    if (!helper_proto.read(connection)) {
        reader.fail();
        return false;
    }
    return true;
}
 
//ProtocolVersion, client side
yarp::os::ApplicationNetworkProtocolVersion ISerialMsgs::getRemoteProtocolVersion()
 {
    if(!yarp().canWrite()) {
        yError(" Missing server method ISerialMsgs::getRemoteProtocolVersion");
    }
    ISerialMsgs_getRemoteProtocolVersion_helper helper{};
    bool ok = yarp().write(helper, helper);
    if (ok) {
        return helper.helper_proto;}
    else {
        yarp::os::ApplicationNetworkProtocolVersion failureproto;
        return failureproto;}
}
 
//ProtocolVersion, client side
bool ISerialMsgs::checkProtocolVersion()
 {
        auto locproto = this->getLocalProtocolVersion();
        auto remproto = this->getRemoteProtocolVersion();
        if (remproto.protocol_version != locproto.protocol_version)
        {
            yCError(SERVICE_LOG_COMPONENT) << "Invalid communication protocol.";
            yCError(SERVICE_LOG_COMPONENT) << "Local Protocol Version: " << locproto.toString();
            yCError(SERVICE_LOG_COMPONENT) << "Remote Protocol Version: " << remproto.toString();
            return false;
        }
        return true;
}
 
//ProtocolVersion, server side
yarp::os::ApplicationNetworkProtocolVersion ISerialMsgs::getLocalProtocolVersion()
{
    yarp::os::ApplicationNetworkProtocolVersion myproto;
    //myproto.protocol_version using default value = 0
    //to change this value add the following line to the .thrift file:
    //const i16 protocol_version = <your_number_here>
    myproto.protocol_version = 0;
    myproto.yarp_major = YARP_VERSION_MAJOR;
    myproto.yarp_minor = YARP_VERSION_MINOR;
    myproto.yarp_patch = YARP_VERSION_PATCH;
    return myproto;
}
 
// setDTR helper class declaration
class ISerialMsgs_setDTR_helper :
        public yarp::os::Portable
{
public:
    ISerialMsgs_setDTR_helper() = default;
    explicit ISerialMsgs_setDTR_helper(const bool enable);
    bool write(yarp::os::ConnectionWriter& connection) const override;
    bool read(yarp::os::ConnectionReader& connection) override;
 
    class Command :
            public yarp::os::idl::WirePortable
    {
    public:
        Command() = default;
        explicit Command(const bool enable);
 
        ~Command() override = default;
 
        bool write(yarp::os::ConnectionWriter& connection) const override;
        bool read(yarp::os::ConnectionReader& connection) override;
 
        bool write(const yarp::os::idl::WireWriter& writer) const override;
        bool writeTag(const yarp::os::idl::WireWriter& writer) const;
        bool writeArgs(const yarp::os::idl::WireWriter& writer) const;
 
        bool read(yarp::os::idl::WireReader& reader) override;
        bool readTag(yarp::os::idl::WireReader& reader);
        bool readArgs(yarp::os::idl::WireReader& reader);
 
        bool enable{false};
    };
 
    class Reply :
            public yarp::os::idl::WirePortable
    {
    public:
        Reply() = default;
        ~Reply() override = default;
 
        bool write(yarp::os::ConnectionWriter& connection) const override;
        bool read(yarp::os::ConnectionReader& connection) override;
 
        bool write(const yarp::os::idl::WireWriter& writer) const override;
        bool read(yarp::os::idl::WireReader& reader) override;
 
        bool return_helper{false};
    };
 
    using funcptr_t = bool (*)(const bool);
    void call(ISerialMsgs* ptr);
 
    Command cmd;
    Reply reply;
 
    static constexpr const char* s_tag{"setDTR"};
    static constexpr size_t s_tag_len{1};
    static constexpr size_t s_cmd_len{2};
    static constexpr size_t s_reply_len{1};
    static constexpr const char* s_prototype{"bool ISerialMsgs::setDTR(const bool enable)"};
    static constexpr const char* s_help{""};
};
 
// flush helper class declaration
class ISerialMsgs_flush_helper :
        public yarp::os::Portable
{
public:
    ISerialMsgs_flush_helper() = default;
    bool write(yarp::os::ConnectionWriter& connection) const override;
    bool read(yarp::os::ConnectionReader& connection) override;
 
    class Command :
            public yarp::os::idl::WirePortable
    {
    public:
        Command() = default;
        ~Command() override = default;
 
        bool write(yarp::os::ConnectionWriter& connection) const override;
        bool read(yarp::os::ConnectionReader& connection) override;
 
        bool write(const yarp::os::idl::WireWriter& writer) const override;
        bool writeTag(const yarp::os::idl::WireWriter& writer) const;
        bool writeArgs(const yarp::os::idl::WireWriter& writer) const;
 
        bool read(yarp::os::idl::WireReader& reader) override;
        bool readTag(yarp::os::idl::WireReader& reader);
        bool readArgs(yarp::os::idl::WireReader& reader);
    };
 
    class Reply :
            public yarp::os::idl::WirePortable
    {
    public:
        Reply() = default;
        ~Reply() override = default;
 
        bool write(yarp::os::ConnectionWriter& connection) const override;
        bool read(yarp::os::ConnectionReader& connection) override;
 
        bool write(const yarp::os::idl::WireWriter& writer) const override;
        bool read(yarp::os::idl::WireReader& reader) override;
 
        std::int32_t return_helper{0};
    };
 
    using funcptr_t = std::int32_t (*)();
    void call(ISerialMsgs* ptr);
 
    Command cmd;
    Reply reply;
 
    static constexpr const char* s_tag{"flush"};
    static constexpr size_t s_tag_len{1};
    static constexpr size_t s_cmd_len{1};
    static constexpr size_t s_reply_len{1};
    static constexpr const char* s_prototype{"std::int32_t ISerialMsgs::flush()"};
    static constexpr const char* s_help{""};
};
 
// setDTR helper class implementation
ISerialMsgs_setDTR_helper::ISerialMsgs_setDTR_helper(const bool enable) :
        cmd{enable}
{
}
 
bool ISerialMsgs_setDTR_helper::write(yarp::os::ConnectionWriter& connection) const
{
    return cmd.write(connection);
}
 
bool ISerialMsgs_setDTR_helper::read(yarp::os::ConnectionReader& connection)
{
    return reply.read(connection);
}
 
ISerialMsgs_setDTR_helper::Command::Command(const bool enable) :
        enable{enable}
{
}
 
bool ISerialMsgs_setDTR_helper::Command::write(yarp::os::ConnectionWriter& connection) const
{
    yarp::os::idl::WireWriter writer(connection);
    if (!writer.writeListHeader(s_cmd_len)) {
        return false;
    }
    return write(writer);
}
 
bool ISerialMsgs_setDTR_helper::Command::read(yarp::os::ConnectionReader& connection)
{
    yarp::os::idl::WireReader reader(connection);
    if (!reader.readListHeader()) {
        reader.fail();
        return false;
    }
    return read(reader);
}
 
bool ISerialMsgs_setDTR_helper::Command::write(const yarp::os::idl::WireWriter& writer) const
{
    if (!writeTag(writer)) {
        return false;
    }
    if (!writeArgs(writer)) {
        return false;
    }
    return true;
}
 
bool ISerialMsgs_setDTR_helper::Command::writeTag(const yarp::os::idl::WireWriter& writer) const
{
    if (!writer.writeTag(s_tag, 1, s_tag_len)) {
        return false;
    }
    return true;
}
 
bool ISerialMsgs_setDTR_helper::Command::writeArgs(const yarp::os::idl::WireWriter& writer) const
{
    if (!writer.writeBool(enable)) {
        return false;
    }
    return true;
}
 
bool ISerialMsgs_setDTR_helper::Command::read(yarp::os::idl::WireReader& reader)
{
    if (!readTag(reader)) {
        return false;
    }
    if (!readArgs(reader)) {
        return false;
    }
    return true;
}
 
bool ISerialMsgs_setDTR_helper::Command::readTag(yarp::os::idl::WireReader& reader)
{
    std::string tag = reader.readTag(s_tag_len);
    if (reader.isError()) {
        return false;
    }
    if (tag != s_tag) {
        reader.fail();
        return false;
    }
    return true;
}
 
bool ISerialMsgs_setDTR_helper::Command::readArgs(yarp::os::idl::WireReader& reader)
{
    if (reader.noMore()) {
        reader.fail();
        return false;
    }
    if (!reader.readBool(enable)) {
        reader.fail();
        return false;
    }
    if (!reader.noMore()) {
        reader.fail();
        return false;
    }
    return true;
}
 
bool ISerialMsgs_setDTR_helper::Reply::write(yarp::os::ConnectionWriter& connection) const
{
    yarp::os::idl::WireWriter writer(connection);
    return write(writer);
}
 
bool ISerialMsgs_setDTR_helper::Reply::read(yarp::os::ConnectionReader& connection)
{
    yarp::os::idl::WireReader reader(connection);
    return read(reader);
}
 
bool ISerialMsgs_setDTR_helper::Reply::write(const yarp::os::idl::WireWriter& writer) const
{
    if (!writer.isNull()) {
        if (!writer.writeListHeader(s_reply_len)) {
            return false;
        }
        if (!writer.writeBool(return_helper)) {
            return false;
        }
    }
    return true;
}
 
bool ISerialMsgs_setDTR_helper::Reply::read(yarp::os::idl::WireReader& reader)
{
    if (!reader.readListReturn()) {
        return false;
    }
    if (reader.noMore()) {
        reader.fail();
        return false;
    }
    if (!reader.readBool(return_helper)) {
        reader.fail();
        return false;
    }
    return true;
}
 
void ISerialMsgs_setDTR_helper::call(ISerialMsgs* ptr)
{
    reply.return_helper = ptr->setDTR(cmd.enable);
}
 
// flush helper class implementation
bool ISerialMsgs_flush_helper::write(yarp::os::ConnectionWriter& connection) const
{
    return cmd.write(connection);
}
 
bool ISerialMsgs_flush_helper::read(yarp::os::ConnectionReader& connection)
{
    return reply.read(connection);
}
 
bool ISerialMsgs_flush_helper::Command::write(yarp::os::ConnectionWriter& connection) const
{
    yarp::os::idl::WireWriter writer(connection);
    if (!writer.writeListHeader(s_cmd_len)) {
        return false;
    }
    return write(writer);
}
 
bool ISerialMsgs_flush_helper::Command::read(yarp::os::ConnectionReader& connection)
{
    yarp::os::idl::WireReader reader(connection);
    if (!reader.readListHeader()) {
        reader.fail();
        return false;
    }
    return read(reader);
}
 
bool ISerialMsgs_flush_helper::Command::write(const yarp::os::idl::WireWriter& writer) const
{
    if (!writeTag(writer)) {
        return false;
    }
    if (!writeArgs(writer)) {
        return false;
    }
    return true;
}
 
bool ISerialMsgs_flush_helper::Command::writeTag(const yarp::os::idl::WireWriter& writer) const
{
    if (!writer.writeTag(s_tag, 1, s_tag_len)) {
        return false;
    }
    return true;
}
 
bool ISerialMsgs_flush_helper::Command::writeArgs(const yarp::os::idl::WireWriter& writer [[maybe_unused]]) const
{
    return true;
}
 
bool ISerialMsgs_flush_helper::Command::read(yarp::os::idl::WireReader& reader)
{
    if (!readTag(reader)) {
        return false;
    }
    if (!readArgs(reader)) {
        return false;
    }
    return true;
}
 
bool ISerialMsgs_flush_helper::Command::readTag(yarp::os::idl::WireReader& reader)
{
    std::string tag = reader.readTag(s_tag_len);
    if (reader.isError()) {
        return false;
    }
    if (tag != s_tag) {
        reader.fail();
        return false;
    }
    return true;
}
 
bool ISerialMsgs_flush_helper::Command::readArgs(yarp::os::idl::WireReader& reader)
{
    if (!reader.noMore()) {
        reader.fail();
        return false;
    }
    return true;
}
 
bool ISerialMsgs_flush_helper::Reply::write(yarp::os::ConnectionWriter& connection) const
{
    yarp::os::idl::WireWriter writer(connection);
    return write(writer);
}
 
bool ISerialMsgs_flush_helper::Reply::read(yarp::os::ConnectionReader& connection)
{
    yarp::os::idl::WireReader reader(connection);
    return read(reader);
}
 
bool ISerialMsgs_flush_helper::Reply::write(const yarp::os::idl::WireWriter& writer) const
{
    if (!writer.isNull()) {
        if (!writer.writeListHeader(s_reply_len)) {
            return false;
        }
        if (!writer.writeI32(return_helper)) {
            return false;
        }
    }
    return true;
}
 
bool ISerialMsgs_flush_helper::Reply::read(yarp::os::idl::WireReader& reader)
{
    if (!reader.readListReturn()) {
        return false;
    }
    if (reader.noMore()) {
        reader.fail();
        return false;
    }
    if (!reader.readI32(return_helper)) {
        reader.fail();
        return false;
    }
    return true;
}
 
void ISerialMsgs_flush_helper::call(ISerialMsgs* ptr)
{
    reply.return_helper = ptr->flush();
}
 
// Constructor
ISerialMsgs::ISerialMsgs()
{
    yarp().setOwner(*this);
}
 
bool ISerialMsgs::setDTR(const bool enable)
{
    if (!yarp().canWrite()) {
        yError("Missing server method '%s'?", ISerialMsgs_setDTR_helper::s_prototype);
    }
    ISerialMsgs_setDTR_helper helper{enable};
    bool ok = yarp().write(helper, helper);
    return ok ? helper.reply.return_helper : bool{};
}
 
std::int32_t ISerialMsgs::flush()
{
    if (!yarp().canWrite()) {
        yError("Missing server method '%s'?", ISerialMsgs_flush_helper::s_prototype);
    }
    ISerialMsgs_flush_helper helper{};
    bool ok = yarp().write(helper, helper);
    return ok ? helper.reply.return_helper : std::int32_t{};
}
 
// help method
std::vector<std::string> ISerialMsgs::help(const std::string& functionName)
{
    bool showAll = (functionName == "--all");
    std::vector<std::string> helpString;
    if (showAll) {
        helpString.emplace_back("*** Available commands:");
        helpString.emplace_back(ISerialMsgs_setDTR_helper::s_tag);
        helpString.emplace_back(ISerialMsgs_flush_helper::s_tag);
        helpString.emplace_back("help");
    } else {
        if (functionName == ISerialMsgs_setDTR_helper::s_tag) {
            helpString.emplace_back(ISerialMsgs_setDTR_helper::s_prototype);
        }
        if (functionName == ISerialMsgs_flush_helper::s_tag) {
            helpString.emplace_back(ISerialMsgs_flush_helper::s_prototype);
        }
        if (functionName == "help") {
            helpString.emplace_back("std::vector<std::string> help(const std::string& functionName = \"--all\")");
            helpString.emplace_back("Return list of available commands, or help message for a specific function");
            helpString.emplace_back("@param functionName name of command for which to get a detailed description. If none or '--all' is provided, print list of available commands");
            helpString.emplace_back("@return list of strings (one string per line)");
        }
    }
    if (helpString.empty()) {
        helpString.emplace_back("Command not found");
    }
    return helpString;
}
 
// read from ConnectionReader
bool ISerialMsgs::read(yarp::os::ConnectionReader& connection)
{
    constexpr size_t max_tag_len = 1;
    size_t tag_len = 1;
 
    yarp::os::idl::WireReader reader(connection);
    reader.expectAccept();
    if (!reader.readListHeader()) {
        reader.fail();
        return false;
    }
 
    std::string tag = reader.readTag(1);
    bool direct = (tag == "__direct__");
    if (direct) {
        tag = reader.readTag(1);
    }
    while (tag_len <= max_tag_len && !reader.isError()) {
        if(tag == "getRemoteProtocolVersion") {
            if (!reader.noMore()) {
                yError("Reader invalid protocol?! %s:%d - %s", __FILE__, __LINE__, __YFUNCTION__);
                reader.fail();
                return false;
            }
 
            auto proto = getLocalProtocolVersion();
 
            yarp::os::idl::WireWriter writer(reader);
           if (!writer.writeListHeader(1)) {
                yWarning("Writer invalid protocol?! %s:%d - %s", __FILE__, __LINE__, __YFUNCTION__);
               return false;}
            if (!writer.write(proto)) {
                yWarning("Writer invalid protocol?! %s:%d - %s", __FILE__, __LINE__, __YFUNCTION__);
                return false;
            }
            reader.accept();
            return true;
        }
        if (tag == ISerialMsgs_setDTR_helper::s_tag) {
            ISerialMsgs_setDTR_helper helper;
            if (!helper.cmd.readArgs(reader)) {
                return false;
            }
 
            helper.call(this);
 
            yarp::os::idl::WireWriter writer(reader);
            if (!helper.reply.write(writer)) {
                return false;
            }
            reader.accept();
            return true;
        }
        if (tag == ISerialMsgs_flush_helper::s_tag) {
            ISerialMsgs_flush_helper helper;
            if (!helper.cmd.readArgs(reader)) {
                return false;
            }
 
            helper.call(this);
 
            yarp::os::idl::WireWriter writer(reader);
            if (!helper.reply.write(writer)) {
                return false;
            }
            reader.accept();
            return true;
        }
        if (tag == "help") {
            std::string functionName;
            if (!reader.readString(functionName)) {
                functionName = "--all";
            }
            auto help_strings = help(functionName);
            yarp::os::idl::WireWriter writer(reader);
            if (!writer.isNull()) {
                if (!writer.writeListHeader(2)) {
                    return false;
                }
                if (!writer.writeTag("many", 1, 0)) {
                    return false;
                }
                if (!writer.writeListBegin(0, help_strings.size())) {
                    return false;
                }
                for (const auto& help_string : help_strings) {
                    if (!writer.writeString(help_string)) {
                        return false;
                    }
                }
                if (!writer.writeListEnd()) {
                    return false;
                }
            }
            reader.accept();
            return true;
        }
        if (reader.noMore()) {
            reader.fail();
            return false;
        }
        std::string next_tag = reader.readTag(1);
        if (next_tag.empty()) {
            break;
        }
        tag.append("_").append(next_tag);
        tag_len = std::count(tag.begin(), tag.end(), '_') + 1;
    }
    return false;
}