SETTINGS frame (RFC 7540 Section 6.5) More...

#include <frame.h>

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

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

Public Member Functions
	settings_frame (std::vector< setting_parameter > settings={}, bool ack=false)
	Construct SETTINGS frame.

auto	settings () const -> const std::vector< setting_parameter > &
	Get settings parameters.

auto	is_ack () const -> bool
	Check if this is an ACK frame.

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< settings_frame > >
	Parse SETTINGS 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< setting_parameter >	settings_
	Settings parameters.

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

SETTINGS frame (RFC 7540 Section 6.5)

SETTINGS frames convey configuration parameters that affect how endpoints communicate.

Definition at line 264 of file frame.h.

Constructor & Destructor Documentation

◆ settings_frame()

kcenon::network::protocols::http2::settings_frame::settings_frame	(	std::vector< setting_parameter >	settings = {},
		bool	ack = false )

explicit

Construct SETTINGS frame.

Parameters

settings	Vector of settings parameters
ack	True if this is an acknowledgment

Definition at line 353 of file frame.cpp.

        : settings_(std::move(settings))
    {
        header_.stream_id = 0;
        header_.type = frame_type::settings;
        header_.flags = ack ? frame_flags::ack : frame_flags::none;
 
        if (!ack)
        {
            for (const auto& setting : settings_)
            {
                auto id_bytes = write_uint32_be(static_cast<uint32_t>(setting.identifier));
                payload_.insert(payload_.end(), id_bytes.begin() + 2, id_bytes.end());
 
                auto value_bytes = write_uint32_be(setting.value);
                payload_.insert(payload_.end(), value_bytes.begin(), value_bytes.end());
            }
        }
 
        header_.length = static_cast<uint32_t>(payload_.size());
    }

Member Function Documentation

◆ is_ack()

auto kcenon::network::protocols::http2::settings_frame::is_ack ( ) const -> bool

Check if this is an ACK frame.

Returns: True if ACK flag is set

Definition at line 416 of file frame.cpp.

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

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

◆ parse()

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

static

Parse SETTINGS frame from raw bytes.

Parameters

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

Returns: Result containing parsed SETTINGS frame or error

Definition at line 375 of file frame.cpp.

    {
        if (hdr.stream_id != 0)
        {
            return error_info(10, "SETTINGS frame must have zero stream ID", "http2");
        }
 
        if (hdr.flags & frame_flags::ack)
        {
            if (!payload.empty())
            {
                return error_info(11, "SETTINGS ACK must have empty payload", "http2");
            }
 
            return std::make_unique<settings_frame>(std::vector<setting_parameter>{}, true);
        }
 
        if (payload.size() % 6 != 0)
        {
            return error_info(12, "Invalid SETTINGS frame payload size", "http2");
        }
 
        std::vector<setting_parameter> settings;
        for (size_t i = 0; i < payload.size(); i += 6)
        {
            uint16_t identifier = (static_cast<uint16_t>(payload[i]) << 8) |
                                 static_cast<uint16_t>(payload[i + 1]);
            uint32_t value = read_uint32_be(payload.subspan(i + 2, 4));
 
            settings.push_back({identifier, value});
        }
 
        return std::make_unique<settings_frame>(std::move(settings), false);
    }

References kcenon::network::protocols::http2::frame_flags::ack, and kcenon::network::protocols::http2::settings.

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

Here is the caller graph for this function:

◆ settings()

auto kcenon::network::protocols::http2::settings_frame::settings ( ) const -> const std::vector<setting_parameter>&

Get settings parameters.

Returns: Vector of settings

Definition at line 411 of file frame.cpp.

    {
        return settings_;
    }

References settings_.

Member Data Documentation

◆ settings_

std::vector<setting_parameter> kcenon::network::protocols::http2::settings_frame::settings_

private

Settings parameters.

Definition at line 297 of file frame.h.

Referenced by settings(), and settings_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