boost socket iostreams echo server com compactação zlib dorme até que a conexão seja fechada

Jan 18 2021

Tento criar um servidor de eco simples com compactação zlib seguindo este e este exemplos.

Minha ideia é enviar alguma string agora porque posso converter os tipos de POD em string ( std::string(reinterpret_cast<const char *>(&pod), sizeof(pod))) antes de enviar, quando terei certeza de que a camada de transporte funciona.

E há um problema aqui. O cliente compacta os dados, os envia e diz que os dados foram enviados, mas o servidor está bloqueado na leitura dos dados. Não consigo entender por que isso acontece.

Tentei usar operator<<com out.flush(), também tentei usar boost::iostreams::copy(). O resultado é o mesmo. O exemplo de código é (eu uso o mesmo arquivo de origem para servidor e cliente, dependendo do args):

#include <boost/iostreams/filtering_stream.hpp>
#include <boost/iostreams/filter/zlib.hpp>
#include <boost/iostreams/copy.hpp>
#include <boost/asio.hpp>

#include <iostream>
#include <sstream>

namespace ip = boost::asio::ip;
using ip::tcp;

const unsigned short port = 9999;
const char host[] = "127.0.0.1";

void receive()
{
    boost::asio::io_context ctx;
    tcp::endpoint ep(ip::address::from_string(host), port);
    tcp::acceptor a(ctx, ep);

    tcp::iostream stream;
    a.accept(stream.socket());

    std::stringstream buffer;

    std::cout << "start session" << std::endl;

    try
    {
        for (;;)
        {
            {
                boost::iostreams::filtering_istream in;
                in.push(boost::iostreams::zlib_decompressor());
                in.push(stream);

                std::cout << "start reading" << std::endl;

                // looks like server is blocked here
                boost::iostreams::copy(in, buffer);
            }

            std::cout << "data: " << buffer.str() << std::endl;

            {
                boost::iostreams::filtering_ostream out;
                out.push(boost::iostreams::zlib_compressor());
                out.push(stream);

                boost::iostreams::copy(buffer, out);
            }

            std::cout << "Reply is sended" << std::endl;
        }
    }
    catch(const boost::iostreams::zlib_error &e)
    {
        std::cerr << e.what() << e.error() << '\n';
        stream.close();
    }
}

void send(const std::string &data)
{
    tcp::endpoint ep(ip::address::from_string(host), port);
    
    tcp::iostream stream;
    stream.connect(ep);

    std::stringstream buffer;
    buffer << data;

    if (!stream)
    {
        std::cerr << "Cannot connect to " << host << ":" << port << std::endl;
        return;
    }

    try
    {
        {
            boost::iostreams::filtering_ostream out;
            out.push(boost::iostreams::zlib_compressor());
            out.push(stream);

            out << buffer.str();
            out.flush();
        }

        std::cout << "sended: " << data << std::endl;
        buffer.str("");

        {
            boost::iostreams::filtering_istream in;
            in.push(boost::iostreams::zlib_decompressor());
            in.push(stream);

            // looks like client is blocked here
            boost::iostreams::copy(in, buffer);
        }

        std::cout << "result: " << buffer.str() << std::endl;
    }
    catch(const boost::iostreams::zlib_error &e)
    {
        std::cerr << e.what() << '\n';
    }
}

int main(int argc, const char *argv[])
{
    if (argc > 1 && argv[1] ==  std::string("sender"))
        send("hello world");
    else
        receive();

    return 0;
}

Primeiro eu inicio o servidor e depois o cliente. A seguinte saída é produzida:

Servidor

$ ./example
# now it waits while client will be accepted
start session
start reading

Cliente

$ ./example sender
sended: hello world

Os programas são bloqueados com a saída acima. Acho que o servidor ainda espera pelos dados do cliente e não sabe que o cliente enviou tudo o que ele tinha.

Se eu fechar o cliente com Ctrl + C, o resultado será o seguinte:

