HEADERS frame (RFC 7540 Section 6.2) More...

#include <frame.h>

Inheritance diagram for kcenon::network::protocols::http2::headers_frame:

Collaboration diagram for kcenon::network::protocols::http2::headers_frame:

Public Member Functions
	headers_frame (uint32_t stream_id, std::vector< uint8_t > header_block, bool end_stream=false, bool end_headers=true)
	Construct HEADERS frame.

auto	is_end_stream () const -> bool
	Check if END_STREAM flag is set.

auto	is_end_headers () const -> bool
	Check if END_HEADERS flag is set.

auto	header_block () const -> std::span< const uint8_t >
	Get header block fragment.

Public Member Functions inherited from kcenon::network::protocols::http2::frame
	frame ()=default
	Default constructor.

	frame (const frame_header &hdr, std::vector< uint8_t > payload)
	Construct frame with header and payload.

auto	serialize () const -> std::vector< uint8_t >
	Serialize frame to bytes.

auto	header () const -> const frame_header &
	Get frame header.

auto	payload () const -> std::span< const uint8_t >
	Get frame payload.

virtual	~frame ()=default
	Virtual destructor.

Static Public Member Functions
static auto	parse (const frame_header &hdr, std::span< const uint8_t > payload) -> Result< std::unique_ptr< headers_frame > >
	Parse HEADERS frame from raw bytes.

Static Public Member Functions inherited from kcenon::network::protocols::http2::frame
static auto	parse (std::span< const uint8_t > data) -> Result< std::unique_ptr< frame > >
	Parse frame from raw bytes.

Private Attributes
std::vector< uint8_t >	header_block_
	Header block fragment.

Additional Inherited Members
Protected Attributes inherited from kcenon::network::protocols::http2::frame
frame_header	header_
	Frame header.

std::vector< uint8_t >	payload_
	Frame payload.

Detailed Description

HEADERS frame (RFC 7540 Section 6.2)

HEADERS frames are used to open a stream and carry a header block fragment.

Definition at line 188 of file frame.h.

Constructor & Destructor Documentation

◆ headers_frame()

kcenon::network::protocols::http2::headers_frame::headers_frame	(	uint32_t	stream_id,
		std::vector< uint8_t >	header_block,
		bool	end_stream = false,
		bool	end_headers = true )

Construct HEADERS frame.

Parameters

stream_id	Stream identifier
header_block	Header block fragment
end_stream	True if this is the last frame in stream
end_headers	True if this is the last header frame
priority_data	Optional priority information

Definition at line 272 of file frame.cpp.

        : header_block_(std::move(header_block))
    {
        header_.stream_id = stream_id;
        header_.type = frame_type::headers;
        header_.flags = frame_flags::none;
 
        if (end_stream)
        {
            header_.flags |= frame_flags::end_stream;
        }
 
        if (end_headers)
        {
            header_.flags |= frame_flags::end_headers;
        }
 
        payload_ = header_block_;
        header_.length = static_cast<uint32_t>(payload_.size());
    }

Member Function Documentation

◆ header_block()

auto kcenon::network::protocols::http2::headers_frame::header_block ( ) const -> std::span<const uint8_t>

Get header block fragment.

Returns: Span of header block bytes

Definition at line 348 of file frame.cpp.

    {
        return header_block_;
    }

References header_block_.

◆ is_end_headers()

auto kcenon::network::protocols::http2::headers_frame::is_end_headers ( ) const -> bool

Check if END_HEADERS flag is set.

Returns: True if this is the last header frame

Definition at line 343 of file frame.cpp.

    {
        return header_.flags & frame_flags::end_headers;
    }

References kcenon::network::protocols::http2::frame_flags::end_headers, kcenon::network::protocols::http2::frame_header::flags, and kcenon::network::protocols::http2::frame::header_.

◆ is_end_stream()

auto kcenon::network::protocols::http2::headers_frame::is_end_stream ( ) const -> bool

Check if END_STREAM flag is set.

Returns: True if this is the last frame in stream

Definition at line 338 of file frame.cpp.

    {
        return header_.flags & frame_flags::end_stream;
    }

References kcenon::network::protocols::http2::frame_flags::end_stream, kcenon::network::protocols::http2::frame_header::flags, and kcenon::network::protocols::http2::frame::header_.

◆ parse()

auto kcenon::network::protocols::http2::headers_frame::parse	(	const frame_header &	hdr,
		std::span< const uint8_t >	payload ) -> Result<std::unique_ptr<headers_frame>>

static

Parse HEADERS frame from raw bytes.

Parameters

hdr	Frame header (must be HEADERS type)
payload	Frame payload

Returns: Result containing parsed HEADERS frame or error

Definition at line 294 of file frame.cpp.

    {
        if (hdr.stream_id == 0)
        {
            return error_info(7, "HEADERS frame must have non-zero stream ID", "http2");
        }
 
        std::vector<uint8_t> header_block;
        size_t offset = 0;
 
        if (hdr.flags & frame_flags::padded)
        {
            if (payload.empty())
            {
                return error_info(8, "Padded HEADERS frame must have pad length", "http2");
            }
 
            uint8_t pad_length = payload[0];
            offset = 1;
 
            if (payload.size() < offset + pad_length)
            {
                return error_info(9, "Invalid padding in HEADERS frame", "http2");
            }
 
            header_block.assign(payload.begin() + offset,
                              payload.end() - pad_length);
        }
        else
        {
            header_block.assign(payload.begin(), payload.end());
        }
 
        auto frame = std::make_unique<headers_frame>(
            hdr.stream_id,
            std::move(header_block),
            hdr.flags & frame_flags::end_stream,
            hdr.flags & frame_flags::end_headers
        );
 
        return frame;
    }

References kcenon::network::protocols::http2::frame_flags::end_headers, kcenon::network::protocols::http2::frame_flags::end_stream, and kcenon::network::protocols::http2::frame_flags::padded.

Referenced by kcenon::network::protocols::http2::frame::parse().

Here is the caller graph for this function:

Member Data Documentation

◆ header_block_

std::vector<uint8_t> kcenon::network::protocols::http2::headers_frame::header_block_

private

Header block fragment.

Definition at line 230 of file frame.h.

Referenced by header_block(), and headers_frame().

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

src/internal/protocols/http2/frame.h
src/protocols/http2/frame.cpp

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members