proxygen: proxygen::QPACKCodec Class Reference

#include <QPACKCodec.h>

Inheritance diagram for proxygen::QPACKCodec:

Public Member Functions
	QPACKCodec ()

	~QPACKCodec () override

QPACKEncoder::EncodeResult	encode (std::vector< compress::Header > &headers, uint64_t id) noexcept

HPACK::DecodeError	decodeEncoderStream (std::unique_ptr< folly::IOBuf > buf)

void	decodeStreaming (uint64_t streamId, std::unique_ptr< folly::IOBuf > block, uint32_t length, HPACK::StreamingCallback *streamingCb) noexcept

void	setEncoderHeaderTableSize (uint32_t size)

void	setDecoderHeaderTableMaxSize (uint32_t size)

HPACK::DecodeError	decodeDecoderStream (std::unique_ptr< folly::IOBuf > buf)

void	onStreamReset (uint64_t streamId)

std::unique_ptr< folly::IOBuf >	encodeTableStateSync ()

std::unique_ptr< folly::IOBuf >	encodeHeaderAck (uint64_t streamId)

std::unique_ptr< folly::IOBuf >	encodeCancelStream (uint64_t streamId)

void	describe (std::ostream &os) const

void	setMaxUncompressed (uint64_t maxUncompressed) override

HPACKTableInfo	getHPACKTableInfo () const

void	setHeaderIndexingStrategy (const HeaderIndexingStrategy *indexingStrat)

const HeaderIndexingStrategy *	getHeaderIndexingStrategy () const

uint64_t	getHolBlockCount () const

uint64_t	getQueuedBytes () const

void	setMaxVulnerable (uint32_t maxVulnerable)

void	setMaxBlocking (uint32_t maxBlocking)

Public Member Functions inherited from proxygen::HeaderCodec
	HeaderCodec ()

virtual	~HeaderCodec ()

const HTTPHeaderSize &	getEncodedSize ()

void	setEncodeHeadroom (uint32_t headroom)

uint64_t	getMaxUncompressed () const

void	setStats (Stats *stats)

Protected Attributes
QPACKEncoder	encoder_

QPACKDecoder	decoder_

Protected Attributes inherited from proxygen::HeaderCodec
HTTPHeaderSize	encodedSize_

uint32_t	encodeHeadroom_ {0}

uint64_t	maxUncompressed_ {kMaxUncompressed}

Stats *	stats_ {nullptr}

Private Member Functions
void	recordCompressedSize (const QPACKEncoder::EncodeResult &encodeRes)

Private Attributes
std::vector< HPACKHeader >	decodedHeaders_

Additional Inherited Members
Public Types inherited from proxygen::HeaderCodec
enum	Type : uint8_t { Type::GZIP = 0, Type::HPACK = 1, Type::QPACK = 2 }

Static Public Attributes inherited from proxygen::HeaderCodec
static const uint32_t	kMaxUncompressed = 128 * 1024

Detailed Description

Definition at line 36 of file QPACKCodec.h.

Constructor & Destructor Documentation

proxygen::QPACKCodec::QPACKCodec ( )

Definition at line 29 of file QPACKCodec.cpp.

30 : encoder_(true, HPACK::kTableSize),

31 decoder_(HPACK::kTableSize, maxUncompressed_) {}

proxygen::HPACK::kTableSize

const uint32_t kTableSize

Definition: HPACKConstants.h:62

proxygen::QPACKCodec::decoder_

QPACKDecoder decoder_

Definition: QPACKCodec.h:131

proxygen::HeaderCodec::maxUncompressed_

uint64_t maxUncompressed_

Definition: HeaderCodec.h:92

proxygen::QPACKCodec::encoder_

QPACKEncoder encoder_

Definition: QPACKCodec.h:130

proxygen::QPACKCodec::~QPACKCodec ( )

inlineoverride

Definition at line 39 of file QPACKCodec.h.

References encode(), folly::pushmi::__adl::noexcept(), and uint64_t.

39 {}

Member Function Documentation

HPACK::DecodeError proxygen::QPACKCodec::decodeDecoderStream ( std::unique_ptr< folly::IOBuf > buf )

inline

Definition at line 67 of file QPACKCodec.h.

References folly::gen::move.