$ ./example
# now it waits while client will be accepted
start session
start reading
# now it is blocked until I press Ctrl + C
data: hello world
Reply is sended
start reading
zlib error-5

$ ./example sender
sended: hello world
^C

Acho que zlib error-5é porque o servidor acha que o arquivo está incompleto.

O comportamento esperado é nenhum bloqueio. A mensagem deve aparecer na saída do programa do servidor quando o cliente foi iniciado.

Por que o programa está bloqueado na leitura? Como posso corrigir isso?

Respostas

1 sehe Jan 18 2021 at 21:56

iostreams::copy faz exatamente isso: copia o stream.

Elogios ao seu código. É muito legível :) Isso me lembra desta resposta Lendo e gravando arquivos com soquete iostream boost . A principal diferença é que essa resposta envia um único blob compactado e fecha.

Você está "certo" que o descompressor sabe quando um bloco compactado está completo, mas não decide que outro não o seguirá.

Portanto, você precisa adicionar um enquadramento. A maneira tradicional é passar um comprimento fora da banda. Implementei as mudanças ao mesmo tempo que reduzi a duplicação de código usando manipuladores de IO.

template <typename T> struct LengthPrefixed {
    T _wrapped;

    friend std::ostream& operator<<(std::ostream& os, LengthPrefixed lp) ;
    friend std::istream& operator>>(std::istream& is, LengthPrefixed lp) ;
};

template <typename T> struct ZLIB {
    T& data;
    ZLIB(T& ref) : data(ref){}

    friend std::ostream& operator<<(std::ostream& os, ZLIB z) ;
    friend std::istream& operator>>(std::istream& is, ZLIB z) ;
};

`ZLIB` manipulador

Este encapsula principalmente o código que você duplicou entre o remetente / destinatário:

template <typename T> struct ZLIB {
    T& data;
    ZLIB(T& ref) : data(ref){}

    friend std::ostream& operator<<(std::ostream& os, ZLIB z) {
        {
            boost::iostreams::filtering_ostream out;
            out.push(boost::iostreams::zlib_compressor());
            out.push(os);
            out << z.data << std::flush;
        }
        return os.flush();
    }

    friend std::istream& operator>>(std::istream& is, ZLIB z) {
        boost::iostreams::filtering_istream in;
        in.push(boost::iostreams::zlib_decompressor());
        in.push(is);

        std::ostringstream oss;
        copy(in, oss);
        z.data = oss.str();

        return is;
    }
};

Fiz Ttemplado para que possa armazenar std::string&ou std::string const&dependendo da necessidade.

`LengthPrefixed` manipulador

Este manipulador não se importa com o que está sendo serializado, mas simplesmente irá prefixar com o comprimento efetivo na conexão:

template <typename T> struct LengthPrefixed {
    T _wrapped;

    friend std::ostream& operator<<(std::ostream& os, LengthPrefixed lp) {
        std::ostringstream oss;
        oss << lp._wrapped;
        auto on_the_wire = std::move(oss).str();

        debug << "Writing length " << on_the_wire.length() << std::endl;
        return os << on_the_wire.length() << "\n" << on_the_wire << std::flush;
    }

    friend std::istream& operator>>(std::istream& is, LengthPrefixed lp) {
        size_t len;
        if (is >> std::noskipws >> len && is.ignore(1, '\n')) {
            debug << "Reading length " << len << std::endl;

            std::string on_the_wire(len, '\0');
            if (is.read(on_the_wire.data(), on_the_wire.size())) {
                std::istringstream iss(on_the_wire);
                iss >> lp._wrapped;
            }
        }
        return is;
    }
};

Adicionamos uma sutileza: ao armazenar uma referência ou valor dependendo do que somos construídos, também podemos aceitar temporários (como o manipulador ZLIB):

boost socket iostreams echo server com compactação zlib dorme até que a conexão seja fechada

Respostas

ZLIB manipulador

LengthPrefixed manipulador

PROGRAMA DE DEMONSTRAÇÃO

Listagem Completa

`ZLIB` manipulador

`LengthPrefixed` manipulador