PING frame (RFC 7540 Section 6.7) More...

#include <frame.h>

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

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

Public Member Functions
	ping_frame (std::array< uint8_t, 8 > opaque_data={}, bool ack=false)
	Construct PING frame.

auto	opaque_data () const -> const std::array< uint8_t, 8 > &
	Get opaque data.

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< ping_frame > >
	Parse PING 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::array< uint8_t, 8 >	opaque_data_
	8-byte opaque 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

PING frame (RFC 7540 Section 6.7)

PING frames are a mechanism for measuring a minimal round-trip time from the sender and for determining whether an idle connection is still functional.

Definition at line 343 of file frame.h.

Constructor & Destructor Documentation

◆ ping_frame()

kcenon::network::protocols::http2::ping_frame::ping_frame	(	std::array< uint8_t, 8 >	opaque_data = {},
		bool	ack = false )

explicit

Construct PING frame.

Parameters

opaque_data	8-byte opaque data
ack	True if this is an acknowledgment

Definition at line 455 of file frame.cpp.

        : opaque_data_(opaque_data)
    {
        header_.stream_id = 0;
        header_.type = frame_type::ping;
        header_.flags = ack ? frame_flags::ack : frame_flags::none;
        header_.length = 8;
 
        payload_.assign(opaque_data_.begin(), opaque_data_.end());
    }

Member Function Documentation

◆ is_ack()

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

Check if this is an ACK frame.

Returns: True if ACK flag is set

Definition at line 490 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_.

◆ opaque_data()

auto kcenon::network::protocols::http2::ping_frame::opaque_data ( ) const -> const std::array<uint8_t, 8>&

Get opaque data.

Returns: 8-byte opaque data

Definition at line 485 of file frame.cpp.

    {
        return opaque_data_;
    }

References opaque_data_.

◆ parse()

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

static

Parse PING frame from raw bytes.

Parameters

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

Returns: Result containing parsed PING frame or error

Definition at line 466 of file frame.cpp.

    {
        if (hdr.stream_id != 0)
        {
            return error_info(15, "PING frame must have zero stream ID", "http2");
        }
 
        if (payload.size() != 8)
        {
            return error_info(16, "PING frame must have 8-byte payload", "http2");
        }
 
        std::array<uint8_t, 8> opaque_data;
        std::copy_n(payload.begin(), 8, opaque_data.begin());
 
        return std::make_unique<ping_frame>(opaque_data, hdr.flags & frame_flags::ack);
    }