Processor.hpp

This File On Github
Ask A Question

API: latest
module: oatpp-zlib
#include "oatpp-zlib/Processor.hpp"

DeflateEncoder

Deflate encoder.

namespace oatpp { namespace zlib { 
  class DeflateEncoder : public oatpp::data::buffer::Processor {}
}}

Methods

Return Type Name Summary
[none] DeflateEncoder Constructor.
v_io_size suggestInputStreamReadSize If the client is using the input stream to read data and push it to the processor,
v_int32 iterate Process data.

DeflateEncoder::DeflateEncoder

Constructor.

  • @param bufferSize
  • @param compressionLevel
  • @param useGzip

DeflateEncoder(v_buff_size bufferSize = 1024, bool gzip = false, v_int32 compressionLevel = Z_DEFAULT_COMPRESSION)

DeflateEncoder::suggestInputStreamReadSize

If the client is using the input stream to read data and push it to the processor, the client MAY ask the processor for a suggested read size.

  • @return - suggested read size.

v_io_size suggestInputStreamReadSize() override

DeflateEncoder::iterate

Process data.

  • @param dataIn - data provided by client to processor. Input data. data::buffer::InlineReadData. Set dataIn buffer pointer to nullptr to designate the end of input.
  • @param dataOut - data provided to client by processor. Output data. data::buffer::InlineReadData.
  • @return - Processor::Error.

v_int32 iterate(data::buffer::InlineReadData& dataIn, data::buffer::InlineReadData& dataOut) override

DeflateDecoder

Deflate decoder.

namespace oatpp { namespace zlib { 
  class DeflateDecoder : public oatpp::data::buffer::Processor {}
}}

Methods

Return Type Name Summary
[none] DeflateDecoder Constructor.
v_io_size suggestInputStreamReadSize If the client is using the input stream to read data and push it to the processor,
v_int32 iterate Process data.

DeflateDecoder::DeflateDecoder

Constructor.

  • @param bufferSize
  • @param gzip

DeflateDecoder(v_buff_size bufferSize = 1024, bool gzip = false)

DeflateDecoder::suggestInputStreamReadSize

If the client is using the input stream to read data and push it to the processor, the client MAY ask the processor for a suggested read size.

  • @return - suggested read size.

v_io_size suggestInputStreamReadSize() override

DeflateDecoder::iterate

Process data.

  • @param dataIn - data provided by client to processor. Input data. data::buffer::InlineReadData. Set dataIn buffer pointer to nullptr to designate the end of input.
  • @param dataOut - data provided to client by processor. Output data. data::buffer::InlineReadData.
  • @return - Processor::Error.

v_int32 iterate(data::buffer::InlineReadData& dataIn, data::buffer::InlineReadData& dataOut) override