Referenced by proxygen::compress::QPACKScheme::recvAck().

                                      {
     return encoder_.decodeDecoderStream(std::move(buf));
   }

HPACK::DecodeError proxygen::QPACKCodec::decodeEncoderStream ( std::unique_ptr< folly::IOBuf > buf )

inline

Definition at line 45 of file QPACKCodec.h.

References folly::gen::move, folly::pushmi::__adl::noexcept(), uint32_t, and uint64_t.

Referenced by proxygen::compress::QPACKScheme::decode().

                                                                       {
     // stats?
     return decoder_.decodeEncoderStream(std::move(buf));
   }

void proxygen::QPACKCodec::decodeStreaming	(	uint64_t	streamId,
		std::unique_ptr< folly::IOBuf >	block,
		uint32_t	length,
		HPACK::StreamingCallback *	streamingCb
	)

noexcept

Definition at line 56 of file QPACKCodec.cpp.

References decoder_, proxygen::QPACKDecoder::decodeStreaming(), folly::gen::move, proxygen::HeaderCodec::stats_, and streamID.

Referenced by proxygen::compress::QPACKScheme::decode().

                                                   {
   if (streamingCb) {
     streamingCb->stats = stats_;
   }
   decoder_.decodeStreaming(streamID, std::move(block), length, streamingCb);
 }

void proxygen::QPACKCodec::describe ( std::ostream & os ) const

Definition at line 67 of file QPACKCodec.cpp.

References decoder_, and encoder_.

Referenced by proxygen::operator<<().

                                                   {
   stream << "DecoderTable:\n" << decoder_;
   stream << "EncoderTable:\n" << encoder_;
 }

QPACKEncoder::EncodeResult proxygen::QPACKCodec::encode	(	std::vector< compress::Header > &	headers,
		uint64_t	id
	)

noexcept

Definition at line 47 of file QPACKCodec.cpp.

References proxygen::QPACKEncoder::encode(), proxygen::HeaderCodec::encodedSize_, proxygen::HeaderCodec::encodeHeadroom_, encoder_, proxygen::compress::prepareHeaders(), recordCompressedSize(), and wangle::HTTPHeaderSize::uncompressed.

Referenced by proxygen::compress::QPACKScheme::encode().

                                                        {
   auto prepared = compress::prepareHeaders(headers);
   encodedSize_.uncompressed = prepared.second;
   auto res = encoder_.encode(prepared.first, encodeHeadroom_, streamId);
   recordCompressedSize(res);
   return res;
 }

std::unique_ptr<folly::IOBuf> proxygen::QPACKCodec::encodeCancelStream ( uint64_t streamId )

inline

Definition at line 86 of file QPACKCodec.h.

                                                                   {
     return decoder_.encodeCancelStream(streamId);
   }

std::unique_ptr<folly::IOBuf> proxygen::QPACKCodec::encodeHeaderAck ( uint64_t streamId )

inline

Definition at line 82 of file QPACKCodec.h.

Referenced by proxygen::compress::QPACKScheme::getAck().

                                                                {
     return decoder_.encodeHeaderAck(streamId);
   }

std::unique_ptr<folly::IOBuf> proxygen::QPACKCodec::encodeTableStateSync ( )

inline

Definition at line 78 of file QPACKCodec.h.

Referenced by proxygen::compress::QPACKScheme::getAck().

                                                    {
     return decoder_.encodeTableStateSync();
   }

const HeaderIndexingStrategy* proxygen::QPACKCodec::getHeaderIndexingStrategy ( ) const

inline

Definition at line 109 of file QPACKCodec.h.

                                                                   {
     return encoder_.getHeaderIndexingStrategy();
   }

uint64_t proxygen::QPACKCodec::getHolBlockCount ( ) const

inline

Definition at line 113 of file QPACKCodec.h.

Referenced by proxygen::compress::QPACKScheme::getHolBlockCount().

                                     {
     return decoder_.getHolBlockCount();
   }

HPACKTableInfo proxygen::QPACKCodec::getHPACKTableInfo ( ) const

inline

Definition at line 97 of file QPACKCodec.h.

                                            {
     return HPACKTableInfo(encoder_.getTableSize(),
                           encoder_.getBytesStored(),
                           encoder_.getHeadersStored(),
                           decoder_.getTableSize(),
                           decoder_.getBytesStored(),
                           decoder_.getHeadersStored());
   }

