Chunked.hpp

This File On Github
Ask A Question

API: latest
module: oatpp
#include "oatpp/web/protocol/http/encoding/Chunked.hpp"

EncoderChunked

Chunked-encoding buffer processor. oatpp::data::buffer::Processor.

namespace oatpp { namespace web { namespace protocol { namespace http { namespace encoding { 
  class EncoderChunked : public data::buffer::Processor {}
}}}}}

Methods

Return Type Name Summary
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.

EncoderChunked::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

EncoderChunked::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

DecoderChunked

Chunked-decoding buffer processor. oatpp::data::buffer::Processor.

namespace oatpp { namespace web { namespace protocol { namespace http { namespace encoding { 
  class DecoderChunked : public data::buffer::Processor {}
}}}}}

Methods

Return Type Name Summary
[none] DecoderChunked 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.

DecoderChunked::DecoderChunked

Constructor.

DecoderChunked()

DecoderChunked::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

DecoderChunked::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

ChunkedEncoderProvider

EncoderProvider for "chunked" encoding.

namespace oatpp { namespace web { namespace protocol { namespace http { namespace encoding { 
  class ChunkedEncoderProvider : public EncoderProvider {}
}}}}}

Methods

Return Type Name Summary
oatpp::String getEncodingName Get encoding name.
std::shared_ptr<data::buffer::Processor> getProcessor Get oatpp::data::buffer::Processor for chunked encoding.

ChunkedEncoderProvider::getEncodingName

Get encoding name.

  • @return

oatpp::String getEncodingName() override

ChunkedEncoderProvider::getProcessor

Get oatpp::data::buffer::Processor for chunked encoding.

std::shared_ptr<data::buffer::Processor> getProcessor() override

ChunkedDecoderProvider

EncoderProvider for "chunked" decoding.

namespace oatpp { namespace web { namespace protocol { namespace http { namespace encoding { 
  class ChunkedDecoderProvider : public EncoderProvider {}
}}}}}

Methods

Return Type Name Summary
oatpp::String getEncodingName Get encoding name.
std::shared_ptr<data::buffer::Processor> getProcessor Get oatpp::data::buffer::Processor for chunked decoding.

ChunkedDecoderProvider::getEncodingName

Get encoding name.

  • @return

oatpp::String getEncodingName() override

ChunkedDecoderProvider::getProcessor

Get oatpp::data::buffer::Processor for chunked decoding.

std::shared_ptr<data::buffer::Processor> getProcessor() override