kcenon::network::protocols::http2::goaway_frame Class Reference

GOAWAY frame (RFC 7540 Section 6.8) More...

#include <frame.h>

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

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

Public Member Functions
	goaway_frame (uint32_t last_stream_id, uint32_t error_code, std::vector< uint8_t > additional_data={})
	Construct GOAWAY frame.
auto	last_stream_id () const -> uint32_t
	Get last stream ID.
auto	error_code () const -> uint32_t
	Get error code.
auto	additional_data () const -> std::span< const uint8_t >
	Get additional debug data.
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< goaway_frame > >
	Parse GOAWAY 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
uint32_t	last_stream_id_
	Last stream ID.
uint32_t	error_code_
	Error code.
std::vector< uint8_t >	additional_data_
	Debug data.

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

GOAWAY frame (RFC 7540 Section 6.8)

GOAWAY frames are used to initiate shutdown of a connection or to signal serious error conditions.

Definition at line 386 of file frame.h.

Constructor & Destructor Documentation

goaway_frame()

kcenon::network::protocols::http2::goaway_frame::goaway_frame	(	uint32_t	last_stream_id,
		uint32_t	error_code,
		std::vector< uint8_t >	additional_data = {} )

Construct GOAWAY frame.

Parameters

last_stream_id	Last stream ID processed
error_code	Error code
additional_data	Optional additional debug data

Definition at line 495 of file frame.cpp.

        : last_stream_id_(last_stream_id),
          error_code_(error_code),
          additional_data_(std::move(additional_data))
    {
        header_.stream_id = 0;
        header_.type = frame_type::goaway;
        header_.flags = frame_flags::none;
 
        auto last_stream_bytes = write_uint32_be(last_stream_id_ & stream_id_mask);
        payload_.insert(payload_.end(), last_stream_bytes.begin(), last_stream_bytes.end());
 
        auto error_bytes = write_uint32_be(error_code_);
        payload_.insert(payload_.end(), error_bytes.begin(), error_bytes.end());
 
        payload_.insert(payload_.end(), additional_data_.begin(), additional_data_.end());
 
        header_.length = static_cast<uint32_t>(payload_.size());
    }

References additional_data_, error_code_, kcenon::network::protocols::http2::frame_header::flags, kcenon::network::protocols::http2::goaway, kcenon::network::protocols::http2::frame::header_, last_stream_id_, kcenon::network::protocols::http2::frame_header::length, kcenon::network::protocols::http2::frame_flags::none, kcenon::network::protocols::http2::frame::payload_, kcenon::network::protocols::http2::frame_header::stream_id, and kcenon::network::protocols::http2::frame_header::type.

Member Function Documentation

additional_data()

auto kcenon::network::protocols::http2::goaway_frame::additional_data

(

)

const -> std::span<const uint8_t>

Get additional debug data.

Returns

Span of additional data

Definition at line 552 of file frame.cpp.

    {
        return additional_data_;
    }

References additional_data_.

error_code()

auto kcenon::network::protocols::http2::goaway_frame::error_code

(

)

const -> uint32_t

Get error code.

Returns

Error code

Definition at line 547 of file frame.cpp.

    {
        return error_code_;
    }

References error_code_.

last_stream_id()

auto kcenon::network::protocols::http2::goaway_frame::last_stream_id

(

)

const -> uint32_t

Get last stream ID.

Returns

Last stream ID processed

Definition at line 542 of file frame.cpp.

    {
        return last_stream_id_;
    }

References last_stream_id_.

parse()

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

static

Parse GOAWAY frame from raw bytes.

Parameters

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

Returns

Result containing parsed GOAWAY frame or error

Definition at line 516 of file frame.cpp.

    {
        if (hdr.stream_id != 0)
        {
            return error_info(17, "GOAWAY frame must have zero stream ID", "http2");
        }
 
        if (payload.size() < 8)
        {
            return error_info(18, "GOAWAY frame must have at least 8-byte payload", "http2");
        }
 
        uint32_t last_stream_id = read_uint32_be(payload.subspan(0, 4)) & stream_id_mask;
        uint32_t error_code = read_uint32_be(payload.subspan(4, 4));
 
        std::vector<uint8_t> additional_data;
        if (payload.size() > 8)
        {
            additional_data.assign(payload.begin() + 8, payload.end());
        }
 
        return std::make_unique<goaway_frame>(last_stream_id, error_code,
                                             std::move(additional_data));
    }

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

Here is the caller graph for this function:

Member Data Documentation

additional_data_

std::vector<uint8_t> kcenon::network::protocols::http2::goaway_frame::additional_data_

private

Debug data.

Definition at line 428 of file frame.h.

Referenced by additional_data(), and goaway_frame().

error_code_

uint32_t kcenon::network::protocols::http2::goaway_frame::error_code_

private

Error code.

Definition at line 427 of file frame.h.

Referenced by error_code(), and goaway_frame().

last_stream_id_

uint32_t kcenon::network::protocols::http2::goaway_frame::last_stream_id_

private

Last stream ID.

Definition at line 426 of file frame.h.

Referenced by goaway_frame(), and last_stream_id().

---

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

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