uint64_t proxygen::QPACKCodec::getQueuedBytes ( ) const

inline

Definition at line 117 of file QPACKCodec.h.

Referenced by proxygen::compress::QPACKScheme::decode(), and proxygen::compress::QPACKScheme::~QPACKScheme().

                                   {
     return decoder_.getQueuedBytes();
   }

void proxygen::QPACKCodec::onStreamReset ( uint64_t streamId )

inline

Definition at line 74 of file QPACKCodec.h.

                                         {
     encoder_.onHeaderAck(streamId, true);
   }

void proxygen::QPACKCodec::recordCompressedSize ( const QPACKEncoder::EncodeResult & encodeRes )

private

Definition at line 33 of file QPACKCodec.cpp.

References wangle::HTTPHeaderSize::compressed, proxygen::QPACKEncoder::EncodeResult::control, proxygen::HeaderCodec::encodedSize_, proxygen::HeaderCodec::QPACK, proxygen::HeaderCodec::Stats::recordEncode(), proxygen::HeaderCodec::stats_, and proxygen::QPACKEncoder::EncodeResult::stream.

Referenced by encode().

                                              {
   encodedSize_.compressed = 0;
   if (encodeRes.control) {
     encodedSize_.compressed += encodeRes.control->computeChainDataLength();
   }
   if (encodeRes.stream) {
     encodedSize_.compressed += encodeRes.stream->computeChainDataLength();
   }
   if (stats_) {
     stats_->recordEncode(Type::QPACK, encodedSize_);
   }
 }

void proxygen::QPACKCodec::setDecoderHeaderTableMaxSize ( uint32_t size )

inline

Definition at line 62 of file QPACKCodec.h.

Referenced by main(), and proxygen::compress::QPACKScheme::QPACKScheme().

                                                    {
     decoder_.setHeaderTableMaxSize(size);
   }

void proxygen::QPACKCodec::setEncoderHeaderTableSize ( uint32_t size )

inline

Definition at line 58 of file QPACKCodec.h.

Referenced by proxygen::compress::QPACKScheme::QPACKScheme().

                                                 {
     encoder_.setHeaderTableSize(size);
   }

void proxygen::QPACKCodec::setHeaderIndexingStrategy ( const HeaderIndexingStrategy * indexingStrat )

inline

Definition at line 106 of file QPACKCodec.h.

Referenced by proxygen::compress::QPACKScheme::QPACKScheme().

                                                                               {
     encoder_.setHeaderIndexingStrategy(indexingStrat);
   }

void proxygen::QPACKCodec::setMaxBlocking ( uint32_t maxBlocking )

inline

Definition at line 125 of file QPACKCodec.h.

Referenced by main(), and proxygen::compress::QPACKScheme::QPACKScheme().

                                             {
     decoder_.setMaxBlocking(maxBlocking);
   }

void proxygen::QPACKCodec::setMaxUncompressed ( uint64_t maxUncompressed )

inlineoverridevirtual

Reimplemented from proxygen::HeaderCodec.

Definition at line 92 of file QPACKCodec.h.

                                                              {
     HeaderCodec::setMaxUncompressed(maxUncompressed);
     decoder_.setMaxUncompressed(maxUncompressed);
   }

void proxygen::QPACKCodec::setMaxVulnerable ( uint32_t maxVulnerable )

inline

Definition at line 121 of file QPACKCodec.h.

Referenced by proxygen::compress::QPACKScheme::QPACKScheme().

                                                 {
     encoder_.setMaxVulnerable(maxVulnerable);
   }

Member Data Documentation

std::vector<HPACKHeader> proxygen::QPACKCodec::decodedHeaders_

private

Definition at line 136 of file QPACKCodec.h.

QPACKDecoder proxygen::QPACKCodec::decoder_

protected

Definition at line 131 of file QPACKCodec.h.

Referenced by decodeStreaming(), and describe().

QPACKEncoder proxygen::QPACKCodec::encoder_

protected

Definition at line 130 of file QPACKCodec.h.

Referenced by describe(), and encode().

The documentation for this class was generated from the following files:

proxygen/lib/http/codec/compress/QPACKCodec.h
proxygen/lib/http/codec/compress/QPACKCodec.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation